From 0a85a8a95980f5b2afa3b09826443d0b6b606d69 Mon Sep 17 00:00:00 2001 From: kosabogi Date: Wed, 2 Jul 2025 11:45:23 +0200 Subject: [PATCH 1/3] Adds external link to the Synonyms API --- output/openapi/elasticsearch-openapi.json | 6 +++++- output/openapi/elasticsearch-serverless-openapi.json | 6 +++++- output/schema/schema.json | 8 +++++--- specification/_doc_ids/table.csv | 1 + specification/synonyms/put_synonym/SynonymsPutRequest.ts | 2 ++ 5 files changed, 18 insertions(+), 5 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 81ecfe9d19..d47d27e271 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -41428,7 +41428,11 @@ "synonyms" ], "summary": "Create or update a synonym set", - "description": "Synonyms sets are limited to a maximum of 10,000 synonym rules per set.\nIf you need to manage more synonym rules, you can create multiple synonym sets.\n\nWhen an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices.\nThis is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.\n\n## Required authorization\n\n* Cluster privileges: `manage_search_synonyms`\n", + "description": "Synonyms sets are limited to a maximum of 10,000 synonym rules per set.\nIf you need to manage more synonym rules, you can create multiple synonym sets.\n\nWhen an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices.\nThis is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.\nFor practical examples of how to create or update a synonyms set, refer to the External documentation.\n\n## Required authorization\n\n* Cluster privileges: `manage_search_synonyms`\n", + "externalDocs": { + "url": "https://www.elastic.co/docs/solutions/search/full-text/create-update-synonyms-api-example", + "x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/put-synonyms-set.html" + }, "operationId": "synonyms-put-synonym", "parameters": [ { diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 1d6fba4fc8..6cfa3dad83 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -22229,7 +22229,11 @@ "synonyms" ], "summary": "Create or update a synonym set", - "description": "Synonyms sets are limited to a maximum of 10,000 synonym rules per set.\nIf you need to manage more synonym rules, you can create multiple synonym sets.\n\nWhen an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices.\nThis is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.\n\n## Required authorization\n\n* Cluster privileges: `manage_search_synonyms`\n", + "description": "Synonyms sets are limited to a maximum of 10,000 synonym rules per set.\nIf you need to manage more synonym rules, you can create multiple synonym sets.\n\nWhen an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices.\nThis is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.\nFor practical examples of how to create or update a synonyms set, refer to the External documentation.\n\n## Required authorization\n\n* Cluster privileges: `manage_search_synonyms`\n", + "externalDocs": { + "url": "https://www.elastic.co/docs/solutions/search/full-text/create-update-synonyms-api-example", + "x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/put-synonyms-set.html" + }, "operationId": "synonyms-put-synonym", "parameters": [ { diff --git a/output/schema/schema.json b/output/schema/schema.json index ab2007136f..7961ac4151 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -22678,9 +22678,11 @@ "stability": "stable" } }, - "description": "Create or update a synonym set.\nSynonyms sets are limited to a maximum of 10,000 synonym rules per set.\nIf you need to manage more synonym rules, you can create multiple synonym sets.\n\nWhen an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices.\nThis is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.", + "description": "Create or update a synonym set.\nSynonyms sets are limited to a maximum of 10,000 synonym rules per set.\nIf you need to manage more synonym rules, you can create multiple synonym sets.\n\nWhen an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices.\nThis is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.\nFor practical examples of how to create or update a synonyms set, refer to the External documentation.", "docId": "synonym-set-create", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-put-synonym", + "extDocId": "synonym-api-examples", + "extDocUrl": "https://www.elastic.co/docs/solutions/search/full-text/create-update-synonyms-api-example", "extPreviousVersionDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/put-synonyms-set.html", "name": "synonyms.put_synonym", "privileges": { @@ -252747,7 +252749,7 @@ } ] }, - "description": "Create or update a synonym set.\nSynonyms sets are limited to a maximum of 10,000 synonym rules per set.\nIf you need to manage more synonym rules, you can create multiple synonym sets.\n\nWhen an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices.\nThis is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.", + "description": "Create or update a synonym set.\nSynonyms sets are limited to a maximum of 10,000 synonym rules per set.\nIf you need to manage more synonym rules, you can create multiple synonym sets.\n\nWhen an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices.\nThis is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.\nFor practical examples of how to create or update a synonyms set, refer to the External documentation.", "examples": { "SynonymsPutRequestExample1": { "alternatives": [ @@ -252819,7 +252821,7 @@ } } ], - "specLocation": "synonyms/put_synonym/SynonymsPutRequest.ts#L23-L64" + "specLocation": "synonyms/put_synonym/SynonymsPutRequest.ts#L23-L66" }, { "kind": "response", diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv index c7c54e6998..daf88b2c80 100644 --- a/specification/_doc_ids/table.csv +++ b/specification/_doc_ids/table.csv @@ -877,6 +877,7 @@ stop-dfanalytics,https://www.elastic.co/docs/api/doc/elasticsearch/operation/ope stop-trained-model-deployment,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-stop-trained-model-deployment,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/stop-trained-model-deployment.html stop-transform,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-stop-transform,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/stop-transform.html stored-fields,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#stored-fields, +synonym-api-examples,https://www.elastic.co/docs/solutions/search/full-text/create-update-synonyms-api-example,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/put-synonyms-set.html synonym-rule-create,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-put-synonym-rule,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/put-synonym-rule.html synonym-rule-delete,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-delete-synonym-rule,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/delete-synonym-rule.html synonym-rule-get,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-get-synonym-rule,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/get-synonym-rule.html diff --git a/specification/synonyms/put_synonym/SynonymsPutRequest.ts b/specification/synonyms/put_synonym/SynonymsPutRequest.ts index 809c5d0a11..7e5c767a41 100644 --- a/specification/synonyms/put_synonym/SynonymsPutRequest.ts +++ b/specification/synonyms/put_synonym/SynonymsPutRequest.ts @@ -27,11 +27,13 @@ import { SynonymRule } from '../_types/SynonymRule' * * When an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices. * This is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set. + * For practical examples of how to create or update a synonyms set, refer to the External documentation. * @rest_spec_name synonyms.put_synonym * @availability stack since=8.10.0 stability=stable * @availability serverless stability=stable visibility=public * @cluster_privileges manage_search_synonyms * @doc_id synonym-set-create + * @ext_doc_id synonym-api-examples */ export interface Request extends RequestBase { urls: [ From 97d5a3fb423b086710589e52fc6395423c5ab4a0 Mon Sep 17 00:00:00 2001 From: kosabogi Date: Wed, 2 Jul 2025 11:52:34 +0200 Subject: [PATCH 2/3] Formatting fix --- output/openapi/elasticsearch-openapi.json | 2 +- output/openapi/elasticsearch-serverless-openapi.json | 2 +- output/schema/schema.json | 6 +++--- specification/synonyms/put_synonym/SynonymsPutRequest.ts | 1 + 4 files changed, 6 insertions(+), 5 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index d47d27e271..d2e3db5ed0 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -41428,7 +41428,7 @@ "synonyms" ], "summary": "Create or update a synonym set", - "description": "Synonyms sets are limited to a maximum of 10,000 synonym rules per set.\nIf you need to manage more synonym rules, you can create multiple synonym sets.\n\nWhen an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices.\nThis is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.\nFor practical examples of how to create or update a synonyms set, refer to the External documentation.\n\n## Required authorization\n\n* Cluster privileges: `manage_search_synonyms`\n", + "description": "Synonyms sets are limited to a maximum of 10,000 synonym rules per set.\nIf you need to manage more synonym rules, you can create multiple synonym sets.\n\nWhen an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices.\nThis is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.\n\nFor practical examples of how to create or update a synonyms set, refer to the External documentation.\n\n## Required authorization\n\n* Cluster privileges: `manage_search_synonyms`\n", "externalDocs": { "url": "https://www.elastic.co/docs/solutions/search/full-text/create-update-synonyms-api-example", "x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/put-synonyms-set.html" diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 6cfa3dad83..044e423005 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -22229,7 +22229,7 @@ "synonyms" ], "summary": "Create or update a synonym set", - "description": "Synonyms sets are limited to a maximum of 10,000 synonym rules per set.\nIf you need to manage more synonym rules, you can create multiple synonym sets.\n\nWhen an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices.\nThis is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.\nFor practical examples of how to create or update a synonyms set, refer to the External documentation.\n\n## Required authorization\n\n* Cluster privileges: `manage_search_synonyms`\n", + "description": "Synonyms sets are limited to a maximum of 10,000 synonym rules per set.\nIf you need to manage more synonym rules, you can create multiple synonym sets.\n\nWhen an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices.\nThis is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.\n\nFor practical examples of how to create or update a synonyms set, refer to the External documentation.\n\n## Required authorization\n\n* Cluster privileges: `manage_search_synonyms`\n", "externalDocs": { "url": "https://www.elastic.co/docs/solutions/search/full-text/create-update-synonyms-api-example", "x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/put-synonyms-set.html" diff --git a/output/schema/schema.json b/output/schema/schema.json index 7961ac4151..a06a849922 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -22678,7 +22678,7 @@ "stability": "stable" } }, - "description": "Create or update a synonym set.\nSynonyms sets are limited to a maximum of 10,000 synonym rules per set.\nIf you need to manage more synonym rules, you can create multiple synonym sets.\n\nWhen an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices.\nThis is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.\nFor practical examples of how to create or update a synonyms set, refer to the External documentation.", + "description": "Create or update a synonym set.\nSynonyms sets are limited to a maximum of 10,000 synonym rules per set.\nIf you need to manage more synonym rules, you can create multiple synonym sets.\n\nWhen an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices.\nThis is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.\n\nFor practical examples of how to create or update a synonyms set, refer to the External documentation.", "docId": "synonym-set-create", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-put-synonym", "extDocId": "synonym-api-examples", @@ -252749,7 +252749,7 @@ } ] }, - "description": "Create or update a synonym set.\nSynonyms sets are limited to a maximum of 10,000 synonym rules per set.\nIf you need to manage more synonym rules, you can create multiple synonym sets.\n\nWhen an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices.\nThis is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.\nFor practical examples of how to create or update a synonyms set, refer to the External documentation.", + "description": "Create or update a synonym set.\nSynonyms sets are limited to a maximum of 10,000 synonym rules per set.\nIf you need to manage more synonym rules, you can create multiple synonym sets.\n\nWhen an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices.\nThis is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.\n\nFor practical examples of how to create or update a synonyms set, refer to the External documentation.", "examples": { "SynonymsPutRequestExample1": { "alternatives": [ @@ -252821,7 +252821,7 @@ } } ], - "specLocation": "synonyms/put_synonym/SynonymsPutRequest.ts#L23-L66" + "specLocation": "synonyms/put_synonym/SynonymsPutRequest.ts#L23-L67" }, { "kind": "response", diff --git a/specification/synonyms/put_synonym/SynonymsPutRequest.ts b/specification/synonyms/put_synonym/SynonymsPutRequest.ts index 7e5c767a41..75411fadbe 100644 --- a/specification/synonyms/put_synonym/SynonymsPutRequest.ts +++ b/specification/synonyms/put_synonym/SynonymsPutRequest.ts @@ -27,6 +27,7 @@ import { SynonymRule } from '../_types/SynonymRule' * * When an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices. * This is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set. + * * For practical examples of how to create or update a synonyms set, refer to the External documentation. * @rest_spec_name synonyms.put_synonym * @availability stack since=8.10.0 stability=stable From 8b1012d918904611faad0a729574d09df4107bd8 Mon Sep 17 00:00:00 2001 From: kosabogi Date: Wed, 2 Jul 2025 11:55:03 +0200 Subject: [PATCH 3/3] Code style fix --- specification/synonyms/put_synonym/SynonymsPutRequest.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/synonyms/put_synonym/SynonymsPutRequest.ts b/specification/synonyms/put_synonym/SynonymsPutRequest.ts index 75411fadbe..5408b22e6b 100644 --- a/specification/synonyms/put_synonym/SynonymsPutRequest.ts +++ b/specification/synonyms/put_synonym/SynonymsPutRequest.ts @@ -27,7 +27,7 @@ import { SynonymRule } from '../_types/SynonymRule' * * When an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices. * This is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set. - * + * * For practical examples of how to create or update a synonyms set, refer to the External documentation. * @rest_spec_name synonyms.put_synonym * @availability stack since=8.10.0 stability=stable