From eca88adc205c360f1c52e75d2dd6a65cd6ac289f Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 5 Dec 2024 10:57:22 -0800 Subject: [PATCH] [DOCS] Add synonym operation summaries (#3220) (#3248) Co-authored-by: Marci W <333176+marciw@users.noreply.github.com> (cherry picked from commit 6fbd2bae71f81e16a26b83608d31b7936b8cc0c2) Co-authored-by: Lisa Cawley --- output/openapi/elasticsearch-openapi.json | 19 ++++++---- .../elasticsearch-serverless-openapi.json | 19 ++++++---- output/schema/schema.json | 38 +++++++++---------- .../delete_synonym/SynonymsDeleteRequest.ts | 2 +- .../SynonymRuleDeleteRequest.ts | 3 +- .../get_synonym/SynonymsGetRequest.ts | 2 +- .../get_synonym_rule/SynonymRuleGetRequest.ts | 3 +- .../SynonymsSetsGetRequest.ts | 3 +- .../put_synonym/SynonymsPutRequest.ts | 4 +- .../put_synonym_rule/SynonymRulePutRequest.ts | 3 +- 10 files changed, 56 insertions(+), 40 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 65411067e5..1c44f61569 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -32508,7 +32508,7 @@ "tags": [ "synonyms" ], - "summary": "Retrieves a synonym set", + "summary": "Get a synonym set", "operationId": "synonyms-get-synonym", "parameters": [ { @@ -32576,7 +32576,8 @@ "tags": [ "synonyms" ], - "summary": "Creates or updates a synonym set", + "summary": "Create or update a synonym set", + "description": "Synonyms sets are limited to a maximum of 10000 synonym rules per set.\nIf you need to manage more synonym rules, you can create multiple synonym sets.", "operationId": "synonyms-put-synonym", "parameters": [ { @@ -32650,7 +32651,7 @@ "tags": [ "synonyms" ], - "summary": "Deletes a synonym set", + "summary": "Delete a synonym set", "operationId": "synonyms-delete-synonym", "parameters": [ { @@ -32685,7 +32686,8 @@ "tags": [ "synonyms" ], - "summary": "Retrieves a synonym rule from a synonym set", + "summary": "Get a synonym rule", + "description": "Get a synonym rule from a synonym set.", "operationId": "synonyms-get-synonym-rule", "parameters": [ { @@ -32729,7 +32731,8 @@ "tags": [ "synonyms" ], - "summary": "Creates or updates a synonym rule in a synonym set", + "summary": "Create or update a synonym rule", + "description": "Create or update a synonym rule in a synonym set.", "operationId": "synonyms-put-synonym-rule", "parameters": [ { @@ -32791,7 +32794,8 @@ "tags": [ "synonyms" ], - "summary": "Deletes a synonym rule in a synonym set", + "summary": "Delete a synonym rule", + "description": "Delete a synonym rule from a synonym set.", "operationId": "synonyms-delete-synonym-rule", "parameters": [ { @@ -32837,7 +32841,8 @@ "tags": [ "synonyms" ], - "summary": "Retrieves a summary of all defined synonym sets", + "summary": "Get all synonym sets", + "description": "Get a summary of all defined synonym sets.", "operationId": "synonyms-get-synonyms-sets", "parameters": [ { diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 9314cea604..0502a344c1 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -17814,7 +17814,7 @@ "tags": [ "synonyms" ], - "summary": "Retrieves a synonym set", + "summary": "Get a synonym set", "operationId": "synonyms-get-synonym", "parameters": [ { @@ -17882,7 +17882,8 @@ "tags": [ "synonyms" ], - "summary": "Creates or updates a synonym set", + "summary": "Create or update a synonym set", + "description": "Synonyms sets are limited to a maximum of 10000 synonym rules per set.\nIf you need to manage more synonym rules, you can create multiple synonym sets.", "operationId": "synonyms-put-synonym", "parameters": [ { @@ -17956,7 +17957,7 @@ "tags": [ "synonyms" ], - "summary": "Deletes a synonym set", + "summary": "Delete a synonym set", "operationId": "synonyms-delete-synonym", "parameters": [ { @@ -17991,7 +17992,8 @@ "tags": [ "synonyms" ], - "summary": "Retrieves a synonym rule from a synonym set", + "summary": "Get a synonym rule", + "description": "Get a synonym rule from a synonym set.", "operationId": "synonyms-get-synonym-rule", "parameters": [ { @@ -18035,7 +18037,8 @@ "tags": [ "synonyms" ], - "summary": "Creates or updates a synonym rule in a synonym set", + "summary": "Create or update a synonym rule", + "description": "Create or update a synonym rule in a synonym set.", "operationId": "synonyms-put-synonym-rule", "parameters": [ { @@ -18097,7 +18100,8 @@ "tags": [ "synonyms" ], - "summary": "Deletes a synonym rule in a synonym set", + "summary": "Delete a synonym rule", + "description": "Delete a synonym rule from a synonym set.", "operationId": "synonyms-delete-synonym-rule", "parameters": [ { @@ -18143,7 +18147,8 @@ "tags": [ "synonyms" ], - "summary": "Retrieves a summary of all defined synonym sets", + "summary": "Get all synonym sets", + "description": "Get a summary of all defined synonym sets.", "operationId": "synonyms-get-synonyms-sets", "parameters": [ { diff --git a/output/schema/schema.json b/output/schema/schema.json index 35324b2745..2f51086478 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -18746,7 +18746,7 @@ "stability": "stable" } }, - "description": "Deletes a synonym set", + "description": "Delete a synonym set.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-synonyms-set.html", "name": "synonyms.delete_synonym", "request": { @@ -18781,7 +18781,7 @@ "stability": "stable" } }, - "description": "Deletes a synonym rule in a synonym set", + "description": "Delete a synonym rule.\nDelete a synonym rule from a synonym set.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-synonym-rule.html", "name": "synonyms.delete_synonym_rule", "request": { @@ -18819,7 +18819,7 @@ "stability": "stable" } }, - "description": "Retrieves a synonym set", + "description": "Get a synonym set.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-synonyms-set.html", "name": "synonyms.get_synonym", "request": { @@ -18854,7 +18854,7 @@ "stability": "stable" } }, - "description": "Retrieves a synonym rule from a synonym set", + "description": "Get a synonym rule.\nGet a synonym rule from a synonym set.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-synonym-rule.html", "name": "synonyms.get_synonym_rule", "request": { @@ -18892,7 +18892,7 @@ "stability": "stable" } }, - "description": "Retrieves a summary of all defined synonym sets", + "description": "Get all synonym sets.\nGet a summary of all defined synonym sets.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-synonyms-sets.html", "name": "synonyms.get_synonyms_sets", "request": { @@ -18927,7 +18927,7 @@ "stability": "stable" } }, - "description": "Creates or updates a synonym set.", + "description": "Create or update a synonym set.\nSynonyms sets are limited to a maximum of 10000 synonym rules per set.\nIf you need to manage more synonym rules, you can create multiple synonym sets.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-synonyms-set.html", "name": "synonyms.put_synonym", "request": { @@ -18965,7 +18965,7 @@ "stability": "stable" } }, - "description": "Creates or updates a synonym rule in a synonym set", + "description": "Create or update a synonym rule.\nCreate or update a synonym rule in a synonym set.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-synonym-rule.html", "name": "synonyms.put_synonym_rule", "request": { @@ -205229,7 +205229,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes a synonym set", + "description": "Delete a synonym set.", "inherits": { "type": { "name": "RequestBase", @@ -205283,7 +205283,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes a synonym rule in a synonym set", + "description": "Delete a synonym rule.\nDelete a synonym rule from a synonym set.", "inherits": { "type": { "name": "RequestBase", @@ -205321,7 +205321,7 @@ } ], "query": [], - "specLocation": "synonyms/delete_synonym_rule/SynonymRuleDeleteRequest.ts#L22-L40" + "specLocation": "synonyms/delete_synonym_rule/SynonymRuleDeleteRequest.ts#L22-L41" }, { "kind": "response", @@ -205349,7 +205349,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves a synonym set", + "description": "Get a synonym set.", "inherits": { "type": { "name": "RequestBase", @@ -205450,7 +205450,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves a synonym rule from a synonym set", + "description": "Get a synonym rule.\nGet a synonym rule from a synonym set.", "inherits": { "type": { "name": "RequestBase", @@ -205488,7 +205488,7 @@ } ], "query": [], - "specLocation": "synonyms/get_synonym_rule/SynonymRuleGetRequest.ts#L22-L40" + "specLocation": "synonyms/get_synonym_rule/SynonymRuleGetRequest.ts#L22-L41" }, { "kind": "response", @@ -205516,7 +205516,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves a summary of all defined synonym sets", + "description": "Get all synonym sets.\nGet a summary of all defined synonym sets.", "inherits": { "type": { "name": "RequestBase", @@ -205556,7 +205556,7 @@ } } ], - "specLocation": "synonyms/get_synonyms_sets/SynonymsSetsGetRequest.ts#L22-L41" + "specLocation": "synonyms/get_synonyms_sets/SynonymsSetsGetRequest.ts#L22-L42" }, { "kind": "response", @@ -205667,7 +205667,7 @@ } ] }, - "description": "Creates or updates a synonym set.", + "description": "Create or update a synonym set.\nSynonyms sets are limited to a maximum of 10000 synonym rules per set.\nIf you need to manage more synonym rules, you can create multiple synonym sets.", "inherits": { "type": { "name": "RequestBase", @@ -205693,7 +205693,7 @@ } ], "query": [], - "specLocation": "synonyms/put_synonym/SynonymsPutRequest.ts#L23-L42" + "specLocation": "synonyms/put_synonym/SynonymsPutRequest.ts#L23-L44" }, { "kind": "response", @@ -205751,7 +205751,7 @@ } ] }, - "description": "Creates or updates a synonym rule in a synonym set", + "description": "Create or update a synonym rule.\nCreate or update a synonym rule in a synonym set.", "inherits": { "type": { "name": "RequestBase", @@ -205789,7 +205789,7 @@ } ], "query": [], - "specLocation": "synonyms/put_synonym_rule/SynonymRulePutRequest.ts#L23-L47" + "specLocation": "synonyms/put_synonym_rule/SynonymRulePutRequest.ts#L23-L48" }, { "kind": "response", diff --git a/specification/synonyms/delete_synonym/SynonymsDeleteRequest.ts b/specification/synonyms/delete_synonym/SynonymsDeleteRequest.ts index 6e6aeeb3ad..ad6e0b7595 100644 --- a/specification/synonyms/delete_synonym/SynonymsDeleteRequest.ts +++ b/specification/synonyms/delete_synonym/SynonymsDeleteRequest.ts @@ -20,7 +20,7 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Deletes a synonym set + * Delete a synonym set. * @rest_spec_name synonyms.delete_synonym * @availability stack since=8.10.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/synonyms/delete_synonym_rule/SynonymRuleDeleteRequest.ts b/specification/synonyms/delete_synonym_rule/SynonymRuleDeleteRequest.ts index ec2af20641..4c095ad1f0 100644 --- a/specification/synonyms/delete_synonym_rule/SynonymRuleDeleteRequest.ts +++ b/specification/synonyms/delete_synonym_rule/SynonymRuleDeleteRequest.ts @@ -20,7 +20,8 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Deletes a synonym rule in a synonym set + * Delete a synonym rule. + * Delete a synonym rule from a synonym set. * @rest_spec_name synonyms.delete_synonym_rule * @availability stack since=8.10.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/synonyms/get_synonym/SynonymsGetRequest.ts b/specification/synonyms/get_synonym/SynonymsGetRequest.ts index 10490a7b04..277ca732b9 100644 --- a/specification/synonyms/get_synonym/SynonymsGetRequest.ts +++ b/specification/synonyms/get_synonym/SynonymsGetRequest.ts @@ -21,7 +21,7 @@ import { Id } from '@_types/common' import { integer } from '@_types/Numeric' /** - * Retrieves a synonym set + * Get a synonym set. * @rest_spec_name synonyms.get_synonym * @availability stack since=8.10.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/synonyms/get_synonym_rule/SynonymRuleGetRequest.ts b/specification/synonyms/get_synonym_rule/SynonymRuleGetRequest.ts index 5f2116dc59..aaabd51d60 100644 --- a/specification/synonyms/get_synonym_rule/SynonymRuleGetRequest.ts +++ b/specification/synonyms/get_synonym_rule/SynonymRuleGetRequest.ts @@ -20,7 +20,8 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Retrieves a synonym rule from a synonym set + * Get a synonym rule. + * Get a synonym rule from a synonym set. * @rest_spec_name synonyms.get_synonym_rule * @availability stack since=8.10.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/synonyms/get_synonyms_sets/SynonymsSetsGetRequest.ts b/specification/synonyms/get_synonyms_sets/SynonymsSetsGetRequest.ts index 49a7e518b3..68dccb4ff5 100644 --- a/specification/synonyms/get_synonyms_sets/SynonymsSetsGetRequest.ts +++ b/specification/synonyms/get_synonyms_sets/SynonymsSetsGetRequest.ts @@ -20,7 +20,8 @@ import { RequestBase } from '@_types/Base' import { integer } from '@_types/Numeric' /** - * Retrieves a summary of all defined synonym sets + * Get all synonym sets. + * Get a summary of all defined synonym sets. * @rest_spec_name synonyms.get_synonyms_sets * @availability stack since=8.10.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/synonyms/put_synonym/SynonymsPutRequest.ts b/specification/synonyms/put_synonym/SynonymsPutRequest.ts index c49bb096bd..73c8b2eaea 100644 --- a/specification/synonyms/put_synonym/SynonymsPutRequest.ts +++ b/specification/synonyms/put_synonym/SynonymsPutRequest.ts @@ -21,7 +21,9 @@ import { Id } from '@_types/common' import { SynonymRule } from '../_types/SynonymRule' /** - * Creates or updates a synonym set. + * Create or update a synonym set. + * Synonyms sets are limited to a maximum of 10,000 synonym rules per set. + * If you need to manage more synonym rules, you can create multiple synonym sets. * @rest_spec_name synonyms.put_synonym * @availability stack since=8.10.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/synonyms/put_synonym_rule/SynonymRulePutRequest.ts b/specification/synonyms/put_synonym_rule/SynonymRulePutRequest.ts index 6da2fda220..a661580cf0 100644 --- a/specification/synonyms/put_synonym_rule/SynonymRulePutRequest.ts +++ b/specification/synonyms/put_synonym_rule/SynonymRulePutRequest.ts @@ -21,7 +21,8 @@ import { Id } from '@_types/common' import { SynonymString } from '../_types/SynonymRule' /** - * Creates or updates a synonym rule in a synonym set + * Create or update a synonym rule. + * Create or update a synonym rule in a synonym set. * @rest_spec_name synonyms.put_synonym_rule * @availability stack since=8.10.0 stability=stable * @availability serverless stability=stable visibility=public