Skip to content

Commit 506de3b

Browse files
authored
[DOCS] Replace _meta with metadata for snapshot APIs. (#44596)
#41281 added custom metadata parameter to snapshots. During review, the parameter name was changed from '_meta' to 'metadata,' but the documentation wasn't updated. This corrects the documentation to use the 'metadata' name.
1 parent e14300e commit 506de3b

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/reference/modules/snapshots.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -359,7 +359,7 @@ PUT /_snapshot/my_backup/snapshot_2?wait_for_completion=true
359359
"indices": "index_1,index_2",
360360
"ignore_unavailable": true,
361361
"include_global_state": false,
362-
"_meta": {
362+
"metadata": {
363363
"taken_by": "kimchy",
364364
"taken_because": "backup before upgrading"
365365
}
@@ -376,7 +376,7 @@ By setting `include_global_state` to false it's possible to prevent the cluster
376376
the snapshot. By default, the entire snapshot will fail if one or more indices participating in the snapshot don't have
377377
all primary shards available. This behaviour can be changed by setting `partial` to `true`.
378378

379-
The `_meta` field can be used to attach arbitrary metadata to the snapshot. This may be a record of who took the snapshot,
379+
The `metadata` field can be used to attach arbitrary metadata to the snapshot. This may be a record of who took the snapshot,
380380
why it was taken, or any other data that might be useful.
381381

382382
Snapshot names can be automatically derived using <<date-math-index-names,date math expressions>>, similarly as when creating

0 commit comments

Comments
 (0)