Update camunda REST API doc #4811
Merged
Conversation
This file contains 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
![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. |
camunda-docs-pr-automation
bot
force-pushed
the
update-rest-doc
branch
from
f6e8443 to
2183bb9
Compare
camunda-docs-pr-automation
bot
force-pushed
the
update-rest-doc
branch
from
2183bb9 to
bbd92a5
Compare
pepopowitz
reviewed
Jan 9, 2025
There was a problem hiding this comment.
I think it came in a previous update, but one change that needs to be pushed upstream is to add title properties to schemas that use oneOf, to avoid the docs displaying a confusing MOD1 tab. The background for this is in Slack: https://camunda.slack.com/archives/C06UKS51QV9/p1736444002167879?thread_ts=1736428754.905439&cid=C06UKS51QV9
I will own this, and include it in my next upstream spec PR.
pepopowitz
approved these changes
Jan 13, 2025
Comment on lines
+3262
to
+3267
| properties: | ||
| files: | ||
| type: array | ||
| items: | ||
| type: string | ||
| format: binary |
There was a problem hiding this comment.
Missing descriptions, I'll include them in my next upstream PR.
Comment on lines
+7400
to
+7407
| createdDocuments: | ||
| type: array | ||
| items: | ||
| $ref: "#/components/schemas/DocumentReference" | ||
| failedDocuments: | ||
| type: array | ||
| items: | ||
| $ref: "#/components/schemas/DocumentCreationFailureDetail" |
There was a problem hiding this comment.
Missing descriptions, I'll add them in my next upstream PR.
|
🧹 Preview environment for this PR has been torn down. |
github-merge-queue bot
pushed a commit
to camunda/camunda
that referenced
this pull request
Jan 20, 2025
## Description Improves the REST API spec documentation, including: 1. Brings some subtle documentation changes upstream from camunda/camunda-docs#4811. 2. Addresses #26741, by adding `title` properties to filtering union types. ### Filtering union titles Previously, the union type switcher which appears on multiple filtering requests would emit a nonsense title for the "exact match" tab, and a schema name for the "advanced filter" tab, as shown in #26741. With this PR, these switchers now all emit the title "Exact match" for the exactly matching type, and "Advanced filter" for the advanced filtering type, like this: <img width="336" alt="image" src="https://github.com/user-attachments/assets/6cbde181-b180-4969-a5fc-a5ed29385428" /> There is one specific change that introduces more than a `title` or `description` property, and I'll call it out with a review comment. #### Strange lack of precision in exact match type descriptions Strangely, the documentation plugin doesn't emit as much precision in the types for the "exact match" option. `date-time` strings are described as `string`, and `int32` integers are described as `integer`. This can be seen in the above screenshot. This strangeness isn't introduced by this PR, but it will be obvious when you review, so I wanted to call it out as a known issue. ## Related issues closes #26741
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
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/).