Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: include priority field in camunda and tasklist API definitions #4178

Merged
merged 2 commits into from
Aug 27, 2024

Conversation

panagiotisgts
Copy link
Contributor

Description

Tasklist & Camunda API changes to include the added User Task Priority field epic.

Changes Preview

Camunda API


Camunda API - Query User Tasks (experimental) Request

image

Camunda API - Query User Tasks (experimental) Response

image

Camunda API - Update User Task Body

image

Tasklist API


All response items containing the whole User Task should include the priority field as in the provided response object.

Tasklist API - Search User Tasks Request

image

Tasklist API - Search User Tasks Response

image

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@panagiotisgts panagiotisgts added component:zeebe Issues related with Zeebe project component:tasklist Issues related with Tasklist project 8.6.0-alpha5 September 2024 alpha release labels Aug 21, 2024
@panagiotisgts panagiotisgts requested a review from a team August 21, 2024 10:59
Copy link
Contributor

github-actions bot commented Aug 21, 2024

👋 🤖 🤔 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.5/.

  • docs/apis-tools/camunda-api-rest/specifications/get-cluster-topology.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/query-user-tasks-experimental.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/update-user-task.api.mdx
  • docs/apis-tools/tasklist-api-rest/schemas/enums/task-sort-fields.mdx
  • docs/apis-tools/tasklist-api-rest/schemas/requests/task-search-request.mdx
  • docs/apis-tools/tasklist-api-rest/schemas/responses/task-response.mdx
  • docs/apis-tools/tasklist-api-rest/schemas/responses/task-search-response.mdx
  • docs/apis-tools/tasklist-api-rest/specifications/assign-task.api.mdx
  • docs/apis-tools/tasklist-api-rest/specifications/complete-task.api.mdx
  • docs/apis-tools/tasklist-api-rest/specifications/get-form.api.mdx
  • docs/apis-tools/tasklist-api-rest/specifications/get-task-by-id.api.mdx
  • docs/apis-tools/tasklist-api-rest/specifications/get-variable-by-id.api.mdx
  • docs/apis-tools/tasklist-api-rest/specifications/save-draft-task-variables.api.mdx
  • docs/apis-tools/tasklist-api-rest/specifications/search-task-variables.api.mdx
  • docs/apis-tools/tasklist-api-rest/specifications/search-tasks.api.mdx
  • docs/apis-tools/tasklist-api-rest/specifications/unassign-task.api.mdx

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.

Copy link
Contributor

@marcosgvieira marcosgvieira left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@panagiotisgts panagiotisgts merged commit 7467b5e into main Aug 27, 2024
7 checks passed
@panagiotisgts panagiotisgts deleted the zeebe-user-task-priority branch August 27, 2024 10:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8.6.0-alpha5 September 2024 alpha release component:tasklist Issues related with Tasklist project component:zeebe Issues related with Zeebe project
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

3 participants