honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Replace `_meta` with `metadata` for snapshot APIs. (#44596) 

elastic/elasticsearch#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.
This commit is contained in:
James Rodewig 2019-07-19 08:40:34 -04:00
parent 597d2dfaf5
commit 76c7e3a05f
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/reference/modules/snapshots.asciidoc
View File

@ -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"
}
@ -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