From 4c43db8aef1958f3cab3df8f5c9840fe73f934a4 Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Wed, 4 Dec 2024 15:01:33 -0800 Subject: [PATCH] [DOCS] Edit some operation summaries (#3222) (cherry picked from commit 87dd0776889055f7b85ab9fcddaa693b84a3a143) --- output/openapi/elasticsearch-openapi.json | 22 ++++++++++------- .../elasticsearch-serverless-openapi.json | 22 ++++++++++------- output/schema/schema.json | 24 +++++++++---------- specification/_global/count/CountRequest.ts | 2 ++ .../ExecuteEnrichPolicyRequest.ts | 3 ++- .../IndicesExistsIndexTemplateRequest.ts | 2 ++ .../resolve_index/ResolveIndexRequest.ts | 3 ++- 7 files changed, 48 insertions(+), 30 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index fc38f09daa..69f1f765fc 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -5594,7 +5594,8 @@ "tags": [ "search" ], - "summary": "Returns number of documents matching a query", + "summary": "Count search results", + "description": "Get the number of documents matching a query.", "operationId": "count-1", "parameters": [ { @@ -5653,7 +5654,8 @@ "tags": [ "search" ], - "summary": "Returns number of documents matching a query", + "summary": "Count search results", + "description": "Get the number of documents matching a query.", "operationId": "count", "parameters": [ { @@ -5714,7 +5716,8 @@ "tags": [ "search" ], - "summary": "Returns number of documents matching a query", + "summary": "Count search results", + "description": "Get the number of documents matching a query.", "operationId": "count-3", "parameters": [ { @@ -5776,7 +5779,8 @@ "tags": [ "search" ], - "summary": "Returns number of documents matching a query", + "summary": "Count search results", + "description": "Get the number of documents matching a query.", "operationId": "count-2", "parameters": [ { @@ -7364,7 +7368,8 @@ "tags": [ "enrich" ], - "summary": "Creates the enrich index for an existing enrich policy", + "summary": "Run an enrich policy", + "description": "Create the enrich index for an existing enrich policy.", "operationId": "enrich-execute-policy", "parameters": [ { @@ -11610,7 +11615,8 @@ "tags": [ "indices" ], - "summary": "Returns information about whether a particular index template exists", + "summary": "Check index templates", + "description": "Check whether index templates exist.", "operationId": "indices-exists-index-template", "parameters": [ { @@ -13589,8 +13595,8 @@ "tags": [ "indices" ], - "summary": "Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams", - "description": "Multiple patterns and remote clusters are supported.", + "summary": "Resolve indices", + "description": "Resolve the names and/or index patterns for indices, aliases, and data streams.\nMultiple patterns and remote clusters are supported.", "operationId": "indices-resolve-index", "parameters": [ { diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index cca4e875b2..45e1341aae 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -3116,7 +3116,8 @@ "tags": [ "search" ], - "summary": "Returns number of documents matching a query", + "summary": "Count search results", + "description": "Get the number of documents matching a query.", "operationId": "count-1", "parameters": [ { @@ -3175,7 +3176,8 @@ "tags": [ "search" ], - "summary": "Returns number of documents matching a query", + "summary": "Count search results", + "description": "Get the number of documents matching a query.", "operationId": "count", "parameters": [ { @@ -3236,7 +3238,8 @@ "tags": [ "search" ], - "summary": "Returns number of documents matching a query", + "summary": "Count search results", + "description": "Get the number of documents matching a query.", "operationId": "count-3", "parameters": [ { @@ -3298,7 +3301,8 @@ "tags": [ "search" ], - "summary": "Returns number of documents matching a query", + "summary": "Count search results", + "description": "Get the number of documents matching a query.", "operationId": "count-2", "parameters": [ { @@ -4664,7 +4668,8 @@ "tags": [ "enrich" ], - "summary": "Creates the enrich index for an existing enrich policy", + "summary": "Run an enrich policy", + "description": "Create the enrich index for an existing enrich policy.", "operationId": "enrich-execute-policy", "parameters": [ { @@ -7194,7 +7199,8 @@ "tags": [ "indices" ], - "summary": "Returns information about whether a particular index template exists", + "summary": "Check index templates", + "description": "Check whether index templates exist.", "operationId": "indices-exists-index-template", "parameters": [ { @@ -8149,8 +8155,8 @@ "tags": [ "indices" ], - "summary": "Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams", - "description": "Multiple patterns and remote clusters are supported.", + "summary": "Resolve indices", + "description": "Resolve the names and/or index patterns for indices, aliases, and data streams.\nMultiple patterns and remote clusters are supported.", "operationId": "indices-resolve-index", "parameters": [ { diff --git a/output/schema/schema.json b/output/schema/schema.json index 5576cb20e9..c95159c93f 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -4092,7 +4092,7 @@ "stability": "stable" } }, - "description": "Returns number of documents matching a query.", + "description": "Count search results.\nGet the number of documents matching a query.", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html", "name": "count", @@ -4455,7 +4455,7 @@ "stability": "stable" } }, - "description": "Creates the enrich index for an existing enrich policy.", + "description": "Run an enrich policy.\nCreate the enrich index for an existing enrich policy.", "docId": "execute-enrich-policy-api", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/execute-enrich-policy-api.html", "name": "enrich.execute_policy", @@ -6648,7 +6648,7 @@ "stability": "stable" } }, - "description": "Returns information about whether a particular index template exists.", + "description": "Check index templates.\nCheck whether index templates exist.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/index-templates.html", "name": "indices.exists_index_template", "request": { @@ -7801,7 +7801,7 @@ "stability": "stable" } }, - "description": "Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams.\nMultiple patterns and remote clusters are supported.", + "description": "Resolve indices.\nResolve the names and/or index patterns for indices, aliases, and data streams.\nMultiple patterns and remote clusters are supported.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-resolve-index-api.html", "name": "indices.resolve_index", "request": { @@ -21589,7 +21589,7 @@ } ] }, - "description": "Returns number of documents matching a query.", + "description": "Count search results.\nGet the number of documents matching a query.", "inherits": { "type": { "name": "RequestBase", @@ -21790,7 +21790,7 @@ } } ], - "specLocation": "_global/count/CountRequest.ts#L26-L121" + "specLocation": "_global/count/CountRequest.ts#L26-L123" }, { "kind": "response", @@ -116296,7 +116296,7 @@ "body": { "kind": "no_body" }, - "description": "Creates the enrich index for an existing enrich policy.", + "description": "Run an enrich policy.\nCreate the enrich index for an existing enrich policy.", "inherits": { "type": { "name": "RequestBase", @@ -116336,7 +116336,7 @@ } } ], - "specLocation": "enrich/execute_policy/ExecuteEnrichPolicyRequest.ts#L23-L44" + "specLocation": "enrich/execute_policy/ExecuteEnrichPolicyRequest.ts#L23-L45" }, { "kind": "response", @@ -130039,7 +130039,7 @@ "body": { "kind": "no_body" }, - "description": "Returns information about whether a particular index template exists.", + "description": "Check index templates.\nCheck whether index templates exist.", "inherits": { "type": { "name": "RequestBase", @@ -130079,7 +130079,7 @@ } } ], - "specLocation": "indices/exists_index_template/IndicesExistsIndexTemplateRequest.ts#L24-L41" + "specLocation": "indices/exists_index_template/IndicesExistsIndexTemplateRequest.ts#L24-L43" }, { "kind": "response", @@ -135844,7 +135844,7 @@ "body": { "kind": "no_body" }, - "description": "Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams.\nMultiple patterns and remote clusters are supported.", + "description": "Resolve indices.\nResolve the names and/or index patterns for indices, aliases, and data streams.\nMultiple patterns and remote clusters are supported.", "inherits": { "type": { "name": "RequestBase", @@ -135910,7 +135910,7 @@ } } ], - "specLocation": "indices/resolve_index/ResolveIndexRequest.ts#L23-L60" + "specLocation": "indices/resolve_index/ResolveIndexRequest.ts#L23-L61" }, { "kind": "interface", diff --git a/specification/_global/count/CountRequest.ts b/specification/_global/count/CountRequest.ts index b6f5ccefad..bd336a274a 100644 --- a/specification/_global/count/CountRequest.ts +++ b/specification/_global/count/CountRequest.ts @@ -24,6 +24,8 @@ import { QueryContainer } from '@_types/query_dsl/abstractions' import { Operator } from '@_types/query_dsl/Operator' /** + * Count search results. + * Get the number of documents matching a query. * @rest_spec_name count * @availability stack stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/enrich/execute_policy/ExecuteEnrichPolicyRequest.ts b/specification/enrich/execute_policy/ExecuteEnrichPolicyRequest.ts index c4149f7196..32095c8f3e 100644 --- a/specification/enrich/execute_policy/ExecuteEnrichPolicyRequest.ts +++ b/specification/enrich/execute_policy/ExecuteEnrichPolicyRequest.ts @@ -21,7 +21,8 @@ import { RequestBase } from '@_types/Base' import { Name } from '@_types/common' /** - * Creates the enrich index for an existing enrich policy. + * Run an enrich policy. + * Create the enrich index for an existing enrich policy. * @doc_id execute-enrich-policy-api * @rest_spec_name enrich.execute_policy * @availability stack since=7.5.0 stability=stable diff --git a/specification/indices/exists_index_template/IndicesExistsIndexTemplateRequest.ts b/specification/indices/exists_index_template/IndicesExistsIndexTemplateRequest.ts index 823cb15db6..9db02487a6 100644 --- a/specification/indices/exists_index_template/IndicesExistsIndexTemplateRequest.ts +++ b/specification/indices/exists_index_template/IndicesExistsIndexTemplateRequest.ts @@ -22,6 +22,8 @@ import { Name } from '@_types/common' import { Duration } from '@_types/Time' /** + * Check index templates. + * Check whether index templates exist. * @rest_spec_name indices.exists_index_template * @availability stack stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/indices/resolve_index/ResolveIndexRequest.ts b/specification/indices/resolve_index/ResolveIndexRequest.ts index 2ea7bc8570..a456eb5e2c 100644 --- a/specification/indices/resolve_index/ResolveIndexRequest.ts +++ b/specification/indices/resolve_index/ResolveIndexRequest.ts @@ -21,7 +21,8 @@ import { RequestBase } from '@_types/Base' import { ExpandWildcards, Names } from '@_types/common' /** - * Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. + * Resolve indices. + * Resolve the names and/or index patterns for indices, aliases, and data streams. * Multiple patterns and remote clusters are supported. * @rest_spec_name indices.resolve_index * @availability stack since=7.9.0 stability=stable