diff --git a/api/camunda/camunda-openapi.yaml b/api/camunda/camunda-openapi.yaml index 62758042dbe..24a937dac63 100644 --- a/api/camunda/camunda-openapi.yaml +++ b/api/camunda/camunda-openapi.yaml @@ -557,14 +557,14 @@ paths: responses: "200": description: > - The User Task Search successful response. + The user task search successful response. content: application/json: schema: $ref: "#/components/schemas/UserTaskSearchQueryResponse" "400": description: > - The User Task Search Query failed. + The user task search query failed. More details are provided in the response body. content: application/problem+json: @@ -894,7 +894,7 @@ components: type: string priority: type: integer - description: The priority of a User Task. The higher the value the higher the priority. + description: The priority of a user task. The higher the value the higher the priority. minimum: 0 maximum: 100 default: 50 diff --git a/api/tasklist/tasklist-openapi.yaml b/api/tasklist/tasklist-openapi.yaml index 2aa8d90a39a..32ee7c05dfd 100644 --- a/api/tasklist/tasklist-openapi.yaml +++ b/api/tasklist/tasklist-openapi.yaml @@ -725,7 +725,7 @@ components: - JOB_WORKER - ZEEBE_USER_TASK priority: - description: Rules to filter out Tasks by their priority. Applicable only for Zeebe User Tasks. + description: Rules to filter out tasks by their priority. Applicable only for Zeebe user tasks. type: object properties: eq: @@ -760,7 +760,7 @@ components: description: The name of the task. taskDefinitionId: type: string - description: User Task ID from the BPMN definition. + description: User task ID from the BPMN definition. processName: type: string description: The name of the process. @@ -859,7 +859,7 @@ components: - JOB_WORKER - ZEEBE_USER_TASK priority: - description: The priority of a User Task. The higher the value the higher the priority. Applicable only for Zeebe User Tasks. + description: The priority of a user task. The higher the value the higher the priority. Applicable only for Zeebe user tasks. type: integer minimum: 0 maximum: 100 @@ -875,7 +875,7 @@ components: description: The name of the task. taskDefinitionId: type: string - description: User Task ID from the BPMN definition. + description: User task ID from the BPMN definition. processName: type: string description: The name of the process. @@ -957,7 +957,7 @@ components: - JOB_WORKER - ZEEBE_USER_TASK priority: - description: The priority of a User Task. The higher the value the higher the priority. Applicable only for Zeebe User Tasks. + description: The priority of a user task. The higher the value the higher the priority. Applicable only for Zeebe user tasks. type: integer minimum: 0 maximum: 100 diff --git a/docs/apis-tools/camunda-api-rest/specifications/query-user-tasks-experimental.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/query-user-tasks-experimental.api.mdx index fd361b1082c..80c1f60b1be 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/query-user-tasks-experimental.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/query-user-tasks-experimental.api.mdx @@ -45,11 +45,11 @@ User task filter request.
priority object
-The User Task Search successful response. +The user task search successful response. -
Schema
    page object
    items object[]
  • Array [
  • customHeaders object
  • ]
+
Schema
    page object
    items object[]
  • Array [
  • customHeaders object
  • ]
-The User Task Search Query failed. More details are provided in the response body. +The user task search query failed. More details are provided in the response body.
Schema
    = 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}>
diff --git a/docs/apis-tools/tasklist-api-rest/schemas/responses/task-response.mdx b/docs/apis-tools/tasklist-api-rest/schemas/responses/task-response.mdx index e36b7e4b5e5..7a2c8ac4a8c 100644 --- a/docs/apis-tools/tasklist-api-rest/schemas/responses/task-response.mdx +++ b/docs/apis-tools/tasklist-api-rest/schemas/responses/task-response.mdx @@ -119,7 +119,7 @@ TaskResponse - represents a user task. #### [TaskResponse.taskDefinitionId](#)`string` -> User Task ID from the BPMN definition +> User task ID from the BPMN definition #### [TaskResponse.processName](#)`string` diff --git a/docs/apis-tools/tasklist-api-rest/schemas/responses/task-search-response.mdx b/docs/apis-tools/tasklist-api-rest/schemas/responses/task-search-response.mdx index ab76142dca4..b466ec57832 100644 --- a/docs/apis-tools/tasklist-api-rest/schemas/responses/task-search-response.mdx +++ b/docs/apis-tools/tasklist-api-rest/schemas/responses/task-search-response.mdx @@ -129,7 +129,7 @@ TaskSearchResponse - representing the searched task. #### [TaskSearchResponse.taskDefinitionId](#)`string` -> User Task ID from the BPMN definition +> User task ID from the BPMN definition #### [TaskSearchResponse.processName](#)`string` diff --git a/docs/apis-tools/tasklist-api-rest/specifications/assign-task.api.mdx b/docs/apis-tools/tasklist-api-rest/specifications/assign-task.api.mdx index e8a5c1624fb..14546a99a99 100644 --- a/docs/apis-tools/tasklist-api-rest/specifications/assign-task.api.mdx +++ b/docs/apis-tools/tasklist-api-rest/specifications/assign-task.api.mdx @@ -44,7 +44,7 @@ When using REST API with JWT authentication token following request body paramet On success returned. -
Schema
+
Schema
An error is returned when the task is not active (not in the CREATED state).
An error is returned when task was already assigned, except the case when JWT authentication token used and `allowOverrideAssignment = true`. diff --git a/docs/apis-tools/tasklist-api-rest/specifications/complete-task.api.mdx b/docs/apis-tools/tasklist-api-rest/specifications/complete-task.api.mdx index b243d97d9e9..1f4e3b31ea8 100644 --- a/docs/apis-tools/tasklist-api-rest/specifications/complete-task.api.mdx +++ b/docs/apis-tools/tasklist-api-rest/specifications/complete-task.api.mdx @@ -44,7 +44,7 @@ Variables to update or add to task during the task completion On success returned. -
Schema
+
Schema
An error is returned when the task is not active (not in the CREATED state).
An error is returned if the task was not claimed (assigned) before.
An error is returned if the task is not assigned to the current user. diff --git a/docs/apis-tools/tasklist-api-rest/specifications/get-task-by-id.api.mdx b/docs/apis-tools/tasklist-api-rest/specifications/get-task-by-id.api.mdx index 1588fb7bf93..c9ba57ae4b2 100644 --- a/docs/apis-tools/tasklist-api-rest/specifications/get-task-by-id.api.mdx +++ b/docs/apis-tools/tasklist-api-rest/specifications/get-task-by-id.api.mdx @@ -37,7 +37,7 @@ Get one task by id. Returns task or error when task does not exist. On success returned. -
Schema
+
Schema
User has no permission to access the task (Self-managed only). diff --git a/docs/apis-tools/tasklist-api-rest/specifications/search-tasks.api.mdx b/docs/apis-tools/tasklist-api-rest/specifications/search-tasks.api.mdx index 25c90187dab..b4d862e180d 100644 --- a/docs/apis-tools/tasklist-api-rest/specifications/search-tasks.api.mdx +++ b/docs/apis-tools/tasklist-api-rest/specifications/search-tasks.api.mdx @@ -55,13 +55,13 @@ An array used to specify a list of variable names that should be included in the
  • Array [
  • ]
  • priority object
    -Rules to filter out Tasks by their priority. Applicable only for Zeebe User Tasks. +Rules to filter out tasks by their priority. Applicable only for Zeebe user tasks.
    On success returned. -
    Schema
    • Array [
    • variables object[]
      +
      Schema
      • Array [
      • variables object[]
        An array of the task's variables. Only variables specified in `TaskSearchRequest.includeVariables` are returned. Note that a variable's draft value is not returned in `TaskSearchResponse`. @@ -69,7 +69,7 @@ An array of the task's variables. Only variables specified in `TaskSearchRequest The draft value of the variable. -
      • ]
    • ]
    +
  • ]
  • ]
  • An error is returned when more than one search parameters among `[searchAfter, searchAfterOrEqual, searchBefore, searchBeforeOrEqual]` are present in request diff --git a/docs/apis-tools/tasklist-api-rest/specifications/unassign-task.api.mdx b/docs/apis-tools/tasklist-api-rest/specifications/unassign-task.api.mdx index 8581e3ab9cf..2ecc8512e03 100644 --- a/docs/apis-tools/tasklist-api-rest/specifications/unassign-task.api.mdx +++ b/docs/apis-tools/tasklist-api-rest/specifications/unassign-task.api.mdx @@ -40,7 +40,7 @@ Unassign a task with `taskId`. Returns the task. On success returned. -
    Schema
    +
    Schema
    An error is returned when the task is not active (not in the CREATED state).
    An error is returned if the task was not claimed (assigned) before.