-
Notifications
You must be signed in to change notification settings - Fork 25.5k
[DOCS] Update put mapping #120248
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] Update put mapping #120248
Conversation
Documentation preview: |
Pinging @elastic/es-docs (Team:Docs) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would avoid manually editing API docs at this point because all API references are moving to being autogenerated from the OpenAPI specs. So my guidance would be to close this PR and focus on non-API docs updates.
Otherwise, I think these changes are problematic.
Your update has a few key issues that could mislead users:
- You've contradicted yourself by saying the API can "change mappings" but then stating Elasticsearch "does not allow in-place field type changes"
- You've removed the crucial "adds new fields" capability, which is actually one of the API's main functions
If updates to this content do need to go ahead, the appropriate file would be https://github.com/elastic/elasticsearch-specification/blob/main/specification/indices/put_mapping/IndicesPutMappingRequest.ts, which ultimately gets published here: https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-mapping-1 |
@thekofimensah need to address:
|
Important Elastic documentation is migrating to Markdown for version 9.0+. See the migration guide for details. ℹ️ What's happening?
What do I need to do?For <=8.x docs:
For 9.0+ docs:Option 1:
Option 2:
💡 Need help?
|
Co-authored-by: Liam Thompson <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
@leemthompo For all of these tickets that we didn't quite get in before the finish line, shall I just create a new PR in v9 and drop these? |
@thekofimensah yup, but remember some of these are API updates that need to happen in the spec, which is unaffected by the migration :) |
@leemthompo, @georgewallace for this one, it's targeting 8.17, so can this be merged as is? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good to merge into 8.x.
Please follow up on #120248 (comment) if you want these changes reflected in 9.x API docs.
Co-authored-by: Kofi B <[email protected]>
Co-authored-by: Kofi B <[email protected]>
Added an intro to this topic to help with understanding of the topic