Skip to content
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

[DOCS] Reformat get mapping API. Reformat and reuse multi-index params. #45699

Merged
merged 4 commits into from Aug 21, 2019

Conversation

@jrodewig
Copy link
Contributor

commented Aug 19, 2019

Changes

  • Updates the get mapping API to use the new Elastic API reference
    template
    .

  • 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.

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

[DOCS] Reformat get mapping API. Reformat and reuse multi-index params.
* 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
@elasticmachine

This comment has been minimized.

Copy link
Collaborator

commented Aug 19, 2019

@elasticmachine

This comment has been minimized.

Copy link
Collaborator

commented Aug 19, 2019

@elasticmachine

This comment has been minimized.

Copy link
Collaborator

commented Aug 19, 2019

jrodewig added 2 commits Aug 19, 2019
@szabosteve
Copy link
Contributor

left a comment

I left one comment regarding the common param changes.

(Optional, string) Controls what kind of indices that wildcard
expressions can expand to. Valid values are:

`open`::

This comment has been minimized.

Copy link
@szabosteve

szabosteve Aug 21, 2019

Contributor

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.

This comment has been minimized.

Copy link
@jrodewig

jrodewig Aug 21, 2019

Author Contributor

Thanks for catching that. It should be all. Fixed with b8653d3.

@jrodewig jrodewig requested a review from szabosteve Aug 21, 2019

@szabosteve
Copy link
Contributor

left a comment

LGTM!

@jrodewig jrodewig merged commit 00b7dc1 into elastic:master Aug 21, 2019

4 checks passed

CLA All commits in pull request signed
Details
elasticsearch-ci/docs Build finished.
Details
elasticsearch-ci/docs-check Build finished.
Details
elasticsearch-ci/oss-distro-docs Build finished.
Details

@jrodewig jrodewig deleted the jrodewig:get-mapping-reformat branch Aug 21, 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[]

This comment has been minimized.

Copy link
@sqren

sqren Sep 6, 2019

Member

@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

This comment has been minimized.

Copy link
@jrodewig

jrodewig Sep 6, 2019

Author Contributor

Thanks for catching this @sqren. I've opened #46450 to correct.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.