Skip to content

Commit 6fbd2ba

Browse files
lcawlmarciw
andauthored
[DOCS] Add synonym operation summaries (#3220)
Co-authored-by: Marci W <[email protected]>
1 parent c39fb15 commit 6fbd2ba

File tree

10 files changed

+56
-40
lines changed

10 files changed

+56
-40
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 12 additions & 7 deletions
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: 12 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/schema.json

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

specification/synonyms/delete_synonym/SynonymsDeleteRequest.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import { RequestBase } from '@_types/Base'
2020
import { Id } from '@_types/common'
2121

2222
/**
23-
* Deletes a synonym set
23+
* Delete a synonym set.
2424
* @rest_spec_name synonyms.delete_synonym
2525
* @availability stack since=8.10.0 stability=stable
2626
* @availability serverless stability=stable visibility=public

specification/synonyms/delete_synonym_rule/SynonymRuleDeleteRequest.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ import { RequestBase } from '@_types/Base'
2020
import { Id } from '@_types/common'
2121

2222
/**
23-
* Deletes a synonym rule in a synonym set
23+
* Delete a synonym rule.
24+
* Delete a synonym rule from a synonym set.
2425
* @rest_spec_name synonyms.delete_synonym_rule
2526
* @availability stack since=8.10.0 stability=stable
2627
* @availability serverless stability=stable visibility=public

specification/synonyms/get_synonym/SynonymsGetRequest.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import { Id } from '@_types/common'
2121
import { integer } from '@_types/Numeric'
2222

2323
/**
24-
* Retrieves a synonym set
24+
* Get a synonym set.
2525
* @rest_spec_name synonyms.get_synonym
2626
* @availability stack since=8.10.0 stability=stable
2727
* @availability serverless stability=stable visibility=public

specification/synonyms/get_synonym_rule/SynonymRuleGetRequest.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ import { RequestBase } from '@_types/Base'
2020
import { Id } from '@_types/common'
2121

2222
/**
23-
* Retrieves a synonym rule from a synonym set
23+
* Get a synonym rule.
24+
* Get a synonym rule from a synonym set.
2425
* @rest_spec_name synonyms.get_synonym_rule
2526
* @availability stack since=8.10.0 stability=stable
2627
* @availability serverless stability=stable visibility=public

specification/synonyms/get_synonyms_sets/SynonymsSetsGetRequest.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ import { RequestBase } from '@_types/Base'
2020
import { integer } from '@_types/Numeric'
2121

2222
/**
23-
* Retrieves a summary of all defined synonym sets
23+
* Get all synonym sets.
24+
* Get a summary of all defined synonym sets.
2425
* @rest_spec_name synonyms.get_synonyms_sets
2526
* @availability stack since=8.10.0 stability=stable
2627
* @availability serverless stability=stable visibility=public

specification/synonyms/put_synonym/SynonymsPutRequest.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,9 @@ import { Id } from '@_types/common'
2121
import { SynonymRule } from '../_types/SynonymRule'
2222

2323
/**
24-
* Creates or updates a synonym set.
24+
* Create or update a synonym set.
25+
* Synonyms sets are limited to a maximum of 10,000 synonym rules per set.
26+
* If you need to manage more synonym rules, you can create multiple synonym sets.
2527
* @rest_spec_name synonyms.put_synonym
2628
* @availability stack since=8.10.0 stability=stable
2729
* @availability serverless stability=stable visibility=public

specification/synonyms/put_synonym_rule/SynonymRulePutRequest.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ import { Id } from '@_types/common'
2121
import { SynonymString } from '../_types/SynonymRule'
2222

2323
/**
24-
* Creates or updates a synonym rule in a synonym set
24+
* Create or update a synonym rule.
25+
* Create or update a synonym rule in a synonym set.
2526
* @rest_spec_name synonyms.put_synonym_rule
2627
* @availability stack since=8.10.0 stability=stable
2728
* @availability serverless stability=stable visibility=public

0 commit comments

Comments
 (0)