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

Start moving docs to typeless APIs. #33953

Closed
wants to merge 1 commit into from

Conversation

jpountz
Copy link
Contributor

@jpountz jpountz commented Sep 21, 2018

A number of APIs (index creation, put mapping, index, etc.) will soon trigger
deprecation warnings unless users opt in for typeless APIs by passing
include_type_name=false.

Relates #15613

A number of APIs (index creation, put mapping, index, etc.) will soon trigger
deprecation warnings unless users opt in for typeless APIs by passing
`include_type_name=false`.

Relates elastic#15613
@jpountz jpountz added >docs General docs changes :Search Foundations/Mapping Index mappings, including merging and defining field types v7.0.0 labels Sep 21, 2018
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-search-aggs

@jpountz jpountz requested a review from jtibshirani September 24, 2018 12:11
Copy link
Contributor

@jtibshirani jtibshirani left a comment

Choose a reason for hiding this comment

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

The change makes sense to me, but I had a high-level question: we’ve discussed how it’s unfortunate that so many important APIs now require an extra parameter by default, and also that users will have to take action both in 7.0 to add the parameter, and in 8.0 to remove it. We’re brainstorming potential approaches to improve this set-up (such as adding a setting can be enabled instead of specifying a parameter in each request). Should we hold off on this change until we have a better handle on that, since it may affect whether we update all the REST documentation?

@@ -19,7 +19,7 @@ the user name:

[source,js]
--------------------------------------------------
POST /twitter/tweet?routing=kimchy
POST twitter/_doc?routing=kimchy&include_type_name=false
Copy link
Contributor

Choose a reason for hiding this comment

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

You might be planning to do this later, but it would be nice to describe the include_type_name parameter in this high-level reference (as we do in get-mapping.asciidoc, etc.)

@jpountz
Copy link
Contributor Author

jpountz commented Sep 26, 2018

Thanks for the feedback @jtibshirani. I raised a discussion at #15613 (comment).

@jtibshirani
Copy link
Contributor

I'm going to close this because our plan has diverged a bit from when this was opened. We'll open new PRs to make the relevant documentation updates.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes :Search Foundations/Mapping Index mappings, including merging and defining field types v7.0.0-beta1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants