diff --git a/CHANGELOG.md b/CHANGELOG.md index dc960e581..e3a357757 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -46,6 +46,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) - Added missing fields to `/_nodes/stats` ([#415](https://github.com/opensearch-project/opensearch-api-specification/pull/415)) - Added missing metrics options to `/_nodes/stats` ([#422](https://github.com/opensearch-project/opensearch-api-specification/pull/422)) - Added tests against OpenSearch 1.3 ([#424](https://github.com/opensearch-project/opensearch-api-specification/pull/424)) +- Added `is_hidden` to `/{index}/_alias/{name}` and `/{index}/_aliases/{name}` ([#429](https://github.com/opensearch-project/opensearch-api-specification/pull/429)) ### Changed diff --git a/spec/namespaces/indices.yaml b/spec/namespaces/indices.yaml index dc113533b..99895bbea 100644 --- a/spec/namespaces/indices.yaml +++ b/spec/namespaces/indices.yaml @@ -1860,6 +1860,12 @@ components: $ref: '../schemas/_common.yaml#/components/schemas/Routing' search_routing: $ref: '../schemas/_common.yaml#/components/schemas/Routing' + is_hidden: + x-version-added: '2.16' + description: |- + If `true`, the alias will be hidden`. + type: boolean + default: false description: The settings for the alias, such as `routing` or `filter` indices.put_index_template: content: diff --git a/tests/indices/aliases.yaml b/tests/indices/aliases.yaml index f9d7dc485..1e28a2638 100644 --- a/tests/indices/aliases.yaml +++ b/tests/indices/aliases.yaml @@ -73,3 +73,33 @@ chapters: parameters: index: games name: plays2 + - synopsis: Create an alias by Create or Update alias endpoint. + path: /{index}/_alias/{name} + method: PUT + parameters: + index: games + name: jeux + - synopsis: Create an alias with custom settings by Create or Update alias endpoint. + path: /{index}/_alias/{name} + method: PUT + parameters: + index: games + name: jeux + request_body: + payload: + index_routing: test1 + search_routing: test2 + routing: test + is_write_index: true + filter: + match_all: {} + - synopsis: Create an alias with is_hidden by Create or Update alias endpoint. + version: '>= 2.16' + path: /{index}/_alias/{name} + method: PUT + parameters: + index: games + name: jeux + request_body: + payload: + is_hidden: true