Update camunda REST API doc #4603
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. |
There was a problem hiding this comment.
FYI, this is going to wash out some property descriptions, due to this issue I found in the docs generator.
I'll work to get those issues resolved iteratively, with follow-up PRs at the source.
| application/problem+json: | ||
| schema: | ||
| $ref: "#/components/schemas/ProblemDetail" | ||
| $ref: "#/components/responses/InternalServerError" |
There was a problem hiding this comment.
💯 I'm a big fan of this abstraction.
| operationId: getRole | ||
| summary: Get role | ||
| description: | | ||
| Get a role by its key |
There was a problem hiding this comment.
| Get a role by its key | |
| Get a role by its key. |
I'll port this change upstream.
| operationId: createRole | ||
| summary: Create role | ||
| description: | | ||
| Create a new role |
There was a problem hiding this comment.
| Create a new role | |
| Create a new role. |
I'll port this change upstream.
| tags: | ||
| - User | ||
| operationId: createUser | ||
| summary: Create user |
There was a problem hiding this comment.
| summary: Create user | |
| summary: Create user | |
| description: Create a new user. |
I'll port this change upstream.
| description: The priority of the user task. | ||
| allOf: |
There was a problem hiding this comment.
I am a big fan of these abstractions.
Heads up though that I found an issue in how the docs sometimes renders them.
These property descriptions themselves don't need changes...but I will introduce some other changes in an upstream PR that modifies how inheritance is handled at a higher level of the schema, as described in that linked comment.
(cc @tmetzke for visibility)
| properties: | ||
| name: | ||
| type: "string" | ||
| description: The display name of the new role |
There was a problem hiding this comment.
| description: The display name of the new role | |
| description: The display name of the new role. |
I'll port this upstream.
| type: "object" | ||
| properties: | ||
| roleKey: | ||
| description: The key of the created role |
There was a problem hiding this comment.
| description: The key of the created role | |
| description: The key of the created role. |
I'll port this upstream.
|
🧹 Preview environment for this PR has been torn down. |
## Description Ports a few very very minor spec updates from camunda/camunda-docs#4603.
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/).