Skip to content

Commit 4434187

Browse files
committed
Adds external link to the Synonyms API (#4756)
* Adds external link to the Synonyms API * Formatting fix * Code style fix (cherry picked from commit 644201b)
1 parent 0e4b1d3 commit 4434187

File tree

5 files changed

+41
-8
lines changed

5 files changed

+41
-8
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 5 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/openapi/elasticsearch-serverless-openapi.json

Lines changed: 5 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/schema.json

Lines changed: 26 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/_doc_ids/table.csv

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -870,6 +870,7 @@ start-trial,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/opera
870870
stop-dfanalytics,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-stop-data-frame-analytics,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/stop-dfanalytics.html
871871
stop-trained-model-deployment,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-stop-trained-model-deployment,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/stop-trained-model-deployment.html
872872
stop-transform,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-stop-transform,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/stop-transform.html
873+
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
873874
stored-fields,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#stored-fields,
874875
synonym-rule-create,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-synonyms-put-synonym-rule,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/put-synonym-rule.html
875876
synonym-rule-delete,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-synonyms-delete-synonym-rule,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/delete-synonym-rule.html
@@ -921,4 +922,4 @@ watcher-api-update-settings,https://www.elastic.co/docs/api/doc/elasticsearch/v9
921922
watsonx-api-keys,https://cloud.ibm.com/iam/apikeys,
922923
watsonx-api-models,https://www.ibm.com/products/watsonx-ai/foundation-models,
923924
watsonx-api-version,https://cloud.ibm.com/apidocs/watsonx-ai#active-version-dates,
924-
xpack-rollup,https://www.elastic.co/docs/manage-data/lifecycle/rollup,
925+
xpack-rollup,https://www.elastic.co/docs/manage-data/lifecycle/rollup,

specification/synonyms/put_synonym/SynonymsPutRequest.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,14 @@ import { SynonymRule } from '../_types/SynonymRule'
2727
*
2828
* When an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices.
2929
* This is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.
30+
*
31+
* For practical examples of how to create or update a synonyms set, refer to the External documentation.
3032
* @rest_spec_name synonyms.put_synonym
3133
* @availability stack since=8.10.0 stability=stable
3234
* @availability serverless stability=stable visibility=public
3335
* @cluster_privileges manage_search_synonyms
3436
* @doc_id synonym-set-create
37+
* @ext_doc_id synonym-api-examples
3538
*/
3639
export interface Request extends RequestBase {
3740
urls: [

0 commit comments

Comments
 (0)