From 69375ba1d61560191f6ba4569f96d0794072a7e5 Mon Sep 17 00:00:00 2001 From: Ralf Puchert <49151958+ralfpuchert@users.noreply.github.com> Date: Fri, 25 Mar 2022 15:10:46 +0100 Subject: [PATCH] Update Operate and Tasklist docs (#705) * docs(operate): add migration requirement of ingest node Related with #641 * docs(operate): update graphql docs Related with #568 * docs(operate): add graphql schema file as link Related with #596 * docs(operate): move graphql schema in asset folder Related with #596 * docs(operate): use relative path Related with #596 * chore(htaccess): add graphqls mime type and workaround Co-authored-by: Sebastian Menski --- .../tasklist-api/assets/tasklist.graphqls | 119 ++++++++++++++++++ .../tasklist-api/directives/deprecated.mdx | 7 ++ .../tasklist-api/directives/include.mdx | 7 ++ .../tasklist-api/directives/skip.mdx | 7 ++ .../tasklist-api/directives/specified-by.mdx | 11 +- .../tasklist-api/enums/task-state.mdx | 21 +++- docs/apis-clients/tasklist-api/generated.md | 3 +- .../tasklist-api/inputs/task-query.mdx | 16 +++ .../tasklist-api/inputs/variable-input.mdx | 12 ++ .../tasklist-api/mutations/claim-task.mdx | 15 ++- .../tasklist-api/mutations/complete-task.mdx | 15 ++- .../mutations/delete-process-instance.mdx | 12 +- .../tasklist-api/mutations/unclaim-task.mdx | 12 +- .../tasklist-api/objects/form.mdx | 9 ++ .../tasklist-api/objects/task.mdx | 20 +++ .../tasklist-api/objects/user.mdx | 24 +++- .../tasklist-api/objects/variable.mdx | 15 +++ .../tasklist-api/queries/current-user.mdx | 9 +- .../tasklist-api/queries/form.mdx | 15 ++- .../tasklist-api/queries/task.mdx | 12 +- .../tasklist-api/queries/tasks.mdx | 12 +- .../tasklist-api/queries/variable.mdx | 12 +- .../tasklist-api/queries/variables.mdx | 15 ++- .../tasklist-api/scalars/boolean.mdx | 6 + docs/apis-clients/tasklist-api/scalars/id.mdx | 6 + .../apis-clients/tasklist-api/scalars/int.mdx | 6 + .../tasklist-api/scalars/string.mdx | 6 + .../tasklist-api/sidebar-schema.js | 10 +- .../schema-and-migration.md | 3 +- static/.htaccess | 4 +- 30 files changed, 412 insertions(+), 29 deletions(-) create mode 100644 docs/apis-clients/tasklist-api/assets/tasklist.graphqls diff --git a/docs/apis-clients/tasklist-api/assets/tasklist.graphqls b/docs/apis-clients/tasklist-api/assets/tasklist.graphqls new file mode 100644 index 00000000000..a6e7b119c29 --- /dev/null +++ b/docs/apis-clients/tasklist-api/assets/tasklist.graphqls @@ -0,0 +1,119 @@ +# Describes the User task. +type Task { + # The unique identifier of the task + id: ID! + # Name of the task + name: String! + # Task Definition ID (node BPMN id) of the process + taskDefinitionId: String! + # Name of the process + processName: String! + # When was the task created + creationTime: String! + # When was the task completed + completionTime: String + # Username/id of who is assigned to the task + assignee: String + # Variables associated to the task + variables: [Variable!] + # State of the task + taskState: TaskState! + # Array of values to be copied into `TaskQuery` to request for next or previous page of tasks. + sortValues: [String!] + # Flag to show that the task is first in current filter + isFirst: Boolean + # Reference to the task form + formKey: String + #Reference to process definition + processDefinitionId: String + #Candidate groups + candidateGroups: [String!] +} + +#Describes task embedded form +type Form { + #The unique identifier of the embedded form within one process + id: String! + #Reference to process definition + processDefinitionId: String! + #Form content + schema: String! +} + +#Task query - query to get one page of tasks. +input TaskQuery { + # State of the tasks + state: TaskState + # Are the tasks assigned? + assigned: Boolean + # Who is assigned to the tasks? + assignee: String + # given group is in candidate groups list + candidateGroup: String + #Size of tasks page (default: 50). + pageSize: Int + # Task definition ID - what's the BPMN flow node? + taskDefinitionId: String + #Array of values copied from `sortValues` of one of the tasks, query will return page of tasks going directly after this values plus same sort values. + searchAfter: [String!] + #Array of values copied from `sortValues` of one of the tasks, query will return page of tasks going directly after this values. + searchAfterOrEqual: [String!] + #Array of values copied from `sortValues` of one of the tasks, query will return page of tasks going directly before this values plus same sort values. + searchBefore: [String!] + #Array of values copied from `sortValues` of one of the tasks, query will return page of tasks going directly before this values. + searchBeforeOrEqual: [String!] +} +# State of the task. +enum TaskState { + CREATED, + COMPLETED, + CANCELED +} +# Variable used in task. +type Variable { + id: ID! + name: String! + # full variable value + value: String! + # value preview (limited in size) + previewValue: String! + # shows, whether previewValue contains truncated value or full value + isValueTruncated: Boolean! +} +# Change or add a variable with name and value. +input VariableInput { + name: String! + value: String! +} +# Describes the user. +type User { + userId: ID! + displayName: String + permissions: [String!] +} +# What can be searched for. +type Query { + # Get list of tasks based on `TaskQuery`. + tasks(query: TaskQuery!): [Task!]! + # Get one task by id. Returns task or error when task does not exist. + task(id: String!): Task! + # Get currently logged in user. + currentUser: User! + # Get task form by id and processDefinitionId + form(id: String!, processDefinitionId: String!): Form + # Get a collection of Variables by name + variables(taskId: String!, variableNames: [String!]!): [Variable!]! + # Get the variables by variable id + variable(id: String!): Variable! +} +# What can be changed. +type Mutation { + # Complete a task with taskId and optional variables. Returns the task. + completeTask(taskId: String!, variables: [VariableInput!]!): Task! + # Claim a task with taskId to currently logged in user. Returns the task. + claimTask(taskId: String!, assignee: String): Task! + # Unclaim a task with taskId. Returns the task. + unclaimTask(taskId: String!): Task! + # Delete process instance by given processInstanceId. Returns true if process instance could be deleted. + deleteProcessInstance(processInstanceId: String!): Boolean! +} diff --git a/docs/apis-clients/tasklist-api/directives/deprecated.mdx b/docs/apis-clients/tasklist-api/directives/deprecated.mdx index 6bd721320a5..190cee514ea 100644 --- a/docs/apis-clients/tasklist-api/directives/deprecated.mdx +++ b/docs/apis-clients/tasklist-api/directives/deprecated.mdx @@ -3,16 +3,23 @@ id: deprecated title: deprecated --- + Marks an element of a GraphQL schema as no longer supported. + ```graphql directive @deprecated( reason: String = "No longer supported" ) ``` + ### Arguments #### `reason` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) Explains why this element was deprecated, usually also including a suggestion for how to access supported similar data. Formatted using the Markdown syntax, as specified by [CommonMark](https://commonmark.org/). + + + + diff --git a/docs/apis-clients/tasklist-api/directives/include.mdx b/docs/apis-clients/tasklist-api/directives/include.mdx index 452fc94d959..314f66988ee 100644 --- a/docs/apis-clients/tasklist-api/directives/include.mdx +++ b/docs/apis-clients/tasklist-api/directives/include.mdx @@ -3,16 +3,23 @@ id: include title: include --- + Directs the executor to include this field or fragment only when the `if` argument is true. + ```graphql directive @include( if: Boolean! ) ``` + ### Arguments #### `if` ([`Boolean`](/docs/apis-clients/tasklist-api/scalars/boolean)) Included when true. + + + + diff --git a/docs/apis-clients/tasklist-api/directives/skip.mdx b/docs/apis-clients/tasklist-api/directives/skip.mdx index e290a53a6ee..7a3348bf0a1 100644 --- a/docs/apis-clients/tasklist-api/directives/skip.mdx +++ b/docs/apis-clients/tasklist-api/directives/skip.mdx @@ -3,16 +3,23 @@ id: skip title: skip --- + Directs the executor to skip this field or fragment when the `if` argument is true. + ```graphql directive @skip( if: Boolean! ) ``` + ### Arguments #### `if` ([`Boolean`](/docs/apis-clients/tasklist-api/scalars/boolean)) Skipped when true. + + + + diff --git a/docs/apis-clients/tasklist-api/directives/specified-by.mdx b/docs/apis-clients/tasklist-api/directives/specified-by.mdx index e85c5387696..829d6434076 100644 --- a/docs/apis-clients/tasklist-api/directives/specified-by.mdx +++ b/docs/apis-clients/tasklist-api/directives/specified-by.mdx @@ -3,7 +3,9 @@ id: specified-by title: specifiedBy --- -Exposes a URL that specifies the behaviour of this scalar. + +Exposes a URL that specifies the behavior of this scalar. + ```graphql directive @specifiedBy( @@ -11,8 +13,13 @@ directive @specifiedBy( ) ``` + ### Arguments #### `url` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) -The URL that specifies the behaviour of this scalar. +The URL that specifies the behavior of this scalar. + + + + diff --git a/docs/apis-clients/tasklist-api/enums/task-state.mdx b/docs/apis-clients/tasklist-api/enums/task-state.mdx index 48da39dfb0a..edc0350cfb5 100644 --- a/docs/apis-clients/tasklist-api/enums/task-state.mdx +++ b/docs/apis-clients/tasklist-api/enums/task-state.mdx @@ -3,8 +3,10 @@ id: task-state title: TaskState --- + State of the task. + ```graphql enum TaskState { CREATED @@ -13,10 +15,23 @@ enum TaskState { } ``` + ### Values -#### `CREATED` +#### `CREATED` + + + + +#### `COMPLETED` + + + + +#### `CANCELED` + + + + -#### `COMPLETED` -#### `CANCELED` diff --git a/docs/apis-clients/tasklist-api/generated.md b/docs/apis-clients/tasklist-api/generated.md index fe64962873c..d5ff1b7a334 100644 --- a/docs/apis-clients/tasklist-api/generated.md +++ b/docs/apis-clients/tasklist-api/generated.md @@ -6,10 +6,11 @@ sidebar_position: 1 --- This documentation has been automatically generated from the GraphQL schema. +GraphQL schema file to download: [tasklist.graphqls](./assets/tasklist.graphqls) Use the docs in the sidebar to find out how to use the schema: - **Allowed operations**: Queries and mutations. - **Schema-defined types**: Scalars, objects, enums, interfaces, unions, and input objects. -Generated on 12/16/2021, 5:19:28 PM. +Generated on 03/21/2022 diff --git a/docs/apis-clients/tasklist-api/inputs/task-query.mdx b/docs/apis-clients/tasklist-api/inputs/task-query.mdx index bbf9ebfbfa0..8cfc4eb2459 100644 --- a/docs/apis-clients/tasklist-api/inputs/task-query.mdx +++ b/docs/apis-clients/tasklist-api/inputs/task-query.mdx @@ -3,8 +3,10 @@ id: task-query title: TaskQuery --- + Task query - query to get one page of tasks. + ```graphql type TaskQuery { state: TaskState @@ -20,44 +22,58 @@ type TaskQuery { } ``` + ### Fields #### `state` ([`TaskState`](/docs/apis-clients/tasklist-api/enums/task-state)) State of the tasks + #### `assigned` ([`Boolean`](/docs/apis-clients/tasklist-api/scalars/boolean)) Are the tasks assigned? + #### `assignee` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) Who is assigned to the tasks? + #### `candidateGroup` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) given group is in candidate groups list + #### `pageSize` ([`Int`](/docs/apis-clients/tasklist-api/scalars/int)) Size of tasks page (default: 50). + #### `taskDefinitionId` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) Task definition ID - what's the BPMN flow node? + #### `searchAfter` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) Array of values copied from `sortValues` of one of the tasks, query will return page of tasks going directly after this values plus same sort values. + #### `searchAfterOrEqual` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) Array of values copied from `sortValues` of one of the tasks, query will return page of tasks going directly after this values. + #### `searchBefore` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) Array of values copied from `sortValues` of one of the tasks, query will return page of tasks going directly before this values plus same sort values. + #### `searchBeforeOrEqual` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) Array of values copied from `sortValues` of one of the tasks, query will return page of tasks going directly before this values. + + + + diff --git a/docs/apis-clients/tasklist-api/inputs/variable-input.mdx b/docs/apis-clients/tasklist-api/inputs/variable-input.mdx index e2c671827ab..5a7738a0d49 100644 --- a/docs/apis-clients/tasklist-api/inputs/variable-input.mdx +++ b/docs/apis-clients/tasklist-api/inputs/variable-input.mdx @@ -3,8 +3,10 @@ id: variable-input title: VariableInput --- + Change or add a variable with name and value. + ```graphql type VariableInput { name: String! @@ -12,8 +14,18 @@ type VariableInput { } ``` + ### Fields #### `name` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) + + + #### `value` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) + + + + + + diff --git a/docs/apis-clients/tasklist-api/mutations/claim-task.mdx b/docs/apis-clients/tasklist-api/mutations/claim-task.mdx index 6476b89feea..5aee65bf4ca 100644 --- a/docs/apis-clients/tasklist-api/mutations/claim-task.mdx +++ b/docs/apis-clients/tasklist-api/mutations/claim-task.mdx @@ -3,8 +3,10 @@ id: claim-task title: claimTask --- + Claim a task with taskId to currently logged in user. Returns the task. + ```graphql claimTask( taskId: String! @@ -13,14 +15,25 @@ claimTask( ``` + ### Arguments #### `taskId` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) + + + #### `assignee` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) + + + ### Type -#### [`Task`](/docs/apis-clients/tasklist-api/objects/task) +#### [`Task`](/docs/apis-clients/tasklist-api/objects/task) Describes the User task. + + + + diff --git a/docs/apis-clients/tasklist-api/mutations/complete-task.mdx b/docs/apis-clients/tasklist-api/mutations/complete-task.mdx index f641d33b420..2dda9ac90c3 100644 --- a/docs/apis-clients/tasklist-api/mutations/complete-task.mdx +++ b/docs/apis-clients/tasklist-api/mutations/complete-task.mdx @@ -3,8 +3,10 @@ id: complete-task title: completeTask --- + Complete a task with taskId and optional variables. Returns the task. + ```graphql completeTask( taskId: String! @@ -13,14 +15,25 @@ completeTask( ``` + ### Arguments #### `taskId` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) + + + #### `variables` ([`VariableInput`](/docs/apis-clients/tasklist-api/inputs/variable-input)) + + + ### Type -#### [`Task`](/docs/apis-clients/tasklist-api/objects/task) +#### [`Task`](/docs/apis-clients/tasklist-api/objects/task) Describes the User task. + + + + diff --git a/docs/apis-clients/tasklist-api/mutations/delete-process-instance.mdx b/docs/apis-clients/tasklist-api/mutations/delete-process-instance.mdx index bdd5686e3d4..3288c85f810 100644 --- a/docs/apis-clients/tasklist-api/mutations/delete-process-instance.mdx +++ b/docs/apis-clients/tasklist-api/mutations/delete-process-instance.mdx @@ -3,8 +3,10 @@ id: delete-process-instance title: deleteProcessInstance --- + Delete process instance by given processInstanceId. Returns true if process instance could be deleted. + ```graphql deleteProcessInstance( processInstanceId: String! @@ -12,12 +14,20 @@ deleteProcessInstance( ``` + ### Arguments #### `processInstanceId` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) + + + ### Type -#### [`Boolean`](/docs/apis-clients/tasklist-api/scalars/boolean) +#### [`Boolean`](/docs/apis-clients/tasklist-api/scalars/boolean) The `Boolean` scalar type represents `true` or `false`. + + + + diff --git a/docs/apis-clients/tasklist-api/mutations/unclaim-task.mdx b/docs/apis-clients/tasklist-api/mutations/unclaim-task.mdx index 30bb4f367a4..7c6514f9fd7 100644 --- a/docs/apis-clients/tasklist-api/mutations/unclaim-task.mdx +++ b/docs/apis-clients/tasklist-api/mutations/unclaim-task.mdx @@ -3,8 +3,10 @@ id: unclaim-task title: unclaimTask --- + Unclaim a task with taskId. Returns the task. + ```graphql unclaimTask( taskId: String! @@ -12,12 +14,20 @@ unclaimTask( ``` + ### Arguments #### `taskId` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) + + + ### Type -#### [`Task`](/docs/apis-clients/tasklist-api/objects/task) +#### [`Task`](/docs/apis-clients/tasklist-api/objects/task) Describes the User task. + + + + diff --git a/docs/apis-clients/tasklist-api/objects/form.mdx b/docs/apis-clients/tasklist-api/objects/form.mdx index da788e5d6f4..8b55f458acf 100644 --- a/docs/apis-clients/tasklist-api/objects/form.mdx +++ b/docs/apis-clients/tasklist-api/objects/form.mdx @@ -3,8 +3,10 @@ id: form title: Form --- + Describes task embedded form + ```graphql type Form { id: String! @@ -13,16 +15,23 @@ type Form { } ``` + ### Fields #### `id` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) The unique identifier of the embedded form within one process + #### `processDefinitionId` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) Reference to process definition + #### `schema` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) Form content + + + + diff --git a/docs/apis-clients/tasklist-api/objects/task.mdx b/docs/apis-clients/tasklist-api/objects/task.mdx index 94726ffe1f1..2a3d8e6cefc 100644 --- a/docs/apis-clients/tasklist-api/objects/task.mdx +++ b/docs/apis-clients/tasklist-api/objects/task.mdx @@ -3,8 +3,10 @@ id: task title: Task --- + Describes the User task. + ```graphql type Task { id: ID! @@ -24,60 +26,78 @@ type Task { } ``` + ### Fields #### `id` ([`ID`](/docs/apis-clients/tasklist-api/scalars/id)) The unique identifier of the task + #### `name` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) Name of the task + #### `taskDefinitionId` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) Task Definition ID (node BPMN id) of the process + #### `processName` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) Name of the process + #### `creationTime` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) When was the task created + #### `completionTime` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) When was the task completed + #### `assignee` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) Username/id of who is assigned to the task + #### `variables` ([`Variable`](/docs/apis-clients/tasklist-api/objects/variable)) Variables associated to the task + #### `taskState` ([`TaskState`](/docs/apis-clients/tasklist-api/enums/task-state)) State of the task + #### `sortValues` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) Array of values to be copied into `TaskQuery` to request for next or previous page of tasks. + #### `isFirst` ([`Boolean`](/docs/apis-clients/tasklist-api/scalars/boolean)) Flag to show that the task is first in current filter + #### `formKey` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) Reference to the task form + #### `processDefinitionId` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) Reference to process definition + #### `candidateGroups` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) Candidate groups + + + + diff --git a/docs/apis-clients/tasklist-api/objects/user.mdx b/docs/apis-clients/tasklist-api/objects/user.mdx index 73342dfbfc8..c00b8243b7a 100644 --- a/docs/apis-clients/tasklist-api/objects/user.mdx +++ b/docs/apis-clients/tasklist-api/objects/user.mdx @@ -3,23 +3,35 @@ id: user title: User --- + Describes the user. + ```graphql type User { - username: ID! - firstname: String - lastname: String + userId: ID! + displayName: String permissions: [String!] } ``` + ### Fields -#### `username` ([`ID`](/docs/apis-clients/tasklist-api/scalars/id)) +#### `userId` ([`ID`](/docs/apis-clients/tasklist-api/scalars/id)) + + + + +#### `displayName` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) + -#### `firstname` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) -#### `lastname` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) #### `permissions` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) + + + + + + diff --git a/docs/apis-clients/tasklist-api/objects/variable.mdx b/docs/apis-clients/tasklist-api/objects/variable.mdx index 6a499f58998..dc9ab26f69e 100644 --- a/docs/apis-clients/tasklist-api/objects/variable.mdx +++ b/docs/apis-clients/tasklist-api/objects/variable.mdx @@ -3,8 +3,10 @@ id: variable title: Variable --- + Variable used in task. + ```graphql type Variable { id: ID! @@ -15,20 +17,33 @@ type Variable { } ``` + ### Fields #### `id` ([`ID`](/docs/apis-clients/tasklist-api/scalars/id)) + + + #### `name` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) + + + #### `value` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) full variable value + #### `previewValue` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) value preview (limited in size) + #### `isValueTruncated` ([`Boolean`](/docs/apis-clients/tasklist-api/scalars/boolean)) shows, whether previewValue contains truncated value or full value + + + + diff --git a/docs/apis-clients/tasklist-api/queries/current-user.mdx b/docs/apis-clients/tasklist-api/queries/current-user.mdx index 2264f26b770..54580c75f91 100644 --- a/docs/apis-clients/tasklist-api/queries/current-user.mdx +++ b/docs/apis-clients/tasklist-api/queries/current-user.mdx @@ -3,15 +3,22 @@ id: current-user title: currentUser --- + Get currently logged in user. + ```graphql currentUser: User! ``` + ### Type -#### [`User`](/docs/apis-clients/tasklist-api/objects/user) +#### [`User`](/docs/apis-clients/tasklist-api/objects/user) Describes the user. + + + + diff --git a/docs/apis-clients/tasklist-api/queries/form.mdx b/docs/apis-clients/tasklist-api/queries/form.mdx index ebb5e65cba5..64bb3461ced 100644 --- a/docs/apis-clients/tasklist-api/queries/form.mdx +++ b/docs/apis-clients/tasklist-api/queries/form.mdx @@ -3,8 +3,10 @@ id: form title: form --- + Get task form by id and processDefinitionId + ```graphql form( id: String! @@ -13,14 +15,25 @@ form( ``` + ### Arguments #### `id` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) + + + #### `processDefinitionId` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) + + + ### Type -#### [`Form`](/docs/apis-clients/tasklist-api/objects/form) +#### [`Form`](/docs/apis-clients/tasklist-api/objects/form) Describes task embedded form + + + + diff --git a/docs/apis-clients/tasklist-api/queries/task.mdx b/docs/apis-clients/tasklist-api/queries/task.mdx index 2470d88dda1..5a7acce2fe9 100644 --- a/docs/apis-clients/tasklist-api/queries/task.mdx +++ b/docs/apis-clients/tasklist-api/queries/task.mdx @@ -3,8 +3,10 @@ id: task title: task --- + Get one task by id. Returns task or error when task does not exist. + ```graphql task( id: String! @@ -12,12 +14,20 @@ task( ``` + ### Arguments #### `id` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) + + + ### Type -#### [`Task`](/docs/apis-clients/tasklist-api/objects/task) +#### [`Task`](/docs/apis-clients/tasklist-api/objects/task) Describes the User task. + + + + diff --git a/docs/apis-clients/tasklist-api/queries/tasks.mdx b/docs/apis-clients/tasklist-api/queries/tasks.mdx index 19970c49106..c15a5bad249 100644 --- a/docs/apis-clients/tasklist-api/queries/tasks.mdx +++ b/docs/apis-clients/tasklist-api/queries/tasks.mdx @@ -3,8 +3,10 @@ id: tasks title: tasks --- + Get list of tasks based on `TaskQuery`. + ```graphql tasks( query: TaskQuery! @@ -12,12 +14,20 @@ tasks( ``` + ### Arguments #### `query` ([`TaskQuery`](/docs/apis-clients/tasklist-api/inputs/task-query)) + + + ### Type -#### [`Task`](/docs/apis-clients/tasklist-api/objects/task) +#### [`Task`](/docs/apis-clients/tasklist-api/objects/task) Describes the User task. + + + + diff --git a/docs/apis-clients/tasklist-api/queries/variable.mdx b/docs/apis-clients/tasklist-api/queries/variable.mdx index c1424856a1d..aa60851db8d 100644 --- a/docs/apis-clients/tasklist-api/queries/variable.mdx +++ b/docs/apis-clients/tasklist-api/queries/variable.mdx @@ -3,8 +3,10 @@ id: variable title: variable --- + Get the variables by variable id + ```graphql variable( id: String! @@ -12,12 +14,20 @@ variable( ``` + ### Arguments #### `id` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) + + + ### Type -#### [`Variable`](/docs/apis-clients/tasklist-api/objects/variable) +#### [`Variable`](/docs/apis-clients/tasklist-api/objects/variable) Variable used in task. + + + + diff --git a/docs/apis-clients/tasklist-api/queries/variables.mdx b/docs/apis-clients/tasklist-api/queries/variables.mdx index d0028ccc835..4615d8be48a 100644 --- a/docs/apis-clients/tasklist-api/queries/variables.mdx +++ b/docs/apis-clients/tasklist-api/queries/variables.mdx @@ -3,8 +3,10 @@ id: variables title: variables --- + Get a collection of Variables by name + ```graphql variables( taskId: String! @@ -13,14 +15,25 @@ variables( ``` + ### Arguments #### `taskId` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) + + + #### `variableNames` ([`String`](/docs/apis-clients/tasklist-api/scalars/string)) + + + ### Type -#### [`Variable`](/docs/apis-clients/tasklist-api/objects/variable) +#### [`Variable`](/docs/apis-clients/tasklist-api/objects/variable) Variable used in task. + + + + diff --git a/docs/apis-clients/tasklist-api/scalars/boolean.mdx b/docs/apis-clients/tasklist-api/scalars/boolean.mdx index cfd55e9b0f9..b6919140ad6 100644 --- a/docs/apis-clients/tasklist-api/scalars/boolean.mdx +++ b/docs/apis-clients/tasklist-api/scalars/boolean.mdx @@ -3,8 +3,14 @@ id: boolean title: Boolean --- + The `Boolean` scalar type represents `true` or `false`. + ```graphql scalar Boolean ``` + + + + diff --git a/docs/apis-clients/tasklist-api/scalars/id.mdx b/docs/apis-clients/tasklist-api/scalars/id.mdx index 7a6918eb044..3d0a65b99d3 100644 --- a/docs/apis-clients/tasklist-api/scalars/id.mdx +++ b/docs/apis-clients/tasklist-api/scalars/id.mdx @@ -3,8 +3,14 @@ id: id title: ID --- + The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"4"`) or integer (such as `4`) input value will be accepted as an ID. + ```graphql scalar ID ``` + + + + diff --git a/docs/apis-clients/tasklist-api/scalars/int.mdx b/docs/apis-clients/tasklist-api/scalars/int.mdx index 05c424ede47..aca3c60b877 100644 --- a/docs/apis-clients/tasklist-api/scalars/int.mdx +++ b/docs/apis-clients/tasklist-api/scalars/int.mdx @@ -3,8 +3,14 @@ id: int title: Int --- + The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1. + ```graphql scalar Int ``` + + + + diff --git a/docs/apis-clients/tasklist-api/scalars/string.mdx b/docs/apis-clients/tasklist-api/scalars/string.mdx index b93b73c1561..9599b729a47 100644 --- a/docs/apis-clients/tasklist-api/scalars/string.mdx +++ b/docs/apis-clients/tasklist-api/scalars/string.mdx @@ -3,8 +3,14 @@ id: string title: String --- + The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text. + ```graphql scalar String ``` + + + + diff --git a/docs/apis-clients/tasklist-api/sidebar-schema.js b/docs/apis-clients/tasklist-api/sidebar-schema.js index 083548f9eac..a39f06a060c 100644 --- a/docs/apis-clients/tasklist-api/sidebar-schema.js +++ b/docs/apis-clients/tasklist-api/sidebar-schema.js @@ -1,8 +1,8 @@ module.exports = { "Tasklist API (GraphQL)": [ { - type: "autogenerated", - dirName: "apis-clients/tasklist-api", - }, - ], -}; + "type": "autogenerated", + "dirName": "apis-clients/tasklist-api" + } + ] +}; \ No newline at end of file diff --git a/docs/self-managed/operate-deployment/schema-and-migration.md b/docs/self-managed/operate-deployment/schema-and-migration.md index 6d09673531e..5870ee766fb 100644 --- a/docs/self-managed/operate-deployment/schema-and-migration.md +++ b/docs/self-managed/operate-deployment/schema-and-migration.md @@ -35,7 +35,8 @@ The version of Operate is reflected in Elasticsearch object names (e.g. `operate ### Concept -The migration uses Elasticsearch [ingest pipelines](https://www.elastic.co/guide/en/elasticsearch/reference/7.12/ingest.html) to reindex the data. +The migration uses Elasticsearch [ingest pipelines](https://www.elastic.co/guide/en/elasticsearch/reference/7.16/ingest.html) to reindex the data. +Please ensure that your Elasticsearch cluster has at least one node with the ingest role, as described [here](https://www.elastic.co/guide/en/elasticsearch/reference/7.16/ingest.html#ingest-prerequisites). Each version of Operate delivers a set of migration steps which need to be applied for a corresponding version of Operate. diff --git a/static/.htaccess b/static/.htaccess index 4fb2350e390..aee0bd92d11 100644 --- a/static/.htaccess +++ b/static/.htaccess @@ -90,7 +90,7 @@ RewriteRule ^docs/components/modeler/desktop-modeler/element-templates/?$ /docs/ RewriteRule ^docs/components/modeler/desktop-modeler/?$ /docs/components/modeler/desktop-modeler/install-the-modeler/ [R=301,L] # workaround for 404 with trailing slashes https://github.com/camunda-cloud/camunda-cloud-documentation/issues/403 -RewriteRule ^(.*\.(yaml|bpmn|xml|png|jpeg|jpg|yml|svg))/$ /$1 [R=301,L] +RewriteRule ^(.*\.(yaml|bpmn|xml|png|jpeg|jpg|yml|svg|graphqls))/$ /$1 [R=301,L] # Replaced deprecated java-client/testing page with java-client/zeebe-process-test page RewriteRule ^docs/apis-clients/java-client/testing(.*)$ /docs/apis-clients/java-client/zeebe-process-test$1 [R=301,L] @@ -123,3 +123,5 @@ RewriteRule ^docs/components/best-practices/?$ /docs/components/best-practices/o AddType text/vnd.yaml yaml # Add bpmn mime type AddType text/xml bpmn +# Add graphql scheme mime type +AddType text/plain graphqls