diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 3e158f92a4..0bffd4e1d0 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -32503,7 +32503,7 @@ "tags": [ "synonyms" ], - "summary": "Retrieves a synonym set", + "summary": "Get a synonym set", "operationId": "synonyms-get-synonym", "parameters": [ { @@ -32571,7 +32571,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": [ { @@ -32645,7 +32646,7 @@ "tags": [ "synonyms" ], - "summary": "Deletes a synonym set", + "summary": "Delete a synonym set", "operationId": "synonyms-delete-synonym", "parameters": [ { @@ -32680,7 +32681,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": [ { @@ -32724,7 +32726,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": [ { @@ -32786,7 +32789,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": [ { @@ -32832,7 +32836,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 c8ef4cfb0b..e97e07511e 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -17816,7 +17816,7 @@ "tags": [ "synonyms" ], - "summary": "Retrieves a synonym set", + "summary": "Get a synonym set", "operationId": "synonyms-get-synonym", "parameters": [ { @@ -17884,7 +17884,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": [ { @@ -17958,7 +17959,7 @@ "tags": [ "synonyms" ], - "summary": "Deletes a synonym set", + "summary": "Delete a synonym set", "operationId": "synonyms-delete-synonym", "parameters": [ { @@ -17993,7 +17994,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": [ { @@ -18037,7 +18039,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": [ { @@ -18099,7 +18102,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": [ { @@ -18145,7 +18149,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 2939998cb2..5f90d29d84 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -18744,7 +18744,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": { @@ -18779,7 +18779,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": { @@ -18817,7 +18817,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": { @@ -18852,7 +18852,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": { @@ -18890,7 +18890,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": { @@ -18925,7 +18925,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": { @@ -18963,7 +18963,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": { @@ -204796,7 +204796,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes a synonym set", + "description": "Delete a synonym set.", "inherits": { "type": { "name": "RequestBase", @@ -204850,7 +204850,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", @@ -204888,7 +204888,7 @@ } ], "query": [], - "specLocation": "synonyms/delete_synonym_rule/SynonymRuleDeleteRequest.ts#L22-L40" + "specLocation": "synonyms/delete_synonym_rule/SynonymRuleDeleteRequest.ts#L22-L41" }, { "kind": "response", @@ -204916,7 +204916,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves a synonym set", + "description": "Get a synonym set.", "inherits": { "type": { "name": "RequestBase", @@ -205017,7 +205017,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", @@ -205055,7 +205055,7 @@ } ], "query": [], - "specLocation": "synonyms/get_synonym_rule/SynonymRuleGetRequest.ts#L22-L40" + "specLocation": "synonyms/get_synonym_rule/SynonymRuleGetRequest.ts#L22-L41" }, { "kind": "response", @@ -205083,7 +205083,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", @@ -205123,7 +205123,7 @@ } } ], - "specLocation": "synonyms/get_synonyms_sets/SynonymsSetsGetRequest.ts#L22-L41" + "specLocation": "synonyms/get_synonyms_sets/SynonymsSetsGetRequest.ts#L22-L42" }, { "kind": "response", @@ -205234,7 +205234,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", @@ -205260,7 +205260,7 @@ } ], "query": [], - "specLocation": "synonyms/put_synonym/SynonymsPutRequest.ts#L23-L42" + "specLocation": "synonyms/put_synonym/SynonymsPutRequest.ts#L23-L44" }, { "kind": "response", @@ -205318,7 +205318,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", @@ -205356,7 +205356,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