Merge pull request #249 from opensearch-project/ism-snapshot-changes

Updated so snapshots now include Mustache templates as names
This commit is contained in:
Keith Chan 2021-11-23 09:48:22 -08:00 committed by GitHub
commit 3ae1a4d68c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -314,13 +314,13 @@ The `snapshot` operation has the following parameters:
Parameter | Description | Type | Required | Default Parameter | Description | Type | Required | Default
:--- | :--- |:--- |:--- | :--- | :--- |:--- |:--- |
`repository` | The repository name that you register through the native snapshot API operations. | `string` | Yes | - `repository` | The repository name that you register through the native snapshot API operations. | `string` | Yes | -
`snapshot` | The name of the snapshot. | `string` | Yes | - `snapshot` | The name of the snapshot. Accepts strings and the Mustache variables `{{ctx.index}}` and `{{ctx.indexUuid}}`. If the Mustache variables are invalid, then the snapshot name defaults to the index's name. | `string` or Mustache template | Yes | -
```json ```json
{ {
"snapshot": { "snapshot": {
"repository": "my_backup", "repository": "my_backup",
"snapshot": "my_snapshot" "snapshot": "{{ctx.indexUuid}}"
} }
} }
``` ```