Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions output/schema/schema.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 11 additions & 2 deletions specification/_json_spec/connector.sync_job_list.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,17 @@
"description": "specifies a max number of results to get (default: 100)"
},
"status": {
"type": "string",
"description": "Sync job status, which sync jobs are fetched for"
"type": "enum",
"description": "A sync job status to fetch connector sync jobs for",
"options": [
"canceling",
"canceled",
"completed",
"error",
"in_progress",
"pending",
"suspended"
]
},
"connector_id": {
"type": "string",
Expand Down
14 changes: 12 additions & 2 deletions specification/_json_spec/esql.async_query.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,18 @@
},
"params": {
"format": {
"type": "string",
"description": "a short version of the Accept header, e.g. json, yaml"
"type": "enum",
"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.",
"options": [
"csv",
"json",
"tsv",
"txt",
"yaml",
"cbor",
"smile",
"arrow"
]
},
"delimiter": {
"type": "string",
Expand Down
14 changes: 12 additions & 2 deletions specification/_json_spec/esql.async_query_get.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,18 @@
},
"params": {
"format": {
"type": "string",
"description": "a short version of the Accept header, e.g. json, yaml"
"type": "enum",
"description": "A short version of the Accept header, for example `json` or `yaml`.",
"options": [
"csv",
"json",
"tsv",
"txt",
"yaml",
"cbor",
"smile",
"arrow"
]
},
"wait_for_completion_timeout": {
"type": "time",
Expand Down
14 changes: 12 additions & 2 deletions specification/_json_spec/esql.query.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,18 @@
},
"params": {
"format": {
"type": "string",
"description": "a short version of the Accept header, e.g. json, yaml"
"type": "enum",
"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.",
"options": [
"csv",
"json",
"tsv",
"txt",
"yaml",
"cbor",
"smile",
"arrow"
]
},
"delimiter": {
"type": "string",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"indices.get_all_sample_configuration": {
"documentation": {
"url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-all-sample-configuration",
"description": "Get sampling configurations for all indices and data streams"
},
"stability": "experimental",
"visibility": "public",
"headers": {
"accept": ["application/json"]
},
"url": {
"paths": [
{
"path": "/_sample/config",
"methods": ["GET"]
}
]
},
"params": {
"master_timeout": {
"type": "time",
"description": "Timeout for connection to master node"
}
}
}
}
11 changes: 9 additions & 2 deletions specification/_json_spec/ml.get_trained_models.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,15 @@
"default": true
},
"include": {
"type": "string",
"description": "A comma-separate list of fields to optionally include. Valid options are 'definition' and 'total_feature_importance'. Default is none."
"type": "enum",
"description": "A comma delimited string of optional fields to include in the response\nbody.",
"options": [
"definition",
"feature_importance_baseline",
"hyperparameters",
"total_feature_importance",
"definition_status"
]
},
"decompress_definition": {
"type": "boolean",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,9 @@
"default": 1
},
"priority": {
"type": "string",
"type": "enum",
"description": "The deployment priority.",
"default": "normal"
"options": ["normal", "low"]
},
"queue_capacity": {
"type": "int",
Expand All @@ -60,9 +60,9 @@
"default": "20s"
},
"wait_for": {
"type": "string",
"description": "The allocation status for which to wait",
"options": ["starting", "started", "fully_allocated"],
"type": "enum",
"description": "Specifies the allocation status to wait for before returning.",
"options": ["started", "starting", "fully_allocated"],
"default": "started"
}
},
Expand Down
5 changes: 3 additions & 2 deletions specification/_json_spec/simulate.ingest.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,9 @@
"description": "The pipeline id to preprocess incoming documents with if no pipeline is given for a particular document"
},
"merge_type": {
"type": "string",
"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.",
"type": "enum",
"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.",
"options": ["index", "template"],
"default": "index"
}
},
Expand Down
5 changes: 3 additions & 2 deletions specification/_json_spec/sql.query.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,9 @@
},
"params": {
"format": {
"type": "string",
"description": "a short version of the Accept header, e.g. json, yaml"
"type": "enum",
"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.",
"options": ["csv", "json", "tsv", "txt", "yaml", "cbor", "smile"]
},
"project_routing": {
"type": "string",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,10 @@
"description": "Optional parameter to specify the Grok pattern that should be used to extract fields from messages in a semi-structured text file"
},
"ecs_compatibility": {
"type": "string",
"default": "disabled",
"description": "Optional parameter to specify the compatibility mode with ECS Grok patterns - may be either 'v1' or 'disabled'"
"type": "enum",
"description": "The mode of compatibility with ECS compliant Grok patterns.\nUse this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern.\nThis setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input.\nIf the structure finder identifies a common structure but has no idea of the meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output.\nThe intention in that situation is that a user who knows the meanings will rename the fields before using them.",
"options": ["disabled", "v1"],
"default": "disabled"
},
"timestamp_field": {
"type": "string",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,10 @@
"description": "Optional parameter to specify the Grok pattern that should be used to extract fields from messages in a semi-structured text file"
},
"ecs_compatibility": {
"type": "string",
"default": "disabled",
"description": "Optional parameter to specify the compatibility mode with ECS Grok patterns - may be either 'v1' or 'disabled'"
"type": "enum",
"description": "The mode of compatibility with ECS compliant Grok patterns.\nUse this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern.\nThis setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input.\nIf the structure finder identifies a common structure but has no idea of meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output, with the intention that a user who knows the meanings rename these fields before using it.",
"options": ["disabled", "v1"],
"default": "disabled"
},
"timestamp_field": {
"type": "string",
Expand Down