diff --git a/docs/overlays/elasticsearch-openapi-overlays.yaml b/docs/overlays/elasticsearch-openapi-overlays.yaml index 20cee553e6..3c99fe1812 100644 --- a/docs/overlays/elasticsearch-openapi-overlays.yaml +++ b/docs/overlays/elasticsearch-openapi-overlays.yaml @@ -199,6 +199,96 @@ actions: examples: resumeFollowIndexResponseExample1: $ref: "../../specification/ccr/resume_follow/examples/response/ResumeFollowIndexResponseExample1.yaml" + - target: "$.paths['/{index}/_ccr/unfollow']['post']" + description: "Add examples for unfollow an index" + update: + responses: + 200: + content: + application/json: + examples: + ccrUnfollowIndexResponseExample1: + $ref: "../../specification/ccr/unfollow/examples/response/UnfollowIndexResponseExample1.yaml" + - target: "$.paths['/_ccr/stats']['get']" + description: "Add examples for get ccr stats" + update: + responses: + 200: + content: + application/json: + examples: + ccrStatsResponseExample1: + $ref: "../../specification/ccr/stats/examples/response/CcrStatsResponseExample1.yaml" + - target: "$.paths['/_ccr/auto_follow/{name}/resume']['post']" + description: "Add examples for resume auto-follow pattern" + update: + responses: + 200: + content: + application/json: + examples: + ccrResumeAutoFollowResponseExample1: + $ref: "../../specification/ccr/resume_auto_follow_pattern/examples/response/ResumeAutoFollowPatternResponseExample1.yaml" + - target: "$.paths['/{index}/_ccr/pause_follow']['post']" + description: "Add examples for resume auto-follow pattern" + update: + responses: + 200: + content: + application/json: + examples: + ccrPauseFollowResponseExample1: + $ref: "../../specification/ccr/pause_follow/examples/response/PauseFollowIndexResponseExample1.yaml" + - target: "$.paths['/_ccr/auto_follow/{name}/pause']['post']" + description: "Add examples for pause auto-follow pattern" + update: + responses: + 200: + content: + application/json: + examples: + ccrPauseAutoFollowPatternResponseExample1: + $ref: "../../specification/ccr/pause_auto_follow_pattern/examples/response/PauseAutoFollowPatternResponseExample1.yaml" + - target: "$.components['responses']['ccr.get_auto_follow_pattern#200']" + description: "Add examples for get auto-follow pattern" + update: + content: + application/json: + examples: + ccrPauseAutoFollowPatternResponseExample1: + $ref: "../../specification/ccr/get_auto_follow_pattern/examples/response/GetAutoFollowPatternResponseExample1.yaml" + - target: "$.paths['/{index}/_ccr/stats']['get']" + description: "Add examples for get follower stats" + update: + responses: + 200: + content: + application/json: + examples: + ccrFollowerStatsResponseExample1: + $ref: "../../specification/ccr/follow_stats/examples/response/FollowIndexStatsResponseExample1.yaml" + - target: "$.paths['/{index}/_ccr/info']['get']" + description: "Add examples for get follower info" + update: + responses: + 200: + content: + application/json: + examples: + ccrFollowerInfoResponseExample1: + $ref: "../../specification/ccr/follow_info/examples/response/FollowInfoResponseExample1.yaml" + ccrFollowerInfoResponseExample2: + $ref: "../../specification/ccr/follow_info/examples/response/FollowInfoResponseExample2.yaml" + - target: "$.paths['/_ccr/auto_follow/{name}']['delete']" + description: "Add examples for delete auto follow pattern" + update: + responses: + 200: + content: + application/json: + examples: + ccrAutoFollowPatternDeleteResponseExample1: + $ref: "../../specification/ccr/delete_auto_follow_pattern/examples/response/DeleteAutoFollowPatternResponseExample1.yaml" ## Examples for cluster - target: "$.components['requestBodies']['cluster.allocation_explain']" description: "Add examples for cluster allocation explain operation" @@ -493,16 +583,16 @@ actions: examples: getIndicesRecoveryResponseExample1: $ref: "../../specification/indices/recovery/examples/200_response/indicesRecoveryResponseExample1.yaml" - - target: "$.paths['/_resolve/cluster/{name}']['get']" + - target: "$.components['responses']['indices.resolve_cluster#200']" description: "Add examples for resolve cluster operation" update: - responses: - 200: - content: - application/json: - examples: - resolveClusterResponseExample1: - $ref: "../../specification/indices/resolve_cluster/examples/200_response/ResolveClusterResponseExample1.yaml" + content: + application/json: + examples: + resolveClusterResponseExample1: + $ref: "../../specification/indices/resolve_cluster/examples/200_response/ResolveClusterResponseExample1.yaml" + resolveClusterResponseExample2: + $ref: "../../specification/indices/resolve_cluster/examples/200_response/ResolveClusterResponseExample2.yaml" - target: "$.components['requestBodies']['indices.shrink']" description: "Add example for shrink index request" update: diff --git a/docs/overlays/elasticsearch-shared-overlays.yaml b/docs/overlays/elasticsearch-shared-overlays.yaml index c34c937f29..6153331317 100644 --- a/docs/overlays/elasticsearch-shared-overlays.yaml +++ b/docs/overlays/elasticsearch-shared-overlays.yaml @@ -2463,6 +2463,30 @@ actions: examples: asyncSearchSubmitResponseExample1: $ref: "../../specification/async_search/submit/examples/response/AsyncSearchSubmitResponseExample1.yaml" + - target: "$.paths['/_async_search/status/{id}']['get']" + description: "Add examples for get async search status" + update: + responses: + 200: + content: + application/json: + examples: + asyncSearchStatusResponseExample1: + $ref: "../../specification/async_search/status/examples/response/AsyncSearchStatusResponseExample1.yaml" + asyncSearchStatusResponseExample2: + $ref: "../../specification/async_search/status/examples/response/AsyncSearchStatusResponseExample2.yaml" + asyncSearchStatusResponseExample3: + $ref: "../../specification/async_search/status/examples/response/AsyncSearchStatusResponseExample3.yaml" + - target: "$.paths['/_async_search/{id}']['get']" + description: "Add examples for get async search" + update: + responses: + 200: + content: + application/json: + examples: + asyncSearchResponseExample1: + $ref: "../../specification/async_search/get/examples/response/AsyncSearchGetResponseExample1.yaml" ## Examples for search applications - target: "$.paths['/_application/search_application']['get']" description: "Add examples for get search applications operation" diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 66335414f0..369733bb9d 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -32,7 +32,7 @@ { "in": "query", "name": "keep_alive", - "description": "Specifies how long the async search should be available in the cluster.\nWhen not specified, the `keep_alive` set with the corresponding submit async request will be used.\nOtherwise, it is possible to override the value and extend the validity of the request.\nWhen this period expires, the search, if still running, is cancelled.\nIf the search is completed, its saved results are deleted.", + "description": "The length of time that the async search should be available in the cluster.\nWhen not specified, the `keep_alive` set with the corresponding submit async request will be used.\nOtherwise, it is possible to override the value and extend the validity of the request.\nWhen this period expires, the search, if still running, is cancelled.\nIf the search is completed, its saved results are deleted.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types:Duration" @@ -115,7 +115,7 @@ "search" ], "summary": "Get the async search status", - "description": "Get the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", + "description": "Get the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, the access to the status of a specific async search is restricted to:\n\n* The user or API key that submitted the original async search request.\n* Users that have the `monitor` cluster privilege or greater privileges.", "operationId": "async-search-status", "parameters": [ { @@ -132,7 +132,7 @@ { "in": "query", "name": "keep_alive", - "description": "Specifies how long the async search needs to be available.\nOngoing async searches and any saved search results are deleted after this period.", + "description": "The length of time that the async search needs to be available.\nOngoing async searches and any saved search results are deleted after this period.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types:Duration" @@ -18071,7 +18071,7 @@ "description": "Column headings for the search results. Each object is a column.", "type": "array", "items": { - "$ref": "#/components/schemas/sql:Column" + "$ref": "#/components/schemas/sql._types:Column" } }, "cursor": { @@ -18082,7 +18082,7 @@ "description": "The values for the search results.", "type": "array", "items": { - "$ref": "#/components/schemas/sql:Row" + "$ref": "#/components/schemas/sql._types:Row" } } }, @@ -20512,7 +20512,7 @@ "type": "object", "properties": { "aggregations": { - "description": "Partial aggregations results, coming from the shards that have already completed the execution of the query.", + "description": "Partial aggregations results, coming from the shards that have already completed running the query.", "type": "object", "additionalProperties": { "$ref": "#/components/schemas/_types.aggregations:Aggregate" @@ -25495,7 +25495,7 @@ "type": "boolean" }, "is_running": { - "description": "Indicates whether the search is still running or has completed.\nNOTE: If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though `is_running` is `false`.", + "description": "Indicates whether the search is still running or has completed.\n\n> info\n> If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though `is_running` is `false`.", "type": "boolean" }, "expiration_time": { @@ -25550,7 +25550,7 @@ "$ref": "#/components/schemas/_types:ClusterStatistics" }, "completion_status": { - "description": "If the async search completed, this field shows the status code of the search.\nFor example, 200 indicates that the async search was successfully completed.\n503 indicates that the async search was completed with an error.", + "description": "If the async search completed, this field shows the status code of the search.\nFor example, `200` indicates that the async search was successfully completed.\n`503` indicates that the async search was completed with an error.", "type": "number" } }, @@ -28709,8 +28709,7 @@ } }, "required": [ - "_id", - "_index" + "_id" ] }, "_types.query_dsl:PrefixQuery": { @@ -29738,7 +29737,7 @@ "type": "object", "properties": { "value": { - "type": "string" + "$ref": "#/components/schemas/_types:FieldValue" } }, "required": [ @@ -36334,26 +36333,23 @@ "$ref": "#/components/schemas/_types:VersionString" }, "max_output_size": { + "description": "The maximum token size to emit. Tokens larger than this size will be discarded.\nDefaults to `255`", "type": "number" }, - "preserve_original": { - "type": "boolean" - }, "separator": { + "description": "The character to use to concatenate the terms.\nDefaults to a space.", "type": "string" }, "stopwords": { "$ref": "#/components/schemas/_types.analysis:StopWords" }, "stopwords_path": { + "description": "The path to a file containing stop words.", "type": "string" } }, "required": [ - "type", - "max_output_size", - "preserve_original", - "separator" + "type" ] }, "_types.analysis:KeywordAnalyzer": { @@ -36496,21 +36492,27 @@ "$ref": "#/components/schemas/_types:VersionString" }, "flags": { + "description": "Java regular expression flags. Flags should be pipe-separated, eg \"CASE_INSENSITIVE|COMMENTS\".", "type": "string" }, "lowercase": { + "description": "Should terms be lowercased or not.\nDefaults to `true`.", "type": "boolean" }, "pattern": { + "description": "A Java regular expression.\nDefaults to `\\W+`.", "type": "string" }, "stopwords": { "$ref": "#/components/schemas/_types.analysis:StopWords" + }, + "stopwords_path": { + "description": "The path to a file containing stop words.", + "type": "string" } }, "required": [ - "type", - "pattern" + "type" ] }, "_types.analysis:SimpleAnalyzer": { @@ -36540,10 +36542,15 @@ ] }, "max_token_length": { + "description": "The maximum token length. If a token is seen that exceeds this length then it is split at `max_token_length` intervals.\nDefaults to `255`.", "type": "number" }, "stopwords": { "$ref": "#/components/schemas/_types.analysis:StopWords" + }, + "stopwords_path": { + "description": "The path to a file containing stop words.", + "type": "string" } }, "required": [ @@ -36566,6 +36573,7 @@ "$ref": "#/components/schemas/_types.analysis:StopWords" }, "stopwords_path": { + "description": "The path to a file containing stop words.", "type": "string" } }, @@ -45164,7 +45172,6 @@ } }, "required": [ - "query", "vertices" ] }, @@ -45216,7 +45223,6 @@ } }, "required": [ - "boost", "term" ] }, @@ -46314,6 +46320,12 @@ "$ref": "#/components/schemas/inference._types:TextEmbeddingByteResult" } }, + "text_embedding_bits": { + "type": "array", + "items": { + "$ref": "#/components/schemas/inference._types:TextEmbeddingByteResult" + } + }, "text_embedding": { "type": "array", "items": { @@ -46866,8 +46878,7 @@ "type": "string" }, "if": { - "description": "Conditionally execute the processor.", - "type": "string" + "$ref": "#/components/schemas/_types:Script" }, "ignore_failure": { "description": "Ignore failures for the processor.", @@ -47211,7 +47222,6 @@ } }, "required": [ - "date_formats", "date_rounding", "field" ] @@ -50014,11 +50024,7 @@ "type": "string" } } - }, - "required": [ - "includes", - "excludes" - ] + } }, "ml._types:DataframeAnalyticsAuthorization": { "type": "object", @@ -55615,7 +55621,7 @@ } ] }, - "sql:Column": { + "sql._types:Column": { "type": "object", "properties": { "name": { @@ -55630,7 +55636,7 @@ "type" ] }, - "sql:Row": { + "sql._types:Row": { "type": "array", "items": { "type": "object" @@ -57850,7 +57856,7 @@ "description": "Column headings for the search results. Each object is a column.", "type": "array", "items": { - "$ref": "#/components/schemas/sql:Column" + "$ref": "#/components/schemas/sql._types:Column" } }, "cursor": { @@ -57872,7 +57878,7 @@ "description": "The values for the search results.", "type": "array", "items": { - "$ref": "#/components/schemas/sql:Row" + "$ref": "#/components/schemas/sql._types:Row" } } }, diff --git a/output/schema/schema-serverless.json b/output/schema/schema-serverless.json index 03f0bcf643..48685ec079 100644 --- a/output/schema/schema-serverless.json +++ b/output/schema/schema-serverless.json @@ -92,11 +92,16 @@ "stability": "stable" } }, - "description": "Get the async search status.\n\nGet the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", + "description": "Get the async search status.\n\nGet the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, the access to the status of a specific async search is restricted to:\n\n* The user or API key that submitted the original async search request.\n* Users that have the `monitor` cluster privilege or greater privileges.", "docId": "async-search", "docTag": "search", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit", "name": "async_search.status", + "privileges": { + "cluster": [ + "monitor" + ] + }, "request": { "name": "Request", "namespace": "async_search.status" @@ -10640,7 +10645,7 @@ ], "query": [ { - "description": "Specifies how long the async search should be available in the cluster.\nWhen not specified, the `keep_alive` set with the corresponding submit async request will be used.\nOtherwise, it is possible to override the value and extend the validity of the request.\nWhen this period expires, the search, if still running, is cancelled.\nIf the search is completed, its saved results are deleted.", + "description": "The length of time that the async search should be available in the cluster.\nWhen not specified, the `keep_alive` set with the corresponding submit async request will be used.\nOtherwise, it is possible to override the value and extend the validity of the request.\nWhen this period expires, the search, if still running, is cancelled.\nIf the search is completed, its saved results are deleted.", "name": "keep_alive", "required": false, "type": { @@ -10718,7 +10723,7 @@ "body": { "kind": "no_body" }, - "description": "Get the async search status.\n\nGet the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", + "description": "Get the async search status.\n\nGet the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, the access to the status of a specific async search is restricted to:\n\n* The user or API key that submitted the original async search request.\n* Users that have the `monitor` cluster privilege or greater privileges.", "inherits": { "type": { "name": "RequestBase", @@ -10746,7 +10751,7 @@ ], "query": [ { - "description": "Specifies how long the async search needs to be available.\nOngoing async searches and any saved search results are deleted after this period.", + "description": "The length of time that the async search needs to be available.\nOngoing async searches and any saved search results are deleted after this period.", "name": "keep_alive", "required": false, "serverDefault": "5d", @@ -10759,7 +10764,7 @@ } } ], - "specLocation": "async_search/status/AsyncSearchStatusRequest.ts#L24-L54" + "specLocation": "async_search/status/AsyncSearchStatusRequest.ts#L24-L58" }, { "body": { @@ -41808,7 +41813,7 @@ "kind": "instance_of", "type": { "name": "Column", - "namespace": "sql" + "namespace": "sql._types" } } } @@ -41835,7 +41840,7 @@ "kind": "instance_of", "type": { "name": "Row", - "namespace": "sql" + "namespace": "sql._types" } } } @@ -42272,7 +42277,7 @@ "kind": "instance_of", "type": { "name": "Column", - "namespace": "sql" + "namespace": "sql._types" } } } @@ -42335,7 +42340,7 @@ "kind": "instance_of", "type": { "name": "Row", - "namespace": "sql" + "namespace": "sql._types" } } } @@ -57275,7 +57280,7 @@ { "description": "The index that contains the document.", "name": "_index", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -59086,7 +59091,7 @@ } } ], - "specLocation": "_types/query_dsl/span.ts#L158-L200", + "specLocation": "_types/query_dsl/span.ts#L159-L201", "variants": { "kind": "container", "nonExhaustive": true @@ -59417,19 +59422,82 @@ }, "properties": [ { + "aliases": [ + "term" + ], "name": "value", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "FieldValue", + "namespace": "_types" } } } ], "shortcutProperty": "value", - "specLocation": "_types/query_dsl/span.ts#L134-L140" + "specLocation": "_types/query_dsl/span.ts#L134-L141" + }, + { + "codegenNames": [ + "long", + "double", + "string", + "boolean", + "null", + "any" + ], + "description": "A field value.", + "kind": "type_alias", + "name": { + "name": "FieldValue", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L25-L37", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + }, + { + "kind": "user_defined_value" + } + ], + "kind": "union_of" + } }, { "extDocId": "query-dsl-span-within-query", @@ -59471,7 +59539,7 @@ } } ], - "specLocation": "_types/query_dsl/span.ts#L142-L156" + "specLocation": "_types/query_dsl/span.ts#L143-L157" }, { "extDocId": "query-dsl-sparse-vector-query", @@ -59698,66 +59766,6 @@ "shortcutProperty": "value", "specLocation": "_types/query_dsl/term.ts#L238-L255" }, - { - "codegenNames": [ - "long", - "double", - "string", - "boolean", - "null", - "any" - ], - "description": "A field value.", - "kind": "type_alias", - "name": { - "name": "FieldValue", - "namespace": "_types" - }, - "specLocation": "_types/common.ts#L25-L37", - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - }, - { - "kind": "user_defined_value" - } - ], - "kind": "union_of" - } - }, { "attachedBehaviors": [ "AdditionalProperty" @@ -79409,7 +79417,7 @@ "name": "Analyzer", "namespace": "_types.analysis" }, - "specLocation": "_types/analysis/analyzers.ts#L359-L413", + "specLocation": "_types/analysis/analyzers.ts#L437-L491", "type": { "items": [ { @@ -79891,6 +79899,10 @@ } }, { + "deprecation": { + "description": "", + "version": "7.14.0" + }, "name": "version", "required": false, "type": { @@ -79902,8 +79914,10 @@ } }, { + "description": "The maximum token size to emit. Tokens larger than this size will be discarded.\nDefaults to `255`", "name": "max_output_size", - "required": true, + "required": false, + "serverDefault": 255, "type": { "kind": "instance_of", "type": { @@ -79913,19 +79927,9 @@ } }, { - "name": "preserve_original", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { + "description": "The character to use to concatenate the terms.\nDefaults to a space.", "name": "separator", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -79935,8 +79939,10 @@ } }, { + "description": "A pre-defined stop words list like `_english_` or an array containing a list of stop words.\nDefaults to `_none_`.", "name": "stopwords", "required": false, + "serverDefault": "_none_", "type": { "kind": "instance_of", "type": { @@ -79946,6 +79952,7 @@ } }, { + "description": "The path to a file containing stop words.", "name": "stopwords_path", "required": false, "type": { @@ -79957,7 +79964,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L37-L45" + "specLocation": "_types/analysis/analyzers.ts#L37-L64" }, { "kind": "interface", @@ -79975,6 +79982,10 @@ } }, { + "deprecation": { + "description": "", + "version": "7.14.0" + }, "name": "version", "required": false, "type": { @@ -79986,7 +79997,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L47-L50" + "specLocation": "_types/analysis/analyzers.ts#L66-L70" }, { "kind": "interface", @@ -80004,6 +80015,10 @@ } }, { + "deprecation": { + "description": "", + "version": "7.14.0" + }, "name": "version", "required": false, "type": { @@ -80062,7 +80077,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L52-L59" + "specLocation": "_types/analysis/analyzers.ts#L72-L80" }, { "kind": "enum", @@ -80192,6 +80207,10 @@ } }, { + "deprecation": { + "description": "", + "version": "7.14.0" + }, "name": "version", "required": false, "type": { @@ -80239,7 +80258,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L312-L318" + "specLocation": "_types/analysis/analyzers.ts#L333-L340" }, { "kind": "enum", @@ -80276,6 +80295,10 @@ } }, { + "deprecation": { + "description": "", + "version": "7.14.0" + }, "name": "version", "required": false, "type": { @@ -80287,6 +80310,7 @@ } }, { + "description": "Java regular expression flags. Flags should be pipe-separated, eg \"CASE_INSENSITIVE|COMMENTS\".", "name": "flags", "required": false, "type": { @@ -80298,8 +80322,10 @@ } }, { + "description": "Should terms be lowercased or not.\nDefaults to `true`.", "name": "lowercase", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -80309,8 +80335,10 @@ } }, { + "description": "A Java regular expression.\nDefaults to `\\W+`.", "name": "pattern", - "required": true, + "required": false, + "serverDefault": "\\W+", "type": { "kind": "instance_of", "type": { @@ -80320,8 +80348,10 @@ } }, { + "description": "A pre-defined stop words list like `_english_` or an array containing a list of stop words.\nDefaults to `_none_`.", "name": "stopwords", "required": false, + "serverDefault": "_none_", "type": { "kind": "instance_of", "type": { @@ -80329,9 +80359,21 @@ "namespace": "_types.analysis" } } + }, + { + "description": "The path to a file containing stop words.", + "name": "stopwords_path", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } ], - "specLocation": "_types/analysis/analyzers.ts#L320-L327" + "specLocation": "_types/analysis/analyzers.ts#L342-L375" }, { "kind": "interface", @@ -80349,6 +80391,10 @@ } }, { + "deprecation": { + "description": "", + "version": "7.14.0" + }, "name": "version", "required": false, "type": { @@ -80360,7 +80406,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L329-L332" + "specLocation": "_types/analysis/analyzers.ts#L377-L381" }, { "kind": "interface", @@ -80378,8 +80424,10 @@ } }, { + "description": "The maximum token length. If a token is seen that exceeds this length then it is split at `max_token_length` intervals.\nDefaults to `255`.", "name": "max_token_length", "required": false, + "serverDefault": 255, "type": { "kind": "instance_of", "type": { @@ -80389,8 +80437,10 @@ } }, { + "description": "A pre-defined stop words list like `_english_` or an array containing a list of stop words.\nDefaults to `_none_`.", "name": "stopwords", "required": false, + "serverDefault": "_none_", "type": { "kind": "instance_of", "type": { @@ -80398,9 +80448,21 @@ "namespace": "_types.analysis" } } + }, + { + "description": "The path to a file containing stop words.", + "name": "stopwords_path", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } ], - "specLocation": "_types/analysis/analyzers.ts#L341-L345" + "specLocation": "_types/analysis/analyzers.ts#L392-L412" }, { "kind": "interface", @@ -80418,6 +80480,10 @@ } }, { + "deprecation": { + "description": "", + "version": "7.14.0" + }, "name": "version", "required": false, "type": { @@ -80429,8 +80495,10 @@ } }, { + "description": "A pre-defined stop words list like `_english_` or an array containing a list of stop words.\nDefaults to `_none_`.", "name": "stopwords", "required": false, + "serverDefault": "_none_", "type": { "kind": "instance_of", "type": { @@ -80440,6 +80508,7 @@ } }, { + "description": "The path to a file containing stop words.", "name": "stopwords_path", "required": false, "type": { @@ -80451,7 +80520,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L347-L352" + "specLocation": "_types/analysis/analyzers.ts#L414-L429" }, { "kind": "interface", @@ -80469,6 +80538,10 @@ } }, { + "deprecation": { + "description": "", + "version": "7.14.0" + }, "name": "version", "required": false, "type": { @@ -80480,7 +80553,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L354-L357" + "specLocation": "_types/analysis/analyzers.ts#L431-L435" }, { "kind": "interface", @@ -80632,6 +80705,10 @@ } }, { + "deprecation": { + "description": "", + "version": "7.14.0" + }, "name": "version", "required": false, "type": { @@ -80665,7 +80742,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L334-L339" + "specLocation": "_types/analysis/analyzers.ts#L384-L390" }, { "kind": "enum", @@ -80795,7 +80872,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L61-L66" + "specLocation": "_types/analysis/analyzers.ts#L82-L87" }, { "kind": "interface", @@ -80849,7 +80926,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L68-L73" + "specLocation": "_types/analysis/analyzers.ts#L89-L94" }, { "kind": "interface", @@ -80903,7 +80980,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L75-L80" + "specLocation": "_types/analysis/analyzers.ts#L96-L101" }, { "kind": "interface", @@ -80957,7 +81034,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L82-L87" + "specLocation": "_types/analysis/analyzers.ts#L103-L108" }, { "kind": "interface", @@ -80997,7 +81074,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L89-L93" + "specLocation": "_types/analysis/analyzers.ts#L110-L114" }, { "kind": "interface", @@ -81051,7 +81128,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L95-L100" + "specLocation": "_types/analysis/analyzers.ts#L116-L121" }, { "kind": "interface", @@ -81105,7 +81182,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L102-L107" + "specLocation": "_types/analysis/analyzers.ts#L123-L128" }, { "kind": "interface", @@ -81145,7 +81222,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L109-L113" + "specLocation": "_types/analysis/analyzers.ts#L130-L134" }, { "kind": "interface", @@ -81185,7 +81262,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L115-L119" + "specLocation": "_types/analysis/analyzers.ts#L136-L140" }, { "kind": "interface", @@ -81239,7 +81316,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L121-L126" + "specLocation": "_types/analysis/analyzers.ts#L142-L147" }, { "kind": "interface", @@ -81279,7 +81356,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L128-L132" + "specLocation": "_types/analysis/analyzers.ts#L149-L153" }, { "kind": "interface", @@ -81333,7 +81410,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L134-L139" + "specLocation": "_types/analysis/analyzers.ts#L155-L160" }, { "kind": "interface", @@ -81387,7 +81464,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L141-L146" + "specLocation": "_types/analysis/analyzers.ts#L162-L167" }, { "kind": "interface", @@ -81427,7 +81504,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L148-L152" + "specLocation": "_types/analysis/analyzers.ts#L169-L173" }, { "kind": "interface", @@ -81481,7 +81558,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L154-L159" + "specLocation": "_types/analysis/analyzers.ts#L175-L180" }, { "kind": "interface", @@ -81535,7 +81612,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L161-L166" + "specLocation": "_types/analysis/analyzers.ts#L182-L187" }, { "kind": "interface", @@ -81589,7 +81666,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L168-L173" + "specLocation": "_types/analysis/analyzers.ts#L189-L194" }, { "kind": "interface", @@ -81643,7 +81720,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L175-L180" + "specLocation": "_types/analysis/analyzers.ts#L196-L201" }, { "kind": "interface", @@ -81683,7 +81760,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L182-L186" + "specLocation": "_types/analysis/analyzers.ts#L203-L207" }, { "kind": "interface", @@ -81737,7 +81814,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L188-L193" + "specLocation": "_types/analysis/analyzers.ts#L209-L214" }, { "kind": "interface", @@ -81791,7 +81868,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L195-L200" + "specLocation": "_types/analysis/analyzers.ts#L216-L221" }, { "kind": "interface", @@ -81845,7 +81922,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L202-L207" + "specLocation": "_types/analysis/analyzers.ts#L223-L228" }, { "kind": "interface", @@ -81899,7 +81976,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L209-L214" + "specLocation": "_types/analysis/analyzers.ts#L230-L235" }, { "kind": "interface", @@ -81953,7 +82030,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L216-L221" + "specLocation": "_types/analysis/analyzers.ts#L237-L242" }, { "kind": "interface", @@ -82007,7 +82084,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L223-L228" + "specLocation": "_types/analysis/analyzers.ts#L244-L249" }, { "kind": "interface", @@ -82061,7 +82138,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L230-L235" + "specLocation": "_types/analysis/analyzers.ts#L251-L256" }, { "kind": "interface", @@ -82115,7 +82192,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L237-L242" + "specLocation": "_types/analysis/analyzers.ts#L258-L263" }, { "kind": "interface", @@ -82155,7 +82232,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L244-L248" + "specLocation": "_types/analysis/analyzers.ts#L265-L269" }, { "kind": "interface", @@ -82209,7 +82286,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L250-L255" + "specLocation": "_types/analysis/analyzers.ts#L271-L276" }, { "kind": "interface", @@ -82263,7 +82340,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L257-L262" + "specLocation": "_types/analysis/analyzers.ts#L278-L283" }, { "kind": "interface", @@ -82317,7 +82394,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L264-L269" + "specLocation": "_types/analysis/analyzers.ts#L285-L290" }, { "kind": "interface", @@ -82371,7 +82448,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L271-L276" + "specLocation": "_types/analysis/analyzers.ts#L292-L297" }, { "kind": "interface", @@ -82425,7 +82502,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L278-L283" + "specLocation": "_types/analysis/analyzers.ts#L299-L304" }, { "kind": "interface", @@ -82479,7 +82556,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L285-L290" + "specLocation": "_types/analysis/analyzers.ts#L306-L311" }, { "kind": "interface", @@ -82533,7 +82610,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L292-L297" + "specLocation": "_types/analysis/analyzers.ts#L313-L318" }, { "kind": "interface", @@ -82587,7 +82664,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L299-L304" + "specLocation": "_types/analysis/analyzers.ts#L320-L325" }, { "kind": "interface", @@ -82627,7 +82704,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L306-L310" + "specLocation": "_types/analysis/analyzers.ts#L327-L331" }, { "codegenNames": [ @@ -93644,7 +93721,7 @@ "name": "FollowerIndexStatus", "namespace": "ccr.follow_info" }, - "specLocation": "ccr/follow_info/types.ts#L32-L35" + "specLocation": "ccr/follow_info/types.ts#L37-L40" }, { "kind": "enum", @@ -93984,7 +94061,7 @@ } }, { - "description": "This field presents and has value of ::es_redacted:: only when the remote cluster is configured with the API key based model. Otherwise, the field is not present.", + "description": "This field is present and has a value of `::es_redacted::` only when the remote cluster is configured with the API key based model. Otherwise, the field is not present.", "name": "cluster_credentials", "required": false, "type": { @@ -96595,7 +96672,7 @@ "name": "ConvertType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L661-L670" + "specLocation": "ingest/_types/Processors.ts#L662-L671" }, { "kind": "enum", @@ -96625,7 +96702,7 @@ "name": "FingerprintDigest", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L896-L902" + "specLocation": "ingest/_types/Processors.ts#L897-L903" }, { "kind": "enum", @@ -96641,7 +96718,7 @@ "name": "GeoGridTargetFormat", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L437-L440" + "specLocation": "ingest/_types/Processors.ts#L438-L441" }, { "kind": "enum", @@ -96660,7 +96737,7 @@ "name": "GeoGridTileType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L431-L435" + "specLocation": "ingest/_types/Processors.ts#L432-L436" }, { "kind": "enum", @@ -96678,7 +96755,7 @@ "name": "JsonProcessorConflictStrategy", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L1151-L1156" + "specLocation": "ingest/_types/Processors.ts#L1152-L1157" }, { "kind": "enum", @@ -96694,7 +96771,7 @@ "name": "ShapeType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L1473-L1476" + "specLocation": "ingest/_types/Processors.ts#L1474-L1477" }, { "kind": "enum", @@ -96719,7 +96796,7 @@ "name": "UserAgentProperty", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L547-L553" + "specLocation": "ingest/_types/Processors.ts#L548-L554" }, { "kind": "enum", @@ -105891,7 +105968,7 @@ { "description": "The repository settings.", "name": "settings", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -106844,9 +106921,9 @@ "kind": "type_alias", "name": { "name": "Row", - "namespace": "sql" + "namespace": "sql._types" }, - "specLocation": "sql/types.ts#L28-L28", + "specLocation": "sql/_types/types.ts#L28-L28", "type": { "kind": "array_of", "value": { @@ -108182,7 +108259,7 @@ } } ], - "specLocation": "async_search/_types/AsyncSearchResponseBase.ts#L50-L54" + "specLocation": "async_search/_types/AsyncSearchResponseBase.ts#L52-L56" }, { "kind": "interface", @@ -108215,7 +108292,7 @@ } }, { - "description": "Indicates whether the search is still running or has completed.\nNOTE: If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though `is_running` is `false`.", + "description": "Indicates whether the search is still running or has completed.\n\n> info\n> If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though `is_running` is `false`.", "name": "is_running", "required": true, "type": { @@ -108290,7 +108367,7 @@ } }, { - "description": "Indicates when the async search completed. Only present\nwhen the search has completed.", + "description": "Indicates when the async search completed.\nIt is present only when the search has completed.", "name": "completion_time", "required": false, "type": { @@ -108322,7 +108399,7 @@ } } ], - "specLocation": "async_search/_types/AsyncSearchResponseBase.ts#L24-L49" + "specLocation": "async_search/_types/AsyncSearchResponseBase.ts#L24-L51" }, { "generics": [ @@ -108338,7 +108415,7 @@ }, "properties": [ { - "description": "Partial aggregations results, coming from the shards that have already completed the execution of the query.", + "description": "Partial aggregations results, coming from the shards that have already completed running the query.", "name": "aggregations", "required": false, "type": { @@ -108561,7 +108638,7 @@ }, "properties": [ { - "description": "Indicates how many shards have run the query so far.", + "description": "The number of shards that have run the query so far.", "name": "_shards", "required": true, "type": { @@ -108573,7 +108650,7 @@ } }, { - "description": "Metadata about clusters involved in the cross-cluster search.\nNot shown for local-only searches.", + "description": "Metadata about clusters involved in the cross-cluster search.\nIt is not shown for local-only searches.", "name": "_clusters", "required": false, "type": { @@ -108585,7 +108662,7 @@ } }, { - "description": "If the async search completed, this field shows the status code of the search.\nFor example, 200 indicates that the async search was successfully completed.\n503 indicates that the async search was completed with an error.", + "description": "If the async search completed, this field shows the status code of the search.\nFor example, `200` indicates that the async search was successfully completed.\n`503` indicates that the async search was completed with an error.", "name": "completion_status", "required": false, "type": { @@ -120344,7 +120421,7 @@ { "description": "An optional guiding query that constrains the Graph API as it explores connected terms.", "name": "query", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -120471,7 +120548,7 @@ "properties": [ { "name": "boost", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -120492,7 +120569,8 @@ } } ], - "specLocation": "graph/_types/Vertex.ts#L61-L64" + "shortcutProperty": "term", + "specLocation": "graph/_types/Vertex.ts#L61-L65" }, { "kind": "interface", @@ -123061,7 +123139,7 @@ } } ], - "specLocation": "inference/_types/Results.ts#L91-L96" + "specLocation": "inference/_types/Results.ts#L92-L97" }, { "description": "Represents an inference endpoint as returned by the GET API", @@ -123173,6 +123251,20 @@ } } }, + { + "name": "text_embedding_bits", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "TextEmbeddingByteResult", + "namespace": "inference._types" + } + } + } + }, { "name": "text_embedding", "required": false, @@ -123230,7 +123322,7 @@ } } ], - "specLocation": "inference/_types/Results.ts#L79-L89", + "specLocation": "inference/_types/Results.ts#L79-L90", "variants": { "kind": "container" } @@ -124441,7 +124533,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L27-L301", + "specLocation": "ingest/_types/Processors.ts#L28-L302", "variants": { "kind": "container", "nonExhaustive": true @@ -124505,7 +124597,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L328-L343" + "specLocation": "ingest/_types/Processors.ts#L329-L344" }, { "kind": "interface", @@ -124533,8 +124625,8 @@ "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Script", + "namespace": "_types" } } }, @@ -124578,7 +124670,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L303-L326" + "specLocation": "ingest/_types/Processors.ts#L304-L327" }, { "inherits": { @@ -124698,7 +124790,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L345-L386" + "specLocation": "ingest/_types/Processors.ts#L346-L387" }, { "inherits": { @@ -124752,7 +124844,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L555-L571" + "specLocation": "ingest/_types/Processors.ts#L556-L572" }, { "inherits": { @@ -124829,7 +124921,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L573-L596" + "specLocation": "ingest/_types/Processors.ts#L574-L597" }, { "inherits": { @@ -124988,7 +125080,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L598-L659" + "specLocation": "ingest/_types/Processors.ts#L599-L660" }, { "inherits": { @@ -125054,7 +125146,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L672-L692" + "specLocation": "ingest/_types/Processors.ts#L673-L693" }, { "inherits": { @@ -125152,7 +125244,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L694-L727" + "specLocation": "ingest/_types/Processors.ts#L695-L728" }, { "inherits": { @@ -125247,7 +125339,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L769-L802" + "specLocation": "ingest/_types/Processors.ts#L770-L803" }, { "inherits": { @@ -125265,7 +125357,7 @@ { "description": "An array of the expected date formats for parsing dates / timestamps in the document being preprocessed.\nCan be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N.", "name": "date_formats", - "required": true, + "required": false, "type": { "kind": "array_of", "value": { @@ -125353,7 +125445,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L729-L767" + "specLocation": "ingest/_types/Processors.ts#L730-L768" }, { "inherits": { @@ -125419,7 +125511,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L804-L823" + "specLocation": "ingest/_types/Processors.ts#L805-L824" }, { "inherits": { @@ -125472,7 +125564,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L825-L843" + "specLocation": "ingest/_types/Processors.ts#L826-L844" }, { "inherits": { @@ -125487,7 +125579,7 @@ "namespace": "ingest._types" }, "properties": [], - "specLocation": "ingest/_types/Processors.ts#L845-L845" + "specLocation": "ingest/_types/Processors.ts#L846-L846" }, { "inherits": { @@ -125591,7 +125683,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L847-L886" + "specLocation": "ingest/_types/Processors.ts#L848-L887" }, { "inherits": { @@ -125619,7 +125711,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L888-L894" + "specLocation": "ingest/_types/Processors.ts#L889-L895" }, { "inherits": { @@ -125698,7 +125790,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L904-L932" + "specLocation": "ingest/_types/Processors.ts#L905-L933" }, { "inherits": { @@ -125751,7 +125843,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L934-L948" + "specLocation": "ingest/_types/Processors.ts#L935-L949" }, { "inherits": { @@ -125858,7 +125950,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L478-L512" + "specLocation": "ingest/_types/Processors.ts#L479-L513" }, { "inherits": { @@ -125985,7 +126077,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L388-L429" + "specLocation": "ingest/_types/Processors.ts#L389-L430" }, { "inherits": { @@ -126092,7 +126184,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L442-L476" + "specLocation": "ingest/_types/Processors.ts#L443-L477" }, { "inherits": { @@ -126197,7 +126289,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L950-L981" + "specLocation": "ingest/_types/Processors.ts#L951-L982" }, { "inherits": { @@ -126275,7 +126367,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L983-L1007" + "specLocation": "ingest/_types/Processors.ts#L984-L1008" }, { "inherits": { @@ -126329,7 +126421,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1009-L1025" + "specLocation": "ingest/_types/Processors.ts#L1010-L1026" }, { "inherits": { @@ -126401,7 +126493,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1027-L1046" + "specLocation": "ingest/_types/Processors.ts#L1028-L1047" }, { "kind": "interface", @@ -126435,7 +126527,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1048-L1060", + "specLocation": "ingest/_types/Processors.ts#L1049-L1061", "variants": { "kind": "container" } @@ -126474,7 +126566,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1062-L1073" + "specLocation": "ingest/_types/Processors.ts#L1063-L1074" }, { "kind": "interface", @@ -126548,7 +126640,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1075-L1101" + "specLocation": "ingest/_types/Processors.ts#L1076-L1102" }, { "inherits": { @@ -126601,7 +126693,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1103-L1118" + "specLocation": "ingest/_types/Processors.ts#L1104-L1119" }, { "inherits": { @@ -126680,7 +126772,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1120-L1149" + "specLocation": "ingest/_types/Processors.ts#L1121-L1150" }, { "inherits": { @@ -126837,7 +126929,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1158-L1210" + "specLocation": "ingest/_types/Processors.ts#L1159-L1211" }, { "inherits": { @@ -126891,7 +126983,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1212-L1228" + "specLocation": "ingest/_types/Processors.ts#L1213-L1229" }, { "inherits": { @@ -126986,7 +127078,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1230-L1264" + "specLocation": "ingest/_types/Processors.ts#L1231-L1265" }, { "inherits": { @@ -127027,7 +127119,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1266-L1277" + "specLocation": "ingest/_types/Processors.ts#L1267-L1278" }, { "inherits": { @@ -127163,7 +127255,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1279-L1320" + "specLocation": "ingest/_types/Processors.ts#L1280-L1321" }, { "inherits": { @@ -127216,7 +127308,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1322-L1338" + "specLocation": "ingest/_types/Processors.ts#L1323-L1339" }, { "inherits": { @@ -127269,7 +127361,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1340-L1354" + "specLocation": "ingest/_types/Processors.ts#L1341-L1355" }, { "inherits": { @@ -127322,7 +127414,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1356-L1372" + "specLocation": "ingest/_types/Processors.ts#L1357-L1373" }, { "inherits": { @@ -127404,7 +127496,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1374-L1402" + "specLocation": "ingest/_types/Processors.ts#L1375-L1403" }, { "inherits": { @@ -127476,7 +127568,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1404-L1424" + "specLocation": "ingest/_types/Processors.ts#L1405-L1425" }, { "inherits": { @@ -127562,7 +127654,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1426-L1460" + "specLocation": "ingest/_types/Processors.ts#L1427-L1461" }, { "inherits": { @@ -127605,7 +127697,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1462-L1471" + "specLocation": "ingest/_types/Processors.ts#L1463-L1472" }, { "inherits": { @@ -127658,7 +127750,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1478-L1494" + "specLocation": "ingest/_types/Processors.ts#L1479-L1495" }, { "inherits": { @@ -127737,7 +127829,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1496-L1521" + "specLocation": "ingest/_types/Processors.ts#L1497-L1522" }, { "inherits": { @@ -127752,7 +127844,7 @@ "namespace": "ingest._types" }, "properties": [], - "specLocation": "ingest/_types/Processors.ts#L1523-L1523" + "specLocation": "ingest/_types/Processors.ts#L1524-L1524" }, { "inherits": { @@ -127806,7 +127898,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1525-L1541" + "specLocation": "ingest/_types/Processors.ts#L1526-L1542" }, { "inherits": { @@ -127860,7 +127952,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1543-L1559" + "specLocation": "ingest/_types/Processors.ts#L1544-L1560" }, { "inherits": { @@ -127914,7 +128006,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1561-L1577" + "specLocation": "ingest/_types/Processors.ts#L1562-L1578" }, { "inherits": { @@ -127994,7 +128086,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1579-L1605" + "specLocation": "ingest/_types/Processors.ts#L1580-L1606" }, { "inherits": { @@ -128107,7 +128199,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L514-L545" + "specLocation": "ingest/_types/Processors.ts#L515-L546" }, { "kind": "interface", @@ -131756,7 +131848,7 @@ { "description": "An array of strings that defines the fields that will be excluded from the analysis. You do not need to add fields with unsupported data types to excludes, these fields are excluded from the analysis automatically.", "name": "includes", - "required": true, + "required": false, "type": { "kind": "array_of", "value": { @@ -131771,7 +131863,7 @@ { "description": "An array of strings that defines the fields that will be included in the analysis.", "name": "excludes", - "required": true, + "required": false, "type": { "kind": "array_of", "value": { @@ -144776,7 +144868,7 @@ "kind": "interface", "name": { "name": "Column", - "namespace": "sql" + "namespace": "sql._types" }, "properties": [ { @@ -144802,7 +144894,7 @@ } } ], - "specLocation": "sql/types.ts#L23-L26" + "specLocation": "sql/_types/types.ts#L23-L26" }, { "kind": "interface", diff --git a/output/schema/validation-errors.json b/output/schema/validation-errors.json index 7b481fb259..82e36e9e37 100644 --- a/output/schema/validation-errors.json +++ b/output/schema/validation-errors.json @@ -255,6 +255,13 @@ ], "response": [] }, + "inference.update": { + "request": [ + "/_inference/{inference_id}/_update: different http methods in the json spec", + "/_inference/{task_type}/{inference_id}/_update: different http methods in the json spec" + ], + "response": [] + }, "ingest.get_ip_location_database": { "request": [ "Request: query parameter 'master_timeout' does not exist in the json spec" diff --git a/output/typescript/types.ts b/output/typescript/types.ts index 8e4925c627..d8079f47cf 100644 --- a/output/typescript/types.ts +++ b/output/typescript/types.ts @@ -4660,9 +4660,8 @@ export interface AnalysisEstonianAnalyzer { export interface AnalysisFingerprintAnalyzer { type: 'fingerprint' version?: VersionString - max_output_size: integer - preserve_original: boolean - separator: string + max_output_size?: integer + separator?: string stopwords?: AnalysisStopWords stopwords_path?: string } @@ -5026,8 +5025,9 @@ export interface AnalysisPatternAnalyzer { version?: VersionString flags?: string lowercase?: boolean - pattern: string + pattern?: string stopwords?: AnalysisStopWords + stopwords_path?: string } export interface AnalysisPatternCaptureTokenFilter extends AnalysisTokenFilterBase { @@ -5184,6 +5184,7 @@ export interface AnalysisStandardAnalyzer { type: 'standard' max_token_length?: integer stopwords?: AnalysisStopWords + stopwords_path?: string } export interface AnalysisStandardTokenizer extends AnalysisTokenizerBase { @@ -6355,7 +6356,7 @@ export interface QueryDslPercolateQuery extends QueryDslQueryBase { export interface QueryDslPinnedDoc { _id: Id - _index: IndexName + _index?: IndexName } export interface QueryDslPinnedQuery extends QueryDslQueryBase { @@ -6425,7 +6426,7 @@ export interface QueryDslQueryContainer { span_near?: QueryDslSpanNearQuery span_not?: QueryDslSpanNotQuery span_or?: QueryDslSpanOrQuery - span_term?: Partial> + span_term?: Partial> span_within?: QueryDslSpanWithinQuery sparse_vector?: QueryDslSparseVectorQuery term?: Partial> @@ -6627,12 +6628,13 @@ export interface QueryDslSpanQuery { span_near?: QueryDslSpanNearQuery span_not?: QueryDslSpanNotQuery span_or?: QueryDslSpanOrQuery - span_term?: Partial> + span_term?: Partial> span_within?: QueryDslSpanWithinQuery } export interface QueryDslSpanTermQuery extends QueryDslQueryBase { - value: string + value: FieldValue + term: FieldValue } export interface QueryDslSpanWithinQuery extends QueryDslQueryBase { @@ -10764,7 +10766,7 @@ export interface GraphExploreControls { export interface GraphHop { connections?: GraphHop - query: QueryDslQueryContainer + query?: QueryDslQueryContainer vertices: GraphVertexDefinition[] } @@ -10783,14 +10785,14 @@ export interface GraphVertex { export interface GraphVertexDefinition { exclude?: string[] field: Field - include?: GraphVertexInclude[] + include?: (GraphVertexInclude | string)[] min_doc_count?: long shard_min_doc_count?: long size?: integer } export interface GraphVertexInclude { - boost: double + boost?: double term: string } @@ -12998,6 +13000,7 @@ export interface InferenceInferenceEndpointInfo extends InferenceInferenceEndpoi export interface InferenceInferenceResult { text_embedding_bytes?: InferenceTextEmbeddingByteResult[] + text_embedding_bits?: InferenceTextEmbeddingByteResult[] text_embedding?: InferenceTextEmbeddingResult[] sparse_embedding?: InferenceSparseEmbeddingResult[] completion?: InferenceCompletionResult[] @@ -13232,7 +13235,7 @@ export interface IngestDatabaseConfigurationFull { } export interface IngestDateIndexNameProcessor extends IngestProcessorBase { - date_formats: string[] + date_formats?: string[] date_rounding: string field: Field index_name_format?: string @@ -13493,7 +13496,7 @@ export interface IngestPipelineSimulation { export interface IngestProcessorBase { description?: string - if?: string + if?: Script | string ignore_failure?: boolean on_failure?: IngestProcessorContainer[] tag?: string @@ -14358,8 +14361,8 @@ export interface MlDataframeAnalysis { } export interface MlDataframeAnalysisAnalyzedFields { - includes: string[] - excludes: string[] + includes?: string[] + excludes?: string[] } export interface MlDataframeAnalysisClassification extends MlDataframeAnalysis { @@ -19649,7 +19652,7 @@ export type SlmStopResponse = AcknowledgedResponseBase export interface SnapshotAzureRepository extends SnapshotRepositoryBase { type: 'azure' - settings: SnapshotAzureRepositorySettings + settings?: SnapshotAzureRepositorySettings } export interface SnapshotAzureRepositorySettings extends SnapshotRepositorySettingsBase { diff --git a/specification/_global/bulk/examples/request/BulkRequestExample4.yaml b/specification/_global/bulk/examples/request/BulkRequestExample4.yaml index 32bc99d57a..7831d65ae3 100644 --- a/specification/_global/bulk/examples/request/BulkRequestExample4.yaml +++ b/specification/_global/bulk/examples/request/BulkRequestExample4.yaml @@ -1,5 +1,5 @@ summary: Dynamic templates -method_request: POST /_bulk +# method_request: POST /_bulk description: > Run `POST /_bulk` to perform a bulk request that consists of index and create actions with the `dynamic_templates` parameter. The bulk request creates two new fields `work_location` and `home_location` with type `geo_point` according to the `dynamic_templates` parameter. diff --git a/specification/_json_spec/inference.update.json b/specification/_json_spec/inference.update.json index 6c458ce080..133354e3ec 100644 --- a/specification/_json_spec/inference.update.json +++ b/specification/_json_spec/inference.update.json @@ -14,7 +14,7 @@ "paths": [ { "path": "/_inference/{inference_id}/_update", - "methods": ["POST"], + "methods": ["PUT"], "parts": { "inference_id": { "type": "string", @@ -24,7 +24,7 @@ }, { "path": "/_inference/{task_type}/{inference_id}/_update", - "methods": ["POST"], + "methods": ["PUT"], "parts": { "task_type": { "type": "string", diff --git a/specification/_types/analysis/analyzers.ts b/specification/_types/analysis/analyzers.ts index 47da0e68fd..592ad25304 100644 --- a/specification/_types/analysis/analyzers.ts +++ b/specification/_types/analysis/analyzers.ts @@ -36,21 +36,42 @@ export class CustomAnalyzer { export class FingerprintAnalyzer { type: 'fingerprint' + /** @deprecated 7.14.0 */ version?: VersionString - max_output_size: integer - preserve_original: boolean - separator: string - stopwords?: StopWords + /** + * The maximum token size to emit. Tokens larger than this size will be discarded. + * Defaults to `255` + * + * @server_default 255 + */ + max_output_size?: integer + /** + * The character to use to concatenate the terms. + * Defaults to a space. + */ + separator?: string + /** + * A pre-defined stop words list like `_english_` or an array containing a list of stop words. + * Defaults to `_none_`. + * + * @server_default _none_ + */ + stopwords?: StopWords + /** + * The path to a file containing stop words. + */ stopwords_path?: string } export class KeywordAnalyzer { type: 'keyword' + /** @deprecated 7.14.0 */ version?: VersionString } export class LanguageAnalyzer { type: 'language' + /** @deprecated 7.14.0 */ version?: VersionString language: Language stem_exclusion: string[] @@ -311,6 +332,7 @@ export class ThaiAnalyzer { export class NoriAnalyzer { type: 'nori' + /** @deprecated 7.14.0 */ version?: VersionString decompound_mode?: NoriDecompoundMode stoptags?: string[] @@ -319,20 +341,49 @@ export class NoriAnalyzer { export class PatternAnalyzer { type: 'pattern' + /** @deprecated 7.14.0 */ version?: VersionString - flags?: string + /** + * Java regular expression flags. Flags should be pipe-separated, eg "CASE_INSENSITIVE|COMMENTS". + */ + flags?: string // TODO: Use PipeSeparatedFlags and proper enum + /** + * Should terms be lowercased or not. + * Defaults to `true`. + * + * @server_default true + */ lowercase?: boolean - pattern: string - stopwords?: StopWords + /** + * A Java regular expression. + * Defaults to `\W+`. + * + * @server_default \W+ + */ + pattern?: string + /** + * A pre-defined stop words list like `_english_` or an array containing a list of stop words. + * Defaults to `_none_`. + * + * @server_default _none_ + */ + stopwords?: StopWords + /** + * The path to a file containing stop words. + */ + stopwords_path?: string } export class SimpleAnalyzer { type: 'simple' + /** @deprecated 7.14.0 */ version?: VersionString } +// TODO: This one seems undocumented!? export class SnowballAnalyzer { type: 'snowball' + /** @deprecated 7.14.0 */ version?: VersionString language: SnowballLanguage stopwords?: StopWords @@ -340,19 +391,46 @@ export class SnowballAnalyzer { export class StandardAnalyzer { type: 'standard' + /** + * The maximum token length. If a token is seen that exceeds this length then it is split at `max_token_length` intervals. + * Defaults to `255`. + * + * @server_default 255 + */ max_token_length?: integer + /** + * A pre-defined stop words list like `_english_` or an array containing a list of stop words. + * Defaults to `_none_`. + * + * @server_default _none_ + */ stopwords?: StopWords + /** + * The path to a file containing stop words. + */ + stopwords_path?: string } export class StopAnalyzer { type: 'stop' + /** @deprecated 7.14.0 */ version?: VersionString + /** + * A pre-defined stop words list like `_english_` or an array containing a list of stop words. + * Defaults to `_none_`. + * + * @server_default _none_ + */ stopwords?: StopWords + /** + * The path to a file containing stop words. + */ stopwords_path?: string } export class WhitespaceAnalyzer { type: 'whitespace' + /** @deprecated 7.14.0 */ version?: VersionString } diff --git a/specification/_types/query_dsl/span.ts b/specification/_types/query_dsl/span.ts index 1ca61e1ed2..e719fe6152 100644 --- a/specification/_types/query_dsl/span.ts +++ b/specification/_types/query_dsl/span.ts @@ -18,7 +18,7 @@ */ import { SingleKeyDictionary } from '@spec_utils/Dictionary' -import { Field } from '@_types/common' +import { Field, FieldValue } from '@_types/common' import { integer } from '@_types/Numeric' import { QueryBase, QueryContainer } from './abstractions' @@ -136,7 +136,8 @@ export class SpanOrQuery extends QueryBase { * @ext_doc_id query-dsl-span-term-query */ export class SpanTermQuery extends QueryBase { - value: string + /** @aliases term */ + value: FieldValue } /** diff --git a/specification/_types/query_dsl/specialized.ts b/specification/_types/query_dsl/specialized.ts index 52dd48edf4..081f8a7b75 100644 --- a/specification/_types/query_dsl/specialized.ts +++ b/specification/_types/query_dsl/specialized.ts @@ -274,7 +274,7 @@ export class PinnedDoc { /** * The index that contains the document. */ - _index: IndexName + _index?: IndexName } export class RankFeatureFunction {} diff --git a/specification/async_search/_types/AsyncSearch.ts b/specification/async_search/_types/AsyncSearch.ts index aebbaa2c9d..2d0febda93 100644 --- a/specification/async_search/_types/AsyncSearch.ts +++ b/specification/async_search/_types/AsyncSearch.ts @@ -29,7 +29,7 @@ import { ClusterStatistics, ShardStatistics } from '@_types/Stats' export class AsyncSearch { /** - * Partial aggregations results, coming from the shards that have already completed the execution of the query. + * Partial aggregations results, coming from the shards that have already completed running the query. */ aggregations?: Dictionary _clusters?: ClusterStatistics diff --git a/specification/async_search/_types/AsyncSearchResponseBase.ts b/specification/async_search/_types/AsyncSearchResponseBase.ts index b909c943c7..7449e8efa7 100644 --- a/specification/async_search/_types/AsyncSearchResponseBase.ts +++ b/specification/async_search/_types/AsyncSearchResponseBase.ts @@ -30,7 +30,9 @@ export class AsyncSearchResponseBase { is_partial: boolean /** * Indicates whether the search is still running or has completed. - * NOTE: If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though `is_running` is `false`. + * + * > info + * > If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though `is_running` is `false`. */ is_running: boolean /** @@ -41,8 +43,8 @@ export class AsyncSearchResponseBase { start_time?: DateTime start_time_in_millis: EpochTime /** - * Indicates when the async search completed. Only present - * when the search has completed. + * Indicates when the async search completed. + * It is present only when the search has completed. */ completion_time?: DateTime completion_time_in_millis?: EpochTime diff --git a/specification/async_search/get/AsyncSearchGetRequest.ts b/specification/async_search/get/AsyncSearchGetRequest.ts index e7d326a6e5..3c29b4d7a3 100644 --- a/specification/async_search/get/AsyncSearchGetRequest.ts +++ b/specification/async_search/get/AsyncSearchGetRequest.ts @@ -45,7 +45,7 @@ export interface Request extends RequestBase { } query_parameters: { /** - * Specifies how long the async search should be available in the cluster. + * The length of time that the async search should be available in the cluster. * When not specified, the `keep_alive` set with the corresponding submit async request will be used. * Otherwise, it is possible to override the value and extend the validity of the request. * When this period expires, the search, if still running, is cancelled. diff --git a/specification/async_search/get/AsyncSearchGetResponseExample1.json b/specification/async_search/get/AsyncSearchGetResponseExample1.json deleted file mode 100644 index aadbdfd6c3..0000000000 --- a/specification/async_search/get/AsyncSearchGetResponseExample1.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "summary": "A succesful response when retrieving the results of a previously submitted async search request given its identifier.", - "description": "", - "type": "response", - "response_code": 200, - "value": "{\n \"id\" : \"FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=\",\n \"is_partial\" : false,\n \"is_running\" : false,\n \"start_time_in_millis\" : 1583945890986,\n \"expiration_time_in_millis\" : 1584377890986,\n \"completion_time_in_millis\" : 1583945903130,\n \"response\" : {\n \"took\" : 12144,\n \"timed_out\" : false,\n \"num_reduce_phases\" : 46,\n \"_shards\" : {\n \"total\" : 562,\n \"successful\" : 188,\n \"skipped\" : 0,\n \"failed\" : 0\n },\n \"hits\" : {\n \"total\" : {\n \"value\" : 456433,\n \"relation\" : \"eq\"\n },\n \"max_score\" : null,\n \"hits\" : [ ]\n },\n \"aggregations\" : {\n \"sale_date\" : {\n \"buckets\" : []\n }\n }\n }\n}" -} diff --git a/specification/async_search/get/AsyncSearchGetResponseExample2.json b/specification/async_search/get/AsyncSearchGetResponseExample2.json deleted file mode 100644 index 2b018a961e..0000000000 --- a/specification/async_search/get/AsyncSearchGetResponseExample2.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "summary": "A succesful response when retrieving the status of a previously submitted and completed async search without the results.", - "description": "For an async search that has been completed, the status response has an additional `completion_status` field that shows the status code of the completed async search which was – in this case – a success.", - "type": "response", - "response_code": 200, - "value": "{\n \"id\" : \"FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=\",\n \"is_running\" : false,\n \"is_partial\" : false,\n \"start_time_in_millis\" : 1583945890986,\n \"expiration_time_in_millis\" : 1584377890986,\n \"_shards\" : {\n \"total\" : 562,\n \"successful\" : 562,\n \"skipped\" : 0,\n \"failed\" : 0\n },\n \"completion_status\" : 200\n}" -} diff --git a/specification/async_search/get/AsyncSearchGetResponseExample3.json b/specification/async_search/get/AsyncSearchGetResponseExample3.json deleted file mode 100644 index b56220971c..0000000000 --- a/specification/async_search/get/AsyncSearchGetResponseExample3.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "summary": "A succesful response when retrieving the status of a previously submitted and completed async search without the results.", - "description": "For an async search that has been completed, the status response has an additional `completion_status` field that shows the status code of the completed async search which was completed – in this case – with an error.", - "type": "response", - "response_code": 200, - "value": "{\n \"id\" : \"FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=\",\n \"is_running\" : false,\n \"is_partial\" : true,\n \"start_time_in_millis\" : 1583945890986,\n \"expiration_time_in_millis\" : 1584377890986,\n \"_shards\" : {\n \"total\" : 562,\n \"successful\" : 450,\n \"skipped\" : 0,\n \"failed\" : 112\n },\n \"completion_status\" : 503\n}" -} diff --git a/specification/async_search/get/examples/response/AsyncSearchGetResponseExample1.yaml b/specification/async_search/get/examples/response/AsyncSearchGetResponseExample1.yaml new file mode 100644 index 0000000000..32e9074e2e --- /dev/null +++ b/specification/async_search/get/examples/response/AsyncSearchGetResponseExample1.yaml @@ -0,0 +1,37 @@ +# summary: +description: A succesful response from `GET /_async_search/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=`. +# type: response +# response_code: 200 +value: |- + { + "id" : "FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=", + "is_partial" : false, + "is_running" : false, + "start_time_in_millis" : 1583945890986, + "expiration_time_in_millis" : 1584377890986, + "completion_time_in_millis" : 1583945903130, + "response" : { + "took" : 12144, + "timed_out" : false, + "num_reduce_phases" : 46, + "_shards" : { + "total" : 562, + "successful" : 188, + "skipped" : 0, + "failed" : 0 + }, + "hits" : { + "total" : { + "value" : 456433, + "relation" : "eq" + }, + "max_score" : null, + "hits" : [ ] + }, + "aggregations" : { + "sale_date" : { + "buckets" : [] + } + } + } + } diff --git a/specification/async_search/status/AsyncSearchStatusRequest.ts b/specification/async_search/status/AsyncSearchStatusRequest.ts index a389afcd46..9de0bfa2e0 100644 --- a/specification/async_search/status/AsyncSearchStatusRequest.ts +++ b/specification/async_search/status/AsyncSearchStatusRequest.ts @@ -25,10 +25,14 @@ import { Duration } from '@_types/Time' * Get the async search status. * * Get the status of a previously submitted async search request given its identifier, without retrieving search results. - * If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role. + * If the Elasticsearch security features are enabled, the access to the status of a specific async search is restricted to: + * + * * The user or API key that submitted the original async search request. + * * Users that have the `monitor` cluster privilege or greater privileges. * @rest_spec_name async_search.status * @availability stack since=7.11.0 stability=stable * @availability serverless stability=stable visibility=public + * @cluster_privileges monitor * @doc_id async-search * @doc_tag search */ @@ -45,7 +49,7 @@ export interface Request extends RequestBase { } query_parameters: { /** - * Specifies how long the async search needs to be available. + * The length of time that the async search needs to be available. * Ongoing async searches and any saved search results are deleted after this period. * @server_default 5d */ diff --git a/specification/async_search/status/AsyncSearchStatusResponse.ts b/specification/async_search/status/AsyncSearchStatusResponse.ts index 278b406e33..9b74b71fd3 100644 --- a/specification/async_search/status/AsyncSearchStatusResponse.ts +++ b/specification/async_search/status/AsyncSearchStatusResponse.ts @@ -22,17 +22,17 @@ import { integer } from '@_types/Numeric' import { ClusterStatistics, ShardStatistics } from '@_types/Stats' export class StatusResponseBase extends AsyncSearchResponseBase { - /** Indicates how many shards have run the query so far. */ + /** The number of shards that have run the query so far. */ _shards: ShardStatistics /** * Metadata about clusters involved in the cross-cluster search. - * Not shown for local-only searches. + * It is not shown for local-only searches. */ _clusters?: ClusterStatistics /** * If the async search completed, this field shows the status code of the search. - * For example, 200 indicates that the async search was successfully completed. - * 503 indicates that the async search was completed with an error. + * For example, `200` indicates that the async search was successfully completed. + * `503` indicates that the async search was completed with an error. */ completion_status?: integer } diff --git a/specification/async_search/status/AsyncSearchStatusResponseExample1.json b/specification/async_search/status/AsyncSearchStatusResponseExample1.json deleted file mode 100644 index 80b82b360f..0000000000 --- a/specification/async_search/status/AsyncSearchStatusResponseExample1.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "summary": "A succesful response when retrieving the status of a previously submitted async search without the results.", - "description": "", - "type": "response", - "response_code": 200, - "value": "{\n \"id\" : \"FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=\",\n \"is_running\" : true,\n \"is_partial\" : true,\n \"start_time_in_millis\" : 1583945890986,\n \"expiration_time_in_millis\" : 1584377890986,\n \"_shards\" : {\n \"total\" : 562,\n \"successful\" : 188,\n \"skipped\" : 0,\n \"failed\" : 0\n }\n}" -} diff --git a/specification/async_search/status/examples/response/AsyncSearchStatusResponseExample1.yaml b/specification/async_search/status/examples/response/AsyncSearchStatusResponseExample1.yaml new file mode 100644 index 0000000000..1e7d61e2ad --- /dev/null +++ b/specification/async_search/status/examples/response/AsyncSearchStatusResponseExample1.yaml @@ -0,0 +1,18 @@ +summary: An active async search +description: A succesful response from `GET /_async_search/status/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=`, which retrieves the status of a previously submitted async search without the results. +# type: response +# response_code: 200 +value: |- + { + "id" : "FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=", + "is_running" : true, + "is_partial" : true, + "start_time_in_millis" : 1583945890986, + "expiration_time_in_millis" : 1584377890986, + "_shards" : { + "total" : 562, + "successful" : 188, + "skipped" : 0, + "failed" : 0 + } + } diff --git a/specification/async_search/status/examples/response/AsyncSearchStatusResponseExample2.yaml b/specification/async_search/status/examples/response/AsyncSearchStatusResponseExample2.yaml new file mode 100644 index 0000000000..bbb0a4ac50 --- /dev/null +++ b/specification/async_search/status/examples/response/AsyncSearchStatusResponseExample2.yaml @@ -0,0 +1,21 @@ +summary: A completed async search +description: > + A succesful response from `GET /_async_search/status/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=` for an async search that has completed. + The status response has an additional `completion_status` field that shows the status code of the completed async search. +# type: response +# response_code: 200 +value: |- + { + "id" : "FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=", + "is_running" : false, + "is_partial" : false, + "start_time_in_millis" : 1583945890986, + "expiration_time_in_millis" : 1584377890986, + "_shards" : { + "total" : 562, + "successful" : 562, + "skipped" : 0, + "failed" : 0 + }, + "completion_status" : 200 + } diff --git a/specification/async_search/status/examples/response/AsyncSearchStatusResponseExample3.yaml b/specification/async_search/status/examples/response/AsyncSearchStatusResponseExample3.yaml new file mode 100644 index 0000000000..dc36319158 --- /dev/null +++ b/specification/async_search/status/examples/response/AsyncSearchStatusResponseExample3.yaml @@ -0,0 +1,21 @@ +summary: A failed async search +description: > + A response from `GET /_async_search/status/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=` for an async search that has completed with an error. + The status response has an additional `completion_status` field that shows the status code of the completed async search. +# type: response +# response_code: 200 +value: |- + { + "id" : "FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=", + "is_running" : false, + "is_partial" : true, + "start_time_in_millis" : 1583945890986, + "expiration_time_in_millis" : 1584377890986, + "_shards" : { + "total" : 562, + "successful" : 450, + "skipped" : 0, + "failed" : 112 + }, + "completion_status" : 503 + } diff --git a/specification/ccr/_types/FollowIndexStats.ts b/specification/ccr/_types/FollowIndexStats.ts index d923c23a84..0e0b992b0d 100644 --- a/specification/ccr/_types/FollowIndexStats.ts +++ b/specification/ccr/_types/FollowIndexStats.ts @@ -28,48 +28,91 @@ import { integer, long } from '@_types/Numeric' import { Duration, DurationValue, UnitMillis } from '@_types/Time' export class FollowIndexStats { + /** The name of the follower index. */ index: IndexName + /** An array of shard-level following task statistics. */ shards: ShardStats[] } export class ShardStats { + /** + * The total of transferred bytes read from the leader. + * This is only an estimate and does not account for compression if enabled. + */ bytes_read: long + /** The number of failed reads. */ failed_read_requests: long + /** The number of failed bulk write requests on the follower. */ failed_write_requests: long fatal_exception?: ErrorCause + /** The index aliases version the follower is synced up to. */ follower_aliases_version: VersionNumber + /** + * The current global checkpoint on the follower. + * The difference between the `leader_global_checkpoint` and the `follower_global_checkpoint` is an indication of how much the follower is lagging the leader. + */ follower_global_checkpoint: long + /** The name of the follower index. */ follower_index: string + /** The mapping version the follower is synced up to. */ follower_mapping_version: VersionNumber + /** The current maximum sequence number on the follower. */ follower_max_seq_no: SequenceNumber + /** The index settings version the follower is synced up to. */ follower_settings_version: VersionNumber + /** The starting sequence number of the last batch of operations requested from the leader. */ last_requested_seq_no: SequenceNumber + /** The current global checkpoint on the leader known to the follower task. */ leader_global_checkpoint: long + /** The name of the index in the leader cluster being followed. */ leader_index: string + /** The current maximum sequence number on the leader known to the follower task. */ leader_max_seq_no: SequenceNumber + /** The total number of operations read from the leader. */ operations_read: long + /** The number of operations written on the follower. */ operations_written: long + /** The number of active read requests from the follower. */ outstanding_read_requests: integer + /** The number of active bulk write requests on the follower. */ outstanding_write_requests: integer + /** An array of objects representing failed reads. */ read_exceptions: ReadException[] + /** The remote cluster containing the leader index. */ remote_cluster: string + /** The numerical shard ID, with values from 0 to one less than the number of replicas. */ shard_id: integer + /** The number of successful fetches. */ successful_read_requests: long + /** The number of bulk write requests run on the follower.*/ successful_write_requests: long time_since_last_read?: Duration + /** The number of milliseconds since a read request was sent to the leader. + * When the follower is caught up to the leader, this number will increase up to the configured `read_poll_timeout` at which point another read request will be sent to the leader. + */ time_since_last_read_millis: DurationValue total_read_remote_exec_time?: Duration + /** The total time reads spent running on the remote cluster. */ total_read_remote_exec_time_millis: DurationValue total_read_time?: Duration + /** + * The total time reads were outstanding, measured from the time a read was sent to the leader to the time a reply was returned to the follower. + */ total_read_time_millis: DurationValue total_write_time?: Duration + /** The total time spent writing on the follower. */ total_write_time_millis: DurationValue + /** The number of write operations queued on the follower. */ write_buffer_operation_count: long + /** The total number of bytes of operations currently queued for writing. */ write_buffer_size_in_bytes: ByteSize } export class ReadException { + /** The exception that caused the read to fail. */ exception: ErrorCause + /** The starting sequence number of the batch requested from the leader. */ from_seq_no: SequenceNumber + /** The number of times the batch has been retried. */ retries: integer } diff --git a/specification/ccr/delete_auto_follow_pattern/DeleteAutoFollowPatternRequest.ts b/specification/ccr/delete_auto_follow_pattern/DeleteAutoFollowPatternRequest.ts index 63701ddf1d..1d661ab1f7 100644 --- a/specification/ccr/delete_auto_follow_pattern/DeleteAutoFollowPatternRequest.ts +++ b/specification/ccr/delete_auto_follow_pattern/DeleteAutoFollowPatternRequest.ts @@ -23,9 +23,11 @@ import { Duration } from '@_types/Time' /** * Delete auto-follow patterns. + * * Delete a collection of cross-cluster replication auto-follow patterns. * @rest_spec_name ccr.delete_auto_follow_pattern * @availability stack since=6.5.0 stability=stable + * @cluster_privileges manage_ccr * @doc_id ccr-delete-auto-follow-pattern * @ext_doc_id ccr-auto-follow */ @@ -37,11 +39,14 @@ export interface Request extends RequestBase { } ] path_parts: { + /** The auto-follow pattern collection to delete. */ name: Name } query_parameters: { /** - * Period to wait for a connection to the master node. + * The period to wait for a connection to the master node. + * If the master node is not available before the timeout expires, the request fails and returns an error. + * It can also be set to `-1` to indicate that the request should never timeout. * @server_default 30s */ master_timeout?: Duration diff --git a/specification/ccr/delete_auto_follow_pattern/ccrApisAutoFollowDeleteAutoFollowPatternResponseExample1.json b/specification/ccr/delete_auto_follow_pattern/ccrApisAutoFollowDeleteAutoFollowPatternResponseExample1.json deleted file mode 100644 index 0a8bdfe88d..0000000000 --- a/specification/ccr/delete_auto_follow_pattern/ccrApisAutoFollowDeleteAutoFollowPatternResponseExample1.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "summary": "A successful response for deleting an auto-follow pattern.", - "description": "", - "type": "response", - "response_code": 200, - "value": "{\n \"acknowledged\" : true\n}" -} diff --git a/specification/ccr/delete_auto_follow_pattern/examples/response/DeleteAutoFollowPatternResponseExample1.yaml b/specification/ccr/delete_auto_follow_pattern/examples/response/DeleteAutoFollowPatternResponseExample1.yaml new file mode 100644 index 0000000000..f31e399d46 --- /dev/null +++ b/specification/ccr/delete_auto_follow_pattern/examples/response/DeleteAutoFollowPatternResponseExample1.yaml @@ -0,0 +1,8 @@ +# summary: +description: A successful response from `DELETE /_ccr/auto_follow/my_auto_follow_pattern`, which deletes an auto-follow pattern. +# type: response +# response_code: 200 +value: |- + { + "acknowledged" : true + } diff --git a/specification/ccr/follow/examples/request/CreateFollowIndexRequestExample1.yaml b/specification/ccr/follow/examples/request/CreateFollowIndexRequestExample1.yaml index 992edd47b5..67f46c8194 100644 --- a/specification/ccr/follow/examples/request/CreateFollowIndexRequestExample1.yaml +++ b/specification/ccr/follow/examples/request/CreateFollowIndexRequestExample1.yaml @@ -1,5 +1,22 @@ # summary: "Create a follower index named `follower_index`." # method_request: "PUT /follower_index/_ccr/follow?wait_for_active_shards=1" -description: Run `PUT /follower_index/_ccr/follow?wait_for_active_shards=1`." +description: Run `PUT /follower_index/_ccr/follow?wait_for_active_shards=1` to create a follower index named `follower_index`. # type: "request" -value: "{\n \"remote_cluster\" : \"remote_cluster\",\n \"leader_index\" : \"leader_index\",\n \"settings\": {\n \"index.number_of_replicas\": 0\n },\n \"max_read_request_operation_count\" : 1024,\n \"max_outstanding_read_requests\" : 16,\n \"max_read_request_size\" : \"1024k\",\n \"max_write_request_operation_count\" : 32768,\n \"max_write_request_size\" : \"16k\",\n \"max_outstanding_write_requests\" : 8,\n \"max_write_buffer_count\" : 512,\n \"max_write_buffer_size\" : \"512k\",\n \"max_retry_delay\" : \"10s\",\n \"read_poll_timeout\" : \"30s\"\n}" +value: |- + { + "remote_cluster" : "remote_cluster", + "leader_index" : "leader_index", + "settings": { + "index.number_of_replicas": 0 + }, + "max_read_request_operation_count" : 1024, + "max_outstanding_read_requests" : 16, + "max_read_request_size" : "1024k", + "max_write_request_operation_count" : 32768, + "max_write_request_size" : "16k", + "max_outstanding_write_requests" : 8, + "max_write_buffer_count" : 512, + "max_write_buffer_size" : "512k", + "max_retry_delay" : "10s", + "read_poll_timeout" : "30s" + } diff --git a/specification/ccr/follow/examples/response/CreateFollowIndexResponseExample1.yaml b/specification/ccr/follow/examples/response/CreateFollowIndexResponseExample1.yaml index 7016d4b67c..757d424edd 100644 --- a/specification/ccr/follow/examples/response/CreateFollowIndexResponseExample1.yaml +++ b/specification/ccr/follow/examples/response/CreateFollowIndexResponseExample1.yaml @@ -1,7 +1,10 @@ -{ - 'summary': 'A successful response for creating a follower index.', - 'description': '', - 'type': 'response', - 'response_code': 200, - 'value': "{\n \"follow_index_created\" : true,\n \"follow_index_shards_acked\" : true,\n \"index_following_started\" : true\n}" -} +# summary: +description: A successful response from `PUT /follower_index/_ccr/follow?wait_for_active_shards=1`. +# type: 'response', +# response_code: 200, +value: |- + { + "follow_index_created" : true, + "follow_index_shards_acked" : true, + "index_following_started" : true + } diff --git a/specification/ccr/follow_info/FollowInfoRequest.ts b/specification/ccr/follow_info/FollowInfoRequest.ts index b9140ac2e0..3ba355df66 100644 --- a/specification/ccr/follow_info/FollowInfoRequest.ts +++ b/specification/ccr/follow_info/FollowInfoRequest.ts @@ -23,10 +23,12 @@ import { Duration } from '@_types/Time' /** * Get follower information. + * * Get information about all cross-cluster replication follower indices. * For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused. * @rest_spec_name ccr.follow_info * @availability stack since=6.7.0 stability=stable + * @cluster_privileges monitor * @doc_id ccr-get-follow-info * @ext_doc_id ccr */ @@ -38,11 +40,14 @@ export interface Request extends RequestBase { } ] path_parts: { + /** A comma-delimited list of follower index patterns. */ index: Indices } query_parameters: { /** - * Period to wait for a connection to the master node. + * The period to wait for a connection to the master node. + * If the master node is not available before the timeout expires, the request fails and returns an error. + * It can also be set to `-1` to indicate that the request should never timeout. * @server_default 30s */ master_timeout?: Duration diff --git a/specification/ccr/follow_info/ccrApisFollowGetFollowInfoResponseExample1.json b/specification/ccr/follow_info/ccrApisFollowGetFollowInfoResponseExample1.json deleted file mode 100644 index c7c4eb89d4..0000000000 --- a/specification/ccr/follow_info/ccrApisFollowGetFollowInfoResponseExample1.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "summary": "A successful response for retrieving information about all follower indices", - "description": "This may be a response to `GET /follower_index/_ccr/info`.", - "type": "response", - "response_code": 200, - "value": "{\n \"follower_indices\": [\n {\n \"follower_index\": \"follower_index\",\n \"remote_cluster\": \"remote_cluster\",\n \"leader_index\": \"leader_index\",\n \"status\": \"active\",\n \"parameters\": {\n \"max_read_request_operation_count\": 5120,\n \"max_read_request_size\": \"32mb\",\n \"max_outstanding_read_requests\": 12,\n \"max_write_request_operation_count\": 5120,\n \"max_write_request_size\": \"9223372036854775807b\",\n \"max_outstanding_write_requests\": 9,\n \"max_write_buffer_count\": 2147483647,\n \"max_write_buffer_size\": \"512mb\",\n \"max_retry_delay\": \"500ms\",\n \"read_poll_timeout\": \"1m\"\n }\n }\n ]\n}" -} diff --git a/specification/ccr/follow_info/ccrApisFollowGetFollowInfoResponseExample2.json b/specification/ccr/follow_info/ccrApisFollowGetFollowInfoResponseExample2.json deleted file mode 100644 index 2be83319d2..0000000000 --- a/specification/ccr/follow_info/ccrApisFollowGetFollowInfoResponseExample2.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "summary": "A successful response for retrieving information about a paused follower index.", - "description": "", - "type": "response", - "response_code": "200", - "value": "{\n \"follower_indices\": [\n {\n \"follower_index\": \"follower_index\",\n \"remote_cluster\": \"remote_cluster\",\n \"leader_index\": \"leader_index\",\n \"status\": \"paused\"\n }\n ]\n}" -} diff --git a/specification/ccr/follow_info/examples/response/FollowInfoResponseExample1.yaml b/specification/ccr/follow_info/examples/response/FollowInfoResponseExample1.yaml new file mode 100644 index 0000000000..8527f61c52 --- /dev/null +++ b/specification/ccr/follow_info/examples/response/FollowInfoResponseExample1.yaml @@ -0,0 +1,27 @@ +summary: An active follower index +description: A successful response from `GET /follower_index/_ccr/info` when the follower index is active. +# type: response +# response_code: 200 +value: |- + { + "follower_indices": [ + { + "follower_index": "follower_index", + "remote_cluster": "remote_cluster", + "leader_index": "leader_index", + "status": "active", + "parameters": { + "max_read_request_operation_count": 5120, + "max_read_request_size": "32mb", + "max_outstanding_read_requests": 12, + "max_write_request_operation_count": 5120, + "max_write_request_size": "9223372036854775807b", + "max_outstanding_write_requests": 9, + "max_write_buffer_count": 2147483647, + "max_write_buffer_size": "512mb", + "max_retry_delay": "500ms", + "read_poll_timeout": "1m" + } + } + ] + } diff --git a/specification/ccr/follow_info/examples/response/FollowInfoResponseExample2.yaml b/specification/ccr/follow_info/examples/response/FollowInfoResponseExample2.yaml new file mode 100644 index 0000000000..62345e2039 --- /dev/null +++ b/specification/ccr/follow_info/examples/response/FollowInfoResponseExample2.yaml @@ -0,0 +1,15 @@ +summary: A paused follower index +description: A successful response from `GET /follower_index/_ccr/info` when the follower index is paused. +# type: response +# response_code: '200' +value: |- + { + "follower_indices": [ + { + "follower_index": "follower_index", + "remote_cluster": "remote_cluster", + "leader_index": "leader_index", + "status": "paused" + } + ] + } diff --git a/specification/ccr/follow_info/types.ts b/specification/ccr/follow_info/types.ts index c722f15bac..4494b90068 100644 --- a/specification/ccr/follow_info/types.ts +++ b/specification/ccr/follow_info/types.ts @@ -22,10 +22,15 @@ import { integer, long } from '@_types/Numeric' import { Duration } from '@_types/Time' export class FollowerIndex { + /** The name of the follower index. */ follower_index: IndexName + /** The name of the index in the leader cluster that is followed. */ leader_index: IndexName + /** An object that encapsulates cross-cluster replication parameters. If the follower index's status is paused, this object is omitted. */ parameters?: FollowerIndexParameters + /** The remote cluster that contains the leader index. */ remote_cluster: Name + /** The status of the index following: `active` or `paused`. */ status: FollowerIndexStatus } diff --git a/specification/ccr/follow_stats/FollowIndexStatsRequest.ts b/specification/ccr/follow_stats/FollowIndexStatsRequest.ts index 64909205ab..420ee63a34 100644 --- a/specification/ccr/follow_stats/FollowIndexStatsRequest.ts +++ b/specification/ccr/follow_stats/FollowIndexStatsRequest.ts @@ -23,10 +23,12 @@ import { Duration } from '@_types/Time' /** * Get follower stats. + * * Get cross-cluster replication follower stats. * The API returns shard-level stats about the "following tasks" associated with each shard for the specified indices. * @rest_spec_name ccr.follow_stats * @availability stack since=6.5.0 stability=stable + * @cluster_privileges monitor * @doc_id ccr-get-follow-stats * @ext_doc_id ccr */ @@ -38,11 +40,13 @@ export interface Request extends RequestBase { } ] path_parts: { + /** A comma-delimited list of index patterns. */ index: Indices } query_parameters: { /** - * Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + * The period to wait for a response. + * If no response is received before the timeout expires, the request fails and returns an error. * @server_default 30s */ timeout?: Duration diff --git a/specification/ccr/follow_stats/FollowIndexStatsResponse.ts b/specification/ccr/follow_stats/FollowIndexStatsResponse.ts index 3e0a710838..a25b796ca8 100644 --- a/specification/ccr/follow_stats/FollowIndexStatsResponse.ts +++ b/specification/ccr/follow_stats/FollowIndexStatsResponse.ts @@ -20,5 +20,8 @@ import { FollowIndexStats } from '@ccr/_types/FollowIndexStats' export class Response { - body: { indices: FollowIndexStats[] } + body: { + /** An array of follower index statistics. */ + indices: FollowIndexStats[] + } } diff --git a/specification/ccr/follow_stats/ccrApisFollowGetFollowStatsResponseExample1.json b/specification/ccr/follow_stats/ccrApisFollowGetFollowStatsResponseExample1.json deleted file mode 100644 index 84c2f738fe..0000000000 --- a/specification/ccr/follow_stats/ccrApisFollowGetFollowStatsResponseExample1.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "summary": "A successful response for retrieving follower stats.", - "description": "", - "type": "response", - "response_code": 200, - "value": "{\n \"indices\" : [\n {\n \"index\" : \"follower_index\",\n \"total_global_checkpoint_lag\" : 256,\n \"shards\" : [\n {\n \"remote_cluster\" : \"remote_cluster\",\n \"leader_index\" : \"leader_index\",\n \"follower_index\" : \"follower_index\",\n \"shard_id\" : 0,\n \"leader_global_checkpoint\" : 1024,\n \"leader_max_seq_no\" : 1536,\n \"follower_global_checkpoint\" : 768,\n \"follower_max_seq_no\" : 896,\n \"last_requested_seq_no\" : 897,\n \"outstanding_read_requests\" : 8,\n \"outstanding_write_requests\" : 2,\n \"write_buffer_operation_count\" : 64,\n \"follower_mapping_version\" : 4,\n \"follower_settings_version\" : 2,\n \"follower_aliases_version\" : 8,\n \"total_read_time_millis\" : 32768,\n \"total_read_remote_exec_time_millis\" : 16384,\n \"successful_read_requests\" : 32,\n \"failed_read_requests\" : 0,\n \"operations_read\" : 896,\n \"bytes_read\" : 32768,\n \"total_write_time_millis\" : 16384,\n \"write_buffer_size_in_bytes\" : 1536,\n \"successful_write_requests\" : 16,\n \"failed_write_requests\" : 0,\n \"operations_written\" : 832,\n \"read_exceptions\" : [ ],\n \"time_since_last_read_millis\" : 8\n }\n ]\n }\n ]\n}" -} diff --git a/specification/ccr/follow_stats/examples/response/FollowIndexStatsResponseExample1.yaml b/specification/ccr/follow_stats/examples/response/FollowIndexStatsResponseExample1.yaml new file mode 100644 index 0000000000..4079daa8a7 --- /dev/null +++ b/specification/ccr/follow_stats/examples/response/FollowIndexStatsResponseExample1.yaml @@ -0,0 +1,45 @@ +# summary: +description: A successful response from `GET /follower_index/_ccr/stats`, which retrieves follower stats. +# type: response +# response_code: 200 +value: |- + { + "indices" : [ + { + "index" : "follower_index", + "total_global_checkpoint_lag" : 256, + "shards" : [ + { + "remote_cluster" : "remote_cluster", + "leader_index" : "leader_index", + "follower_index" : "follower_index", + "shard_id" : 0, + "leader_global_checkpoint" : 1024, + "leader_max_seq_no" : 1536, + "follower_global_checkpoint" : 768, + "follower_max_seq_no" : 896, + "last_requested_seq_no" : 897, + "outstanding_read_requests" : 8, + "outstanding_write_requests" : 2, + "write_buffer_operation_count" : 64, + "follower_mapping_version" : 4, + "follower_settings_version" : 2, + "follower_aliases_version" : 8, + "total_read_time_millis" : 32768, + "total_read_remote_exec_time_millis" : 16384, + "successful_read_requests" : 32, + "failed_read_requests" : 0, + "operations_read" : 896, + "bytes_read" : 32768, + "total_write_time_millis" : 16384, + "write_buffer_size_in_bytes" : 1536, + "successful_write_requests" : 16, + "failed_write_requests" : 0, + "operations_written" : 832, + "read_exceptions" : [ ], + "time_since_last_read_millis" : 8 + } + ] + } + ] + } diff --git a/specification/ccr/get_auto_follow_pattern/GetAutoFollowPatternRequest.ts b/specification/ccr/get_auto_follow_pattern/GetAutoFollowPatternRequest.ts index ff6ff14993..976fd20d32 100644 --- a/specification/ccr/get_auto_follow_pattern/GetAutoFollowPatternRequest.ts +++ b/specification/ccr/get_auto_follow_pattern/GetAutoFollowPatternRequest.ts @@ -23,9 +23,11 @@ import { Duration } from '@_types/Time' /** * Get auto-follow patterns. + * * Get cross-cluster replication auto-follow patterns. * @rest_spec_name ccr.get_auto_follow_pattern * @availability stack since=6.5.0 stability=stable + * @cluster_privileges manage_ccr * @doc_id ccr-get-auto-follow-pattern * @ext_doc_id ccr-auto-follow */ @@ -41,12 +43,16 @@ export interface Request extends RequestBase { } ] path_parts: { - /** Specifies the auto-follow pattern collection that you want to retrieve. If you do not specify a name, the API returns information for all collections. */ + /** + * The auto-follow pattern collection that you want to retrieve. + * If you do not specify a name, the API returns information for all collections. */ name?: Name } query_parameters: { /** - * Period to wait for a connection to the master node. + * The period to wait for a connection to the master node. + * If the master node is not available before the timeout expires, the request fails and returns an error. + * It can also be set to `-1` to indicate that the request should never timeout. * @server_default 30s */ master_timeout?: Duration diff --git a/specification/ccr/get_auto_follow_pattern/ccrApisAutoFollowGetAutoFollowPatternResponseExample1.json b/specification/ccr/get_auto_follow_pattern/ccrApisAutoFollowGetAutoFollowPatternResponseExample1.json deleted file mode 100644 index a5c328bc55..0000000000 --- a/specification/ccr/get_auto_follow_pattern/ccrApisAutoFollowGetAutoFollowPatternResponseExample1.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "summary": "A successful response for retrieving an auto-follow pattern.", - "description": "This may be a respons to `GET /_ccr/auto_follow/my_auto_follow_pattern`. ", - "type": "response", - "response_code": 200, - "value": "{\n \"patterns\": [\n {\n \"name\": \"my_auto_follow_pattern\",\n \"pattern\": {\n \"active\": true,\n \"remote_cluster\" : \"remote_cluster\",\n \"leader_index_patterns\" :\n [\n \"leader_index*\"\n ],\n \"leader_index_exclusion_patterns\":\n [\n \"leader_index_001\"\n ],\n \"follow_index_pattern\" : \"{{leader_index}}-follower\"\n }\n }\n ]\n}" -} diff --git a/specification/ccr/get_auto_follow_pattern/examples/response/GetAutoFollowPatternResponseExample1.yaml b/specification/ccr/get_auto_follow_pattern/examples/response/GetAutoFollowPatternResponseExample1.yaml new file mode 100644 index 0000000000..63b4b66f95 --- /dev/null +++ b/specification/ccr/get_auto_follow_pattern/examples/response/GetAutoFollowPatternResponseExample1.yaml @@ -0,0 +1,25 @@ +# summary: +description: A successful response from `GET /_ccr/auto_follow/my_auto_follow_pattern`, which gets auto-follow patterns. +# type: response +# response_code: 200 +value: |- + { + "patterns": [ + { + "name": "my_auto_follow_pattern", + "pattern": { + "active": true, + "remote_cluster" : "remote_cluster", + "leader_index_patterns" : + [ + "leader_index*" + ], + "leader_index_exclusion_patterns": + [ + "leader_index_001" + ], + "follow_index_pattern" : "{{leader_index}}-follower" + } + } + ] + } diff --git a/specification/ccr/pause_auto_follow_pattern/PauseAutoFollowPatternRequest.ts b/specification/ccr/pause_auto_follow_pattern/PauseAutoFollowPatternRequest.ts index 1fe5cdb136..e9e3335c5b 100644 --- a/specification/ccr/pause_auto_follow_pattern/PauseAutoFollowPatternRequest.ts +++ b/specification/ccr/pause_auto_follow_pattern/PauseAutoFollowPatternRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Pause an auto-follow pattern. + * * Pause a cross-cluster replication auto-follow pattern. * When the API returns, the auto-follow pattern is inactive. * New indices that are created on the remote cluster and match the auto-follow patterns are ignored. @@ -32,6 +33,7 @@ import { Duration } from '@_types/Time' * Remote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim. * @rest_spec_name ccr.pause_auto_follow_pattern * @availability stack since=7.5.0 stability=stable + * @cluster_privileges manage_ccr * @doc_id ccr-pause-auto-follow-pattern * @ext_doc_id ccr-auto-follow */ @@ -43,11 +45,14 @@ export interface Request extends RequestBase { } ] path_parts: { + /** The name of the auto-follow pattern to pause. */ name: Name } query_parameters: { /** - * Period to wait for a connection to the master node. + * The period to wait for a connection to the master node. + * If the master node is not available before the timeout expires, the request fails and returns an error. + * It can also be set to `-1` to indicate that the request should never timeout. * @server_default 30s */ master_timeout?: Duration diff --git a/specification/ccr/pause_auto_follow_pattern/ccrApisAutoFollowPauseAutoFollowPatternResponseExample1.json b/specification/ccr/pause_auto_follow_pattern/ccrApisAutoFollowPauseAutoFollowPatternResponseExample1.json deleted file mode 100644 index 05d29b79e8..0000000000 --- a/specification/ccr/pause_auto_follow_pattern/ccrApisAutoFollowPauseAutoFollowPatternResponseExample1.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "summary": "A successful response for pausing an auto-follow pattern.", - "description": "", - "type": "response", - "response_code": 200, - "value": "{\n \"acknowledged\" : true\n}" -} diff --git a/specification/ccr/pause_auto_follow_pattern/examples/response/PauseAutoFollowPatternResponseExample1.yaml b/specification/ccr/pause_auto_follow_pattern/examples/response/PauseAutoFollowPatternResponseExample1.yaml new file mode 100644 index 0000000000..b0bb0f358d --- /dev/null +++ b/specification/ccr/pause_auto_follow_pattern/examples/response/PauseAutoFollowPatternResponseExample1.yaml @@ -0,0 +1,8 @@ +# summary: +description: A successful response from `POST /_ccr/auto_follow/my_auto_follow_pattern/pause`, which pauses an auto-follow pattern. +# type: response +# response_code: 200 +value: |- + { + "acknowledged" : true + } diff --git a/specification/ccr/pause_follow/PauseFollowIndexRequest.ts b/specification/ccr/pause_follow/PauseFollowIndexRequest.ts index 60974b6859..f2ac1d3255 100644 --- a/specification/ccr/pause_follow/PauseFollowIndexRequest.ts +++ b/specification/ccr/pause_follow/PauseFollowIndexRequest.ts @@ -23,12 +23,14 @@ import { Duration } from '@_types/Time' /** * Pause a follower. + * * Pause a cross-cluster replication follower index. * The follower index will not fetch any additional operations from the leader index. * You can resume following with the resume follower API. * You can pause and resume a follower index to change the configuration of the following task. * @rest_spec_name ccr.pause_follow * @availability stack since=6.5.0 stability=stable + * @cluster_privileges manage_ccr * @doc_id ccr-post-pause-follow */ export interface Request extends RequestBase { @@ -39,11 +41,14 @@ export interface Request extends RequestBase { } ] path_parts: { + /** The name of the follower index. */ index: IndexName } query_parameters: { /** - * Period to wait for a connection to the master node. + * The period to wait for a connection to the master node. + * If the master node is not available before the timeout expires, the request fails and returns an error. + * It can also be set to `-1` to indicate that the request should never timeout. * @server_default 30s */ master_timeout?: Duration diff --git a/specification/ccr/pause_follow/ccrApisFollowPostPauseFollowResponseExample1.json b/specification/ccr/pause_follow/ccrApisFollowPostPauseFollowResponseExample1.json deleted file mode 100644 index 7084ad5783..0000000000 --- a/specification/ccr/pause_follow/ccrApisFollowPostPauseFollowResponseExample1.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "summary": "A successful response for pausing a follower index.", - "description": "", - "type": "response", - "response_code": 200, - "value": "{\n \"acknowledged\" : true\n}" -} diff --git a/specification/ccr/pause_follow/examples/response/PauseFollowIndexResponseExample1.yaml b/specification/ccr/pause_follow/examples/response/PauseFollowIndexResponseExample1.yaml new file mode 100644 index 0000000000..df592307a8 --- /dev/null +++ b/specification/ccr/pause_follow/examples/response/PauseFollowIndexResponseExample1.yaml @@ -0,0 +1,8 @@ +# summary: +description: A successful response from `POST /follower_index/_ccr/pause_follow`, which pauses a follower index. +# type: response +# response_code: 200 +value: |- + { + "acknowledged" : true + } diff --git a/specification/ccr/resume_auto_follow_pattern/ResumeAutoFollowPatternRequest.ts b/specification/ccr/resume_auto_follow_pattern/ResumeAutoFollowPatternRequest.ts index 358003df1c..71045499f9 100644 --- a/specification/ccr/resume_auto_follow_pattern/ResumeAutoFollowPatternRequest.ts +++ b/specification/ccr/resume_auto_follow_pattern/ResumeAutoFollowPatternRequest.ts @@ -23,11 +23,13 @@ import { Duration } from '@_types/Time' /** * Resume an auto-follow pattern. + * * Resume a cross-cluster replication auto-follow pattern that was paused. * The auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster. * Remote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim. * @rest_spec_name ccr.resume_auto_follow_pattern * @availability stack since=7.5.0 stability=stable + * @cluster_privileges manage_ccr * @doc_id ccr-resume-auto-follow-pattern * @ext_doc_id ccr-auto-follow */ @@ -39,11 +41,14 @@ export interface Request extends RequestBase { } ] path_parts: { + /** The name of the auto-follow pattern to resume. */ name: Name } query_parameters: { /** - * Period to wait for a connection to the master node. + * The period to wait for a connection to the master node. + * If the master node is not available before the timeout expires, the request fails and returns an error. + * It can also be set to `-1` to indicate that the request should never timeout. * @server_default 30s */ master_timeout?: Duration diff --git a/specification/ccr/resume_auto_follow_pattern/ccrApisAutoFollowResumeAutoFollowPatternResponseExample1.json b/specification/ccr/resume_auto_follow_pattern/ccrApisAutoFollowResumeAutoFollowPatternResponseExample1.json deleted file mode 100644 index 118c48137c..0000000000 --- a/specification/ccr/resume_auto_follow_pattern/ccrApisAutoFollowResumeAutoFollowPatternResponseExample1.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "summary": "A successful response for resuming an auto-follow pattern.", - "description": "", - "type": "response", - "response_code": 200, - "value": "{\n \"acknowledged\" : true\n}" -} diff --git a/specification/ccr/resume_auto_follow_pattern/examples/response/ResumeAutoFollowPatternResponseExample1.yaml b/specification/ccr/resume_auto_follow_pattern/examples/response/ResumeAutoFollowPatternResponseExample1.yaml new file mode 100644 index 0000000000..e2ab7bb500 --- /dev/null +++ b/specification/ccr/resume_auto_follow_pattern/examples/response/ResumeAutoFollowPatternResponseExample1.yaml @@ -0,0 +1,9 @@ +# summary: +description: > + A successful response `POST /_ccr/auto_follow/my_auto_follow_pattern/resume`, which resumes an auto-follow pattern. +# type: response +# response_code: 200 +value: |- + { + "acknowledged" : true + } diff --git a/specification/ccr/stats/CcrStatsRequest.ts b/specification/ccr/stats/CcrStatsRequest.ts index 6065a964a0..39e31b08c9 100644 --- a/specification/ccr/stats/CcrStatsRequest.ts +++ b/specification/ccr/stats/CcrStatsRequest.ts @@ -22,9 +22,11 @@ import { Duration } from '@_types/Time' /** * Get cross-cluster replication stats. + * * This API returns stats about auto-following and the same shard-level stats as the get follower stats API. * @rest_spec_name ccr.stats * @availability stack since=6.5.0 stability=stable + * @cluster_privileges monitor * @doc_id ccr-get-stats */ export interface Request extends RequestBase { @@ -36,12 +38,14 @@ export interface Request extends RequestBase { ] query_parameters: { /** - * Period to wait for a connection to the master node. + * The period to wait for a connection to the master node. + * If the master node is not available before the timeout expires, the request fails and returns an error. + * It can also be set to `-1` to indicate that the request should never timeout. * @server_default 30s */ master_timeout?: Duration /** - * Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + * The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. * @server_default 30s */ timeout?: Duration diff --git a/specification/ccr/stats/CcrStatsResponse.ts b/specification/ccr/stats/CcrStatsResponse.ts index e22682073a..afb4b8c69e 100644 --- a/specification/ccr/stats/CcrStatsResponse.ts +++ b/specification/ccr/stats/CcrStatsResponse.ts @@ -21,7 +21,9 @@ import { AutoFollowStats, FollowStats } from './types.ts' export class Response { body: { + /** Statistics for the auto-follow coordinator. */ auto_follow_stats: AutoFollowStats + /** Shard-level statistics for follower indices. */ follow_stats: FollowStats } } diff --git a/specification/ccr/stats/ccrApisGetCcrStatsResponseExample1.json b/specification/ccr/stats/ccrApisGetCcrStatsResponseExample1.json deleted file mode 100644 index 92c423b739..0000000000 --- a/specification/ccr/stats/ccrApisGetCcrStatsResponseExample1.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "summary": "A successful response for retrieving cross-cluster replication stats.", - "description": "", - "type": "response", - "response_code": 200, - "value": "{\n \"auto_follow_stats\" : {\n \"number_of_failed_follow_indices\" : 0,\n \"number_of_failed_remote_cluster_state_requests\" : 0,\n \"number_of_successful_follow_indices\" : 1,\n \"recent_auto_follow_errors\" : [],\n \"auto_followed_clusters\" : []\n },\n \"follow_stats\" : {\n \"indices\" : [\n {\n \"index\" : \"follower_index\",\n \"total_global_checkpoint_lag\" : 256,\n \"shards\" : [\n {\n \"remote_cluster\" : \"remote_cluster\",\n \"leader_index\" : \"leader_index\",\n \"follower_index\" : \"follower_index\",\n \"shard_id\" : 0,\n \"leader_global_checkpoint\" : 1024,\n \"leader_max_seq_no\" : 1536,\n \"follower_global_checkpoint\" : 768,\n \"follower_max_seq_no\" : 896,\n \"last_requested_seq_no\" : 897,\n \"outstanding_read_requests\" : 8,\n \"outstanding_write_requests\" : 2,\n \"write_buffer_operation_count\" : 64,\n \"follower_mapping_version\" : 4,\n \"follower_settings_version\" : 2,\n \"follower_aliases_version\" : 8,\n \"total_read_time_millis\" : 32768,\n \"total_read_remote_exec_time_millis\" : 16384,\n \"successful_read_requests\" : 32,\n \"failed_read_requests\" : 0,\n \"operations_read\" : 896,\n \"bytes_read\" : 32768,\n \"total_write_time_millis\" : 16384,\n \"write_buffer_size_in_bytes\" : 1536,\n \"successful_write_requests\" : 16,\n \"failed_write_requests\" : 0,\n \"operations_written\" : 832,\n \"read_exceptions\" : [ ],\n \"time_since_last_read_millis\" : 8\n }\n ]\n }\n ]\n }\n}" -} diff --git a/specification/ccr/stats/examples/response/CcrStatsResponseExample1.yaml b/specification/ccr/stats/examples/response/CcrStatsResponseExample1.yaml new file mode 100644 index 0000000000..1f0ab038c5 --- /dev/null +++ b/specification/ccr/stats/examples/response/CcrStatsResponseExample1.yaml @@ -0,0 +1,54 @@ +# summary: +description: A successful response from `GET /_ccr/stats` that returns cross-cluster replication stats. +# type: response +# response_code: 200 +value: |- + { + "auto_follow_stats" : { + "number_of_failed_follow_indices" : 0, + "number_of_failed_remote_cluster_state_requests" : 0, + "number_of_successful_follow_indices" : 1, + "recent_auto_follow_errors" : [], + "auto_followed_clusters" : [] + }, + "follow_stats" : { + "indices" : [ + { + "index" : "follower_index", + "total_global_checkpoint_lag" : 256, + "shards" : [ + { + "remote_cluster" : "remote_cluster", + "leader_index" : "leader_index", + "follower_index" : "follower_index", + "shard_id" : 0, + "leader_global_checkpoint" : 1024, + "leader_max_seq_no" : 1536, + "follower_global_checkpoint" : 768, + "follower_max_seq_no" : 896, + "last_requested_seq_no" : 897, + "outstanding_read_requests" : 8, + "outstanding_write_requests" : 2, + "write_buffer_operation_count" : 64, + "follower_mapping_version" : 4, + "follower_settings_version" : 2, + "follower_aliases_version" : 8, + "total_read_time_millis" : 32768, + "total_read_remote_exec_time_millis" : 16384, + "successful_read_requests" : 32, + "failed_read_requests" : 0, + "operations_read" : 896, + "bytes_read" : 32768, + "total_write_time_millis" : 16384, + "write_buffer_size_in_bytes" : 1536, + "successful_write_requests" : 16, + "failed_write_requests" : 0, + "operations_written" : 832, + "read_exceptions" : [ ], + "time_since_last_read_millis" : 8 + } + ] + } + ] + } + } diff --git a/specification/ccr/stats/types.ts.ts b/specification/ccr/stats/types.ts.ts index 9522232c4a..53d9eee553 100644 --- a/specification/ccr/stats/types.ts.ts +++ b/specification/ccr/stats/types.ts.ts @@ -31,9 +31,18 @@ export class AutoFollowedCluster { export class AutoFollowStats { auto_followed_clusters: AutoFollowedCluster[] + /** + * The number of indices that the auto-follow coordinator failed to automatically follow. + * The causes of recent failures are captured in the logs of the elected master node and in the `auto_follow_stats.recent_auto_follow_errors` field. + */ number_of_failed_follow_indices: long + /** + * The number of times that the auto-follow coordinator failed to retrieve the cluster state from a remote cluster registered in a collection of auto-follow patterns. + */ number_of_failed_remote_cluster_state_requests: long + /** The number of indices that the auto-follow coordinator successfully followed. */ number_of_successful_follow_indices: long + /** An array of objects representing failures by the auto-follow coordinator. */ recent_auto_follow_errors: ErrorCause[] } diff --git a/specification/ccr/unfollow/UnfollowIndexRequest.ts b/specification/ccr/unfollow/UnfollowIndexRequest.ts index 7fbdb6d65d..ec469d7633 100644 --- a/specification/ccr/unfollow/UnfollowIndexRequest.ts +++ b/specification/ccr/unfollow/UnfollowIndexRequest.ts @@ -23,13 +23,16 @@ import { Duration } from '@_types/Time' /** * Unfollow an index. + * * Convert a cross-cluster replication follower index to a regular index. * The API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. * The follower index must be paused and closed before you call the unfollow API. * - * NOTE: Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation. + * > info + * > Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation. * @rest_spec_name ccr.unfollow * @availability stack since=6.5.0 stability=stable + * @index_privileges manage_follow_index * @doc_id ccr-post-unfollow * @ext_doc_id ccr */ @@ -41,11 +44,14 @@ export interface Request extends RequestBase { } ] path_parts: { + /** The name of the follower index. */ index: IndexName } query_parameters: { /** - * Period to wait for a connection to the master node. + * The period to wait for a connection to the master node. + * If the master node is not available before the timeout expires, the request fails and returns an error. + * It can also be set to `-1` to indicate that the request should never timeout. * @server_default 30s */ master_timeout?: Duration diff --git a/specification/ccr/unfollow/ccrApisFollowPostUnfollowResponseExample1.json b/specification/ccr/unfollow/ccrApisFollowPostUnfollowResponseExample1.json deleted file mode 100644 index 8fa74c6ccb..0000000000 --- a/specification/ccr/unfollow/ccrApisFollowPostUnfollowResponseExample1.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "summary": "A successful response for converting a follower index to a regular index.", - "description": "", - "type": "response", - "response_code": 200, - "value": "{\n \"acknowledged\" : true\n}" -} diff --git a/specification/ccr/unfollow/examples/response/UnfollowIndexResponseExample1.yaml b/specification/ccr/unfollow/examples/response/UnfollowIndexResponseExample1.yaml new file mode 100644 index 0000000000..81e3b6a1fd --- /dev/null +++ b/specification/ccr/unfollow/examples/response/UnfollowIndexResponseExample1.yaml @@ -0,0 +1,8 @@ +# summary: +description: A successful response from `POST /follower_index/_ccr/unfollow`. +# type: response +# response_code: 200 +value: |- + { + "acknowledged" : true + } diff --git a/specification/cluster/health/examples/response/ClusterHealthResponseExample1.yaml b/specification/cluster/health/examples/response/ClusterHealthResponseExample1.yaml index 53304058fd..7f7e8bb02c 100644 --- a/specification/cluster/health/examples/response/ClusterHealthResponseExample1.yaml +++ b/specification/cluster/health/examples/response/ClusterHealthResponseExample1.yaml @@ -2,8 +2,8 @@ description: > A successful response from `GET _cluster/health`. It is the health status of a quiet single node cluster with a single index with one shard and one replica. -type: response -response_code: 200 +# type: response +# response_code: 200 value: |- { "cluster_name" : "testcluster", diff --git a/specification/cluster/remote_info/ClusterRemoteInfoResponse.ts b/specification/cluster/remote_info/ClusterRemoteInfoResponse.ts index 3afe6d055b..25790ba838 100644 --- a/specification/cluster/remote_info/ClusterRemoteInfoResponse.ts +++ b/specification/cluster/remote_info/ClusterRemoteInfoResponse.ts @@ -78,6 +78,6 @@ export class ClusterRemoteProxyInfo { num_proxy_sockets_connected: integer /** The maximum number of socket connections to the remote cluster when proxy mode is configured. */ max_proxy_socket_connections: integer - /** This field presents and has value of ::es_redacted:: only when the remote cluster is configured with the API key based model. Otherwise, the field is not present. */ + /** This field is present and has a value of `::es_redacted::` only when the remote cluster is configured with the API key based model. Otherwise, the field is not present. */ cluster_credentials?: string } diff --git a/specification/graph/_types/Hop.ts b/specification/graph/_types/Hop.ts index c1a0f6071f..2464023039 100644 --- a/specification/graph/_types/Hop.ts +++ b/specification/graph/_types/Hop.ts @@ -28,7 +28,7 @@ export class Hop { /** * An optional guiding query that constrains the Graph API as it explores connected terms. */ - query: QueryContainer + query?: QueryContainer /** * Contains the fields you are interested in. */ diff --git a/specification/graph/_types/Vertex.ts b/specification/graph/_types/Vertex.ts index 05c925aa45..87d664eabc 100644 --- a/specification/graph/_types/Vertex.ts +++ b/specification/graph/_types/Vertex.ts @@ -58,7 +58,8 @@ export class VertexDefinition { size?: integer } +/** @shortcut_property term */ export class VertexInclude { - boost: double + boost?: double term: string } diff --git a/specification/inference/_types/Results.ts b/specification/inference/_types/Results.ts index 1a35289bab..54a5ddda9d 100644 --- a/specification/inference/_types/Results.ts +++ b/specification/inference/_types/Results.ts @@ -82,6 +82,7 @@ export class RankedDocument { */ export class InferenceResult { text_embedding_bytes?: Array + text_embedding_bits?: Array text_embedding?: Array sparse_embedding?: Array completion?: Array diff --git a/specification/ingest/_types/Processors.ts b/specification/ingest/_types/Processors.ts index b507d6deec..43a5bf0496 100644 --- a/specification/ingest/_types/Processors.ts +++ b/specification/ingest/_types/Processors.ts @@ -22,6 +22,7 @@ import { UserDefinedValue } from '@spec_utils/UserDefinedValue' import { Field, Fields, GrokPattern, Id, Name } from '@_types/common' import { GeoShapeRelation } from '@_types/Geo' import { double, integer, long } from '@_types/Numeric' +import { Script } from '@_types/Scripting' import { SortOrder } from '@_types/sort' /** @@ -309,7 +310,7 @@ export class ProcessorBase { /** * Conditionally execute the processor. */ - if?: string + if?: Script /** * Ignore failures for the processor. */ @@ -731,7 +732,7 @@ export class DateIndexNameProcessor extends ProcessorBase { * An array of the expected date formats for parsing dates / timestamps in the document being preprocessed. * Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. */ - date_formats: string[] + date_formats?: string[] /** * How to round the date when formatting the date into the index name. Valid values are: * `y` (year), `M` (month), `w` (week), `d` (day), `h` (hour), `m` (minute) and `s` (second). diff --git a/specification/ingest/put_pipeline/examples/request/PutPipelineRequestExample2.yaml b/specification/ingest/put_pipeline/examples/request/PutPipelineRequestExample2.yaml index a36e912842..2b795926aa 100644 --- a/specification/ingest/put_pipeline/examples/request/PutPipelineRequestExample2.yaml +++ b/specification/ingest/put_pipeline/examples/request/PutPipelineRequestExample2.yaml @@ -1,7 +1,7 @@ summary: Create an ingest pipeline with metadata. # method_request: PUT /_ingest/pipeline/my-pipeline-id description: You can use the `_meta` parameter to add arbitrary metadata to a pipeline. -type: request +# type: request value: "{\n \"description\" : \"My optional pipeline description\",\n \"processors\"\ \ : [\n {\n \"set\" : {\n \"description\" : \"My optional processor\ diff --git a/specification/ml/_types/DataframeAnalytics.ts b/specification/ml/_types/DataframeAnalytics.ts index 95d4b3e9db..a55eb45b37 100644 --- a/specification/ml/_types/DataframeAnalytics.ts +++ b/specification/ml/_types/DataframeAnalytics.ts @@ -238,9 +238,9 @@ export class DataframeAnalysisClassification extends DataframeAnalysis { /** @shortcut_property includes */ export class DataframeAnalysisAnalyzedFields { /** An array of strings that defines the fields that will be excluded from the analysis. You do not need to add fields with unsupported data types to excludes, these fields are excluded from the analysis automatically. */ - includes: string[] + includes?: string[] /** An array of strings that defines the fields that will be included in the analysis. */ - excludes: string[] + excludes?: string[] } /** @variants container */ diff --git a/specification/ml/close_job/examples/response/MlCloseJobResponseExample1.yaml b/specification/ml/close_job/examples/response/MlCloseJobResponseExample1.yaml index 4ad5911988..9ca7fcc22d 100644 --- a/specification/ml/close_job/examples/response/MlCloseJobResponseExample1.yaml +++ b/specification/ml/close_job/examples/response/MlCloseJobResponseExample1.yaml @@ -1,4 +1,4 @@ -summary: +# summary: description: A successful response when closing anomaly detection jobs. # type: response # response_code: 200 diff --git a/specification/ml/delete_calendar_event/examples/response/MlDeleteCalendarEventResponseExample1.yaml b/specification/ml/delete_calendar_event/examples/response/MlDeleteCalendarEventResponseExample1.yaml index d419e5714c..a704ebd832 100644 --- a/specification/ml/delete_calendar_event/examples/response/MlDeleteCalendarEventResponseExample1.yaml +++ b/specification/ml/delete_calendar_event/examples/response/MlDeleteCalendarEventResponseExample1.yaml @@ -1,4 +1,4 @@ -summary: +# summary: description: A successful response when deleting a calendar event. # type: response # response_code: 200 diff --git a/specification/ml/estimate_model_memory/examples/response/MlEstimateModelMemoryResponseExample1.yaml b/specification/ml/estimate_model_memory/examples/response/MlEstimateModelMemoryResponseExample1.yaml index cad8f96906..fcdde1e7f7 100644 --- a/specification/ml/estimate_model_memory/examples/response/MlEstimateModelMemoryResponseExample1.yaml +++ b/specification/ml/estimate_model_memory/examples/response/MlEstimateModelMemoryResponseExample1.yaml @@ -1,6 +1,6 @@ # summary: description: A successful response from `POST _ml/anomaly_detectors/_estimate_model_memory`. -type: response -response_code: 200 +# type: response +# response_code: 200 value: model_memory_estimate: 21mb diff --git a/specification/snapshot/_types/SnapshotRepository.ts b/specification/snapshot/_types/SnapshotRepository.ts index 6f65d4ab8f..fb809ea381 100644 --- a/specification/snapshot/_types/SnapshotRepository.ts +++ b/specification/snapshot/_types/SnapshotRepository.ts @@ -46,7 +46,7 @@ export class AzureRepository extends RepositoryBase { /** * The repository settings. */ - settings: AzureRepositorySettings + settings?: AzureRepositorySettings } export class GcsRepository extends RepositoryBase { diff --git a/specification/sql/types.ts b/specification/sql/_types/types.ts similarity index 100% rename from specification/sql/types.ts rename to specification/sql/_types/types.ts diff --git a/specification/sql/get_async/SqlGetAsyncResponse.ts b/specification/sql/get_async/SqlGetAsyncResponse.ts index 34f9aa2651..827ab45fe7 100644 --- a/specification/sql/get_async/SqlGetAsyncResponse.ts +++ b/specification/sql/get_async/SqlGetAsyncResponse.ts @@ -18,7 +18,7 @@ */ import { Id } from '@_types/common' -import { Column, Row } from '../types' +import { Column, Row } from '../_types/types' export class Response { body: { diff --git a/specification/sql/query/QuerySqlResponse.ts b/specification/sql/query/QuerySqlResponse.ts index 29e6a69e94..d7f8452dc6 100644 --- a/specification/sql/query/QuerySqlResponse.ts +++ b/specification/sql/query/QuerySqlResponse.ts @@ -18,7 +18,7 @@ */ import { Id } from '@_types/common' -import { Column, Row } from '../types' +import { Column, Row } from '../_types/types' export class Response { body: {