Update camunda REST API doc #4760
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. |
pepopowitz
approved these changes
Dec 12, 2024
| description: The ID of the user. | ||
| type: "string" | ||
| userKey: | ||
| description: The system generated key of the User |
There was a problem hiding this comment.
The descriptions on this schema should either all use periods, or never use periods. Preference is all periods, but if it's consistent I usually let none periods slide. It's not consistent though, so I'll PR a change upstream for all periods.
Comment on lines
+5202
to
+5205
| name: | ||
| type: "string" | ||
| link: | ||
| type: "string" |
There was a problem hiding this comment.
Missing descriptions. I'll PR upstream.
Comment on lines
+5179
to
+5181
| tenantId: | ||
| type: "string" | ||
| name: |
There was a problem hiding this comment.
Missing descriptions. I'll PR them upstream.
|
🧹 Preview environment for this PR has been torn down. |
github-merge-queue bot
pushed a commit
to camunda/camunda
that referenced
this pull request
Dec 13, 2024
## Description Brings upstream a few API spec updates noticed in camunda/camunda-docs#4760.
github-merge-queue bot
pushed a commit
to camunda/camunda
that referenced
this pull request
Dec 13, 2024
## Description Brings upstream a few API spec updates noticed in camunda/camunda-docs#4760.
github-merge-queue bot
pushed a commit
to camunda/camunda
that referenced
this pull request
Dec 13, 2024
## Description Brings upstream a few API spec updates noticed in camunda/camunda-docs#4760.
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/).