Skip to content

Commit

Permalink
docs: explain C8 REST Query API availability
Browse files Browse the repository at this point in the history
* Explains why the Query API is disabled by default
* Describes how to enable the Query API
* Links to the description from the REST Query API explorer endpoints
  • Loading branch information
tmetzke committed Aug 8, 2024
1 parent 830d894 commit 364c059
Show file tree
Hide file tree
Showing 6 changed files with 47 additions and 18 deletions.
21 changes: 15 additions & 6 deletions api/camunda/camunda-openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -478,8 +478,11 @@ paths:
description: |
Search for user tasks based on given criteria.
**Note**: This endpoint is experimental and not enabled on Camunda clusters
out of the box. It has to be enabled explicitly for a cluster.
:::note
This endpoint is experimental and not enabled on Camunda clusters out of the box.
See [Camunda 8 REST API overview](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md#query-api)
for further details.
:::
requestBody:
required: false
content:
Expand Down Expand Up @@ -517,8 +520,11 @@ paths:
description: |
Search for process instances based on given criteria.
**Note**: This endpoint is experimental and not enabled on Camunda clusters
out of the box. It has to be enabled explicitly for a cluster.
:::note
This endpoint is experimental and not enabled on Camunda clusters out of the box.
See [Camunda 8 REST API overview](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md#query-api)
for further details.
:::
requestBody:
required: false
content:
Expand Down Expand Up @@ -556,8 +562,11 @@ paths:
description: |
Search for decision definitions based on given criteria.
**Note**: This endpoint is experimental and not enabled on Camunda clusters
out of the box. It has to be enabled explicitly for a cluster.
:::note
This endpoint is experimental and not enabled on Camunda clusters out of the box.
See [Camunda 8 REST API overview](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md#query-api)
for further details.
:::
requestBody:
required: false
content:
Expand Down
11 changes: 11 additions & 0 deletions docs/apis-tools/camunda-api-rest/camunda-api-rest-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,15 @@ For Self-Managed, the host and port depend on your configuration. The context pa

See [the interactive Camunda 8 REST API Explorer][camunda-api-explorer] for specifications, example requests and responses, and code samples of interacting with the Camunda 8 REST API.

### Query API

All Query API endpoints contain an `(experimental)` declaration. Those endpoints are not accessible by default in Camunda 8 clusters.

The search endpoints don't yet integrate with [resource authorizations][]. As a result, using search endpoints, users can expand their access to
resources they are not allowed to. Thus, if you use resource permissions, we don't recommend to allow public access to those endpoints.

You can enable the experimental search endpoints by setting the configuration property `camunda.rest.query.enabled` to `true`. Alternatively,
the environment variable `CAMUNDA_REST_QUERY_ENABLED` can be set to `true`.

[camunda-api-explorer]: ./specifications/camunda-8-rest-api.info.mdx
[resource authorizations]: /self-managed/concepts/access-control/resource-authorizations.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Search for decision definitions based on given criteria."
sidebar_label: "Query decision definitions (experimental)"
hide_title: true
hide_table_of_contents: true
api: eJztWEtz2zYQ/isYnBKXlpjESVPeFNtp1SaOayvpQdYBIpciEhBgANCSRsP/3lmAlCiJ8iOTXjr2jMcmse/db7nYFbVsZmg0pmcQc8OVJGeQcsktV5JOApqAiTUv3GNEr4HpOCOp0iRp6JM1vSFTZiAhSpIZvwVJYs0taM56N/JGHh1dKAtHRxEZZdwQkEmhuLQE/18UoHkO0jJBmEyIVJaAZFPhpZ2yvJQJI7EojQVtbqQqLVEpsRmQqVr0yNCSjBliFZnCmhMWheAxt2LpLF7z924kDaiG7yUY+04lSxqt3CPXkNAoZcJAQGMlLUiLZ6xAQQx97H81GIkVNXEGOXOnQnxKaTReUbssgEZUTb9CbGlAC60K0JaDcRxKO2k1FdOaLWlAuYXcPEZOykEkLUHGai5ntAqo0gno/RPMYspKYVGriWlVBS13x7XASUAttwLWaf67BL28Vtpe+UjRaoKcBZvBo8zVKm/ZxKWFGWga0FTpnFn/6tVLtF/wnNsH0hpn4yC1Wx7vBXXbtmrN+A5SpeExnFVnfC7ZDDbxCTr0dTAdZtjPtagdfGi4G1z+Bct7I/nmBCOZ5LIB/7C7rloUFyyHTppb0IZ7aDwgey2JV74SEf3mkP4O0of7Z0EyaTtFt9LTmLNpf+9d7LeL/zB1V3orjzRTKGl8dl6GoU9Su6uOMiAd7ZfU3daUcQzGpKUgjSzfwX56h3ostK2yTAx3AHNXKlKujcWW8oWJEszjgCvYj/LeBV0f0Mdg9yDHbnh27bnHzick/1dIxhLdLoN78Nuk2PGc/ABmnRySMi4g6ZGPSgNJwDIuDGEaSKHVLU8gIVy6GabBNZmqZHknuAutpgLyX/ZBvm3fgFx6ylov8UVGmCGecOq1j6/en5LfTl7/OnmWWVuYqN+fz+c9ncbHkHCrdE/pWV+nMf4i3fMeGWWggeRsicMWSxLnORNkU77EFBDzlMc4kaGDtdkEs+b9u6ezuNP9QWZdE6XmdHc6HZDPV0PCE5CWp0suZ/uqt2ehqSptNBVMfqOb2uianra1mDLPmV42A+i2ApwwLLPl/S3x1cs92VhVf4xGl8SLILFKwM2uFkfmWhE6kXPJ8zKn0UkYBjRnC//0JgwdyDDjD/BEuhGZSVdau+5wSfJN3TrHuDSWyfhnZUZpPuO7entbWK6L+Mx75PH4uguPA0kwyhrrELRWmqg4LrWGhMwzLpx4/Io2uuvp/wlrT1h7wtohrFUBzcFmKqERLZRxpcNsRiPabz7kx63rf99frSjesTROEW6ELLWgEV158FRRv7/KlLFVtCqUtlX/FjNzyzTHO7tLJB57kDXFI1TMROYN2E8iHkiWQ+Ncsy14S67Or0fkd2ZhzpYuqEV9Bd+Ifhu+DTulIukBiYPLIfEe+hJstYVGLOK7U6wnfojgCgdMA3GpuV1eI5sPzxSYBj0oMQ/r0qj1Oen47IloUP/zvimYP/8ZuZxjS7vaLEDOFywvPCA3N86t+TPcmy5blb47VG6O1rNkeOek2EbNgQExbI9/rYnSb1XG67XIRlS9DfErj8lmceEXEuF63RDuLBPGKx/59poA31UOlalyYa8xs5/AttM07L3Yx+fl0LWZWOV5Kd23Rs7InNuMsFZBNLsqinbGgONotKLSx7ch++BPyBevkbzoYTF7xDWfmBm3WTntxSrvx55t/Xcq1LSfMy77tQrTPx18/HxxNjj+MDw9v7g+P37RC3t24W9D2AJyJlt2+DG3cxX4rL3Ue74bhdXmm/u/WirWcLSwsP1CMC6xRF0+VnXrHNOu1kmbgsM1nG+AY7paoeuftagqfP0dg02j8WTTL/GpCmgGLPGVS78hVuipD+7xCM1BclG6C+julqAKGo5BHENh76SdtL4Gl5+uR9hd6uVprhLk0WyOi1U2pxG9oTcUQVh4/3DDiu9XVDA5Kx0UqZeLP/8CMfrSlA==
api: eJztWEtz2zYQ/isY9JJMJZJJnDTlTbGd1m3iuLaSHiQdIHIpIgEBBgAtazT8750FSImS6FcmvdkzHpvEvne/xXLX1LKFofGEnkDCDVeSnEDGJbdcSTob0BRMonnpHmN6BUwnOcmUJmlLn27oDZkzAylRkiz4NUiSaG5BcxZM5VTGcSyVhakc59wQkGmpuLQE/78pQfMCpGWCMJkSqSwByebCCztmRSVTRhJRGQvaEFVZojJicyBzdRNM5RUAmbRkb8nl6dWYjC7OiLoGfc1hOXsWspKboVVKmDDxhENW8qEGYw9eDFu+oEh/+V6BXuHR86lEx7NK2xwwAJZxYQLn2VTSAdXwvQJj36l0ReO1e+QaUhpnTBgY0ERJC9LiGStLwROGUQu/Goztmpokh4K5UyE+ZTSerKldlUBjquZfIbF0QEutStCWg3EcSjtpDRXTmq3ogHILhXmMnIyDSDuCjNVcLmg9oEqnoA9PsC4yVgmLWk1C63rQcXfSCJwNqOVWwKZw/sFQXiltL32kaD1DzpIt4FHmalV0bOLSwgI0HdBM6YJZ/+rVS7Rf8ILbB9IaZ+MoszseHwR117Z6w/gOMqXhMZx1b3wu2AK28Rn06Othup3hMNeicfCh4W6R/jes7o3kmyOMZFrItp2c9ddVh+KcFdBLcw3acA+NB2SvI/HSVyI2FHOb/h7Sh/tnQTJpe0V30tOas22o713sd4v/duq+9NYeaaZU0vjsvIwin6Runx7nQHoaOmn6t6mSBIzJKkFaWYHrYD+9Qz0W2lZZJs72AHNXKjKujcWW8oWJCszjgCvYj/LeBV0f0Mdg91aO/fDs23OPnU9I/r+QjCW6Wwb34LdNseM5+gHMOjkkY1xAGpCPSkM7gRCmgZRaXfMUUsKlm4taXJO5Sld3grvUai6g+PUQ5Lv2jciFp2z0El9khBniCede++Ty/TH5/ej1b7NnubWlicNwuVwGOkuGkHKrdKD0ItRZgr9I9zwg4xw0kIKtyBwIS1PnORNkW77ElJDwjCfEKudgYzbBrHn/7uks7vRwkNnURKU53Z93R+Tz5RnhKUjLsxWXi0PVu7PQXFU2ngsmv9FtbfRNT7taTFUUTK/aoXZXAU4Yltnq/pb46uWBbKyqP8fjC+JFkESl4OZ3i1N4owidKLjkRVXQ+CiKBrRgN/7pTRQ5kGHGH+CJxGFeMOlKa98dLkmxrVvnGJfGMpn8rMwozRd8X2+wg+WmiE+8Rx6Pr/vwOJIEo6yxDkFrpYlKkkprSMky58KJx1u01d1M/09Ye8LaE9Zuw1o9oAXYXKU0pqUyrnSYzWlMw/YiH3YWCqH/tKL4jaVxinAjZKUFjenag6eOw3CdK2PreF0qbevwGjNzzTTHBYJLJB57kLXFI1TCRO4NOEwiHkhWQOvc3mbhD2ZhyVYuqGXzCb4V/TZ6G/VKRdJbJOKuwnvoS7DTFlqxiO9esZ74IYJrHDANJJXmdnWFbD48c2Aa9KjCPGxKo9HnpOOzJ6KD5p/3bcH89e/Y5Rxb2uV2AXJ6w4rSA3L7xbkzf0YH02Wn0veHyu3RZpaM7pwUu6i5ZUCMuuNfZ6L0W5XJZi2yFdVsQ/zKY7ZdXPiFRLRZN0R7y4TJ2ke+uybAd7VDZaZc2BvMHCaw6zSNgheH+Lw4c20mUUVRSXfXyAVZcpsT1imIZn2GDUjwBHAcjddU+vi2ZB/8CfniNZIXARazR1x7xSy4zat5kKii3Zxt/s6FmocF4zJsVJjwePTx8/nJaPjh7Pj0/Op0+CKIAnvjv4awBRRMduzwY27vcvFZd0/4fD8K6+2d+7SmvHNN2QDcwo0NS8G4xKJ3GV43zXhC+5oxbUsYF3u+pU7oeo3B/KxFXeNrZwWNJ7NtB8anekBzYKnHAv2G6KPHPl3DMZqD5KJyn7T7e4d60HKMkgRKeyftrHO/XHy6GmO/ataxhUqRR7MlrmrZksZ0SqcUYV16/3Bni+/XVDC5qBy4qZeLP/8B5h4PnQ==
sidebar_class_name: "post api-method"
info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api
custom_edit_url: null
Expand Down Expand Up @@ -36,8 +36,11 @@ import TabItem from "@theme/TabItem";

Search for decision definitions based on given criteria.

**Note**: This endpoint is experimental and not enabled on Camunda clusters
out of the box. It has to be enabled explicitly for a cluster.
:::note
This endpoint is experimental and not enabled on Camunda clusters out of the box.
See [Camunda 8 REST API overview](/apis-tools/camunda-api-rest/camunda-api-rest-overview.md#query-api)
for further details.
:::

## Request

Expand Down
Loading

0 comments on commit 364c059

Please sign in to comment.