Skip to content

Commit 7361d64

Browse files
tmetzkegithub-actions[bot]
authored andcommitted
docs: update REST API spec
1 parent 61e6b47 commit 7361d64

168 files changed

Lines changed: 336 additions & 504 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/apis-tools/orchestration-cluster-api-rest/specifications/activate-ad-hoc-sub-process-activities.api.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: activate-ad-hoc-sub-process-activities
33
title: "Activate activities within an ad-hoc sub-process"
4-
description: "<MarkerStronglyConsistentExtension /> [Learn about endpoint consistency](../../orchestration-cluster-api-rest-data-fetching/#data-consistency)"
4+
description: "<MarkerStronglyConsistentExtension />"
55
sidebar_label: "Activate activities within an ad-hoc sub-process"
66
hide_title: true
77
hide_table_of_contents: true
@@ -36,8 +36,7 @@ import Heading from "@theme/Heading";
3636
context={"endpoint"}
3737
></MethodEndpoint>
3838

39-
<MarkerStronglyConsistentExtension /> [Learn about endpoint
40-
consistency](../../orchestration-cluster-api-rest-data-fetching/#data-consistency)
39+
<MarkerStronglyConsistentExtension />
4140

4241
Activates selected activities within an ad-hoc sub-process identified by element ID.
4342
The provided element IDs must exist within the ad-hoc sub-process instance identified by the

docs/apis-tools/orchestration-cluster-api-rest/specifications/activate-jobs.api.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: activate-jobs
33
title: "Activate jobs"
4-
description: "<MarkerStronglyConsistentExtension /> [Learn about endpoint consistency](../../orchestration-cluster-api-rest-data-fetching/#data-consistency)"
4+
description: "<MarkerStronglyConsistentExtension />"
55
sidebar_label: "Activate jobs"
66
hide_title: true
77
hide_table_of_contents: true
@@ -34,8 +34,7 @@ import Heading from "@theme/Heading";
3434
context={"endpoint"}
3535
></MethodEndpoint>
3636

37-
<MarkerStronglyConsistentExtension /> [Learn about endpoint
38-
consistency](../../orchestration-cluster-api-rest-data-fetching/#data-consistency)
37+
<MarkerStronglyConsistentExtension />
3938

4039
Iterate through all known partitions and activate jobs up to the requested maximum.
4140

docs/apis-tools/orchestration-cluster-api-rest/specifications/assign-client-to-group.api.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: assign-client-to-group
33
title: "Assign a client to a group"
4-
description: "<MarkerStronglyConsistentExtension /> [Learn about endpoint consistency](../../orchestration-cluster-api-rest-data-fetching/#data-consistency)"
4+
description: "<MarkerStronglyConsistentExtension />"
55
sidebar_label: "Assign a client to a group"
66
hide_title: true
77
hide_table_of_contents: true
@@ -34,8 +34,7 @@ import Heading from "@theme/Heading";
3434
context={"endpoint"}
3535
></MethodEndpoint>
3636

37-
<MarkerStronglyConsistentExtension /> [Learn about endpoint
38-
consistency](../../orchestration-cluster-api-rest-data-fetching/#data-consistency)
37+
<MarkerStronglyConsistentExtension />
3938

4039
Assigns a client to a group, making it a member of the group.
4140
Members of the group inherit the group authorizations, roles, and tenant assignments.

docs/apis-tools/orchestration-cluster-api-rest/specifications/assign-client-to-tenant.api.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: assign-client-to-tenant
33
title: "Assign a client to a tenant"
4-
description: "<MarkerStronglyConsistentExtension /> [Learn about endpoint consistency](../../orchestration-cluster-api-rest-data-fetching/#data-consistency)"
4+
description: "<MarkerStronglyConsistentExtension />"
55
sidebar_label: "Assign a client to a tenant"
66
hide_title: true
77
hide_table_of_contents: true
@@ -34,8 +34,7 @@ import Heading from "@theme/Heading";
3434
context={"endpoint"}
3535
></MethodEndpoint>
3636

37-
<MarkerStronglyConsistentExtension /> [Learn about endpoint
38-
consistency](../../orchestration-cluster-api-rest-data-fetching/#data-consistency)
37+
<MarkerStronglyConsistentExtension />
3938

4039
Assign the client to the specified tenant.
4140
The client can then access tenant data and perform authorized actions.

docs/apis-tools/orchestration-cluster-api-rest/specifications/assign-group-to-tenant.api.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: assign-group-to-tenant
33
title: "Assign a group to a tenant"
4-
description: "<MarkerStronglyConsistentExtension /> [Learn about endpoint consistency](../../orchestration-cluster-api-rest-data-fetching/#data-consistency)"
4+
description: "<MarkerStronglyConsistentExtension />"
55
sidebar_label: "Assign a group to a tenant"
66
hide_title: true
77
hide_table_of_contents: true
@@ -34,8 +34,7 @@ import Heading from "@theme/Heading";
3434
context={"endpoint"}
3535
></MethodEndpoint>
3636

37-
<MarkerStronglyConsistentExtension /> [Learn about endpoint
38-
consistency](../../orchestration-cluster-api-rest-data-fetching/#data-consistency)
37+
<MarkerStronglyConsistentExtension />
3938

4039
Assigns a group to a specified tenant.
4140
Group members (users, clients) can then access tenant data and perform authorized actions.

docs/apis-tools/orchestration-cluster-api-rest/specifications/assign-mapping-rule-to-group.api.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: assign-mapping-rule-to-group
33
title: "Assign a mapping rule to a group"
4-
description: "<MarkerStronglyConsistentExtension /> [Learn about endpoint consistency](../../orchestration-cluster-api-rest-data-fetching/#data-consistency)"
4+
description: "<MarkerStronglyConsistentExtension />"
55
sidebar_label: "Assign a mapping rule to a group"
66
hide_title: true
77
hide_table_of_contents: true
@@ -34,8 +34,7 @@ import Heading from "@theme/Heading";
3434
context={"endpoint"}
3535
></MethodEndpoint>
3636

37-
<MarkerStronglyConsistentExtension /> [Learn about endpoint
38-
consistency](../../orchestration-cluster-api-rest-data-fetching/#data-consistency)
37+
<MarkerStronglyConsistentExtension />
3938

4039
Assigns a mapping rule to a group.
4140

docs/apis-tools/orchestration-cluster-api-rest/specifications/assign-mapping-rule-to-tenant.api.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: assign-mapping-rule-to-tenant
33
title: "Assign a mapping rule to a tenant"
4-
description: "<MarkerStronglyConsistentExtension /> [Learn about endpoint consistency](../../orchestration-cluster-api-rest-data-fetching/#data-consistency)"
4+
description: "<MarkerStronglyConsistentExtension />"
55
sidebar_label: "Assign a mapping rule to a tenant"
66
hide_title: true
77
hide_table_of_contents: true
@@ -34,8 +34,7 @@ import Heading from "@theme/Heading";
3434
context={"endpoint"}
3535
></MethodEndpoint>
3636

37-
<MarkerStronglyConsistentExtension /> [Learn about endpoint
38-
consistency](../../orchestration-cluster-api-rest-data-fetching/#data-consistency)
37+
<MarkerStronglyConsistentExtension />
3938

4039
Assign a single mapping rule to a specified tenant.
4140

docs/apis-tools/orchestration-cluster-api-rest/specifications/assign-role-to-client.api.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: assign-role-to-client
33
title: "Assign a role to a client"
4-
description: "<MarkerStronglyConsistentExtension /> [Learn about endpoint consistency](../../orchestration-cluster-api-rest-data-fetching/#data-consistency)"
4+
description: "<MarkerStronglyConsistentExtension />"
55
sidebar_label: "Assign a role to a client"
66
hide_title: true
77
hide_table_of_contents: true
@@ -34,8 +34,7 @@ import Heading from "@theme/Heading";
3434
context={"endpoint"}
3535
></MethodEndpoint>
3636

37-
<MarkerStronglyConsistentExtension /> [Learn about endpoint
38-
consistency](../../orchestration-cluster-api-rest-data-fetching/#data-consistency)
37+
<MarkerStronglyConsistentExtension />
3938

4039
Assigns the specified role to the client. The client will inherit the authorizations associated with this role.
4140

docs/apis-tools/orchestration-cluster-api-rest/specifications/assign-role-to-group.api.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: assign-role-to-group
33
title: "Assign a role to a group"
4-
description: "<MarkerStronglyConsistentExtension /> [Learn about endpoint consistency](../../orchestration-cluster-api-rest-data-fetching/#data-consistency)"
4+
description: "<MarkerStronglyConsistentExtension />"
55
sidebar_label: "Assign a role to a group"
66
hide_title: true
77
hide_table_of_contents: true
@@ -34,8 +34,7 @@ import Heading from "@theme/Heading";
3434
context={"endpoint"}
3535
></MethodEndpoint>
3636

37-
<MarkerStronglyConsistentExtension /> [Learn about endpoint
38-
consistency](../../orchestration-cluster-api-rest-data-fetching/#data-consistency)
37+
<MarkerStronglyConsistentExtension />
3938

4039
Assigns the specified role to the group. Every member of the group (user or client) will inherit the authorizations associated with this role.
4140

docs/apis-tools/orchestration-cluster-api-rest/specifications/assign-role-to-mapping-rule.api.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: assign-role-to-mapping-rule
33
title: "Assign a role to a mapping rule"
4-
description: "<MarkerStronglyConsistentExtension /> [Learn about endpoint consistency](../../orchestration-cluster-api-rest-data-fetching/#data-consistency)"
4+
description: "<MarkerStronglyConsistentExtension />"
55
sidebar_label: "Assign a role to a mapping rule"
66
hide_title: true
77
hide_table_of_contents: true
@@ -34,8 +34,7 @@ import Heading from "@theme/Heading";
3434
context={"endpoint"}
3535
></MethodEndpoint>
3636

37-
<MarkerStronglyConsistentExtension /> [Learn about endpoint
38-
consistency](../../orchestration-cluster-api-rest-data-fetching/#data-consistency)
37+
<MarkerStronglyConsistentExtension />
3938

4039
Assigns a role to a mapping rule.
4140

0 commit comments

Comments
 (0)