From 3189c2498e5560f7cc65caae47e3778f0eb97a08 Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Wed, 4 Dec 2024 16:56:21 -0800 Subject: [PATCH] [DOCS] Add synonym operation summaries (#3220) Co-authored-by: Marci W <333176+marciw@users.noreply.github.com> (cherry picked from commit 6fbd2bae71f81e16a26b83608d31b7936b8cc0c2) --- 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 bce163a970..057a4369b2 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -32498,7 +32498,7 @@ "tags": [ "synonyms" ], - "summary": "Retrieves a synonym set", + "summary": "Get a synonym set", "operationId": "synonyms-get-synonym", "parameters": [ { @@ -32566,7 +32566,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": [ { @@ -32640,7 +32641,7 @@ "tags": [ "synonyms" ], - "summary": "Deletes a synonym set", + "summary": "Delete a synonym set", "operationId": "synonyms-delete-synonym", "parameters": [ { @@ -32675,7 +32676,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": [ { @@ -32719,7 +32721,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": [ { @@ -32781,7 +32784,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": [ { @@ -32827,7 +32831,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 cca4e875b2..beef1646f8 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -17804,7 +17804,7 @@ "tags": [ "synonyms" ], - "summary": "Retrieves a synonym set", + "summary": "Get a synonym set", "operationId": "synonyms-get-synonym", "parameters": [ { @@ -17872,7 +17872,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": [ { @@ -17946,7 +17947,7 @@ "tags": [ "synonyms" ], - "summary": "Deletes a synonym set", + "summary": "Delete a synonym set", "operationId": "synonyms-delete-synonym", "parameters": [ { @@ -17981,7 +17982,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": [ { @@ -18025,7 +18027,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": [ { @@ -18087,7 +18090,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": [ { @@ -18133,7 +18137,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 af5719be61..e757402672 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": { @@ -205227,7 +205227,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes a synonym set", + "description": "Delete a synonym set.", "inherits": { "type": { "name": "RequestBase", @@ -205281,7 +205281,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", @@ -205319,7 +205319,7 @@ } ], "query": [], - "specLocation": "synonyms/delete_synonym_rule/SynonymRuleDeleteRequest.ts#L22-L40" + "specLocation": "synonyms/delete_synonym_rule/SynonymRuleDeleteRequest.ts#L22-L41" }, { "kind": "response", @@ -205347,7 +205347,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves a synonym set", + "description": "Get a synonym set.", "inherits": { "type": { "name": "RequestBase", @@ -205448,7 +205448,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", @@ -205486,7 +205486,7 @@ } ], "query": [], - "specLocation": "synonyms/get_synonym_rule/SynonymRuleGetRequest.ts#L22-L40" + "specLocation": "synonyms/get_synonym_rule/SynonymRuleGetRequest.ts#L22-L41" }, { "kind": "response", @@ -205514,7 +205514,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", @@ -205554,7 +205554,7 @@ } } ], - "specLocation": "synonyms/get_synonyms_sets/SynonymsSetsGetRequest.ts#L22-L41" + "specLocation": "synonyms/get_synonyms_sets/SynonymsSetsGetRequest.ts#L22-L42" }, { "kind": "response", @@ -205665,7 +205665,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", @@ -205691,7 +205691,7 @@ } ], "query": [], - "specLocation": "synonyms/put_synonym/SynonymsPutRequest.ts#L23-L42" + "specLocation": "synonyms/put_synonym/SynonymsPutRequest.ts#L23-L44" }, { "kind": "response", @@ -205749,7 +205749,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", @@ -205787,7 +205787,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