openapi: 3.2.0
info:
  title: Elasticsearch Synonyms API
  description: 'Elasticsearch provides REST APIs that are used by the UI components and can be called directly to configure and access Elasticsearch features.

    ## Documentation source and versions

    This documentation is derived from the main branch of the elasticsearch-specification repository. It is provided under license Attribution-NonCommercial-NoDerivatives 4.0 International.

    This documentation contains work-in-progress information for future Elastic Stack releases.'
  license:
    name: Apache 2.0
    url: https://github.com/elastic/elasticsearch-specification/blob/main/LICENSE
  version: ''
security:
- apiKeyAuth: []
- basicAuth: []
- bearerAuth: []
tags:
- name: Synonyms
  description: The synonyms management API provides a convenient way to define and manage synonyms in an internal system index. Related synonyms can be grouped in a "synonyms set". Create as many synonym sets as you need.
  externalDocs:
    description: Learn more.
    url: https://www.elastic.co/docs/solutions/search/full-text/search-with-synonyms
  x-displayName: Synonyms
paths:
  /_synonyms/{id}:
    get:
      tags:
      - Synonyms
      summary: Get a synonym set
      operationId: synonyms-get-synonym
      parameters:
      - in: path
        name: id
        description: The synonyms set identifier to retrieve.
        required: true
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Id'
        style: simple
      - in: query
        name: from
        description: The starting offset for query rules to retrieve.
        deprecated: false
        schema:
          type: number
        style: form
      - in: query
        name: size
        description: The max number of query rules to retrieve.
        deprecated: false
        schema:
          type: number
        style: form
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    description: The total number of synonyms rules that the synonyms set contains.
                    type: number
                  synonyms_set:
                    description: Synonym rule details.
                    type: array
                    items:
                      $ref: '#/components/schemas/synonyms._types.SynonymRuleRead'
                required:
                - count
                - synonyms_set
              examples:
                SynonymsGetResponseExample1:
                  description: A successful response from `GET _synonyms/my-synonyms-set`.
                  value: "{\n  \"count\": 3,\n  \"synonyms_set\": [\n    {\n      \"id\": \"test-1\",\n      \"synonyms\": \"hello, hi\"\n    },\n    {\n      \"id\": \"test-2\",\n      \"synonyms\": \"bye, goodbye\"\n    },\n    {\n      \"id\": \"test-3\",\n      \"synonyms\": \"test => check\"\n    }\n  ]\n}"
      x-state: Generally available; Added in 8.10.0
      x-variations:
      - "<div>\n              <span class=\"operation-verb get\">GET</span>\n              <span class=\"operation-path\">/_synonyms/{id}</span>\n              </div>\n            "
      x-req-auth:
      - 'Cluster privileges: `manage_search_synonyms`

        '
      x-api: get_synonym.synonyms
      x-category: ingest
      x-codeSamples:
      - lang: Console
        source: 'GET _synonyms/my-synonyms-set

          '
      - lang: Python
        source: "resp = client.synonyms.get_synonym(\n    id=\"my-synonyms-set\",\n)"
      - lang: JavaScript
        source: "const response = await client.synonyms.getSynonym({\n  id: \"my-synonyms-set\",\n});"
      - lang: Ruby
        source: "response = client.synonyms.get_synonym(\n  id: \"my-synonyms-set\"\n)"
      - lang: PHP
        source: "$resp = $client->synonyms()->getSynonym([\n    \"id\" => \"my-synonyms-set\",\n]);"
      - lang: curl
        source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_synonyms/my-synonyms-set"'
      - lang: Java
        source: "client.synonyms().getSynonym(g -> g\n    .id(\"my-synonyms-set\")\n);\n"
      x-metaTags:
      - content: Elasticsearch
        name: product_name
    put:
      tags:
      - Synonyms
      summary: Create or update a synonym set
      description: '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.


        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.'
      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.19/put-synonyms-set.html
      operationId: synonyms-put-synonym
      parameters:
      - in: path
        name: id
        description: The ID of the synonyms set to be created or updated.
        required: true
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Id'
        style: simple
      - in: query
        name: refresh
        description: 'If `true`, the request will refresh the analyzers with the new synonyms set and wait for the new synonyms to be available before returning.

          If `false`, analyzers will not be reloaded with the new synonym set'
        deprecated: false
        schema:
          type: boolean
        x-state: Generally available; Added in 9.1.0
        style: form
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                synonyms_set:
                  description: The synonym rules definitions for the synonyms set.
                  oneOf:
                  - $ref: '#/components/schemas/synonyms._types.SynonymRule'
                  - type: array
                    items:
                      $ref: '#/components/schemas/synonyms._types.SynonymRule'
              required:
              - synonyms_set
            examples:
              SynonymsPutRequestExample1:
                description: ''
                value: "\n{\n  \"synonyms_set\": {\n  \"synonyms\" : \"hello, hi, howdy\"\n  }\n}"
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    description: The update operation result.
                    allOf:
                    - $ref: '#/components/schemas/_types.Result'
                  reload_analyzers_details:
                    description: 'Updating a synonyms set can reload the associated analyzers in case refresh is set to true.

                      This information is the analyzers reloading result.'
                    allOf:
                    - $ref: '#/components/schemas/indices.reload_search_analyzers.ReloadResult'
                required:
                - result
      x-state: Generally available; Added in 8.10.0
      x-variations:
      - "<div>\n              <span class=\"operation-verb put\">PUT</span>\n              <span class=\"operation-path\">/_synonyms/{id}</span>\n              </div>\n            "
      x-req-auth:
      - 'Cluster privileges: `manage_search_synonyms`

        '
      x-api: put_synonym.synonyms
      x-category: ingest
      x-codeSamples:
      - lang: Console
        source: "PUT _synonyms/my-synonyms-set\n\n{\n  \"synonyms_set\": {\n  \"synonyms\" : \"hello, hi, howdy\"\n  }\n}"
      - lang: Python
        source: "resp = client.synonyms.put_synonym(\n    id=\"my-synonyms-set\",\n    synonyms_set={\n        \"synonyms\": \"hello, hi, howdy\"\n    },\n)"
      - lang: JavaScript
        source: "const response = await client.synonyms.putSynonym({\n  id: \"my-synonyms-set\",\n  synonyms_set: {\n    synonyms: \"hello, hi, howdy\",\n  },\n});"
      - lang: Ruby
        source: "response = client.synonyms.put_synonym(\n  id: \"my-synonyms-set\",\n  body: {\n    \"synonyms_set\": {\n      \"synonyms\": \"hello, hi, howdy\"\n    }\n  }\n)"
      - lang: PHP
        source: "$resp = $client->synonyms()->putSynonym([\n    \"id\" => \"my-synonyms-set\",\n    \"body\" => [\n        \"synonyms_set\" => [\n            \"synonyms\" => \"hello, hi, howdy\",\n        ],\n    ],\n]);"
      - lang: curl
        source: 'curl -X PUT -H "Authorization: ApiKey $ELASTIC_API_KEY" -H "Content-Type: application/json" -d ''{"synonyms_set":{"synonyms":"hello, hi, howdy"}}'' "$ELASTICSEARCH_URL/_synonyms/my-synonyms-set"'
      - lang: Java
        source: "client.synonyms().putSynonym(p -> p\n    .id(\"my-synonyms-set\")\n    .synonymsSet(s -> s\n        .synonyms(\"hello, hi, howdy\")\n    )\n);\n"
      x-metaTags:
      - content: Elasticsearch
        name: product_name
    delete:
      tags:
      - Synonyms
      summary: Delete a synonym set
      description: 'You can only delete a synonyms set that is not in use by any index analyzer.


        Synonyms sets can be used in synonym graph token filters and synonym token filters.

        These synonym filters can be used as part of search analyzers.


        Analyzers need to be loaded when an index is restored (such as when a node starts, or the index becomes open).

        Even if the analyzer is not used on any field mapping, it still needs to be loaded on the index recovery phase.


        If any analyzers cannot be loaded, the index becomes unavailable and the cluster status becomes red or yellow as index shards are not available.

        To prevent that, synonyms sets that are used in analyzers can''t be deleted.

        A delete request in this case will return a 400 response code.


        To remove a synonyms set, you must first remove all indices that contain analyzers using it.

        You can migrate an index by creating a new index that does not contain the token filter with the synonyms set, and use the reindex API in order to copy over the index data.

        Once finished, you can delete the index.

        When the synonyms set is not used in analyzers, you will be able to delete it.'
      operationId: synonyms-delete-synonym
      parameters:
      - in: path
        name: id
        description: The synonyms set identifier to delete.
        required: true
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Id'
        style: simple
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/_types.AcknowledgedResponseBase'
      x-state: Generally available; Added in 8.10.0
      x-variations:
      - "<div>\n              <span class=\"operation-verb delete\">DELETE</span>\n              <span class=\"operation-path\">/_synonyms/{id}</span>\n              </div>\n            "
      x-req-auth:
      - 'Cluster privileges: `manage_search_synonyms`

        '
      x-api: delete_synonym.synonyms
      x-category: ingest
      x-codeSamples:
      - lang: Console
        source: 'DELETE _synonyms/my-synonyms-set

          '
      - lang: Python
        source: "resp = client.synonyms.delete_synonym(\n    id=\"my-synonyms-set\",\n)"
      - lang: JavaScript
        source: "const response = await client.synonyms.deleteSynonym({\n  id: \"my-synonyms-set\",\n});"
      - lang: Ruby
        source: "response = client.synonyms.delete_synonym(\n  id: \"my-synonyms-set\"\n)"
      - lang: PHP
        source: "$resp = $client->synonyms()->deleteSynonym([\n    \"id\" => \"my-synonyms-set\",\n]);"
      - lang: curl
        source: 'curl -X DELETE -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_synonyms/my-synonyms-set"'
      - lang: Java
        source: "client.synonyms().deleteSynonym(d -> d\n    .id(\"my-synonyms-set\")\n);\n"
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /_synonyms/{set_id}/{rule_id}:
    get:
      tags:
      - Synonyms
      summary: Get a synonym rule
      description: Get a synonym rule from a synonym set.
      operationId: synonyms-get-synonym-rule
      parameters:
      - in: path
        name: set_id
        description: The ID of the synonym set to retrieve the synonym rule from.
        required: true
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Id'
        style: simple
      - in: path
        name: rule_id
        description: The ID of the synonym rule to retrieve.
        required: true
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Id'
        style: simple
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/synonyms._types.SynonymRuleRead'
              examples:
                SynonymRuleGetResponseExample1:
                  description: A successful response from `GET _synonyms/my-synonyms-set/test-1`.
                  value: "{\n  \"id\": \"test-1\",\n  \"synonyms\": \"hello, hi\"\n}"
      x-state: Generally available; Added in 8.10.0
      x-variations:
      - "<div>\n              <span class=\"operation-verb get\">GET</span>\n              <span class=\"operation-path\">/_synonyms/{set_id}/{rule_id}</span>\n              </div>\n            "
      x-req-auth:
      - 'Cluster privileges: `manage_search_synonyms`

        '
      x-api: get_synonym_rule.synonyms
      x-category: ingest
      x-codeSamples:
      - lang: Console
        source: 'GET _synonyms/my-synonyms-set/test-1

          '
      - lang: Python
        source: "resp = client.synonyms.get_synonym_rule(\n    set_id=\"my-synonyms-set\",\n    rule_id=\"test-1\",\n)"
      - lang: JavaScript
        source: "const response = await client.synonyms.getSynonymRule({\n  set_id: \"my-synonyms-set\",\n  rule_id: \"test-1\",\n});"
      - lang: Ruby
        source: "response = client.synonyms.get_synonym_rule(\n  set_id: \"my-synonyms-set\",\n  rule_id: \"test-1\"\n)"
      - lang: PHP
        source: "$resp = $client->synonyms()->getSynonymRule([\n    \"set_id\" => \"my-synonyms-set\",\n    \"rule_id\" => \"test-1\",\n]);"
      - lang: curl
        source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_synonyms/my-synonyms-set/test-1"'
      - lang: Java
        source: "client.synonyms().getSynonymRule(g -> g\n    .ruleId(\"test-1\")\n    .setId(\"my-synonyms-set\")\n);\n"
      x-metaTags:
      - content: Elasticsearch
        name: product_name
    put:
      tags:
      - Synonyms
      summary: Create or update a synonym rule
      description: 'Create or update a synonym rule in a synonym set.


        If any of the synonym rules included is invalid, the API returns an error.


        When you update a synonym rule, all analyzers using the synonyms set will be reloaded automatically to reflect the new rule.'
      operationId: synonyms-put-synonym-rule
      parameters:
      - in: path
        name: set_id
        description: The ID of the synonym set.
        required: true
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Id'
        style: simple
      - in: path
        name: rule_id
        description: The ID of the synonym rule to be updated or created.
        required: true
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Id'
        style: simple
      - in: query
        name: refresh
        description: 'If `true`, the request will refresh the analyzers with the new synonym rule and wait for the new synonyms to be available before returning.

          If `false`, analyzers will not be reloaded with the new synonym rule'
        deprecated: false
        schema:
          type: boolean
        x-state: Generally available; Added in 9.1.0
        style: form
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                synonyms:
                  externalDocs:
                    url: https://www.elastic.co/docs/reference/text-analysis/analysis-synonym-graph-tokenfilter#analysis-synonym-graph-define-synonyms
                  description: The synonym rule information definition, which must be in Solr format.
                  allOf:
                  - $ref: '#/components/schemas/synonyms._types.SynonymString'
              required:
              - synonyms
            examples:
              SynonymRulePutRequestExample1:
                summary: synonyms/apis/put-synonym-rule.asciidoc:107
                description: ''
                value: "{\n  \"synonyms\": \"hello, hi, howdy\"\n}"
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/synonyms._types.SynonymsUpdateResult'
              examples:
                SynonymRuleResponseExample1:
                  description: 'A successful response from `PUT _synonyms/my-synonyms-set/test-1`.

                    '
                  value: "{\n  \"result\": \"updated\",\n  \"reload_analyzers_details\": {\n    \"_shards\": {\n      \"total\": 2,\n      \"successful\": 1,\n      \"failed\": 0\n    },\n    \"reload_details\": [\n      {\n        \"index\": \"test-index\",\n        \"reloaded_analyzers\": [\n          \"my_search_analyzer\"\n        ],\n        \"reloaded_node_ids\": [\n          \"1wYFZzq8Sxeu_Jvt9mlbkg\"\n        ]\n      }\n    ]\n  }\n}"
      x-state: Generally available; Added in 8.10.0
      x-variations:
      - "<div>\n              <span class=\"operation-verb put\">PUT</span>\n              <span class=\"operation-path\">/_synonyms/{set_id}/{rule_id}</span>\n              </div>\n            "
      x-req-auth:
      - 'Cluster privileges: `manage_search_synonyms`

        '
      x-api: put_synonym_rule.synonyms
      x-category: ingest
      x-codeSamples:
      - lang: Console
        source: "PUT _synonyms/my-synonyms-set/test-1\n{\n  \"synonyms\": \"hello, hi, howdy\"\n}"
      - lang: Python
        source: "resp = client.synonyms.put_synonym_rule(\n    set_id=\"my-synonyms-set\",\n    rule_id=\"test-1\",\n    synonyms=\"hello, hi, howdy\",\n)"
      - lang: JavaScript
        source: "const response = await client.synonyms.putSynonymRule({\n  set_id: \"my-synonyms-set\",\n  rule_id: \"test-1\",\n  synonyms: \"hello, hi, howdy\",\n});"
      - lang: Ruby
        source: "response = client.synonyms.put_synonym_rule(\n  set_id: \"my-synonyms-set\",\n  rule_id: \"test-1\",\n  body: {\n    \"synonyms\": \"hello, hi, howdy\"\n  }\n)"
      - lang: PHP
        source: "$resp = $client->synonyms()->putSynonymRule([\n    \"set_id\" => \"my-synonyms-set\",\n    \"rule_id\" => \"test-1\",\n    \"body\" => [\n        \"synonyms\" => \"hello, hi, howdy\",\n    ],\n]);"
      - lang: curl
        source: 'curl -X PUT -H "Authorization: ApiKey $ELASTIC_API_KEY" -H "Content-Type: application/json" -d ''{"synonyms":"hello, hi, howdy"}'' "$ELASTICSEARCH_URL/_synonyms/my-synonyms-set/test-1"'
      - lang: Java
        source: "client.synonyms().putSynonymRule(p -> p\n    .ruleId(\"test-1\")\n    .setId(\"my-synonyms-set\")\n    .synonyms(\"hello, hi, howdy\")\n);\n"
      x-metaTags:
      - content: Elasticsearch
        name: product_name
    delete:
      tags:
      - Synonyms
      summary: Delete a synonym rule
      description: Delete a synonym rule from a synonym set.
      operationId: synonyms-delete-synonym-rule
      parameters:
      - in: path
        name: set_id
        description: The ID of the synonym set to update.
        required: true
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Id'
        style: simple
      - in: path
        name: rule_id
        description: The ID of the synonym rule to delete.
        required: true
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Id'
        style: simple
      - in: query
        name: refresh
        description: 'If `true`, the request will refresh the analyzers with the deleted synonym rule and wait for the new synonyms to be available before returning.

          If `false`, analyzers will not be reloaded with the deleted synonym rule'
        deprecated: false
        schema:
          type: boolean
        x-state: Generally available; Added in 9.1.0
        style: form
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/synonyms._types.SynonymsUpdateResult'
              examples:
                SynonymRuleDeleteResponseExample1:
                  description: 'A successful response from `DELETE _synonyms/my-synonyms-set/test-1`. All analyzers using this synonyms set will be reloaded automatically to reflect the rule being deleted.

                    '
                  value: "{\n  \"result\": \"deleted\",\n  \"reload_analyzers_details\": {\n    \"_shards\": {\n      \"total\": 2,\n      \"successful\": 1,\n      \"failed\": 0\n    },\n    \"reload_details\": [\n      {\n        \"index\": \"test-index\",\n        \"reloaded_analyzers\": [\n          \"my_search_analyzer\"\n        ],\n        \"reloaded_node_ids\": [\n          \"1wYFZzq8Sxeu_Jvt9mlbkg\"\n        ]\n      }\n    ]\n  }\n}"
      x-state: Generally available; Added in 8.10.0
      x-variations:
      - "<div>\n              <span class=\"operation-verb delete\">DELETE</span>\n              <span class=\"operation-path\">/_synonyms/{set_id}/{rule_id}</span>\n              </div>\n            "
      x-req-auth:
      - 'Cluster privileges: `manage_search_synonyms`

        '
      x-api: delete_synonym_rule.synonyms
      x-category: ingest
      x-codeSamples:
      - lang: Console
        source: 'DELETE _synonyms/my-synonyms-set/test-1

          '
      - lang: Python
        source: "resp = client.synonyms.delete_synonym_rule(\n    set_id=\"my-synonyms-set\",\n    rule_id=\"test-1\",\n)"
      - lang: JavaScript
        source: "const response = await client.synonyms.deleteSynonymRule({\n  set_id: \"my-synonyms-set\",\n  rule_id: \"test-1\",\n});"
      - lang: Ruby
        source: "response = client.synonyms.delete_synonym_rule(\n  set_id: \"my-synonyms-set\",\n  rule_id: \"test-1\"\n)"
      - lang: PHP
        source: "$resp = $client->synonyms()->deleteSynonymRule([\n    \"set_id\" => \"my-synonyms-set\",\n    \"rule_id\" => \"test-1\",\n]);"
      - lang: curl
        source: 'curl -X DELETE -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_synonyms/my-synonyms-set/test-1"'
      - lang: Java
        source: "client.synonyms().deleteSynonymRule(d -> d\n    .ruleId(\"test-1\")\n    .setId(\"my-synonyms-set\")\n);\n"
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /_synonyms:
    get:
      tags:
      - Synonyms
      summary: Get all synonym sets
      description: Get a summary of all defined synonym sets.
      operationId: synonyms-get-synonyms-sets
      parameters:
      - in: query
        name: from
        description: The starting offset for synonyms sets to retrieve.
        deprecated: false
        schema:
          type: number
        style: form
      - in: query
        name: size
        description: The maximum number of synonyms sets to retrieve.
        deprecated: false
        schema:
          type: number
        style: form
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    description: The total number of synonyms sets defined.
                    type: number
                  results:
                    description: The identifier and total number of defined synonym rules for each synonyms set.
                    type: array
                    items:
                      $ref: '#/components/schemas/synonyms.get_synonyms_sets.SynonymsSetItem'
                required:
                - count
                - results
              examples:
                SynonymsSetsGetResponseExample1:
                  description: A successful response from `GET _synonyms`.
                  value: "{\n  \"count\": 3,\n  \"results\": [\n    {\n      \"synonyms_set\": \"ecommerce-synonyms\",\n      \"count\": 2\n    },\n    {\n      \"synonyms_set\": \"my-synonyms-set\",\n      \"count\": 3\n    },\n    {\n      \"synonyms_set\": \"new-ecommerce-synonyms\",\n      \"count\": 1\n    }\n  ]\n}"
      x-state: Generally available; Added in 8.10.0
      x-variations:
      - "<div>\n              <span class=\"operation-verb get\">GET</span>\n              <span class=\"operation-path\">/_synonyms</span>\n              </div>\n            "
      x-req-auth:
      - 'Cluster privileges: `manage_search_synonyms`

        '
      x-api: get_synonyms_sets.synonyms
      x-category: ingest
      x-codeSamples:
      - lang: Console
        source: 'GET _synonyms

          '
      - lang: Python
        source: resp = client.synonyms.get_synonyms_sets()
      - lang: JavaScript
        source: const response = await client.synonyms.getSynonymsSets();
      - lang: Ruby
        source: response = client.synonyms.get_synonyms_sets
      - lang: PHP
        source: $resp = $client->synonyms()->getSynonymsSets();
      - lang: curl
        source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_synonyms"'
      - lang: Java
        source: 'client.synonyms().getSynonymsSets(g -> g);

          '
      x-metaTags:
      - content: Elasticsearch
        name: product_name
components:
  schemas:
    _types.uint:
      type: number
    synonyms._types.SynonymString:
      type: string
    synonyms._types.SynonymRuleRead:
      type: object
      properties:
        id:
          description: Synonym Rule identifier
          allOf:
          - $ref: '#/components/schemas/_types.Id'
        synonyms:
          externalDocs:
            url: https://www.elastic.co/docs/reference/text-analysis/analysis-synonym-graph-tokenfilter#_solr_format_2
          description: Synonyms, in Solr format, that conform the synonym rule.
          allOf:
          - $ref: '#/components/schemas/synonyms._types.SynonymString'
      required:
      - id
      - synonyms
    indices.reload_search_analyzers.ReloadDetails:
      type: object
      properties:
        index:
          type: string
        reloaded_analyzers:
          type: array
          items:
            type: string
        reloaded_node_ids:
          type: array
          items:
            type: string
      required:
      - index
      - reloaded_analyzers
      - reloaded_node_ids
    _types.AcknowledgedResponseBase:
      type: object
      properties:
        acknowledged:
          description: For a successful response, this value is always true. On failure, an exception is returned instead.
          type: boolean
      required:
      - acknowledged
    synonyms._types.SynonymsUpdateResult:
      type: object
      properties:
        result:
          description: The update operation result.
          allOf:
          - $ref: '#/components/schemas/_types.Result'
        reload_analyzers_details:
          description: 'Updating synonyms in a synonym set can reload the associated analyzers in case refresh is set to true.

            This information is the analyzers reloading result.'
          allOf:
          - $ref: '#/components/schemas/indices.reload_search_analyzers.ReloadResult'
      required:
      - result
    _types.ShardStatistics:
      type: object
      properties:
        failed:
          description: The number of shards the operation or search attempted to run on but failed.
          allOf:
          - $ref: '#/components/schemas/_types.uint'
        successful:
          description: The number of shards the operation or search succeeded on.
          allOf:
          - $ref: '#/components/schemas/_types.uint'
        total:
          description: The number of shards the operation or search will run on overall.
          allOf:
          - $ref: '#/components/schemas/_types.uint'
        failures:
          type: array
          items:
            $ref: '#/components/schemas/_types.ShardFailure'
        skipped:
          allOf:
          - $ref: '#/components/schemas/_types.uint'
      required:
      - failed
      - successful
      - total
    _types.ErrorCause:
      description: 'Cause and details about a request failure. This class defines the properties common to all error types.

        Additional details are also provided, that depend on the error type.'
      type: object
      properties:
        type:
          description: The type of error
          type: string
        reason:
          description: A human-readable explanation of the error, in English.
          oneOf:
          - type: string
          - type:
            - string
            - 'null'
        stack_trace:
          description: The server stack trace. Present only if the `error_trace=true` parameter was sent with the request.
          type: string
        caused_by:
          allOf:
          - $ref: '#/components/schemas/_types.ErrorCause'
        root_cause:
          type: array
          items:
            $ref: '#/components/schemas/_types.ErrorCause'
        suppressed:
          type: array
          items:
            $ref: '#/components/schemas/_types.ErrorCause'
      required:
      - type
    synonyms.get_synonyms_sets.SynonymsSetItem:
      type: object
      properties:
        synonyms_set:
          description: Synonyms set identifier
          allOf:
          - $ref: '#/components/schemas/_types.Id'
        count:
          description: Number of synonym rules that the synonym set contains
          type: number
      required:
      - synonyms_set
      - count
    _types.ShardFailure:
      type: object
      properties:
        index:
          allOf:
          - $ref: '#/components/schemas/_types.IndexName'
        node:
          type: string
        reason:
          allOf:
          - $ref: '#/components/schemas/_types.ErrorCause'
        shard:
          type: number
        status:
          type: string
        primary:
          type: boolean
      required:
      - reason
    synonyms._types.SynonymRule:
      type: object
      properties:
        id:
          description: 'The identifier for the synonym rule.

            If you do not specify a synonym rule ID when you create a rule, an identifier is created automatically by Elasticsearch.'
          allOf:
          - $ref: '#/components/schemas/_types.Id'
        synonyms:
          externalDocs:
            url: https://www.elastic.co/docs/reference/text-analysis/analysis-synonym-graph-tokenfilter#analysis-synonym-graph-define-synonyms
          description: The synonyms that conform the synonym rule in Solr format.
          allOf:
          - $ref: '#/components/schemas/synonyms._types.SynonymString'
      required:
      - synonyms
    indices.reload_search_analyzers.ReloadResult:
      type: object
      properties:
        reload_details:
          type: array
          items:
            $ref: '#/components/schemas/indices.reload_search_analyzers.ReloadDetails'
        _shards:
          allOf:
          - $ref: '#/components/schemas/_types.ShardStatistics'
      required:
      - reload_details
      - _shards
    _types.Result:
      type: string
      enum:
      - created
      - updated
      - deleted
      - not_found
      - noop
    _types.Id:
      type: string
    _types.IndexName:
      type: string
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: "Elasticsearch APIs support key-based authentication.\nYou must create an API key and use the encoded value in the request header.\nFor example:\n\n```\ncurl -X GET \"${ES_URL}/_cat/indices?v=true\" \\\n  -H \"Authorization: ApiKey ${API_KEY}\"\n```\n\nTo get API keys, use the `/_security/api_key` APIs."
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Elasticsearch APIs support the use of bearer tokens in the `Authorization` HTTP header to authenticate with the API.

        For examples, refer to [Token-based authentication services](https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/token-based-authentication-services)'
x-tagGroups:
- name: AI & Machine Learning
  tags:
  - analytics
  - graph
  - inference
  - ml
  - ml anomaly
  - ml data frame
  - ml trained model
  - query_rules
  - text_structure
- name: Cluster Management
  tags:
  - ccr
  - cluster
  - connector
  - data stream
  - ilm
  - indices
  - rollup
  - script
  - search_application
  - searchable_snapshots
  - slm
  - snapshot
- name: Data Processing
  tags:
  - enrich
  - fleet
  - ingest
  - logstash
  - synonyms
  - transform
- name: Information & Monitoring
  tags:
  - cat
  - features
  - health_report
  - info
  - license
  - migration
  - tasks
  - watcher
  - xpack
- name: Search & Document APIs
  tags:
  - document
  - eql
  - esql
  - search
  - sql
- name: Security
  tags:
  - security