Skip to content

Commit

Permalink
renaming apis tools (#2574)
Browse files Browse the repository at this point in the history
  • Loading branch information
christinaausley authored Sep 11, 2023
1 parent 1dcdc82 commit d0c2e26
Show file tree
Hide file tree
Showing 43 changed files with 111 additions and 111 deletions.
6 changes: 3 additions & 3 deletions docs/apis-tools/cli-client/cli-get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ title: Getting started with the CLI client
sidebar_label: "Getting started with the CLI client"
---

In this tutorial, you will learn to use the CLI client `zbctl` to interact with Camunda Platform 8.
In this tutorial, you will learn to use the CLI client `zbctl` to interact with Camunda 8.

## Prerequisites

- [Camunda Platform 8 account](/guides/create-account.md)
- [Camunda 8 account](/guides/create-account.md)
- [Cluster](/guides/create-cluster.md)
- [Client credentials](/guides/setup-client-connection-credentials.md)
- [Modeler](/guides/model-your-first-process.md)
Expand Down Expand Up @@ -37,7 +37,7 @@ export ZEEBE_CLIENT_SECRET='[Client Secret]'
export ZEEBE_AUTHORIZATION_SERVER_URL='[OAuth API]'
```

When creating client credentials in Camunda Platform 8, you have the option to download a file with the lines above filled out for you.
When creating client credentials in Camunda 8, you have the option to download a file with the lines above filled out for you.

Alternatively, use the [described flags](https://www.npmjs.com/package/zbctl#usage) (`--address`, `--clientId`, and `--clientSecret`) with the `zbctl` commands.

Expand Down
6 changes: 3 additions & 3 deletions docs/apis-tools/cli-client/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
id: index
title: CLI client
sidebar_label: "Quick reference"
description: "Learn how to use the CLI client and command line interface `zbctl` to interact with Camunda Platform 8 and test a connection."
description: "Learn how to use the CLI client and command line interface `zbctl` to interact with Camunda 8 and test a connection."
---

`zbctl` is the command line interface to interact with Camunda Platform 8. After installation, a connection can be tested immediately.
`zbctl` is the command line interface to interact with Camunda 8. After installation, a connection can be tested immediately.

## Installation

Expand All @@ -28,7 +28,7 @@ export ZEEBE_CLIENT_SECRET='[Client Secret]'
export ZEEBE_AUTHORIZATION_SERVER_URL='[OAuth API]'
```

When you create client credentials in Camunda Platform 8, you have the option to download a file with the lines above filled out for you.
When you create client credentials in Camunda 8, you have the option to download a file with the lines above filled out for you.

Alternatively, use the [described flags](https://www.npmjs.com/package/zbctl#usage) (`--address`, `--clientId`, and `--clientSecret`) with the `zbctl` commands.

Expand Down
10 changes: 5 additions & 5 deletions docs/apis-tools/console-api-reference.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
---
id: console-api-reference
title: Console API clients (REST)
description: "Create and manage clusters, and interact with Camunda Platform 8 programmatically without using the Camunda Platform 8 Console."
description: "Create and manage clusters, and interact with Camunda 8 programmatically without using the Camunda 8 Console."
---

## Console API (REST)

For all requests, include the access token in the Authorization header: `authorization:Bearer ${TOKEN}`.

:::note
A detailed API description can be found [here](https://console.cloud.camunda.io/customer-api/openapi/docs/#/) via Swagger. With a valid access token, this offers an interactive API experience against your Camunda Platform 8 cluster.
A detailed API description can be found [here](https://console.cloud.camunda.io/customer-api/openapi/docs/#/) via Swagger. With a valid access token, this offers an interactive API experience against your Camunda 8 cluster.
:::

### Client credentials and scopes

To interact with Camunda Platform 8 programmatically without using the Camunda Platform 8 Console, create client credentials in the organization settings under the **Console API** tab.
To interact with Camunda 8 programmatically without using the Camunda 8 Console, create client credentials in the organization settings under the **Console API** tab.

Client credentials are created for an organization, and therefore can access all Camunda Platform 8 clusters of this organization.
Client credentials are created for an organization, and therefore can access all Camunda 8 clusters of this organization.

Scopes define the access for client credentials. A client can have one or multiple of the following permissions:

Expand All @@ -30,7 +30,7 @@ A client can have one or multiple permissions from the following groups:
- **IP Whitelist**: Configure [IP-Whitelist](../components/console/manage-clusters/manage-ip-whitelists.md) rules.
- **Connector Secrets**: [Manage secrets](../components/console/manage-clusters/manage-secrets.md) of your clusters.
- **Members**: [Manage members](../components/console/manage-organization/manage-users.md) of your organization.
- **Backups**: Manage [backups](https://docs.camunda.io/docs/components/concepts/backups) of your Camunda Platform 8 clusters (only available to Enterprise customers).
- **Backups**: Manage [backups](https://docs.camunda.io/docs/components/concepts/backups) of your Camunda 8 clusters (only available to Enterprise customers).

The full API description can be found [here](https://console.cloud.camunda.io/customer-api/openapi/docs/#/).

Expand Down
14 changes: 7 additions & 7 deletions docs/apis-tools/go-client/go-get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ sidebar_label: "Getting started with the Go client"
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

In this tutorial, you will learn how to use the Go client in a Go application to interact with Camunda Platform 8.
In this tutorial, you will learn how to use the Go client in a Go application to interact with Camunda 8.

You can find a complete example on [GitHub](https://github.com/camunda/camunda-platform-get-started/tree/main/go).

## Prerequisites

- [Camunda Platform 8 account](/guides/create-account.md)
- [Camunda 8 account](/guides/create-account.md)
- [Cluster](/guides/create-cluster.md)
- [Client credentials](/guides/setup-client-connection-credentials.md)
- [Go v1.13+ environment installed](https://go.dev/)
Expand Down Expand Up @@ -50,7 +50,7 @@ export ZEEBE_AUTHORIZATION_SERVER_URL='[OAuth API]'
```

:::note
When you create client credentials in Camunda Platform 8, you have the option to download a file with the lines above filled out for you.
When you create client credentials in Camunda 8, you have the option to download a file with the lines above filled out for you.
:::

4. Create a `main.go` file inside the module and add the following lines to bootstrap the Zeebe client:
Expand Down Expand Up @@ -141,7 +141,7 @@ Now, we need a simple process we can deploy. Later, we will extend the process w

<TabItem value='desktop'>

1. Open Desktop Modeler and create a new Camunda Platform 8 BPMN diagram named `order-process.bpmn`.
1. Open Desktop Modeler and create a new Camunda 8 BPMN diagram named `order-process.bpmn`.

2. Add a start event named `Order Placed` and an end event named `Order Delivered` to the diagram. Then, connect the events.

Expand Down Expand Up @@ -236,9 +236,9 @@ processKey:2251799813686742 bpmnProcessId:"order-process" version:3 processInsta

Want to note how the process instance is executed? Follow the steps below:

1. Go to the cluster in Camunda Platform 8 and select it.
1. Click on the link to [Operate](/components/operate/userguide/basic-operate-navigation.md).
1. Select the process **order process**.
1. Go to the cluster in Camunda 8 and select it.
2. Click on the link to [Operate](/components/operate/userguide/basic-operate-navigation.md).
3. Select the process **order process**.

A process instance has now been started and finished.

Expand Down
4 changes: 2 additions & 2 deletions docs/apis-tools/go-client/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: index
title: "Go client"
sidebar_label: "Quick reference"
description: "Instantiate the client by passing in the address of the cluster you want to connect to in a Go application to interact with Camunda Platform 8."
description: "Instantiate the client by passing in the address of the cluster you want to connect to in a Go application to interact with Camunda 8."
---

## Dependencies
Expand Down Expand Up @@ -76,7 +76,7 @@ export ZEEBE_CLIENT_SECRET='[Client Secret]'
export ZEEBE_AUTHORIZATION_SERVER_URL='[OAuth API]'
```

When you create client credentials in Camunda Platform 8, you have the option to download a file with the lines above filled out for you.
When you create client credentials in Camunda 8, you have the option to download a file with the lines above filled out for you.

Given these environment variables, you can instantiate the client as follows:

Expand Down
2 changes: 1 addition & 1 deletion docs/apis-tools/java-client/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ export ZEEBE_CLIENT_SECRET='[Client Secret]'
export ZEEBE_AUTHORIZATION_SERVER_URL='[OAuth API]'
```

When you create client credentials in Camunda Platform 8, you have the option to download a file with the lines above filled out for you.
When you create client credentials in Camunda 8, you have the option to download a file with the lines above filled out for you.

Given these environment variables, you can instantiate the client as follows:

Expand Down
2 changes: 1 addition & 1 deletion docs/apis-tools/java-client/zeebe-process-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: zeebe-process-test
title: "Zeebe Process Test"
---

[Zeebe Process Test](https://github.com/camunda-cloud/zeebe-process-test) allows you to unit test your Camunda Platform 8 BPMN
[Zeebe Process Test](https://github.com/camunda-cloud/zeebe-process-test) allows you to unit test your Camunda 8 BPMN
processes. It will start a Zeebe test engine and provide you with a set of assertions you can use to verify your process
behaves as expected.

Expand Down
2 changes: 1 addition & 1 deletion docs/apis-tools/operate-api/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ The following settings are needed to request a token:
| authorization server url | Token issuer server | - |

:::note
For more information on how to get these values for Camunda Platform 8, read [Manage API Clients](/docs/components/console/manage-clusters/manage-api-clients/).
For more information on how to get these values for Camunda 8, read [Manage API Clients](/docs/components/console/manage-clusters/manage-api-clients/).
:::

Send a token issue _POST_ request to the authorization server with the required settings:
Expand Down
6 changes: 3 additions & 3 deletions docs/apis-tools/public-api.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
id: public-api
title: "Public API"
description: "Camunda Platform 8 provides a public API. Obtain more information on backwards compatibility for version updates."
description: "Camunda 8 provides a public API. Obtain more information on backwards compatibility for version updates."
---

Camunda Platform 8 provides a public API. This section covers the definition of the public API and backwards compatibility for version updates.
Camunda 8 provides a public API. This section covers the definition of the public API and backwards compatibility for version updates.

## Backwards compatibility for public API

Camunda Platform 8 versioning scheme follows the `MAJOR.MINOR.PATCH` pattern put forward by [semantic versioning](https://semver.org/). Camunda Platform 8 will
Camunda 8 versioning scheme follows the `MAJOR.MINOR.PATCH` pattern put forward by [semantic versioning](https://semver.org/). Camunda 8 will
maintain public API backwards compatibility for `MINOR` version updates.

Example: Update from version `1.0.x` to `1.1.y` will not break the public API.
Expand Down
2 changes: 1 addition & 1 deletion docs/apis-tools/tasklist-api/tasklist-api-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The GraphQL API will be deprecated in the near future. To ensure a smooth transi

Tasklist provides a GraphQL API at endpoint `/graphql`.

From Camunda Platform 8 the endpoint is `${base-url}/graphql`.
From Camunda 8 the endpoint is `${base-url}/graphql`.

For SaaS: `https://${REGION}.tasklist.camunda.io:443/${CLUSTER_ID}/graphql`, and for Self-Managed installations: `http://localhost:8080/graphql`.

Expand Down
2 changes: 1 addition & 1 deletion docs/apis-tools/tasklist-api/tasklist-api-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ For this tutorial we'll need:

- Node v14+
- The [NestJS CLI](https://docs.nestjs.com/cli/overview) tool. Install it by running `npm install -g @nestjs/cli`.
- [A cluster on Camunda Platform 8](../../components/console/manage-clusters/create-cluster.md)
- [A cluster on Camunda 8](../../components/console/manage-clusters/create-cluster.md)
- [A set of API credentials; remember to check the Tasklist option when creating them](../../components/console/manage-clusters/manage-api-clients.md). Don't forget to save these, we'll need them later.
- [A clone of this repo](https://github.com/camunda-community-hub/camunda-cloud-tasklist-api-nestjs)

Expand Down
18 changes: 9 additions & 9 deletions docs/apis-tools/working-with-apis-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@
id: working-with-apis-tools
title: "Working with APIs & tools"
sidebar_label: "Working with APIs & tools"
description: "Interact programmatically with Camunda Platform 8 using official Zeebe client libraries and APIs."
description: "Interact programmatically with Camunda 8 using official Zeebe client libraries and APIs."
---

import DocCardList from '@theme/DocCardList';

This section steps through two concepts for integration:

- **Control your Camunda Platform 8 process automation** by [deploying processes](/components/modeler/web-modeler/run-or-publish-your-process.md#deploy-a-process), [starting process instances](/components/modeler/web-modeler/run-or-publish-your-process.md), [activating jobs](/components/concepts/job-workers.md), and more using supplemental and community-maintained **Zeebe client libraries**.
- **Interact with the Camunda Platform 8 ecosystem** by learning about [Camunda Components](/components/components-overview.md) and their APIs to communicate with your cluster, search, get and change data, create Cloud API clients, and more.
- **Control your Camunda 8 process automation** by [deploying processes](/components/modeler/web-modeler/run-or-publish-your-process.md#deploy-a-process), [starting process instances](/components/modeler/web-modeler/run-or-publish-your-process.md), [activating jobs](/components/concepts/job-workers.md), and more using supplemental and community-maintained **Zeebe client libraries**.
- **Interact with the Camunda 8 ecosystem** by learning about [Camunda Components](/components/components-overview.md) and their APIs to communicate with your cluster, search, get and change data, create Cloud API clients, and more.

:::note
You're permitted to use these web apps and APIs for free with the Free Edition in non-production environments. To use the software in production, [purchase the Camunda Platform Enterprise Edition](https://camunda.com/products/cloud/camunda-cloud-enterprise-contact/). Read more in our [licensing](../reference/licenses.md) documentation.
You're permitted to use these web apps and APIs for free with the Free Edition in non-production environments. To use the software in production, [purchase the Camunda Enterprise Edition](https://camunda.com/products/cloud/camunda-cloud-enterprise-contact/). Read more in our [licensing](../reference/licenses.md) documentation.
:::

## Deploy processes, start process instances, and more using Zeebe client libraries
Expand All @@ -26,9 +26,9 @@ Clients allow applications to do the following:
- Publish messages.
- Update process instance variables and resolve incidents.

The official clients mentioned below interact with [Zeebe](/components/zeebe/zeebe-overview.md), the workflow engine integrated into Camunda Platform 8. All clients require [setting up client credentials](/guides/setup-client-connection-credentials.md) to authenticate. Clients connect to Camunda Platform 8 via [gRPC](https://grpc.io), a high-performance, open source, and universal RPC protocol.
The official clients mentioned below interact with [Zeebe](/components/zeebe/zeebe-overview.md), the workflow engine integrated into Camunda 8. All clients require [setting up client credentials](/guides/setup-client-connection-credentials.md) to authenticate. Clients connect to Camunda 8 via [gRPC](https://grpc.io), a high-performance, open source, and universal RPC protocol.

Camunda Platform 8 provides several official clients based on this API. Official clients have been developed and tested by Camunda. They also add convenience functions (for example, thread handling for job workers) on top of the core API.
Camunda 8 provides several official clients based on this API. Official clients have been developed and tested by Camunda. They also add convenience functions (for example, thread handling for job workers) on top of the core API.

### Official Zeebe clients

Expand All @@ -44,14 +44,14 @@ type:"link", href:"/docs/next/apis-tools/java-client/", label: "Java client", do
]}/>

:::note
Other components in Camunda Platform 8, such as [Tasklist API (GraphQL)](../apis-tools/tasklist-api/generated.md), provide language-agnostic APIs, but no clients to interact with them. GraphQL enables you to query, claim, and complete user tasks.
Other components in Camunda 8, such as [Tasklist API (GraphQL)](../apis-tools/tasklist-api/generated.md), provide language-agnostic APIs, but no clients to interact with them. GraphQL enables you to query, claim, and complete user tasks.
:::

## Learn about Camunda Components and their APIs

Camunda Platform 8 components have APIs to enable polyglot developers to work with in their programming language of choice. Below are links to available component APIs.
Camunda 8 components have APIs to enable polyglot developers to work with in their programming language of choice. Below are links to available component APIs.

![Architecture diagram for Camunda Platform including all the components for SaaS](./img/ComponentsAndArchitecture_SaaS.png)
![Architecture diagram for Camunda including all the components for SaaS](./img/ComponentsAndArchitecture_SaaS.png)

### API Reference

Expand Down
4 changes: 2 additions & 2 deletions optimize/apis-tools/optimize-api/event-ingestion.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ title: "Event ingestion"
description: "The REST API to ingest external events into Optimize."
---

<span class="badge badge--platform">Camunda Platform 7 only</span>
<span class="badge badge--platform">Camunda 7 only</span>

The Event Ingestion REST API ingests business process related event data from any third-party system to Camunda Optimize. These events can then be correlated into an [event-based process](components/userguide/additional-features/event-based-processes.md) in Optimize to get business insights into business processes that are not yet fully modeled nor automated using Camunda Platform 7.
The Event Ingestion REST API ingests business process related event data from any third-party system to Camunda Optimize. These events can then be correlated into an [event-based process](components/userguide/additional-features/event-based-processes.md) in Optimize to get business insights into business processes that are not yet fully modeled nor automated using Camunda 7.

## Functionality

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Given a valid token `mySecret`, the header would need to be set as follows:
Authorization: Bearer mySecret
```

The token used to access the Optimize API can be a configurable shared secret (except in Camunda Platform 8 SaaS mode) or a JWT compliant with the OAuth2 Protocol (all modes).
The token used to access the Optimize API can be a configurable shared secret (except in Camunda 8 SaaS mode) or a JWT compliant with the OAuth2 Protocol (all modes).

Refer to [Public API Configuration](../../self-managed/optimize-deployment/configuration/system-configuration.md#public-api) for the particular configuration to access the public API using a token.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ title: "Event ingestion"
description: "The REST API to ingest external events into Optimize."
---

<span class="badge badge--platform">Camunda Platform 7 only</span>
<span class="badge badge--platform">Camunda 7 only</span>

The Event Ingestion REST API ingests business process related event data from any third-party system to Camunda Optimize. These events can then be correlated into an [event-based process](components/userguide/additional-features/event-based-processes.md) in Optimize to get business insights into business processes that are not yet fully modeled nor automated using Camunda Platform 7.
The Event Ingestion REST API ingests business process related event data from any third-party system to Camunda Optimize. These events can then be correlated into an [event-based process](components/userguide/additional-features/event-based-processes.md) in Optimize to get business insights into business processes that are not yet fully modeled nor automated using Camunda 7.

## Functionality

Expand Down
Loading

0 comments on commit d0c2e26

Please sign in to comment.