Skip to content

Commit 82a3e5f

Browse files
authored
Renamed synonyms API namespaces (#2234)
1 parent d91da1a commit 82a3e5f

24 files changed

+480
-485
lines changed

output/schema/schema.json

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

output/schema/validation-errors.json

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

output/typescript/types.ts

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

specification/_json_spec/synonyms.delete.json renamed to specification/_json_spec/synonyms.delete_synonym.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"synonyms.delete": {
2+
"synonyms.delete_synonym": {
33
"documentation": {
44
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-synonyms-set.html",
55
"description": "Deletes a synonym set"
@@ -12,12 +12,12 @@
1212
"url": {
1313
"paths": [
1414
{
15-
"path": "/_synonyms/{synonyms_set}",
15+
"path": "/_synonyms/{id}",
1616
"methods": ["DELETE"],
1717
"parts": {
18-
"synonyms_set": {
18+
"id": {
1919
"type": "string",
20-
"description": "The name of the synonyms set to be deleted"
20+
"description": "The id of the synonyms set to be deleted"
2121
}
2222
}
2323
}

specification/_json_spec/synonym_rule.delete.json renamed to specification/_json_spec/synonyms.delete_synonym_rule.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"synonym_rule.delete": {
2+
"synonyms.delete_synonym_rule": {
33
"documentation": {
44
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-synonym-rule.html",
55
"description": "Deletes a synonym rule in a synonym set"
@@ -13,14 +13,14 @@
1313
"url": {
1414
"paths": [
1515
{
16-
"path": "/_synonyms/{synonyms_set}/{synonym_rule}",
16+
"path": "/_synonyms/{set_id}/{rule_id}",
1717
"methods": ["DELETE"],
1818
"parts": {
19-
"synonyms_set": {
19+
"set_id": {
2020
"type": "string",
2121
"description": "The id of the synonym set to be updated"
2222
},
23-
"synonym_rule": {
23+
"rule_id": {
2424
"type": "string",
2525
"description": "The id of the synonym rule to be deleted"
2626
}

specification/_json_spec/synonyms.get.json renamed to specification/_json_spec/synonyms.get_synonym.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"synonyms.get": {
2+
"synonyms.get_synonym": {
33
"documentation": {
44
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-synonyms-set.html",
55
"description": "Retrieves a synonym set"
@@ -12,10 +12,10 @@
1212
"url": {
1313
"paths": [
1414
{
15-
"path": "/_synonyms/{synonyms_set}",
15+
"path": "/_synonyms/{id}",
1616
"methods": ["GET"],
1717
"parts": {
18-
"synonyms_set": {
18+
"id": {
1919
"type": "string",
2020
"description": "The name of the synonyms set to be retrieved"
2121
}

specification/_json_spec/synonym_rule.get.json renamed to specification/_json_spec/synonyms.get_synonym_rule.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"synonym_rule.get": {
2+
"synonyms.get_synonym_rule": {
33
"documentation": {
44
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-synonym-rule.html",
55
"description": "Retrieves a synonym rule from a synonym set"
@@ -13,14 +13,14 @@
1313
"url": {
1414
"paths": [
1515
{
16-
"path": "/_synonyms/{synonyms_set}/{synonym_rule}",
16+
"path": "/_synonyms/{set_id}/{rule_id}",
1717
"methods": ["GET"],
1818
"parts": {
19-
"synonyms_set": {
19+
"set_id": {
2020
"type": "string",
2121
"description": "The id of the synonym set to retrieve the synonym rule from"
2222
},
23-
"synonym_rule": {
23+
"rule_id": {
2424
"type": "string",
2525
"description": "The id of the synonym rule to retrieve"
2626
}

specification/_json_spec/synonyms_sets.get.json renamed to specification/_json_spec/synonyms.get_synonyms_sets.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"synonyms_sets.get": {
2+
"synonyms.get_synonyms_sets": {
33
"documentation": {
44
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-synonyms-sets.html",
55
"description": "Retrieves a summary of all defined synonym sets"

specification/_json_spec/synonyms.put.json renamed to specification/_json_spec/synonyms.put_synonym.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"synonyms.put": {
2+
"synonyms.put_synonym": {
33
"documentation": {
44
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-synonyms-set.html",
55
"description": "Creates or updates a synonyms set"
@@ -13,12 +13,12 @@
1313
"url": {
1414
"paths": [
1515
{
16-
"path": "/_synonyms/{synonyms_set}",
16+
"path": "/_synonyms/{id}",
1717
"methods": ["PUT"],
1818
"parts": {
19-
"synonyms_set": {
19+
"id": {
2020
"type": "string",
21-
"description": "The name of the synonyms set to be created or updated"
21+
"description": "The id of the synonyms set to be created or updated"
2222
}
2323
}
2424
}

specification/_json_spec/synonym_rule.put.json renamed to specification/_json_spec/synonyms.put_synonym_rule.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"synonym_rule.put": {
2+
"synonyms.put_synonym_rule": {
33
"documentation": {
44
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-synonym-rule.html",
55
"description": "Creates or updates a synonym rule in a synonym set"
@@ -13,14 +13,14 @@
1313
"url": {
1414
"paths": [
1515
{
16-
"path": "/_synonyms/{synonyms_set}/{synonym_rule}",
16+
"path": "/_synonyms/{set_id}/{rule_id}",
1717
"methods": ["PUT"],
1818
"parts": {
19-
"synonyms_set": {
19+
"set_id": {
2020
"type": "string",
2121
"description": "The id of the synonym set to be updated with the synonym rule"
2222
},
23-
"synonym_rule": {
23+
"rule_id": {
2424
"type": "string",
2525
"description": "The id of the synonym rule to be updated or created"
2626
}

specification/synonyms/delete/SynonymsDeleteRequest.ts renamed to specification/synonyms/delete_synonym/SynonymsDeleteRequest.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@ import { Name } from '@_types/common'
2121

2222
/**
2323
* Deletes a synonym set
24-
* @rest_spec_name synonyms.delete
24+
* @rest_spec_name synonyms.delete_synonym
2525
* @availability stack since=8.10.0 stability=experimental
2626
* @availability serverless stability=experimental visibility=public
2727
*/
2828
interface Request extends RequestBase {
2929
path_parts: {
3030
/**
31-
* The name of the synonyms set to be deleted
31+
* The id of the synonyms set to be deleted
3232
*/
33-
synonyms_set: Name
33+
id: Name
3434
}
3535
}

specification/synonym_rule/delete/SynonymRuleDeleteRequest.ts renamed to specification/synonyms/delete_synonym_rule/SynonymRuleDeleteRequest.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import { Name } from '@_types/common'
2121

2222
/**
2323
* Deletes a synonym rule in a synonym set
24-
* @rest_spec_name synonym_rule.delete
24+
* @rest_spec_name synonyms.delete_synonym_rule
2525
* @availability stack since=8.10.0 stability=experimental
2626
* @availability serverless stability=experimental visibility=public
2727
*/
@@ -30,11 +30,11 @@ interface Request extends RequestBase {
3030
/**
3131
* The id of the synonym set to be updated
3232
*/
33-
synonyms_set: Name
33+
set_id: Name
3434

3535
/**
3636
* The id of the synonym rule to be deleted
3737
*/
38-
synonym_rule: Name
38+
rule_id: Name
3939
}
4040
}

specification/synonym_rule/delete/SynonymRuleDeleteResponse.ts renamed to specification/synonyms/delete_synonym_rule/SynonymRuleDeleteResponse.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
* under the License.
1818
*/
1919

20-
import { SynonymsUpdateResult } from '../../synonyms/_types/SynonymsUpdateResult'
20+
import { SynonymsUpdateResult } from '../_types/SynonymsUpdateResult'
2121

2222
export class Response {
2323
body: SynonymsUpdateResult

specification/synonyms/get/SynonymsGetRequest.ts renamed to specification/synonyms/get_synonym/SynonymsGetRequest.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,16 @@ import { integer } from '@_types/Numeric'
2323

2424
/**
2525
* Retrieves a synonym set
26-
* @rest_spec_name synonyms.get
26+
* @rest_spec_name synonyms.get_synonym
2727
* @availability stack since=8.10.0 stability=experimental
2828
* @availability serverless stability=experimental visibility=public
2929
*/
3030
interface Request extends RequestBase {
3131
path_parts: {
3232
/**
33-
* "The name of the synonyms set to be retrieved
33+
* "The id of the synonyms set to be retrieved
3434
*/
35-
synonyms_set: Name
35+
id: Name
3636
}
3737
query_parameters: {
3838
/**

0 commit comments

Comments
 (0)