Skip to content

Commit 28c9813

Browse files
Update rest-api-spec (#1814)
1 parent 984c219 commit 28c9813

File tree

2 files changed

+40
-7
lines changed

2 files changed

+40
-7
lines changed

output/schema/validation-errors.json

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

specification/_json_spec/snapshot.get.json

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,46 @@
4444
"type": "boolean",
4545
"description": "Whether to include the repository name in the snapshot info. Defaults to true."
4646
},
47+
"sort": {
48+
"type": "enum",
49+
"default": "start_time",
50+
"options": [
51+
"start_time",
52+
"duration",
53+
"name",
54+
"repository",
55+
"index_count",
56+
"shard_count",
57+
"failed_shard_count"
58+
],
59+
"description": "Allows setting a sort order for the result. Defaults to start_time"
60+
},
61+
"size": {
62+
"type": "integer",
63+
"description": "Maximum number of snapshots to return. Defaults to 0 which means return all that match without limit."
64+
},
65+
"order": {
66+
"type": "enum",
67+
"default": "asc",
68+
"options": ["asc", "desc"],
69+
"description": "Sort order"
70+
},
71+
"from_sort_value": {
72+
"type": "string",
73+
"description": "Value of the current sort column at which to start retrieval."
74+
},
75+
"after": {
76+
"type": "string",
77+
"description": "Offset identifier to start pagination from as returned by the 'next' field in the response body."
78+
},
79+
"offset": {
80+
"type": "integer",
81+
"description": "Numeric offset to start pagination based on the snapshots matching the request. Defaults to 0"
82+
},
83+
"slm_policy_filter": {
84+
"type": "string",
85+
"description": "Filter snapshots by a comma-separated list of SLM policy names that snapshots belong to. Accepts wildcards. Use the special pattern '_none' to match snapshots without an SLM policy"
86+
},
4787
"verbose": {
4888
"type": "boolean",
4989
"description": "Whether to show verbose snapshot info or only show the basic info found in the repository index blob"

0 commit comments

Comments
 (0)