Skip to content

Commit 381e5f1

Browse files
pquentingithub-actions[bot]
pquentin
authored and
github-actions[bot]
committed
Update rest-api-spec
1 parent 2162c0f commit 381e5f1

13 files changed

+81
-31
lines changed

‎specification/_json_spec/connector.sync_job_list.json‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,17 @@
2929
"description": "specifies a max number of results to get (default: 100)"
3030
},
3131
"status": {
32-
"type": "string",
33-
"description": "Sync job status, which sync jobs are fetched for"
32+
"type": "enum",
33+
"description": "A sync job status to fetch connector sync jobs for",
34+
"options": [
35+
"canceling",
36+
"canceled",
37+
"completed",
38+
"error",
39+
"in_progress",
40+
"pending",
41+
"suspended"
42+
]
3443
},
3544
"connector_id": {
3645
"type": "string",

‎specification/_json_spec/esql.async_query.json‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,18 @@
2020
},
2121
"params": {
2222
"format": {
23-
"type": "string",
24-
"description": "a short version of the Accept header, e.g. json, yaml"
23+
"type": "enum",
24+
"description": "A short version of the Accept header, e.g. json, yaml.\n\n`csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.\n\nFor async requests, nothing will be returned if the async query doesn't finish within the timeout.\nThe query ID and running status are available in the `X-Elasticsearch-Async-Id` and `X-Elasticsearch-Async-Is-Running` HTTP headers of the response, respectively.",
25+
"options": [
26+
"csv",
27+
"json",
28+
"tsv",
29+
"txt",
30+
"yaml",
31+
"cbor",
32+
"smile",
33+
"arrow"
34+
]
2535
},
2636
"delimiter": {
2737
"type": "string",

‎specification/_json_spec/esql.async_query_get.json‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,18 @@
2525
},
2626
"params": {
2727
"format": {
28-
"type": "string",
29-
"description": "a short version of the Accept header, e.g. json, yaml"
28+
"type": "enum",
29+
"description": "A short version of the Accept header, for example `json` or `yaml`.",
30+
"options": [
31+
"csv",
32+
"json",
33+
"tsv",
34+
"txt",
35+
"yaml",
36+
"cbor",
37+
"smile",
38+
"arrow"
39+
]
3040
},
3141
"wait_for_completion_timeout": {
3242
"type": "time",

‎specification/_json_spec/esql.query.json‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,18 @@
2020
},
2121
"params": {
2222
"format": {
23-
"type": "string",
24-
"description": "a short version of the Accept header, e.g. json, yaml"
23+
"type": "enum",
24+
"description": "A short version of the Accept header, e.g. json, yaml.\n\n`csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.",
25+
"options": [
26+
"csv",
27+
"json",
28+
"tsv",
29+
"txt",
30+
"yaml",
31+
"cbor",
32+
"smile",
33+
"arrow"
34+
]
2535
},
2636
"delimiter": {
2737
"type": "string",

‎specification/_json_spec/ml.get_trained_models.json‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,15 @@
3434
"default": true
3535
},
3636
"include": {
37-
"type": "string",
38-
"description": "A comma-separate list of fields to optionally include. Valid options are 'definition' and 'total_feature_importance'. Default is none."
37+
"type": "enum",
38+
"description": "A comma delimited string of optional fields to include in the response\nbody.",
39+
"options": [
40+
"definition",
41+
"feature_importance_baseline",
42+
"hyperparameters",
43+
"total_feature_importance",
44+
"definition_status"
45+
]
3946
},
4047
"decompress_definition": {
4148
"type": "boolean",

‎specification/_json_spec/ml.start_trained_model_deployment.json‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,9 @@
4545
"default": 1
4646
},
4747
"priority": {
48-
"type": "string",
48+
"type": "enum",
4949
"description": "The deployment priority.",
50-
"default": "normal"
50+
"options": ["normal", "low"]
5151
},
5252
"queue_capacity": {
5353
"type": "int",
@@ -60,9 +60,9 @@
6060
"default": "20s"
6161
},
6262
"wait_for": {
63-
"type": "string",
64-
"description": "The allocation status for which to wait",
65-
"options": ["starting", "started", "fully_allocated"],
63+
"type": "enum",
64+
"description": "Specifies the allocation status to wait for before returning.",
65+
"options": ["started", "starting", "fully_allocated"],
6666
"default": "started"
6767
}
6868
},

‎specification/_json_spec/simulate.ingest.json‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,9 @@
3434
"description": "The pipeline id to preprocess incoming documents with if no pipeline is given for a particular document"
3535
},
3636
"merge_type": {
37-
"type": "string",
38-
"description": "The mapping merge type if mapping overrides are being provided in mapping_addition. The allowed values are one of index or template. The index option merges mappings the way they would be merged into an existing index. The template option merges mappings the way they would be merged into a template.",
37+
"type": "enum",
38+
"description": "The mapping merge type if mapping overrides are being provided in mapping_addition.\nThe allowed values are one of index or template.\nThe index option merges mappings the way they would be merged into an existing index.\nThe template option merges mappings the way they would be merged into a template.",
39+
"options": ["index", "template"],
3940
"default": "index"
4041
}
4142
},

‎specification/_json_spec/sql.query.json‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,9 @@
2020
},
2121
"params": {
2222
"format": {
23-
"type": "string",
24-
"description": "a short version of the Accept header, e.g. json, yaml"
23+
"type": "enum",
24+
"description": "The format for the response.\nYou can also specify a format using the `Accept` HTTP header.\nIf you specify both this parameter and the `Accept` HTTP header, this parameter takes precedence.",
25+
"options": ["csv", "json", "tsv", "txt", "yaml", "cbor", "smile"]
2526
},
2627
"project_routing": {
2728
"type": "string",

‎specification/_json_spec/streams.logs_disable.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
{
22
"streams.logs_disable": {
33
"documentation": {
4-
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/streams-logs-disable.html",
4+
"url": "https://www.elastic.co/docs/api/doc/elasticsearch#TODO",
55
"description": "Disable the Logs Streams feature for this cluster"
66
},
7-
"stability": "stable",
7+
"stability": "experimental",
88
"visibility": "feature_flag",
99
"feature_flag": "logs_stream",
1010
"headers": {

‎specification/_json_spec/streams.logs_enable.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
{
22
"streams.logs_enable": {
33
"documentation": {
4-
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/streams-logs-enable.html",
4+
"url": "https://www.elastic.co/docs/api/doc/elasticsearch#TODO",
55
"description": "Enable the Logs Streams feature for this cluster"
66
},
7-
"stability": "stable",
7+
"stability": "experimental",
88
"visibility": "feature_flag",
99
"feature_flag": "logs_stream",
1010
"headers": {

0 commit comments

Comments
 (0)