Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Path to Docusaurus 3 #4560

Closed
wants to merge 11 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Dockerfile.build
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# To run: `npm run build:docker`

# Install dependencies
FROM node:16 AS build-setup
FROM node:23 AS build-setup
WORKDIR /app
COPY package*.json ./
RUN npm install
Expand Down
2 changes: 1 addition & 1 deletion docs/apis-tools/camunda-api-rest/sidebar-schema.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ module.exports = {
"apis-tools/camunda-api-rest/camunda-api-rest-overview",
"apis-tools/camunda-api-rest/camunda-api-rest-authentication",
{
Specifications: require("./specifications/sidebar.js"),
Specifications: require("./specifications/sidebar"),
},
],
};
300 changes: 268 additions & 32 deletions docs/apis-tools/camunda-api-rest/specifications/activate-jobs.api.mdx

Large diffs are not rendered by default.

266 changes: 235 additions & 31 deletions docs/apis-tools/camunda-api-rest/specifications/assign-user-task.api.mdx

Large diffs are not rendered by default.

241 changes: 206 additions & 35 deletions docs/apis-tools/camunda-api-rest/specifications/broadcast-signal.api.mdx

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,33 @@ custom_edit_url: null
---

import ApiLogo from "@theme/ApiLogo";
import Heading from "@theme/Heading";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";
import Export from "@theme/ApiExplorer/Export";

<h1 className={"openapi__heading"}>Camunda 8 REST API</h1>
<span
className={"theme-doc-version-badge badge badge--secondary"}

>

</span>

<Heading
as={"h1"}
className={"openapi__heading"}
children={"Camunda 8 REST API"}
></Heading>

API for communicating with a Camunda 8 cluster.

<div style={{ marginBottom: "2rem" }}>
<h2 id={"authentication"} style={{ marginBottom: "1rem" }}>
Authentication
</h2>
<Heading
id={"authentication"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Authentication"}
></Heading>
<SchemaTabs className={"openapi-tabs__security-schemes"}>
<TabItem label={"HTTP: Bearer Auth"} value={"bearerAuth"}>
<div>
Expand Down

Large diffs are not rendered by default.

264 changes: 226 additions & 38 deletions docs/apis-tools/camunda-api-rest/specifications/complete-job.api.mdx

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -5,31 +5,31 @@ description: "Create a link to a document in the Camunda 8 cluster."
sidebar_label: "Create document link (alpha)"
hide_title: true
hide_table_of_contents: true
api: eJztV0tz2zYQ/is7ONlTipQTN015U22ndSdJPbbSHmwfVuRKREICDABa5mj43zsLkJZkybHb5ljN6EUs9/V9++BKOFxYkV6LU501FSknbiOhazLopFbnuUhFZggdDefvpfoiIpGTzYysWUik4sSLAEIp1RdwGhDyXh6kAlcQnGDVqBzhLWRlYx2Z+EbdqI/aEbgCHbhCWsgaY0i5sgWtyhZsU9faOAuoQKpRRZU27VqzddpQBMtCZgVIC0o7qAiVg7k2UBudNxk7CI0lby1NU6Ud3agpGyOV11qyh97ANZZ1gTAndI2h24Mk01WtFSlnE0JTtiPMMrI28XLhc9RL27jKDwFVDhW2MCOwzewzZY5TkRWoFnSjpIJ5w8JgqCS0ZGPv0Y0SkajRYEWODGOxEgorEqkYIj3PRSQkJ7pGV4hIGPraSEO5SJ1p6DEa04Lg/BT03Cf+IV1Oe3hiEQmbFVShSFfCtTVbss5ItRBdFz0Y99ldW/7akGm3TM+xtC+17ZUNHmwfzY2uvu3TbbBK1v2i85YldpzItHJM3nQlsK5LmXn6Jp8tO7Xa1a09PJx4w2R3kqw/lRVN9Xt5RxuyUjlakBGRmGtToQuX3hzvVAHHzhpGTo9KeUc7WfDBSwWVjf3Nc2xKJ9LXb8b86rpIOOlKtrlZbZchdtF1LGHI1lrZ4O+r8RF/7bqxbXKJFkIV52Abz+J5U5Yte/GdMteYche6fQkaOsRmYmLRRYLua2nITtw+PQ+Zz9HRiJO8V3nuu5DKPQywLCj0Hm+z1x+Lp/LcJ/h4PH5JTn0+ubnMUZaUx/CBGZ6TQ1laQEPcgO5kTvnQAQfkYKbzNvZl/0Tya6NnJVU/7IKw7dUELoJkbxcCOIAWguAsWL++fHcCPx//+NPtQeFcbdMkWS6XsZlnI8ql0ybWZpGYecZvljuMYVqQoaGdYZ5LtoklrGEHW1Mm5zIb4OzdBgYvxPdMtfnTb4DdGLkD8wQ+XZ6DzEk5OW+lWuya3qwtgTPduHRWIgP8APxzTJ2AbaoKTTvU8LaBLhLWoWvss23i9au9RP1tOr2AoAIynZOfWH4E9oY4iEoqWTWVSI/H40hUeB/+vRmPO9bJiL8gEsXML1EFtj4Kh5vRmrc+MKmsQ5V9L2S0kQv52O52EfYkPg0RdaEMK3KF5vWj1tZThydfKpKhCpPVejp2CZek5SFC5m4Yor4liVUoni5NklWhrevSFe8UXXLHyNyhkTgrAx/5OBTZQJ5SZ1gWwYFdEPmAh+UQ3HrFuTy7msKv6GiJrU8qm9xW/Xb8drxXK4s+oXFycQ4hwkDBjbYwqOX63qs2CL9EsR+4lrLGSNde8W0hPTNCQ2bSMA4P1Ojtee38PwiJqP/xbiDM739NPebc0i7Xw/zsHqu6L8iN2TtMRGbjXIfTwJVdxxlFMjZEOo6Pdnl5ce7LK9NV1SjfY9UCltIVgHvWUhGJUmakrPeqX4YGsffhBP4MFuEoZhAD04bWupCuaGZxpqskC7c9fM9KPUsqlCrpTdjkZPLh08fTyej9+cnZx6uz0VE8jt2988li6leoNv0Ii/b2KDrwu+jh48BX6/Hy/4L+Xxf0nu6O7l1SlygVF2C/9ITWdP2wrotIpFure+hOt1HfYa7FajVDS59M2XV8OezW3LNyabkdPbFdbyL67xftvaF8oXZr57/DsmEpwc1g6JL/0MWDy35NP4TnH0n2etVfRNVuujR4u5Hj7raLREGYk/FOBoGT4MpoymrWCnb2XH7qCXdMsoxq903Z243ZdPHH1ZR7Xf9YUumc7zG45AclXIpU3Igbdlj79Pg26q+vRIlq0eCC5YNefv0N6EFkAg==
api: eJztV0tz2zYQ/is7ONlTipQTN015U22ndSdJPbbSHmwfVuRKREICDABa5mj43zsLkJZkybHb5ljN6EUs9/V9++BKOFxYkV6LU501FSknbiOhazLopFbnuUhFZggdDefvpfoiIpGTzYysWUik4sSLAEIp1RdwGhDyXh6kAlcQnGDVqBzhLWRlYx2Z+EbdqI/aEbgCHbhCWsgaY0i5sgWtyhZsU9faOAuoQKpRRZU27VqzddpQBMtCZgVIC0o7qAiVg7k2UBudNxk7CI0lby1NU6Ud3agpGyOV11qyh97ANZZ1gTAndI2h24Mk01WtFSlnE0JTtiPMMrI28XLhc9RL27jKDwFVDhW2MCOwzewzZY5TkRWoFnSjpIJ5w8JgqCS0ZGPv0Y0SkajRYEWODGOxEgorEqkYIj3PRSQkJ7pGV4hIGPraSEO5SJ1p6DEa04Lg/BT03Cf+IV1Oe3hiEQmbFVShSFfCtTVbss5ItRBdFz0Y99ldW/7akGm3TM+xtC+17ZUNHmwfzY2uvu3TbbBK1v2i85YldpzItHJM3nQlsK5LmXn6Jp8tO7Xa1a09PJx4w2R3kqw/lRVN9Xt5RxuyUjlakBGRmGtToQuX3hzvVAHHzhpGTo9KeUc7WfDBSwWVjf3Nc2xKJ9LXb8b86rpIOOlKtrlZbZchdtF1LGHI1lrZ4O+r8RF/7bqxbXKJFkIV52Abz+J5U5Yte/GdMteYche6fQkaOsRmYmLRRYLua2nITtw+PQ+Zz9HRiJO8V3nuu5DKPQywLCj0Hm+z1x+Lp/LcJ/h4PH5JTn0+ubnMUZaUx/CBGZ6TQ1laQEPcgO5kTvnQAQfkYKbzNvZl/0Tya6NnJVU/7IKw7dUELoJkbxcCOIAWguAsWL++fHcCPx//+NPtQeFcbdMkWS6XsZlnI8ql0ybWZpGYecZvljuMYVqQoaGdYZ5LtoklrGEHW1Mm5zIb4OzdBgYvxPdMtfnTb4DdGLkD8wQ+XZ6DzEk5OW+lWuya3qwtgTPduHRWIgP8APxzTJ2AbaoKTTvU8LaBLhLWoWvss23i9au9RP1tOr2AoAIynZOfWH4E9oY4iEoqWTWVSI/H40hUeB/+vRmPO9bJiL8gEsXML1EFtj4Kh5vRmrc+MKmsQ5V9L2S0kQv52O52EfYkPg0RdaEMK3KF5vWj1tZThydfKpKhCpPVejp2CZek5SFC5m4Yor4liVUoni5NklWhrevSFe8UXXLHyNyhkTgrAx/5OBTZQJ5SZ1gWwYFdEPmAh+UQ3HrFuTy7msKv6GiJrU8qm9xW/Xb8drxXK4s+oXFycQ4hwkDBjbYwqOX63qs2CL9EsR+4lrLGSNde8W0hPTNCQ2bSMA4P1Ojtee38PwiJqP/xbiDM739NPebc0i7Xw/zsHqu6L8iN2TtMRGbjXIfTwJVdxxlFMjZEOo6Pdnl5ce7LK9NV1SjfY9UCltIVgHvWUhGJUmakrPeqX4YGsffhBP4MFuEoZhAD04bWupCuaGZxpqskC7c9fM9KPUsqlCrpTdjkZPLh08fTyej9+cnZx6uz0VE8jt2988li6leoNv0Ii/b2KDrwu+jh48BX6/Hy/4L+Xxf0nu6O7l1SlygVF2C/9ITWdP2wrotIpFure+hOt1HfYa7FajVDS59M2XV8OezW3LNyabkdPbFdbyL67xftvaF8oXZr57/DsmEpwc1g6JL/0MWDy35NP4TnH0n2etVfRNVuujR4u5Hj7raLREGYk/FOBoGT4MpoymrWCnb2XH7qCXdMsoxq903Z243ZdPHH1ZR7Xf9YUumc7zG45AclXAZntU+Nb6H+2kqUqBYNLlg26OTX32suYwY=
sidebar_class_name: "post api-method"
info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api
custom_edit_url: null
hide_send_button: true
---

import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<h1 className={"openapi__heading"}>Create document link (alpha)</h1>
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Create document link (alpha)"}
></Heading>

<MethodEndpoint
method={"post"}
path={"/document/{documentId}/links"}
context={"endpoint"}
></MethodEndpoint>

Create a link to a document in the Camunda 8 cluster.
Expand All @@ -41,14 +41,119 @@ This endpoint is an [alpha feature](/components/early-access/alpha/alpha-feature
in future releases.
:::

## Request
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
></Heading>

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"documentId","in":"path","required":true,"description":"The ID of the document to link.","schema":{"type":"string"}}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"storeId","in":"query","required":false,"description":"The ID of the document store to link the document from.","schema":{"type":"string"}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"timeToLive"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","description":"The time-to-live of the document link in ms.","default":3600000}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"201"} value={"201"}><div>
<ParamsDetails
parameters={[
{
name: "documentId",
in: "path",
required: true,
description: "The ID of the document to link.",
schema: { type: "string" },
},
{
name: "storeId",
in: "query",
required: false,
description: "The ID of the document store to link the document from.",
schema: { type: "string" },
},
]}
></ParamsDetails>

The document link was created successfully.
<RequestSchema
title={"Body"}
body={{
required: false,
content: {
"application/json": {
schema: {
type: "object",
properties: {
timeToLive: {
type: "integer",
format: "int64",
description: "The time-to-live of the document link in ms.",
default: 3600000,
},
},
title: "DocumentLinkRequest",
},
},
},
}}
></RequestSchema>

</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-11-07T21:11:50.865Z\"\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.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/problem+json"} value={"application/problem+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={"type"} required={false} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"A URI identifying the problem type.","default":"about:blank"}}></SchemaItem><SchemaItem collapsible={false} name={"title"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A summary of the problem type."}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"int32"} qualifierMessage={"**Possible values:** `>= 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}></SchemaItem><SchemaItem collapsible={false} name={"detail"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"An explanation of the problem in more detail."}}></SchemaItem><SchemaItem collapsible={false} name={"instance"} required={false} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"A URI identifying the origin of the problem."}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 0,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
<StatusCodes
id={undefined}
label={undefined}
responses={{
"201": {
description: "The document link was created successfully.",
content: {
"application/json": {
schema: {
type: "object",
properties: {
url: { type: "string", description: "The link to the document." },
expiresAt: {
type: "string",
format: "date-time",
description: "The date and time when the link expires.",
},
},
title: "DocumentLink",
},
},
},
},
"400": {
description:
"The document link creation failed. More details are provided in the response body.\n",
content: {
"application/problem+json": {
schema: {
description:
"A Problem detail object as described in [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457). There may be additional properties specific to the problem type.\n",
type: "object",
properties: {
type: {
type: "string",
format: "uri",
description: "A URI identifying the problem type.",
default: "about:blank",
},
title: {
type: "string",
description: "A summary of the problem type.",
},
status: {
type: "integer",
format: "int32",
description: "The HTTP status code for this problem.",
minimum: 400,
maximum: 600,
},
detail: {
type: "string",
description: "An explanation of the problem in more detail.",
},
instance: {
type: "string",
format: "uri",
description: "A URI identifying the origin of the problem.",
},
},
title: "ProblemDetail",
},
},
},
},
}}
></StatusCodes>
Loading
Loading