Skip to content

Commit

Permalink
docs: don't link the word "endpoint"
Browse files Browse the repository at this point in the history
  • Loading branch information
pepopowitz committed Oct 1, 2024
1 parent ab129fd commit d7bfe59
Show file tree
Hide file tree
Showing 7 changed files with 9 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ All Administration Self-Managed API requests require authentication. To authenti

Include the previously captured token as an authorization header in each request: `Authorization: Bearer <TOKEN>`.

For example, to send a request to the ["Get current clusters" endpoint](./specifications/get-clusters.api.mdx):
For example, to send a request to the ["Get current clusters"](./specifications/get-clusters.api.mdx) endpoint:

:::tip
The `${CAMUNDA_BASE_URL}` variable below represents the URL of the Self-Managed environment. You can configure this value in your Self-Managed installation. The default value is `http://localhost:8080`.
Expand Down
2 changes: 1 addition & 1 deletion docs/apis-tools/operate-api/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ See the [Operate Configuration - Authentication](/self-managed/operate-deploymen

Include the previously captured token as an authorization header in each request: `Authorization: Bearer <TOKEN>`.

For example, to send a request to the Operate REST API's ["Search process instances" endpoint](./specifications/search-1.api.mdx):
For example, to send a request to the Operate REST API's ["Search process instances"](./specifications/search-1.api.mdx) endpoint:

<Tabs groupId="environment" defaultValue="saas" queryString values={
[
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ See the [Tasklist Configuration - Authentication](/self-managed/tasklist-deploym

Include the previously captured token as an authorization header in each request: `Authorization: Bearer <TOKEN>`.

For example, to send a request to the Tasklist API's ["Search tasks" endpoint](./specifications/search-tasks.api.mdx):
For example, to send a request to the Tasklist API's ["Search tasks"](./specifications/search-tasks.api.mdx) endpoint:

<Tabs groupId="environment" defaultValue="saas" queryString values={
[
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: "Connect business process-related event data and variable data held
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

All Optimize API requests except [the health readiness endpoint](./health-readiness.md) require authentication. To authenticate, generate a [JSON Web Token (JWT)](https://jwt.io/introduction/) and include it in each request.
All Optimize API requests except [the health readiness](./health-readiness.md) endpoint require authentication. To authenticate, generate a [JSON Web Token (JWT)](https://jwt.io/introduction/) and include it in each request.

## Generate a token

Expand Down Expand Up @@ -93,7 +93,7 @@ The Optimize API can also be configured in a Self-Managed environment to authent

Include the previously captured token as an authorization header in each request: `Authorization: Bearer <TOKEN>`.

For example, to send a request to the Optimize API's ["Get dashboard IDs" endpoint](./dashboard/get-dashboard-ids.md):
For example, to send a request to the Optimize API's ["Get dashboard IDs"](./dashboard/get-dashboard-ids.md) endpoint:

<Tabs groupId="environment" defaultValue="saas" queryString values={
[
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: "Connect business process-related event data and variable data held
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

All Optimize API requests except [the health readiness endpoint](./health-readiness.md) require authentication. To authenticate, generate a [JSON Web Token (JWT)](https://jwt.io/introduction/) and include it in each request.
All Optimize API requests except [the health readiness](./health-readiness.md) endpoint require authentication. To authenticate, generate a [JSON Web Token (JWT)](https://jwt.io/introduction/) and include it in each request.

## Generate a token

Expand Down Expand Up @@ -93,7 +93,7 @@ The Optimize API can also be configured in a Self-Managed environment to authent

Include the previously captured token as an authorization header in each request: `Authorization: Bearer <TOKEN>`.

For example, to send a request to the Optimize API's ["Get dashboard IDs" endpoint](./dashboard/get-dashboard-ids.md):
For example, to send a request to the Optimize API's ["Get dashboard IDs"](./dashboard/get-dashboard-ids.md) endpoint:

<Tabs groupId="environment" defaultValue="saas" queryString values={
[
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ See the [Operate Configuration - Authentication](/self-managed/operate-deploymen

Include the previously captured token as an authorization header in each request: `Authorization: Bearer <TOKEN>`.

For example, to send a request to the Operate REST API's ["Search process instances" endpoint](./specifications/search-1.api.mdx):
For example, to send a request to the Operate REST API's ["Search process instances"](./specifications/search-1.api.mdx) endpoint:

<Tabs groupId="environment" defaultValue="saas" queryString values={
[
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ See the [Tasklist Configuration - Authentication](/self-managed/tasklist-deploym

Include the previously captured token as an authorization header in each request: `Authorization: Bearer <TOKEN>`.

For example, to send a request to the Tasklist API's ["Search tasks" endpoint](./specifications/search-tasks.api.mdx):
For example, to send a request to the Tasklist API's ["Search tasks"](./specifications/search-tasks.api.mdx) endpoint:

<Tabs groupId="environment" defaultValue="saas" queryString values={
[
Expand Down

0 comments on commit d7bfe59

Please sign in to comment.