From 91d1c9e3c521d84ed5fac855da0013ac42f3a75b Mon Sep 17 00:00:00 2001 From: James Rodewig Date: Thu, 18 Jul 2019 16:02:19 -0400 Subject: [PATCH] [DOCS] Replace `_meta` with `metadata` for snapshot APIs. 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. --- docs/reference/modules/snapshots.asciidoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/reference/modules/snapshots.asciidoc b/docs/reference/modules/snapshots.asciidoc index 68fdf72984533..240fbb6e70e30 100644 --- a/docs/reference/modules/snapshots.asciidoc +++ b/docs/reference/modules/snapshots.asciidoc @@ -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 <>, similarly as when creating