REST API compatiblity documentation #83487
Merged
Conversation
This file contains hidden or 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
jakelandis
added
>docs
Collaborator
|
Pinging @elastic/es-docs (Team:Docs) |
jakelandis
commented
Feb 3, 2022
debadair
suggested changes
Feb 4, 2022
Contributor
debadair
left a comment
debadair
left a comment
There was a problem hiding this comment.
I added some editorial suggestions & tried to streamline this a bit.
Let me know if you have questions!
docs/reference/upgrade.asciidoc
Outdated
| ifeval::["{release-state}"!="released"] | ||
| [[upgrade-pre-release]] | ||
| IMPORTANT: This documentation is for a pre-release of {es} {minor-version}. | ||
| IMPORTANT: This documentation is for a pre-release of {es} {minor-version}. |
Contributor
There was a problem hiding this comment.
I've got changes to this topic in flight. Revert these & I'll add the compatibility info where needed. (And link to the new topic.)
Contributor
Author
There was a problem hiding this comment.
The whitespace changes were accidental and have been removed from the PR. Did you mean just the white space or the entire file ?
Co-authored-by: debadair <[email protected]>
Co-authored-by: debadair <[email protected]>
Co-authored-by: debadair <[email protected]>
Co-authored-by: debadair <[email protected]>
Co-authored-by: debadair <[email protected]>
Co-authored-by: debadair <[email protected]>
Co-authored-by: debadair <[email protected]>
Co-authored-by: debadair <[email protected]>
Co-authored-by: debadair <[email protected]>
Co-authored-by: debadair <[email protected]>
Co-authored-by: debadair <[email protected]>
Co-authored-by: debadair <[email protected]>
Co-authored-by: debadair <[email protected]>
Co-authored-by: debadair <[email protected]>
Co-authored-by: debadair <[email protected]>
Co-authored-by: debadair <[email protected]>
Co-authored-by: debadair <[email protected]>
Co-authored-by: debadair <[email protected]>
Contributor
Author
|
@elasticmachine run elasticsearch-ci/docs |
This reverts commit e51189b.
jakelandis
commented
Feb 4, 2022
| "application/vnd.elasticsearch+smile;compatible-with=7" | ||
| "application/vnd.elasticsearch+cbor;compatible-with=7" | ||
| ------------------------------------------------------------ | ||
| The [link:/guide](https://www.elastic.co/guide/en/elasticsearch/client/index.html)[officially supported {es} clients] |
Contributor
Author
There was a problem hiding this comment.
@debadair - can you help out again with this link the build still claims this as broken:
13:02:16 INFO:build_docs: /tmp/docsbuild/target_repo/html/en/elasticsearch/reference/master/rest-api-compatibility.html contains broken links to:
13:02:16 INFO:build_docs: - en/elasticsearch/client/index.html)
debadair
approved these changes
Feb 4, 2022
Contributor
debadair
left a comment
debadair
left a comment
There was a problem hiding this comment.
Left a suggestion that should fix the link.
Co-authored-by: debadair <[email protected]>
Contributor
Author
|
Thank you @debadair - your edits were really good ! |
jakelandis
added a commit
to jakelandis/elasticsearch
that referenced
this pull request
Feb 4, 2022
Co-authored-by: debadair <[email protected]>
Collaborator
jakelandis
added a commit
to jakelandis/elasticsearch
that referenced
this pull request
Feb 4, 2022
Co-authored-by: debadair <[email protected]>
elasticsearchmachine
pushed a commit
that referenced
this pull request
Feb 4, 2022
Co-authored-by: debadair <[email protected]> Co-authored-by: debadair <[email protected]>
pgomulka
reviewed
Feb 7, 2022
Contributor
pgomulka
left a comment
pgomulka
left a comment
There was a problem hiding this comment.
LGTM, sorry for the delay
elasticsearchmachine
pushed a commit
that referenced
this pull request
Feb 7, 2022
* REST API compatiblity documentation (#83487) Co-authored-by: debadair <[email protected]> * Switch xrefs to external links Co-authored-by: debadair <[email protected]> Co-authored-by: James Rodewig <[email protected]>
jrodewig
added a commit
that referenced
this pull request
Feb 7, 2022
We reuse our breaking changes in the [Elastic Installation and Upgrade Guide](https://www.elastic.co/guide/en/elastic-stack/current/index.html). To prevent broken links, we have to use external links rather than xrefs inside breaking changes. Relates to #83487.
elasticsearchmachine
pushed a commit
that referenced
this pull request
Feb 7, 2022
We reuse our breaking changes in the [Elastic Installation and Upgrade Guide](https://www.elastic.co/guide/en/elastic-stack/current/index.html). To prevent broken links, we have to use external links rather than xrefs inside breaking changes. Relates to #83487. (cherry picked from commit 02ea65a)
jrodewig
added a commit
that referenced
this pull request
Feb 8, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
related: #51816
Preview
https://elasticsearch_83487.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/rest-api-compatibility.html
https://elasticsearch_83487.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/migrating-8.0.html#breaking_80_rest_api_changes
https://elasticsearch_83487.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/setup-upgrade.html