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

docs: mark C8 REST search as experimental #4098

Merged
merged 3 commits into from
Aug 6, 2024
Merged
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
821 changes: 761 additions & 60 deletions api/camunda/camunda-openapi.yaml

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
id: assign-a-user-task
title: "Assign a user task"
id: assign-user-task
title: "Assign user task"
description: "Assigns a user task with the given key to the given assignee."
sidebar_label: "Assign a user task"
sidebar_label: "Assign user task"
hide_title: true
hide_table_of_contents: true
api: eJztWFlz2zYQ/is7eGkypSUlddOEb47jtG5zeGy5fbA9YwhcSYhBgMYhmaPhf+8sQIrWkWPaPMYzGpPEYs/vW2K5Yp7PHMuv2KVDC567O3aTsQKdsLLy0miWsyPn5Ew74BA6IVhKPwc/R5jJBWq4wxq8efSAxz2IA5axilteokdLhlZM8xJZzkjXmLu7v7BmGZNkqOJ+zjJm8T5IiwXLvQ247c14jtGcmUZzvUvetFbJphNzLDnLV8zXFZmT2uMMLcvY1NiS+/ToxSFrmptkEp1/bYqa9mx7IIz2qD0t8apSUnByZvjJkUerXWNm8gmFp9CtqdB6iS7ubZNC17tBdaswNXYztAFsrJfBedDGwwQBy8rXYCzc6qDULYXe+uC8lXrGMkYLfKKQ5VOuHDYZ40qZ5ccFWiuLPc68rqHAKQ/KZ9GPmF3pwGLrQgFyCtLDkjvgyiIv6s67YgAX6MHPpaOC3EaTt3Rp0QergWtAa40FqcEFMQfBHboUYTQUo/Nz1DCV1sUgg14b9oYerG/5jEs9gEuHyeSS9tUmwJwvUgIdVFLcST2DqTUlzKwJVTJ0HzBg9LKyuEDtwXKBIIwuJGXCDa51n86JMQq53sgngYPSKVLitvN4BCI4b0pIArDgKpCf3MNSKhUDEQKdkxOFyb0ezdEjyrkLyq/dj0GiLiojtQepFyZBcQCn0wiJypqFLLDIYn3ISltKivO6ReA12whtD1JiZE3GvPR0G7sDkTW1ghK1P0+MYU1DchZdZbRLMH8+OtyP8HV0P7m2hKQpwaj4FJzHYsCajB2ORl+iSNy0Q/89HUlw3dJEmLJSSPrhvbEIBXoulQNucZ0yQiTt72KBiSnqlKjP8L+yZqKw/Hm3D2wD4SxJtnYh9QfgDpLgJFm/On97DK8Of/3t5snc+8rlw+FyuRzYqTjAQnpjB8bOhnYq6EdyTyNvLELJ6winIkGXK+g7D7gKhZxK0XXo1m2g8m8A4TNtK62uduCybqTBSrbz0oDL81OQBWovpzUBeMd03BPByXLGJyb4fKK4vmM98HaNbltxoSy5Xb8ONg00GXOe++C++iL45fmObgLcH+PxGSQVIEzR9WbpOkMURCm1LEPJ8sPRKGMlf0h3L0ajhnRSxb8hEg34UCmuI7S2w5Eayh63MTCpnedafK/KGCtnctvugD1uAi2I36SIEvEPv8r1fcQkxhMzpybojvKv/oMe6TrSLq3Rs1gpBBGsRe1V/YPsP8j+g+zfi+xNxkr0c1PQSd24CB06sOdsSCQ9IJK64erRub4Z9i9sOpOjXXRDQLCK5WyVSNTkw+Fqbpxv8lVlrG+GC6rQgltJx5FYUFpOZOtApIzgap4c2S0mLdCk0QV5/BLOTy7G8Dv3uOR1zCrZ2tT5cvRytFcdiW6rOjo7hRRTAt+jhtDpI2bv1ZeEv6gxDiYORbDS1xcknzIxQW7RHgVK/RoNraGoNh5XoxDL2ou3HUb+/Gccy0xd7Lwfek4eOB2QNoeUHmJbA0MairpjbycWYTo10akWRMe8DLrg0IdHZUXr0sbR4NkuYM9OI++EKcugY/PVs7739xqFogOjJU4qKVC76H07XHZi79IK/J1swrMBlTeBr+u6M+nnYTIQphyKtG39f6LMZFhyqYetCTc8Pnp/+eHN0cG70+OTDxcnB88Go4F/8DGpxIqS60d+pPPy48l5O+BV/77534N2iwWPD35YKS411SQGu2qpesV6qrKM5ZtD+CO23mQt467YajXhDi+tahp6fB/Q1iy/uukJGhldSEfXRTtmfiHMJ+fteP0Uvm2Y3xtX+5DrOrYKFeiOZewO662vC81Nk7E58gJt9DRJHCd/Dsakp9ewM983WbfjSAis/GdkN44HxNx1rzz7eDEmIrbfFkpDFGKWL+lTB1+ynF2za/LcxFxFjsfnK6a4ngU+I/mkl/7+BSY7JFE=
api: eJztWFtv2zYU/isHfFmLKba7pV2rNzdtt2y9BImzPSQBQlPHNhuKVHmxIxj678MhJTu+pC22PjqAEUk8PNfvO5TOknk+dSy/YpcOLXju7thNxgp0wsrKS6NZzobOyal2wCF0QrCQfgZ+hjCVc9RwhzV48+ABj3sQeyxjFbe8RI+WDC2Z5iWynJGuEXd3f2HNMibJUMX9jGXM4pcgLRYs9zbgtjejGUZzZhLNrV3yprVKNp2YYclZvmS+rsic1B6naFnGJsaW3KdHL45Z09wkk+j8a1PUtGfbA2G0R+1piVeVkoKTM/3Pjjxa7hoz488oPIVuTYXWS3Rxb5sUut4NqluFibGbofVgY70MzoM2HsYIWFa+BmPhVgelbin01gfnrdRTljFa4GOFLJ9w5bDJGFfKLD7N0VpZ7HHmdQ0FTnhQPot+xOxKBxZbFwqQE5AeFtwBVxZ5UXfeFT24QA9+Jh0V5DaavKVLiz5YDVwDWmssSA0uiBkI7tClCKOhGJ2foYaJtC4GGfTKsDf0YHXLp1zqHlw6TCYXtK82AWZ8nhLooJLiTuopTKwpYWpNqJKhLwEDRi8ri3PUHiwXCMLoQlImXO9ar9M5NkYh1xv5JHBQOkVK3HYehyCC86aEJABzrgL5yT0spFIxECHQOTlWmNxbozl6RDl3QfmV+zFI1EVlpPYg9dwkKPbgdBIhUVkzlwUWWawPWWlLSXFetwi8Zhuh7UFKjKzJmJeebmN3ILKmVlCi9ueJMaxpSM6iq4x2Cea/DI73I3wV3U+uLSFpSjAqPgfnseixJmPHg8HXKBI37dB/T0cSXLc0EaasFJJ++GAsQoGeS+WAW1yljBBJ+7tYYGyKOiXqEf5X1owVlj/v9oFtIJwlydYupP4A3EESHCfrV+fvTuDV8fPfbp7MvK9c3u8vFouenYgjLKQ3tmfstG8ngn4k9zTyxiKUvI5wKhJ0uYJ15wFXoZATKboO3boNVP4NIDzSttLqcgcuq0YarGQ7hwZcnp+CLFB7OakJwDum454ITpYzPjbB52PF9R1bA2/X6LYVF8qS29VxsGmgyZjz3Af3zYPg1192dBPg/hiNziCpAGGKrjdL1xmiIEqpZRlKlh8PBhkr+X26ezEYNKSTKv4dkWjA+0pxHaG1HY7UUK5xGwOT2nmuxY+qjLFyKrft9tjDJtCC+E2KKBH/+Jtc30dMYjwxc2KCLnoHgh0IdiDYowR79R8IJl13mi2s0dOYYQQRrEXtVX04BQ8kPZD0x5H0+b4X1qEGyrIlHKZPHiMiAwtYzKSK6uPbf2u7/QY9cO3AtQPXHuNak7ES/cwUNC4yLkKHpkY569OBeEQHousvHwyXmv76q5EGQ2jn3SQqWMVytkwkavJ+fzkzzjf5sjLWN/05VWjOraRv4lhQWk5k60CkjOBqlhzZLSYt0LirC/KEl0EXHF7C+duLEfzOPS54HZNLJjdVvxy8HOzVSqKPaByenUKKMEHxQXvo1BLP96pNwt+jOI7MHIpgpa8vaFtKzxi5RTsMVI8VRFp7UXscpEQhlrUX7zrg/PnPKNaeWtv5ehz39p7Tp/vm+GyNu61RVhrXdQOZTixid2KiUy2ydsOjWqN1aeOg92wXxWenkYzClGXQsSPraXr54g/SJRQNMizRVEmB2kXf26FnJ/Y+rcDfySI861GpEx67RjyVfhbGPWHKvkjbVv/Hyoz7JZe635pw/ZPhh8uPb4ZH709P3n68eHv0rDfo+XsfU0pEKbl+4Eea46zfIbeDXa4PoP89/m1x4PHe9yvFpaZ6xFCXLXev2Jq7LGP55mj4AX1vspaCV2y5HHOHl1Y1DT3+EtDWLL+6WTM2UryQjq6Ldvj5lTCfnLdD36fwfSPmvXG1D7muY+9Qge5Yxu6w3pp5NzdNxmbIC7TR0yRxkvw5GpGetYadqXOTdTuGQmDlH5HdeF8g1q6a59mnixGRsJ14l4bowyxf0ACeL1jOrtk1eW5iriK/4/MlU1xPA5+SfNJLf/8COgNsig==
sidebar_class_name: "post api-method"
info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api
custom_edit_url: null
Expand All @@ -25,7 +25,7 @@ import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Assign a user task</h1>
<h1 className={"openapi__heading"}>Assign user task</h1>

<MethodEndpoint
method={"post"}
Expand All @@ -48,8 +48,12 @@ The assignment of the user task with the given key cannot be completed. More det

The user task with the given key was not found.

</div><div></div></TabItem><TabItem label={"409"} value={"409"}><div>
</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><TabItem label={"409"} value={"409"}><div>

The user task with the given key is in the wrong state currently. 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><TabItem label={"500"} value={"500"}><div>

An internal error occurred while processing the request.

</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>
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: camunda-8-rest-api
title: "Camunda 8 REST API"
description: "API for communicating with the Camunda 8 cluster."
description: "API for communicating with a Camunda 8 cluster."
sidebar_label: Introduction
sidebar_position: 0
hide_title: true
Expand All @@ -15,7 +15,7 @@ import Export from "@theme/ApiExplorer/Export";

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

API for communicating with the Camunda 8 cluster.
API for communicating with a Camunda 8 cluster.

<div style={{ marginBottom: "2rem" }}>
<h2 id={"authentication"} style={{ marginBottom: "1rem" }}>
Expand Down
Loading
Loading