Merge branch 'main' into remove-OSS-section

camunda · Jul 11, 2023 · 36d9f97 · 36d9f97
2 parents b3e3461 + e04819b
commit 36d9f97
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 28 deletions.
diff --git a/docs/apis-tools/tasklist-api-rest/tasklist-api-rest-overview.md b/docs/apis-tools/tasklist-api-rest/tasklist-api-rest-overview.md
@@ -12,20 +12,23 @@ Requests and responses are in JSON notation. Some objects have additional endpoi
 
 ## API documentation as Swagger
 
-A detailed API description is also available as Swagger UI at `https://${base-url}/swagger-ui/index.html`. For SaaS: `https://${REGION}.tasklist.camunda.io:443/${CLUSTER_ID}/swagger-ui/index.html`, and for Self-Managed installations: `http://localhost:8080/swagger-ui/index.html`.
+A detailed API description is also available as Swagger UI at `https://${base-url}/swagger-ui/index.html`.<br/>
+For SaaS: `https://${REGION}.tasklist.camunda.io:443/${CLUSTER_ID}/swagger-ui/index.html`,<br/>
+and for Self-Managed installations: [`http://localhost:8080/swagger-ui/index.html`](http://localhost:8080/swagger-ui/index.html).
 
 ## Endpoints
 
-| Endpoint (HTTP verb + URL path) | Description |
-| :----------------------------------------- | ----------------------------------------------------------------------------: |
-| **Tasks** | |
-| `GET /v1/tasks/{taskId}` | Return a task by taskId. |
-| `POST /v1/tasks/search` | Returns the list of tasks that satisfy search request params. |
-| `POST /v1/tasks/{taskId}/variables/search` | Returns a list of task variables for the specified taskId and variableName. |
-| `PATCH /v1/tasks/{taskId}/assign` | Assign a task with `taskId` to `assignee` or the active user. |
-| `PATCH /v1/tasks/{taskId}/unassign` | Unassign a task with provided `taskId`. |
-| `PATCH /v1/tasks/{taskId}/complete` | Complete a task with taskId and optional variables. |
-| **Forms** | |
-| `POST /v1/forms/{formId}` | Get the form details by formId and processDefinitionKey required query param. |
-| **Variables** | |
-| `POST /v1/variables/{variableId}` | Get the variable details by variable id. |
+| Endpoint (HTTP verb + URL path) | Description |
+| :-------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------: |
+| **Tasks** | |
+| [`GET /v1/tasks/{taskId}`](/apis-tools/tasklist-api-rest/controllers/tasklist-api-rest-task-controller.md#get-task) | Return a task by `taskId`. |
+| [`POST /v1/tasks/search`](/apis-tools/tasklist-api-rest/controllers/tasklist-api-rest-task-controller.md#search-tasks) | Returns the list of tasks that satisfy search request params. |
+| [`POST /v1/tasks/{taskId}/variables`](/apis-tools/tasklist-api-rest/controllers/tasklist-api-rest-task-controller.md#save-draft-task-variables) | Saves draft variables for a specific task. |
+| [`POST /v1/tasks/{taskId}/variables/search`](/apis-tools/tasklist-api-rest/controllers/tasklist-api-rest-task-controller.md#search-task-variables) | Returns a list of task variables for the specified `taskId` and `variableNames`. |
+| [`PATCH /v1/tasks/{taskId}/assign`](/apis-tools/tasklist-api-rest/controllers/tasklist-api-rest-task-controller.md#assign-task) | Assign a task with `taskId` to `assignee` or the active user. |
+| [`PATCH /v1/tasks/{taskId}/unassign`](/apis-tools/tasklist-api-rest/controllers/tasklist-api-rest-task-controller.md#unassign-task) | Unassign a task with provided `taskId`. |
+| [`PATCH /v1/tasks/{taskId}/complete`](/apis-tools/tasklist-api-rest/controllers/tasklist-api-rest-task-controller.md#complete-task) | Complete a task with `taskId` and optional variables. |
+| **Forms** | |
+| [`GET /v1/forms/{formId}?processDefinitionKey={processDefinitionKey}`](/apis-tools/tasklist-api-rest/controllers/tasklist-api-rest-form-controller.md#get-form) | Get the form details by `formId` and `processDefinitionKey` required query param. |
+| **Variables** | |
+| [`GET /v1/variables/{variableId}`](/apis-tools/tasklist-api-rest/controllers/tasklist-api-rest-variables-controller.md#get-variable) | Get the variable details by `variableId`. |
diff --git a/...ned_docs/version-8.2/apis-tools/tasklist-api-rest/tasklist-api-rest-overview.md b/...ned_docs/version-8.2/apis-tools/tasklist-api-rest/tasklist-api-rest-overview.md
@@ -12,20 +12,22 @@ Requests and responses are in JSON notation. Some objects have additional endpoi
 
 ## API documentation as Swagger
 
-A detailed API description is also available as Swagger UI at `https://${base-url}/swagger-ui/index.html`.
+A detailed API description is also available as Swagger UI at `https://${base-url}/swagger-ui/index.html`.<br/>
+For SaaS: `https://${REGION}.tasklist.camunda.io:443/${CLUSTER_ID}/swagger-ui/index.html`,<br/>
+and for Self-Managed installations: [`http://localhost:8080/swagger-ui/index.html`](http://localhost:8080/swagger-ui/index.html).
 
 ## Endpoints
 
-| Endpoint (HTTP verb + URL path) | Description |
-| :----------------------------------------- | ----------------------------------------------------------------------------: |
-| **Tasks** | |
-| `GET /v1/tasks/{taskId}` | Return a task by taskId. |
-| `POST /v1/tasks/search` | Returns the list of tasks that satisfy search request params. |
-| `POST /v1/tasks/{taskId}/variables/search` | Returns a list of task variables for the specified taskId and variableName. |
-| `PATCH /v1/tasks/{taskId}/assign` | Assign a task with `taskId` to `assignee` or the active user. |
-| `PATCH /v1/tasks/{taskId}/unassign` | Unassign a task with provided `taskId`. |
-| `PATCH /v1/tasks/{taskId}/complete` | Complete a task with taskId and optional variables. |
-| **Forms** | |
-| `POST /v1/forms/{formId}` | Get the form details by formId and processDefinitionKey required query param. |
-| **Variables** | |
-| `POST /v1/variables/{variableId}` | Get the variable details by variable id. |
+| Endpoint (HTTP verb + URL path)  |  Description |
+| :-------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------: |
+| **Tasks**  |  |
+| [`GET /v1/tasks/{taskId}`](/apis-tools/tasklist-api-rest/controllers/tasklist-api-rest-task-controller.md#get-task)  |  Return a task by `taskId`. |
+| [`POST /v1/tasks/search`](/apis-tools/tasklist-api-rest/controllers/tasklist-api-rest-task-controller.md#search-tasks)  |  Returns the list of tasks that satisfy search request params. |
+| [`POST /v1/tasks/{taskId}/variables/search`](/apis-tools/tasklist-api-rest/controllers/tasklist-api-rest-task-controller.md#search-task-variables)   | Returns a list of task variables for the specified `taskId` and `variableNames.` |
+| [`PATCH /v1/tasks/{taskId}/assign`](/apis-tools/tasklist-api-rest/controllers/tasklist-api-rest-task-controller.md#assign-task)  |  Assign a task with `taskId` to `assignee` or the active user. |
+| [`PATCH /v1/tasks/{taskId}/unassign`](/apis-tools/tasklist-api-rest/controllers/tasklist-api-rest-task-controller.md#unassign-task)  |  Unassign a task with provided `taskId`. |
+| [`PATCH /v1/tasks/{taskId}/complete`](/apis-tools/tasklist-api-rest/controllers/tasklist-api-rest-task-controller.md#complete-task)  |  Complete a task with `taskId` and optional variables. |
+| **Forms**  |  |
+| [`GET /v1/forms/{formId}?processDefinitionKey={processDefinitionKey}`](/apis-tools/tasklist-api-rest/controllers/tasklist-api-rest-form-controller.md#get-form) | Get the form details by `formId` and `processDefinitionKey` required query param. |
+| **Variables**  |  |
+| [`GET /v1/variables/{variableId}`](/apis-tools/tasklist-api-rest/controllers/tasklist-api-rest-variables-controller.md#get-variable)  |  Get the variable details by `variableId`. |