Skip to content

Commit

Permalink
[DOCS] Replace _meta with metadata for snapshot APIs. (#44596)
Browse files Browse the repository at this point in the history
#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.
  • Loading branch information
jrodewig authored Jul 19, 2019
1 parent e14300e commit 506de3b
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/reference/modules/snapshots.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -359,7 +359,7 @@ PUT /_snapshot/my_backup/snapshot_2?wait_for_completion=true
"indices": "index_1,index_2",
"ignore_unavailable": true,
"include_global_state": false,
"_meta": {
"metadata": {
"taken_by": "kimchy",
"taken_because": "backup before upgrading"
}
Expand All @@ -376,7 +376,7 @@ By setting `include_global_state` to false it's possible to prevent the cluster
the snapshot. By default, the entire snapshot will fail if one or more indices participating in the snapshot don't have
all primary shards available. This behaviour can be changed by setting `partial` to `true`.

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

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

0 comments on commit 506de3b

Please sign in to comment.