docs(apis): add client and API compatibility section#8361
docs(apis): add client and API compatibility section#8361
Conversation
- Add "Client and API compatibility" section to public-api.md with forward/backward compatibility table for clients, SDKs, CPT, and REST APIs - Add compatibility note in 8.9 announcements (APIs & tools section) - Add compatibility summary with link in working-with-apis-tools.md
|
👋 🤖 🤔 Hello, @nicpuppa! Did you make your changes in all the right places? These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.8/.
You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines. |
|
The preview environment relating to the commit 2c73957 has successfully been deployed. You can access it at https://preview.docs.camunda.cloud/pr-8361/ |
megglos
left a comment
There was a problem hiding this comment.
My understanding is that SDKs/clients are only forward-comaptible, while the API is generally backwardscompatible - old requests are processable still.
Clients are not backwardscompatible, as they may contain new functionality not present on the previous OC release. A new client may send requests the server is not capable to handle properly. E.g. a new endpoint and/or property.
That's why the upgrade path should be cluster first, then clients.
Let's align on what I might be getting wrong.

Description
Adds documentation explaining the forward and backward compatibility guarantees between Camunda clients/SDKs and the Orchestration Cluster.
When should this change go live?
bugorsupportlabel)available & undocumentedlabel)holdlabel)low priolabel)PR Checklist
{type}(scope): {description}commit message(s)/docsdirectory (version 8.9)./versioned_docsdirectory.@camunda/tech-writersunless working with an embedded writer.closes camunda/camunda#41938