Skip to content

Commit b4f30cf

Browse files
authored
Get snapshots response example for the breaking change (#43475)
#42090 PR added support for requesting snapshots from multiple repositories. And it has changed the response format in a non-BwC way. There is a mentioning of a response format change in the breaking changes docs, however, there is no example of how new format looks like. Pointed out by @dakrone. This commit adds the missing example.
1 parent f26f266 commit b4f30cf

File tree

1 file changed

+49
-1
lines changed

1 file changed

+49
-1
lines changed

docs/reference/migration/migrate_8_0/snapshots.asciidoc

Lines changed: 49 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,55 @@
1212
[float]
1313
=== Get snapshots response format is changed
1414
It's possible to get snapshots from multiple repositories in one go. The response format has changed
15-
and now contains separate response for each repository. See <<modules-snapshots>> for more information.
15+
and now contains separate response for each repository.
16+
17+
For example, requesting one snapshot from particular repository
18+
19+
[source,js]
20+
-----------------------------------
21+
GET _snapshot/repo1/snap1
22+
-----------------------------------
23+
// CONSOLE
24+
// TEST[skip:no repo and snapshots are created]
25+
26+
produces the following response
27+
28+
[source,js]
29+
-----------------------------------
30+
{
31+
"responses": [
32+
{
33+
"repository": "repo1",
34+
"snapshots": [
35+
{
36+
"snapshot": "snap1",
37+
"uuid": "cEzdqUKxQ5G6MyrJAcYwmA",
38+
"version_id": 8000099,
39+
"version": "8.0.0",
40+
"indices": [],
41+
"include_global_state": true,
42+
"state": "SUCCESS",
43+
"start_time": "2019-05-10T17:01:57.868Z",
44+
"start_time_in_millis": 1557507717868,
45+
"end_time": "2019-05-10T17:01:57.909Z",
46+
"end_time_in_millis": 1557507717909,
47+
"duration_in_millis": 41,
48+
"failures": [],
49+
"shards": {
50+
"total": 0,
51+
"failed": 0,
52+
"successful": 0
53+
}
54+
}
55+
]
56+
}
57+
]
58+
}
59+
-----------------------------------
60+
// TESTRESPONSE
61+
// TEST[skip:no repo and snapshots are created]
62+
63+
See <<modules-snapshots>> for more information.
1664

1765
[float]
1866
==== Deprecated node level compress setting removed

0 commit comments

Comments
 (0)