Skip to content

Commit

Permalink
style(formatting): adjust casing
Browse files Browse the repository at this point in the history
  • Loading branch information
@christinaausley @panagiotisgts
christinaausley authored and panagiotisgts committed Aug 26, 2024
1 parent 388636a commit 45b9e61
Show file tree
Hide file tree
Showing 10 changed files with 20 additions and 20 deletions.
6 changes: 3 additions & 3 deletions api/camunda/camunda-openapi.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down
10 changes: 5 additions & 5 deletions api/tasklist/tasklist-openapi.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand All @@ -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.
Expand Down Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions ...pis-tools/camunda-api-rest/specifications/query-user-tasks-experimental.api.mdx
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/apis-tools/tasklist-api-rest/schemas/responses/task-response.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ TaskResponse - represents a user task.
#### [<code style={{ fontWeight: 'normal' }}>TaskResponse.<b>taskDefinitionId</b></code>](#)<Bullet />`string` <Badge class="secondary" text="non-null"/>

> User Task ID from the BPMN definition
> User task ID from the BPMN definition
#### [<code style={{ fontWeight: 'normal' }}>TaskResponse.<b>processName</b></code>](#)<Bullet />`string` <Badge class="secondary" text="non-null"/>

Expand Down
2 changes: 1 addition & 1 deletion docs/apis-tools/tasklist-api-rest/schemas/responses/task-search-response.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ TaskSearchResponse - representing the searched task.
#### [<code style={{ fontWeight: 'normal' }}>TaskSearchResponse.<b>taskDefinitionId</b></code>](#)<Bullet />`string` <Badge class="secondary" text="non-null"/>

> User Task ID from the BPMN definition
> User task ID from the BPMN definition
#### [<code style={{ fontWeight: 'normal' }}>TaskSearchResponse.<b>processName</b></code>](#)<Bullet />`string` <Badge class="secondary" text="non-null"/>

Expand Down
2 changes: 1 addition & 1 deletion docs/apis-tools/tasklist-api-rest/specifications/assign-task.api.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ When using REST API with JWT authentication token following request body paramet

On success returned.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The unique identifier of the task."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the task."}}></SchemaItem><SchemaItem collapsible={false} name={"taskDefinitionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"User Task ID from the BPMN definition."}}></SchemaItem><SchemaItem collapsible={false} name={"processName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the process."}}></SchemaItem><SchemaItem collapsible={false} name={"creationDate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"When was the task created (renamed equivalent of `Task.creationTime` field)."}}></SchemaItem><SchemaItem collapsible={false} name={"completionDate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"When was the task completed (renamed equivalent of `Task.completionTime` field)."}}></SchemaItem><SchemaItem collapsible={false} name={"assignee"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The username/id of who is assigned to the task."}}></SchemaItem><SchemaItem collapsible={false} name={"taskState"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`CREATED`, `COMPLETED`, `CANCELED`, `FAILED`]"} schema={{"type":"string","description":"The state of the task.","readOnly":true,"enum":["CREATED","COMPLETED","CANCELED","FAILED"]}}></SchemaItem><SchemaItem collapsible={false} name={"formKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Reference to the task form."}}></SchemaItem><SchemaItem collapsible={false} name={"formId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Reference to the ID of a deployed form. If the form is not deployed, this property is null."}}></SchemaItem><SchemaItem collapsible={false} name={"formVersion"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","description":"Reference to the version of a deployed form. If the form is not deployed, this property is null.","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"isFormEmbedded"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Is the form embedded for this task? If there is no form, this property is null."}}></SchemaItem><SchemaItem collapsible={false} name={"processDefinitionKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Reference to process definition (renamed equivalent of `Task.processDefinitionId` field)."}}></SchemaItem><SchemaItem collapsible={false} name={"processInstanceKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Reference to process instance id (renamed equivalent of `Task.processInstanceId` field)."}}></SchemaItem><SchemaItem collapsible={false} name={"tenantId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The tenant ID associated with the task."}}></SchemaItem><SchemaItem collapsible={false} name={"dueDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"The due date for the task.","format":"date-time"}}></SchemaItem><SchemaItem collapsible={false} name={"followUpDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"The follow-up date for the task.","format":"date-time"}}></SchemaItem><SchemaItem collapsible={false} name={"candidateGroups"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"The candidate groups for the task.","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"candidateUsers"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"The candidate users for the task.","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"implementation"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`JOB_WORKER`, `ZEEBE_USER_TASK`]"} schema={{"type":"string","enum":["JOB_WORKER","ZEEBE_USER_TASK"]}}></SchemaItem><SchemaItem collapsible={false} name={"priority"} required={false} schemaName={"integer"} qualifierMessage={"**Possible values:** `[0,100]`"} schema={{"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,"default":50}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"string\",\n \"name\": \"string\",\n \"taskDefinitionId\": \"string\",\n \"processName\": \"string\",\n \"creationDate\": \"string\",\n \"completionDate\": \"string\",\n \"assignee\": \"string\",\n \"taskState\": \"CREATED\",\n \"formKey\": \"string\",\n \"formId\": \"string\",\n \"formVersion\": 0,\n \"isFormEmbedded\": true,\n \"processDefinitionKey\": \"string\",\n \"processInstanceKey\": \"string\",\n \"tenantId\": \"string\",\n \"dueDate\": \"2024-08-16T13:54:01.392Z\",\n \"followUpDate\": \"2024-08-16T13:54:01.392Z\",\n \"candidateGroups\": [\n \"string\"\n ],\n \"candidateUsers\": [\n \"string\"\n ],\n \"implementation\": \"JOB_WORKER\",\n \"priority\": 50\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The unique identifier of the task."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the task."}}></SchemaItem><SchemaItem collapsible={false} name={"taskDefinitionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"User task ID from the BPMN definition."}}></SchemaItem><SchemaItem collapsible={false} name={"processName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the process."}}></SchemaItem><SchemaItem collapsible={false} name={"creationDate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"When was the task created (renamed equivalent of `Task.creationTime` field)."}}></SchemaItem><SchemaItem collapsible={false} name={"completionDate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"When was the task completed (renamed equivalent of `Task.completionTime` field)."}}></SchemaItem><SchemaItem collapsible={false} name={"assignee"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The username/id of who is assigned to the task."}}></SchemaItem><SchemaItem collapsible={false} name={"taskState"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`CREATED`, `COMPLETED`, `CANCELED`, `FAILED`]"} schema={{"type":"string","description":"The state of the task.","readOnly":true,"enum":["CREATED","COMPLETED","CANCELED","FAILED"]}}></SchemaItem><SchemaItem collapsible={false} name={"formKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Reference to the task form."}}></SchemaItem><SchemaItem collapsible={false} name={"formId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Reference to the ID of a deployed form. If the form is not deployed, this property is null."}}></SchemaItem><SchemaItem collapsible={false} name={"formVersion"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","description":"Reference to the version of a deployed form. If the form is not deployed, this property is null.","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"isFormEmbedded"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Is the form embedded for this task? If there is no form, this property is null."}}></SchemaItem><SchemaItem collapsible={false} name={"processDefinitionKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Reference to process definition (renamed equivalent of `Task.processDefinitionId` field)."}}></SchemaItem><SchemaItem collapsible={false} name={"processInstanceKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Reference to process instance id (renamed equivalent of `Task.processInstanceId` field)."}}></SchemaItem><SchemaItem collapsible={false} name={"tenantId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The tenant ID associated with the task."}}></SchemaItem><SchemaItem collapsible={false} name={"dueDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"The due date for the task.","format":"date-time"}}></SchemaItem><SchemaItem collapsible={false} name={"followUpDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"The follow-up date for the task.","format":"date-time"}}></SchemaItem><SchemaItem collapsible={false} name={"candidateGroups"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"The candidate groups for the task.","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"candidateUsers"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"The candidate users for the task.","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"implementation"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`JOB_WORKER`, `ZEEBE_USER_TASK`]"} schema={{"type":"string","enum":["JOB_WORKER","ZEEBE_USER_TASK"]}}></SchemaItem><SchemaItem collapsible={false} name={"priority"} required={false} schemaName={"integer"} qualifierMessage={"**Possible values:** `[0,100]`"} schema={{"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,"default":50}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"string\",\n \"name\": \"string\",\n \"taskDefinitionId\": \"string\",\n \"processName\": \"string\",\n \"creationDate\": \"string\",\n \"completionDate\": \"string\",\n \"assignee\": \"string\",\n \"taskState\": \"CREATED\",\n \"formKey\": \"string\",\n \"formId\": \"string\",\n \"formVersion\": 0,\n \"isFormEmbedded\": true,\n \"processDefinitionKey\": \"string\",\n \"processInstanceKey\": \"string\",\n \"tenantId\": \"string\",\n \"dueDate\": \"2024-08-16T13:54:01.392Z\",\n \"followUpDate\": \"2024-08-16T13:54:01.392Z\",\n \"candidateGroups\": [\n \"string\"\n ],\n \"candidateUsers\": [\n \"string\"\n ],\n \"implementation\": \"JOB_WORKER\",\n \"priority\": 50\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

An error is returned when the task is not active (not in the CREATED state).<br/>An error is returned when task was already assigned, except the case when JWT authentication token used and `allowOverrideAssignment = true`.

Expand Down
Loading

0 comments on commit 45b9e61

Please sign in to comment.