Skip to content

Commit

Permalink
docs: update REST API spec
Browse files Browse the repository at this point in the history
  • Loading branch information
@tmetzke
tmetzke authored Dec 13, 2024
1 parent 2e3e444 commit 3d2ad74
Show file tree
Hide file tree
Showing 16 changed files with 37 additions and 33 deletions.
24 changes: 14 additions & 10 deletions api/camunda/camunda-openapi.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4945,55 +4945,59 @@ components:
description: The ID of the user.
type: "string"
userKey:
description: The system generated key of the User
description: The system generated key of the user.
type: "integer"
format: "int64"
displayName:
description: The display name of the User
description: The display name of the user.
type: "string"
authorizedApplications:
description: The applications the User is authorized to use
description: The applications the user is authorized to use.
type: array
items:
type: "string"
tenants:
description: The tenants the User is a member of
description: The tenants the user is a member of.
type: array
items:
type: "object"
properties:
tenantId:
type: "string"
description: The ID of the tenant.
name:
type: "string"
description: The name of the tenant.
groups:
description: The groups assigned to the user
description: The groups assigned to the user.
type: array
items:
type: "string"
roles:
description: The roles assigned to the user
description: The roles assigned to the user.
type: array
items:
type: "string"
salesPlanType:
description: The plan of the user
description: The plan of the user.
type: "string"
c8Links:
description: The links to the components in the C8 stack
description: The links to the components in the C8 stack.
type: array
items:
type: "object"
properties:
name:
type: "string"
description: The name of the component.
link:
type: "string"
description: A link to the component.
canLogout:
description: Flag for understanding if the user is able to perform logout
description: Flag for understanding if the user is able to perform logout.
type: boolean
apiUser:
description: Flag for understanding if the user is an API user
description: Flag for understanding if the user is an API user.
type: boolean
UserResponse:
type: "object"
Expand Down
2 changes: 1 addition & 1 deletion docs/apis-tools/camunda-api-rest/specifications/create-document-link.api.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ in future releases.

The document link was created successfully.

</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={"url"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The link to the document."}}></SchemaItem><SchemaItem collapsible={false} name={"expiresAt"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The date and time when the link expires."}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"url\": \"string\",\n \"expiresAt\": \"2024-12-13T12:46:07.970Z\"\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={"url"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The link to the document."}}></SchemaItem><SchemaItem collapsible={false} name={"expiresAt"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The date and time when the link expires."}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"url\": \"string\",\n \"expiresAt\": \"2024-12-13T13:19:42.600Z\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The document link creation failed. More details are provided in the response body.

Expand Down
2 changes: 1 addition & 1 deletion docs/apis-tools/camunda-api-rest/specifications/create-document.api.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Information about the document.

Custom properties of the document.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Custom properties of the document.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"camunda.document.type\": \"camunda\",\n \"storeId\": \"string\",\n \"documentId\": \"string\",\n \"metadata\": {\n \"contentType\": \"string\",\n \"fileName\": \"string\",\n \"expiresAt\": \"2024-12-13T12:46:07.969Z\",\n \"size\": 0,\n \"customProperties\": {}\n }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Custom properties of the document.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"camunda.document.type\": \"camunda\",\n \"storeId\": \"string\",\n \"documentId\": \"string\",\n \"metadata\": {\n \"contentType\": \"string\",\n \"fileName\": \"string\",\n \"expiresAt\": \"2024-12-13T13:19:42.598Z\",\n \"size\": 0,\n \"customProperties\": {}\n }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The document upload failed. More details are provided in the response body.

Expand Down
4 changes: 2 additions & 2 deletions docs/apis-tools/camunda-api-rest/specifications/find-decision-instances.api.mdx
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/apis-tools/camunda-api-rest/specifications/find-flow-node-instances.api.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Pagination information about the search results.

The matching flow node instances.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"flowNodeInstanceKey"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","description":"The assigned key, which acts as a unique identifier for this flow node instance.","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"processInstanceKey"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"description":"The process instance key associated to this flow node instance.","type":"integer","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"processDefinitionKey"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"description":"The process definition key associated to this flow node instance.","type":"integer","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"processDefinitionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The process definition ID associated to this flow node instance.","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"startDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Date when flow node instance started.","type":"string","format":"date-time"}}></SchemaItem><SchemaItem collapsible={false} name={"endDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Date when flow node instance finished.","type":"string","format":"date-time"}}></SchemaItem><SchemaItem collapsible={false} name={"flowNodeId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The flow node ID for this flow node instance.","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"flowNodeName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The flow node name for this flow node instance.","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`UNSPECIFIED`, `PROCESS`, `SUB_PROCESS`, `EVENT_SUB_PROCESS`, `START_EVENT`, `INTERMEDIATE_CATCH_EVENT`, `INTERMEDIATE_THROW_EVENT`, `BOUNDARY_EVENT`, `END_EVENT`, `SERVICE_TASK`, `RECEIVE_TASK`, `USER_TASK`, `MANUAL_TASK`, `TASK`, `EXCLUSIVE_GATEWAY`, `INCLUSIVE_GATEWAY`, `PARALLEL_GATEWAY`, `EVENT_BASED_GATEWAY`, `SEQUENCE_FLOW`, `MULTI_INSTANCE_BODY`, `CALL_ACTIVITY`, `BUSINESS_RULE_TASK`, `SCRIPT_TASK`, `SEND_TASK`, `UNKNOWN`]"} schema={{"description":"Type of flow node as defined set of values.","type":"string","enum":["UNSPECIFIED","PROCESS","SUB_PROCESS","EVENT_SUB_PROCESS","START_EVENT","INTERMEDIATE_CATCH_EVENT","INTERMEDIATE_THROW_EVENT","BOUNDARY_EVENT","END_EVENT","SERVICE_TASK","RECEIVE_TASK","USER_TASK","MANUAL_TASK","TASK","EXCLUSIVE_GATEWAY","INCLUSIVE_GATEWAY","PARALLEL_GATEWAY","EVENT_BASED_GATEWAY","SEQUENCE_FLOW","MULTI_INSTANCE_BODY","CALL_ACTIVITY","BUSINESS_RULE_TASK","SCRIPT_TASK","SEND_TASK","UNKNOWN"]}}></SchemaItem><SchemaItem collapsible={false} name={"state"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ACTIVE`, `COMPLETED`, `TERMINATED`]"} schema={{"description":"State of flow node instance as defined set of values.","type":"string","enum":["ACTIVE","COMPLETED","TERMINATED"]}}></SchemaItem><SchemaItem collapsible={false} name={"hasIncident"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"Shows whether this flow node instance has an incident. If true also an incidentKey is provided.","type":"boolean"}}></SchemaItem><SchemaItem collapsible={false} name={"incidentKey"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"description":"Incident key associated with this flow node instance.","type":"integer","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"tenantId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The tenant ID of the incident.","type":"string"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"items\": [\n {\n \"flowNodeInstanceKey\": 0,\n \"processInstanceKey\": 0,\n \"processDefinitionKey\": 0,\n \"processDefinitionId\": \"string\",\n \"startDate\": \"2024-12-13T12:46:07.924Z\",\n \"endDate\": \"2024-12-13T12:46:07.924Z\",\n \"flowNodeId\": \"string\",\n \"flowNodeName\": \"string\",\n \"type\": \"UNSPECIFIED\",\n \"state\": \"ACTIVE\",\n \"hasIncident\": true,\n \"incidentKey\": 0,\n \"tenantId\": \"string\"\n }\n ],\n \"page\": {\n \"totalItems\": 0,\n \"firstSortValues\": [\n {}\n ],\n \"lastSortValues\": [\n {}\n ]\n }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"flowNodeInstanceKey"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","description":"The assigned key, which acts as a unique identifier for this flow node instance.","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"processInstanceKey"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"description":"The process instance key associated to this flow node instance.","type":"integer","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"processDefinitionKey"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"description":"The process definition key associated to this flow node instance.","type":"integer","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"processDefinitionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The process definition ID associated to this flow node instance.","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"startDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Date when flow node instance started.","type":"string","format":"date-time"}}></SchemaItem><SchemaItem collapsible={false} name={"endDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Date when flow node instance finished.","type":"string","format":"date-time"}}></SchemaItem><SchemaItem collapsible={false} name={"flowNodeId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The flow node ID for this flow node instance.","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"flowNodeName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The flow node name for this flow node instance.","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`UNSPECIFIED`, `PROCESS`, `SUB_PROCESS`, `EVENT_SUB_PROCESS`, `START_EVENT`, `INTERMEDIATE_CATCH_EVENT`, `INTERMEDIATE_THROW_EVENT`, `BOUNDARY_EVENT`, `END_EVENT`, `SERVICE_TASK`, `RECEIVE_TASK`, `USER_TASK`, `MANUAL_TASK`, `TASK`, `EXCLUSIVE_GATEWAY`, `INCLUSIVE_GATEWAY`, `PARALLEL_GATEWAY`, `EVENT_BASED_GATEWAY`, `SEQUENCE_FLOW`, `MULTI_INSTANCE_BODY`, `CALL_ACTIVITY`, `BUSINESS_RULE_TASK`, `SCRIPT_TASK`, `SEND_TASK`, `UNKNOWN`]"} schema={{"description":"Type of flow node as defined set of values.","type":"string","enum":["UNSPECIFIED","PROCESS","SUB_PROCESS","EVENT_SUB_PROCESS","START_EVENT","INTERMEDIATE_CATCH_EVENT","INTERMEDIATE_THROW_EVENT","BOUNDARY_EVENT","END_EVENT","SERVICE_TASK","RECEIVE_TASK","USER_TASK","MANUAL_TASK","TASK","EXCLUSIVE_GATEWAY","INCLUSIVE_GATEWAY","PARALLEL_GATEWAY","EVENT_BASED_GATEWAY","SEQUENCE_FLOW","MULTI_INSTANCE_BODY","CALL_ACTIVITY","BUSINESS_RULE_TASK","SCRIPT_TASK","SEND_TASK","UNKNOWN"]}}></SchemaItem><SchemaItem collapsible={false} name={"state"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ACTIVE`, `COMPLETED`, `TERMINATED`]"} schema={{"description":"State of flow node instance as defined set of values.","type":"string","enum":["ACTIVE","COMPLETED","TERMINATED"]}}></SchemaItem><SchemaItem collapsible={false} name={"hasIncident"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"Shows whether this flow node instance has an incident. If true also an incidentKey is provided.","type":"boolean"}}></SchemaItem><SchemaItem collapsible={false} name={"incidentKey"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"description":"Incident key associated with this flow node instance.","type":"integer","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"tenantId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The tenant ID of the incident.","type":"string"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"items\": [\n {\n \"flowNodeInstanceKey\": 0,\n \"processInstanceKey\": 0,\n \"processDefinitionKey\": 0,\n \"processDefinitionId\": \"string\",\n \"startDate\": \"2024-12-13T13:19:42.551Z\",\n \"endDate\": \"2024-12-13T13:19:42.551Z\",\n \"flowNodeId\": \"string\",\n \"flowNodeName\": \"string\",\n \"type\": \"UNSPECIFIED\",\n \"state\": \"ACTIVE\",\n \"hasIncident\": true,\n \"incidentKey\": 0,\n \"tenantId\": \"string\"\n }\n ],\n \"page\": {\n \"totalItems\": 0,\n \"firstSortValues\": [\n {}\n ],\n \"lastSortValues\": [\n {}\n ]\n }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The Flow node instance search query failed. More details are provided in the response body.

Expand Down
Loading

0 comments on commit 3d2ad74

Please sign in to comment.