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 <[email protected]>
camunda · Mar 25, 2022 · 69375ba · 69375ba
1 parent cb7b028
commit 69375ba
Show file tree

Hide file tree

Showing 30 changed files with 412 additions and 29 deletions.
diff --git a/docs/apis-clients/tasklist-api/assets/tasklist.graphqls 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
@@ -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
@@ -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
@@ -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
@@ -3,16 +3,23 @@ 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(
   url: String!
 )
 ```
 
+
 ### 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
@@ -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
@@ -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.
 
-<small><i>Generated on 12/16/2021, 5:19:28 PM.</i></small>
+<small><i>Generated on 03/21/2022</i></small>
diff --git 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
@@ -3,17 +3,29 @@ id: variable-input
 title: VariableInput
 ---
 
+
 Change or add a variable with name and value.
 
+
 ```graphql
 type VariableInput {
   name: String!
   value: String!
 }
 ```
 
+
 ### Fields
 
 #### `name` ([`String`](/docs/apis-clients/tasklist-api/scalars/string))
 
+
+
+
 #### `value` ([`String`](/docs/apis-clients/tasklist-api/scalars/string))
+
+
+
+
+
+