Update camunda REST API doc #4639
Conversation
![camunda-docs-pr-automation[bot]](https://avatars.githubusercontent.com/u/2443838?s=60&v=4){kind=small}
camunda-docs-pr-automation
bot
added
the
deploy
|
👋 🤖 🤔 Hello, @camunda-docs-pr-automation[bot]! 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.6/.
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. |
| allOf: | ||
| - $ref: "#/components/schemas/StringFilterProperty" |
There was a problem hiding this comment.
This abstraction (which is great) will obscure the descriptions of properties in this schema, as explained in this other issue.
The fix is to make the parent use allOf inheritance for this schema instead of direct $ref. This will be resolved upstream for this specific schema in this PR.
No further action needed, just over-communicating.
| allOf: | ||
| - $ref: "#/components/schemas/LongFilterProperty" |
There was a problem hiding this comment.
This abstraction (which is great) will obscure the descriptions of properties in this schema, as explained in this other issue.
The fix is to make the parent use allOf inheritance for this schema instead of direct $ref. This will be resolved upstream for this specific schema in this PR.
No further action needed, just over-communicating.
| allOf: | ||
| - $ref: "#/components/schemas/StringFilterProperty" |
There was a problem hiding this comment.
(Note that not all instances of these type abstractions introduce the obscuration of schema properties. This one, and the others I've left unmarked in this review, are already fine because their parents use allOf inheritance instead of direct $ref.)
|
🧹 Preview environment for this PR has been torn down. |
Description
This is an autogenerated PR by the sync api specs workflow.
This PR contains every changes made to the REST api specs in the monorepo in the last week.
This PR contains also all the generated OpenAPI files related to the changes.
When should this change go live?
PR Checklist
/docsdirectory (aka/next/).