Skip to content

updating default values for shard_stores parameters #928

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
- Added `ToolAttributes` to `ml._common.yaml` ([#878](https://github.com/opensearch-project/opensearch-api-specification/pull/878))
- Added `GET _plugins/geospatial/_upload/stats`, `PUT`, `POST _plugins/geospatial/geojson/_upload`, `GET _plugins/geospatial/ip2geo/datasource`, `GET`, `PUT`, `DELETE _plugins/geospatial/ip2geo/datasource/{name}` and `PUT _plugins/geospatial/ip2geo/datasource/{name}/_settings` ([#893](https://github.com/opensearch-project/opensearch-api-specification/pull/893))
- Added schemas for the score ranker search processor ([#899](https://github.com/opensearch-project/opensearch-api-specification/pull/899))
- Added default values for `shard_stores` parameters ([#928](https://github.com/opensearch-project/opensearch-api-specification/pull/928))

### Removed

Expand Down
4 changes: 4 additions & 0 deletions spec/namespaces/indices.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4772,6 +4772,7 @@ components:
targets other open indexes.
schema:
type: boolean
default: false
style: form
indices.shard_stores::query.expand_wildcards:
in: query
Expand All @@ -4781,19 +4782,22 @@ components:
this argument determines whether wildcard expressions match hidden data streams.
schema:
$ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards'
default: open
style: form
indices.shard_stores::query.ignore_unavailable:
in: query
name: ignore_unavailable
description: If `true`, missing or closed indexes are not included in the response.
schema:
type: boolean
default: false
style: form
indices.shard_stores::query.status:
in: query
name: status
description: List of shard health statuses used to limit the request.
schema:
default: all
oneOf:
- $ref: '../schemas/indices.shard_stores.yaml#/components/schemas/ShardStoreStatus'
- type: array
Expand Down
17 changes: 17 additions & 0 deletions tests/default/indices/shard_stores.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
$schema: ../../../json_schemas/test_story.schema.yaml

description: Test _shard_stores API.

prologues:
- path: /_bulk
method: POST
Expand All @@ -13,6 +14,7 @@ prologues:
- {director: Quentin Tarantino, title: Pulp Fiction, year: 1994}
- {create: {_index: movies, _id: movie2}}
- {director: Christopher Nolan, title: Inception, year: 2010}

epilogues:
- path: /movies
method: DELETE
Expand All @@ -21,8 +23,23 @@ epilogues:
chapters:
- synopsis: Verify shard store information for a specific index.
path: /{index}/_shard_stores
method: GET
parameters:
index: movies
allow_no_indices: false
expand_wildcards: open
ignore_unavailable: false
status: all
response:
status: 200

- synopsis: Verify shard store information for all indices.
path: /_shard_stores
method: GET
parameters:
allow_no_indices: false
expand_wildcards: open
ignore_unavailable: false
status: all
response:
status: 200