REST API compatiblity documentation by jakelandis · Pull Request #83487 · elastic/elasticsearch

jakelandis · 2022-02-03T22:32:53Z

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

elasticmachine · 2022-02-03T22:32:57Z

Pinging @elastic/es-docs (Team:Docs)

docs/reference/rest-api/rest-api-compatibility.asciidoc

debadair

I added some editorial suggestions & tried to streamline this a bit.

Let me know if you have questions!

docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc

docs/reference/rest-api/rest-api-compatibility.asciidoc

debadair · 2022-02-04T01:12:12Z

docs/reference/upgrade.asciidoc

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


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

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 <debadair@elastic.co>

jakelandis · 2022-02-04T18:52:10Z

@elasticmachine run elasticsearch-ci/docs

This reverts commit e51189b.

jakelandis · 2022-02-04T20:15:30Z

docs/reference/rest-api/rest-api-compatibility.asciidoc

+"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]


@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

Left a suggestion that should fix the link.

docs/reference/rest-api/rest-api-compatibility.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

jakelandis · 2022-02-04T22:32:10Z

Thank you @debadair - your edits were really good !

Co-authored-by: debadair <debadair@elastic.co>

elasticsearchmachine · 2022-02-04T22:33:27Z

💚 Backport successful

Status	Branch	Result
✅	8.0
✅	8.1

Co-authored-by: debadair <debadair@elastic.co>

Co-authored-by: debadair <debadair@elastic.co> Co-authored-by: debadair <debadair@elastic.co>

pgomulka

LGTM, sorry for the delay

* REST API compatiblity documentation (#83487) Co-authored-by: debadair <debadair@elastic.co> * Switch xrefs to external links Co-authored-by: debadair <debadair@elastic.co> Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>

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.

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)

Adds a release highlight for the 7.x REST API compatibility headers. Relates to #51816 and #83487

initial stab at compat api docs

feac71c

jakelandis added >docs General docs changes v8.0.0 auto-backport-and-merge v8.1.0 v8.0.1 v8.2.0 v8.1.1 labels Feb 3, 2022

jakelandis requested review from debadair, joegallo and pgomulka February 3, 2022 22:32

elasticmachine added the Team:Docs Meta label for docs team label Feb 3, 2022

fix build error

be39b51

jakelandis commented Feb 3, 2022

View reviewed changes

docs/reference/rest-api/rest-api-compatibility.asciidoc Show resolved Hide resolved

debadair suggested changes Feb 4, 2022

View reviewed changes

jakelandis and others added 14 commits February 4, 2022 11:17

Update docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc

0a47ad3

Co-authored-by: debadair <debadair@elastic.co>

Update docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc

08423a4

Co-authored-by: debadair <debadair@elastic.co>

Update docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc

f77fed3

Co-authored-by: debadair <debadair@elastic.co>

Update docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc

db7b284

Co-authored-by: debadair <debadair@elastic.co>

Update docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc

a02b6b0

Co-authored-by: debadair <debadair@elastic.co>

Update docs/reference/rest-api/rest-api-compatibility.asciidoc

cdc889f

Co-authored-by: debadair <debadair@elastic.co>

Update docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc

1033656

Co-authored-by: debadair <debadair@elastic.co>

Update docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc

90bb1cb

Co-authored-by: debadair <debadair@elastic.co>

Update docs/reference/rest-api/rest-api-compatibility.asciidoc

b0fedbf

Co-authored-by: debadair <debadair@elastic.co>

Update docs/reference/rest-api/rest-api-compatibility.asciidoc

f2e0a98

Co-authored-by: debadair <debadair@elastic.co>

Update docs/reference/rest-api/rest-api-compatibility.asciidoc

fdd4e57

Co-authored-by: debadair <debadair@elastic.co>

Update docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc

e9591c8

Co-authored-by: debadair <debadair@elastic.co>

Update docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc

f5df150

Co-authored-by: debadair <debadair@elastic.co>

Update docs/reference/rest-api/rest-api-compatibility.asciidoc

8cf35fb

Co-authored-by: debadair <debadair@elastic.co>

jakelandis and others added 6 commits February 4, 2022 11:23

Update docs/reference/rest-api/rest-api-compatibility.asciidoc

45da4c8

Co-authored-by: debadair <debadair@elastic.co>

Update docs/reference/rest-api/rest-api-compatibility.asciidoc

4cf9bd7

Co-authored-by: debadair <debadair@elastic.co>

Update docs/reference/rest-api/rest-api-compatibility.asciidoc

1713dc5

Co-authored-by: debadair <debadair@elastic.co>

Update docs/reference/rest-api/rest-api-compatibility.asciidoc

a838243

Co-authored-by: debadair <debadair@elastic.co>

line breaks

367c860

remove whitespace

9c248e4

jakelandis added 2 commits February 4, 2022 14:13

added todo to fix broken link

e51189b

Revert "added todo to fix broken link"

ed669b3

This reverts commit e51189b.

jakelandis commented Feb 4, 2022

View reviewed changes

debadair approved these changes Feb 4, 2022

View reviewed changes

docs/reference/rest-api/rest-api-compatibility.asciidoc Outdated Show resolved Hide resolved

Update docs/reference/rest-api/rest-api-compatibility.asciidoc

17f423f

Co-authored-by: debadair <debadair@elastic.co>

jakelandis merged commit 5c73ad1 into elastic:master Feb 4, 2022

jakelandis deleted the compat_rest_api_doc branch February 4, 2022 22:32

jakelandis mentioned this pull request Feb 4, 2022

[8.0] REST API compatiblity documentation (#83487) #83557

Merged

jakelandis added a commit to jakelandis/elasticsearch that referenced this pull request Feb 4, 2022

REST API compatiblity documentation (elastic#83487)

a504aeb

Co-authored-by: debadair <debadair@elastic.co>

jakelandis mentioned this pull request Feb 4, 2022

[8.1] REST API compatiblity documentation (#83487) #83558

Merged

jakelandis added a commit to jakelandis/elasticsearch that referenced this pull request Feb 4, 2022

REST API compatiblity documentation (elastic#83487)

089a7ad

Co-authored-by: debadair <debadair@elastic.co>

elasticsearchmachine pushed a commit that referenced this pull request Feb 4, 2022

REST API compatiblity documentation (#83487) (#83558)

57ee116

Co-authored-by: debadair <debadair@elastic.co> Co-authored-by: debadair <debadair@elastic.co>

pgomulka reviewed Feb 7, 2022

View reviewed changes

jrodewig mentioned this pull request Feb 7, 2022

[DOCS] Switch xrefs to external links in migration guide #83590

Merged

jrodewig mentioned this pull request Feb 7, 2022

[DOCS] Add release highlight for REST API compatibility #83614

Merged

jrodewig added a commit that referenced this pull request Feb 8, 2022

[DOCS] Add release highlight for REST API compatibility (#83614)

4711a79

Adds a release highlight for the 7.x REST API compatibility headers. Relates to #51816 and #83487

Conversation

jakelandis commented Feb 3, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

elasticmachine commented Feb 3, 2022

Uh oh!

Uh oh!

debadair left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

debadair Feb 4, 2022

Choose a reason for hiding this comment

Uh oh!

jakelandis Feb 4, 2022

Choose a reason for hiding this comment

Uh oh!

jakelandis commented Feb 4, 2022

Uh oh!

jakelandis Feb 4, 2022

Choose a reason for hiding this comment

Uh oh!

debadair left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jakelandis commented Feb 4, 2022

Uh oh!

elasticsearchmachine commented Feb 4, 2022

💚 Backport successful

Uh oh!

pgomulka left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

jakelandis commented Feb 3, 2022 •

edited

Loading