Skip to content

Commit 8d5d843

Browse files
authored
updating default values for shard_stores parameters (#928)
* updating default values for shard_stores parameters Signed-off-by: Anton Rubin <[email protected]> * adding tests Signed-off-by: Anton Rubin <[email protected]> * updating test to cover all of the changes Signed-off-by: Anton Rubin <[email protected]> * updating the changelog Signed-off-by: Anton Rubin <[email protected]> --------- Signed-off-by: Anton Rubin <[email protected]>
1 parent aee5770 commit 8d5d843

File tree

3 files changed

+22
-0
lines changed

3 files changed

+22
-0
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
103103
- Added `ToolAttributes` to `ml._common.yaml` ([#878](https://github.com/opensearch-project/opensearch-api-specification/pull/878))
104104
- 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))
105105
- Added schemas for the score ranker search processor ([#899](https://github.com/opensearch-project/opensearch-api-specification/pull/899))
106+
- Added default values for `shard_stores` parameters ([#928](https://github.com/opensearch-project/opensearch-api-specification/pull/928))
106107

107108
### Removed
108109

spec/namespaces/indices.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4772,6 +4772,7 @@ components:
47724772
targets other open indexes.
47734773
schema:
47744774
type: boolean
4775+
default: false
47754776
style: form
47764777
indices.shard_stores::query.expand_wildcards:
47774778
in: query
@@ -4781,19 +4782,22 @@ components:
47814782
this argument determines whether wildcard expressions match hidden data streams.
47824783
schema:
47834784
$ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards'
4785+
default: open
47844786
style: form
47854787
indices.shard_stores::query.ignore_unavailable:
47864788
in: query
47874789
name: ignore_unavailable
47884790
description: If `true`, missing or closed indexes are not included in the response.
47894791
schema:
47904792
type: boolean
4793+
default: false
47914794
style: form
47924795
indices.shard_stores::query.status:
47934796
in: query
47944797
name: status
47954798
description: List of shard health statuses used to limit the request.
47964799
schema:
4800+
default: all
47974801
oneOf:
47984802
- $ref: '../schemas/indices.shard_stores.yaml#/components/schemas/ShardStoreStatus'
47994803
- type: array

tests/default/indices/shard_stores.yaml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
$schema: ../../../json_schemas/test_story.schema.yaml
22

33
description: Test _shard_stores API.
4+
45
prologues:
56
- path: /_bulk
67
method: POST
@@ -13,6 +14,7 @@ prologues:
1314
- {director: Quentin Tarantino, title: Pulp Fiction, year: 1994}
1415
- {create: {_index: movies, _id: movie2}}
1516
- {director: Christopher Nolan, title: Inception, year: 2010}
17+
1618
epilogues:
1719
- path: /movies
1820
method: DELETE
@@ -21,8 +23,23 @@ epilogues:
2123
chapters:
2224
- synopsis: Verify shard store information for a specific index.
2325
path: /{index}/_shard_stores
26+
method: GET
2427
parameters:
2528
index: movies
29+
allow_no_indices: false
30+
expand_wildcards: open
31+
ignore_unavailable: false
32+
status: all
33+
response:
34+
status: 200
35+
36+
- synopsis: Verify shard store information for all indices.
37+
path: /_shard_stores
2638
method: GET
39+
parameters:
40+
allow_no_indices: false
41+
expand_wildcards: open
42+
ignore_unavailable: false
43+
status: all
2744
response:
2845
status: 200

0 commit comments

Comments
 (0)