Skip to content

[DOCS] Fix create snapshot API parameters #79209

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 21, 2021
Merged

[DOCS] Fix create snapshot API parameters #79209

merged 3 commits into from
Oct 21, 2021

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Oct 15, 2021

Changes:

  • Notes snapshot names support date math
  • Sorts request body parameters alphabetically
  • Adds the expand_wildcards request body parameter
  • Reuses cluster state contents list from the restore snapshot API
  • Notes the indices and feature_states parameters support a special none value

Relates to #79081

Preview

https://elasticsearch_79209.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/create-snapshot-api.html#create-snapshot-api-path-params

Changes:

- Notes snapshot names support date math
- Sorts request body parameters alphabetically
- Adds the `expand_wildcards` request body parameter
- Reuses cluster state contents list from the restore snapshot API
- Notes the `indices` and `feature_states` parameters support a special `none` value

Relates to #79081
@jrodewig jrodewig marked this pull request as ready for review October 15, 2021 15:12
@jrodewig jrodewig added :Distributed Coordination/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs v7.15.2 v7.16.0 labels Oct 15, 2021
@elasticmachine elasticmachine added the Team:Distributed (Obsolete) Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination. label Oct 15, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-distributed (Team:Distributed)

--
(Optional, string) Determines how wildcard patterns in the `indices` parameter
match data streams and indices. Supports comma-separated values, such as
`open,hidden`. Defaults to `all`. Valid values are:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Defaults to all.

I'll change this to open,hidden on 7.x backports.

Copy link
Contributor

@original-brownbear original-brownbear left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jrodewig jrodewig merged commit 12474b1 into elastic:master Oct 21, 2021
@jrodewig jrodewig deleted the docs__fix-snapshot-api-docs branch October 21, 2021 13:03
@jrodewig jrodewig added the >docs General docs changes label Oct 21, 2021
@elasticmachine elasticmachine added the Team:Docs Meta label for docs team label Oct 21, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

elasticsearchmachine pushed a commit that referenced this pull request Oct 21, 2021
* [DOCS] Fix create snapshot API parameters (#79209)

Changes:

- Notes snapshot names support date math
- Sorts request body parameters alphabetically
- Adds the `expand_wildcards` request body parameter
- Reuses cluster state contents list from the restore snapshot API
- Notes the `indices` and `feature_states` parameters support a special `none` value

Relates to #79081

* Update `expand_wildcards` default

* Fix xref

* Fix xref
elasticsearchmachine pushed a commit that referenced this pull request Oct 21, 2021
* [DOCS] Fix create snapshot API parameters (#79209)

Changes:

- Notes snapshot names support date math
- Sorts request body parameters alphabetically
- Adds the `expand_wildcards` request body parameter
- Reuses cluster state contents list from the restore snapshot API
- Notes the `indices` and `feature_states` parameters support a special `none` value

Relates to #79081

* Update `expand_wildcards` default

* Fix xref

* Fix xref
jrodewig added a commit that referenced this pull request Jan 28, 2022
The create snapshot API's `indices` parameter doesn't support a `none`
value.

Relates to #83273 and #79209.
jrodewig added a commit that referenced this pull request Jan 28, 2022
The create snapshot API's `indices` parameter doesn't support a `none`
value.

Relates to #83273 and #79209.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Distributed Coordination/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs >docs General docs changes Team:Distributed (Obsolete) Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination. Team:Docs Meta label for docs team v7.15.2 v7.16.0 v8.0.0-beta1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants