Update camunda REST API doc #4427
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
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
pepopowitz
added
deploy
pepopowitz
approved these changes
Oct 9, 2024
| get: | ||
| tags: | ||
| - User task | ||
| summary: Return user task by a user task key. |
There was a problem hiding this comment.
Suggested change
| summary: Return user task by a user task key. | |
| summary: Return user task by a user task key |
❌ no periods in summary
owner: me in an upstream PR
| @@ -441,6 +441,58 @@ paths: | |||
| schema: | |||
| $ref: "#/components/schemas/ProblemDetail" | |||
| /user-tasks/{userTaskKey}: | |||
| get: | |||
| tags: | |||
| - User task | |||
There was a problem hiding this comment.
Not sure which one, but either this one or the next endpoint are going to need to change, for consistency. (The next one is tagged with User Task, in title case.)
owner: me
| $ref: "#/components/schemas/FlowNodeInstanceItem" | ||
| "400": | ||
| description: > | ||
| The flow node instance Get failed. |
There was a problem hiding this comment.
Suggested change
| The flow node instance Get failed. | |
| The flow node instance request failed. |
owner: me
| $ref: "#/components/schemas/DecisionDefinitionItem" | ||
| "400": | ||
| description: > | ||
| The decision definition Get by key failed. |
There was a problem hiding this comment.
Suggested change
| The decision definition Get by key failed. | |
| The decision definition request failed. |
owner: me
| $ref: "#/components/schemas/DecisionRequirementsItem" | ||
| "400": | ||
| description: > | ||
| The decision requirements Get failed. |
There was a problem hiding this comment.
Suggested change
| The decision requirements Get failed. | |
| The decision requirements request failed. |
owner: me
| get: | ||
| tags: | ||
| - Decision requirements | ||
| summary: Get decision requirements XML (alpha). |
There was a problem hiding this comment.
Suggested change
| summary: Get decision requirements XML (alpha). | |
| summary: Get decision requirements XML (alpha) |
owner: me
| type: string | ||
| "400": | ||
| description: > | ||
| The decision requirements Get XML failed. |
There was a problem hiding this comment.
Suggested change
| The decision requirements Get XML failed. | |
| The decision requirements request failed. |
owner: me
| The decision instance search successful response. | ||
| "202": | ||
| description: | | ||
| The Authorization was patched successfully. |
There was a problem hiding this comment.
Suggested change
| The Authorization was patched successfully. | |
| The authorization was patched successfully. |
owner: me
| The Authorization was patched successfully. | ||
| "400": | ||
| description: | | ||
| The Authorization could not be patched. |
There was a problem hiding this comment.
Suggested change
| The Authorization could not be patched. | |
| The authorization could not be patched. |
owner: me
| format: date-time | ||
| endDate: | ||
| processDefinitionId: | ||
| description: Process defintion id of this process definition. |
There was a problem hiding this comment.
Suggested change
| description: Process defintion id of this process definition. | |
| description: Process definition id of this process definition. |
owner: me
|
@pepopowitz, would you like to add the changes here and create an upstream PR to "manifest" them? Or just create the upstream PR and update here after merging it? |
I will merge this one as-is, and then open a PR upstream, so that the next sync corrects them all. I don't mind these things sitting in vNext for a week. |
|
👋 🤖 🤔 Hello! 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. |
|
🧹 Preview environment for this PR has been torn down. |
This was referenced Oct 10, 2024
github-merge-queue bot
pushed a commit
to camunda/camunda
that referenced
this pull request
Oct 16, 2024
…cs (#23595) ## Description This PR addresses a few small C8 REST API spec issues, most of which were identified in camunda/camunda-docs#4427. There are a few extra changes that were identified from pattern-matching the issues in 4427. See camunda/camunda-docs#4427 for original conversation on these changes.
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/).