[DOCS] Reformat get mapping API. Reformat and reuse multi-index params. #45699
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Updates the get mapping API to use the new Elastic API reference template: https://github.com/elastic/docs/blob/master/shared/api-ref-ex.asciidoc * Adds documentation for several multi-index parameters to common-parms.asciidoc for reuse throughout API reference documentation. * Updates API conventions chapter to reuse parameters from common-parms.asciidoc
jrodewig
added
>docs
jrodewig
requested review from
debadair,
jtibshirani,
szabosteve,
lcawl and
wchrisdean
|
Pinging @elastic/es-core-features |
|
Pinging @elastic/es-search |
|
Pinging @elastic/es-docs |
This was referenced Aug 19, 2019
This was referenced Aug 19, 2019
szabosteve
requested changes
Aug 21, 2019
| (Optional, string) Controls what kind of indices that wildcard | ||
| expressions can expand to. Valid values are: | ||
|
|
||
| `open`:: |
There was a problem hiding this comment.
Should it be open,closed rather than simply open? The next value is also open, based on the descriptions, the first one should be changed.
There was a problem hiding this comment.
Thanks for catching that. It should be all. Fixed with b8653d3.
jrodewig
added a commit
that referenced
this pull request
Aug 21, 2019
jrodewig
added a commit
that referenced
this pull request
Aug 21, 2019
sorenlouv
reviewed
Sep 6, 2019
| expression or `_all` value retrieves only missing or closed indices. This | ||
| parameter also applies to <<indices-aliases,index aliases>> that point to a | ||
| missing or closed index. | ||
| end::allow-no-indices[] |
There was a problem hiding this comment.
@jrodewig It seems this behaves opposite of the description here. afaict allow_no_indices = true will allow empty indices and thus not return an error. allow_no_indices = false will not allow empty and will return an error if empty indicies are encountered.
cc @weltenwort
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
Updates the get mapping API to use the new Elastic API reference
template.
Adds documentation for several multi-index parameters to
common-parms.asciidocfor reuse throughout API referencedocumentation.
Updates API conventions chapter to reuse parameters from
common-parms.asciidoc.Relates to elastic/docs#937 and #43765
Preview
http://elasticsearch_45699.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/indices-get-mapping.html