Update camunda REST API doc #4196
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
Hey @akeller @pepopowitz @tmetzke, This is a PR generated by the new rest docs sync workflow. The workflow PR is still a draft but I think it's ready to be reviewed (small adjustments to add). |
akeller
added
dx
|
The preview environment relating to the commit 1dcaccf has successfully been deployed. You can access it at https://preview.docs.camunda.cloud/pr-4196/index.html |
There was a problem hiding this comment.
I love that you automated this!! I'm excited for #4168 ❤️ ❤️ ❤️ ❤️
Changes requested
There are many properties missing descriptions. This is something we should resolve -- my preference would be that the authors of the API update the upstream source first, then propagate them here....but if we need to add descriptions here first, and then open a separate PR to port them upstream, that is fine too. Either way, please let me know if my assistance is needed for any of it.
No changes requested, but noteworthy
There are regressions in many descriptions based on previous reviews, but I'm not very worried about those. Especially knowing that ensuing PRs would fix them, as long as we're pushing them upstream (example: camunda/camunda#21596).
| type: object | ||
| properties: | ||
| ownerKey: | ||
| type: string | ||
| ownerType: | ||
| type: string | ||
| enum: | ||
| - USER | ||
| - ROLE | ||
| - GROUP | ||
| resourceKey: | ||
| type: string | ||
| resourceType: | ||
| type: string | ||
| permissions: | ||
| type: array | ||
| items: | ||
| type: string |
There was a problem hiding this comment.
These properties would benefit from descriptions:
| UserFilterRequest: | ||
| type: object | ||
| properties: | ||
| username: | ||
| type: "string" | ||
| name: | ||
| type: "string" | ||
| email: | ||
| type: "string" | ||
| UserResponse: | ||
| type: "object" | ||
| properties: | ||
| id: | ||
| type: "integer" | ||
| format: "int64" | ||
| username: | ||
| type: "string" | ||
| name: | ||
| type: "string" | ||
| email: | ||
| type: "string" | ||
| UserSearchResponse: | ||
| type: object | ||
| allOf: | ||
| - $ref: "#/components/schemas/SearchQueryResponse" | ||
| properties: | ||
| items: | ||
| type: array | ||
| items: | ||
| $ref: "#/components/schemas/UserResponse" |
There was a problem hiding this comment.
These properties are all missing descriptions.
| @@ -41,8 +41,8 @@ paths: | |||
| get: | |||
| tags: | |||
| - License | |||
| summary: Get status of Camunda license | |||
| description: Obtains the status of the current Camunda license | |||
| summary: Get status of Camunda License | |||
There was a problem hiding this comment.
This, and many changes like it, are a result of us not making changes upstream yet 😅
@christinaausley and I opened camunda/camunda#21596 today to fix that.
@christinaausley, I don't know how you feel, but I would be fine with these regressions making it into this PR knowing that they will be fixed by the next one. Otherwise, we'll want to manually fix these like in this PR like we did in #4166.
|
Hey @pepopowitz, thanks for the review. This PR is just an example to show the result of the automation. I think it can be closed. Happy to here other idea here 💪 |
|
My bad, the body is generated by the workflow. I should convert the PR as draft to avoid the mistake 🙇 |
This PR updates the camunda REST API