diff --git a/docs/apis-tools/web-modeler-api/authentication.md b/docs/apis-tools/web-modeler-api/authentication.md index 388f3f494b..2182aee180 100644 --- a/docs/apis-tools/web-modeler-api/authentication.md +++ b/docs/apis-tools/web-modeler-api/authentication.md @@ -70,7 +70,7 @@ To authenticate for the API, generate a JWT token depending on your environment To use the JWT token in the cloud, use the following command: ```shell - curl -o - 'https://modeler.cloud.camunda.io/api/v1/info' -H 'Authorization: Bearer eyJhb...' + curl -o - 'https://modeler.camunda.io/api/v1/info' -H 'Authorization: Bearer eyJhb...' ``` When using a Self-Managed installation, you can use the following command instead: diff --git a/docs/apis-tools/web-modeler-api/index.md b/docs/apis-tools/web-modeler-api/index.md index 2072f90e96..43d1d5d9c1 100644 --- a/docs/apis-tools/web-modeler-api/index.md +++ b/docs/apis-tools/web-modeler-api/index.md @@ -14,7 +14,7 @@ Ensure you [authenticate](./authentication.md) before accessing the Web Modeler ## OpenAPI documentation -A detailed API description is available as [OpenAPI](https://www.openapis.org/) specification at [https://modeler.cloud.camunda.io/swagger-ui/index.html](https://modeler.cloud.camunda.io/swagger-ui/index.html) +A detailed API description is available as [OpenAPI](https://www.openapis.org/) specification at [https://modeler.camunda.io/swagger-ui/index.html](https://modeler.camunda.io/swagger-ui/index.html) for SaaS and at [http://localhost:8070/swagger-ui.html](http://localhost:8070/swagger-ui.html) for Self-Managed installations. diff --git a/docs/components/connectors/protocol/rest.md b/docs/components/connectors/protocol/rest.md index 05dae186b3..4a2b159f3b 100644 --- a/docs/components/connectors/protocol/rest.md +++ b/docs/components/connectors/protocol/rest.md @@ -142,7 +142,7 @@ Similarly to the Query Parameters, the **HTTP headers** can be specified using t ``` = { - Origin: "https://modeler.cloud.camunda.io/" + Origin: "https://modeler.camunda.io/" } ``` diff --git a/docs/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md b/docs/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md index a91f8d177f..6ececf915e 100644 --- a/docs/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md +++ b/docs/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md @@ -26,7 +26,7 @@ Each pipeline is unique. The Web Modeler API offers flexibility to tailor integr - A platform to host a version control system (VCS) such as GitHub or GitLab. - An existing pipeline or a plan to set one up using tools like [CircleCI](https://circleci.com/) or [Jenkins](https://www.jenkins.io/), cloud platforms such as [Azure DevOps Pipelines](https://azure.microsoft.com/de-de/products/devops), or built-in solutions of VCS platforms like [GitHub Actions](https://github.com/features/actions) or [GitLab's DevSecOps Lifecycle](https://about.gitlab.com/stages-devops-lifecycle/). -- Make yourself familiar with the [Web Modeler API](/apis-tools/web-modeler-api/index.md) through the [OpenAPI documentation](https://modeler.cloud.camunda.io/swagger-ui/index.html). +- Make yourself familiar with the [Web Modeler API](/apis-tools/web-modeler-api/index.md) through the [OpenAPI documentation](https://modeler.camunda.io/swagger-ui/index.html). - Understand how [clusters](/components/concepts/clusters.md) work in Camunda 8. - Ensure you’ve [created a Camunda 8 account](/guides/create-account.md), or installed [Camunda 8 Self-Managed](/self-managed/about-self-managed.md). @@ -91,7 +91,7 @@ Synchronize files between Web Modeler and version control systems (VCS) and vice For automatic file synchronization, consider maintaining a secondary system of record for mapping Web Modeler projects to VCS repositories. This system also monitors the project-to-repository mapping and update timestamps. -To listen to changes in Web Modeler, you currently need to implement a polling approach that compares the update dates with the last sync dates recorded. Use the `POST /api/v1/files/search` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Files/searchFiles) with the following payload to identify files updated after the last sync date: +To listen to changes in Web Modeler, you currently need to implement a polling approach that compares the update dates with the last sync dates recorded. Use the `POST /api/v1/files/search` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Files/searchFiles) with the following payload to identify files updated after the last sync date: ```json title="POST /api/v1/files/search" { @@ -116,7 +116,7 @@ Real-time synchronization isn't always what you need. Consider Web Modeler as a A milestone reflects a state of a file in Web Modeler with a certain level of qualification, such as being ready for deployment. You can use this property to trigger deployments when a certain milestone is created. -Currently, you have to poll for milestones to listen to new ones created. Use the `POST /api/v1/milestones/search` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Milestones/searchMilestones) with the following payload to identify milestones created after the last sync date: +Currently, you have to poll for milestones to listen to new ones created. Use the `POST /api/v1/milestones/search` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Milestones/searchMilestones) with the following payload to identify milestones created after the last sync date: ```json title="POST /api/v1/milestones/search" { @@ -226,10 +226,10 @@ For unit tests, select a test framework suitable for your environment. If workin ### Review stage -During reviews, use the Modeler API again to [add collaborators](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Collaborators/modifyCollaborator), or to [create links to visual diffs of your milestones](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Milestones/compareMilestones), and automatically paste them into your GitHub or GitLab pull or merge requests. +During reviews, use the Modeler API again to [add collaborators](https://modeler.camunda.io/swagger-ui/index.html#/Collaborators/modifyCollaborator), or to [create links to visual diffs of your milestones](https://modeler.camunda.io/swagger-ui/index.html#/Milestones/compareMilestones), and automatically paste them into your GitHub or GitLab pull or merge requests. This provides you the freedom to let reviews happen where you want them, and even include business by sharing the diff links with them in an automated fashion. -After review, use the `DELETE /api/v1/projects/{projectId}/collaborators/email` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Collaborators/deleteCollaborator) to remove collaborators again. +After review, use the `DELETE /api/v1/projects/{projectId}/collaborators/email` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Collaborators/deleteCollaborator) to remove collaborators again. #### Create a link to a visual diff for reviews @@ -237,7 +237,7 @@ Use milestones to indicate a state for review. Use the `POST /api/v1/milestones` While it is possible to do a diff of your diagrams by comparing the XML in your VCS system, this is often not very convenient, and lacks insight into process flow changes. This approach is also less effective when involving business stakeholders in the review. -The Web Modeler API addresses this by providing an endpoint to generate visual diff links for milestones. Utilize the `GET /api/v1/milestones/compare/{milestone1Id}...{milestone2Id}` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Milestones/compareMilestones) to compare two milestones. Obtain IDs for the latest milestones via the `POST /api/v1/milestones/search` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Milestones/searchMilestones), utilizing the `fileId` filter to identify the file to review. The resulting URL leads to a visual diff page similar to this: +The Web Modeler API addresses this by providing an endpoint to generate visual diff links for milestones. Utilize the `GET /api/v1/milestones/compare/{milestone1Id}...{milestone2Id}` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Milestones/compareMilestones) to compare two milestones. Obtain IDs for the latest milestones via the `POST /api/v1/milestones/search` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Milestones/searchMilestones), utilizing the `fileId` filter to identify the file to review. The resulting URL leads to a visual diff page similar to this: ![Visual diff of two milestones](img/visual-diff.png) diff --git a/docs/guides/getting-started-orchestrate-apis.md b/docs/guides/getting-started-orchestrate-apis.md index 880f19567e..d81b24bbaf 100644 --- a/docs/guides/getting-started-orchestrate-apis.md +++ b/docs/guides/getting-started-orchestrate-apis.md @@ -77,7 +77,7 @@ Don't want to build the process yourself? Click this button to create it from a className={clsx( "button button--outline button--secondary button--lg" )} - href="https://modeler.cloud.camunda.io/tutorial/quick-start-api-orchestration?utm_source=docs.camunda.io.gettingstarted"> + href="https://modeler.camunda.io/tutorial/quick-start-api-orchestration?utm_source=docs.camunda.io.gettingstarted"> Open model in Camunda 8 + href="https://modeler.camunda.io/tutorial/quick-start-human-tasks?utm_source=docs.camunda.io.gettingstarted"> Open model in Camunda 8 + href="https://modeler.camunda.io/tutorial/quick-start-microservices?utm_source=docs.camunda.io.gettingstarted"> Open model in Camunda 8 + href="https://modeler.camunda.io/tutorial/quick-start-api-orchestration?utm_source=docs.camunda.io.gettingstarted"> Open model in Camunda 8 + href="https://modeler.camunda.io/tutorial/quick-start-human-tasks?utm_source=docs.camunda.io.gettingstarted"> Open model in Camunda 8 + href="https://modeler.camunda.io/tutorial/quick-start-microservices?utm_source=docs.camunda.io.gettingstarted"> Open model in Camunda 8 Beginner Time estimate: 5 minutes -This guide steps through how to migrate BPMN diagrams created in Cawemo to Camunda 8 [Web Modeler](https://modeler.cloud.camunda.io/). +This guide steps through how to migrate BPMN diagrams created in Cawemo to Camunda 8 [Web Modeler](https://modeler.camunda.io/). You should consider migrating diagrams from Cawemo to Camunda 8 Web Modeler if: diff --git a/versioned_docs/version-8.3/apis-tools/web-modeler-api/index.md b/versioned_docs/version-8.3/apis-tools/web-modeler-api/index.md index e567c9801b..10cf76e737 100644 --- a/versioned_docs/version-8.3/apis-tools/web-modeler-api/index.md +++ b/versioned_docs/version-8.3/apis-tools/web-modeler-api/index.md @@ -11,7 +11,7 @@ Web Modeler provides a REST API at `/api/*`. Clients can access this API by pass ## OpenAPI documentation -A detailed API description is available as [OpenAPI](https://www.openapis.org/) specification at [https://modeler.cloud.camunda.io/swagger-ui/index.html](https://modeler.cloud.camunda.io/swagger-ui/index.html) +A detailed API description is available as [OpenAPI](https://www.openapis.org/) specification at [https://modeler.camunda.io/swagger-ui/index.html](https://modeler.camunda.io/swagger-ui/index.html) for SaaS and at [http://localhost:8070/swagger-ui.html](http://localhost:8070/swagger-ui.html) for Self-Managed installations. @@ -78,7 +78,7 @@ To authenticate for the API, generate a JWT token depending on your environment To use the JWT token in the cloud, use the following command: ```shell - curl -o - 'https://modeler.cloud.camunda.io/api/v1/info' -H 'Authorization: Bearer eyJhb...' + curl -o - 'https://modeler.camunda.io/api/v1/info' -H 'Authorization: Bearer eyJhb...' ``` When using a Self-Managed installation, you can use the following command instead: diff --git a/versioned_docs/version-8.3/components/connectors/protocol/rest.md b/versioned_docs/version-8.3/components/connectors/protocol/rest.md index aba75cf00e..5683db47a4 100644 --- a/versioned_docs/version-8.3/components/connectors/protocol/rest.md +++ b/versioned_docs/version-8.3/components/connectors/protocol/rest.md @@ -140,7 +140,7 @@ Similarly to the Query Parameters, the **HTTP headers** can be specified using t ``` = { - Origin: "https://modeler.cloud.camunda.io/" + Origin: "https://modeler.camunda.io/" } ``` diff --git a/versioned_docs/version-8.3/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md b/versioned_docs/version-8.3/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md index 2fb6b71536..0861c59074 100644 --- a/versioned_docs/version-8.3/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md +++ b/versioned_docs/version-8.3/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md @@ -26,7 +26,7 @@ Each pipeline is unique. The Web Modeler API offers flexibility to tailor integr - A platform to host a version control system (VCS) such as GitHub or GitLab. - An existing pipeline or a plan to set one up using tools like [CircleCI](https://circleci.com/) or [Jenkins](https://www.jenkins.io/), cloud platforms such as [Azure DevOps Pipelines](https://azure.microsoft.com/de-de/products/devops), or built-in solutions of VCS platforms like [GitHub Actions](https://github.com/features/actions) or [GitLab's DevSecOps Lifecycle](https://about.gitlab.com/stages-devops-lifecycle/). -- Make yourself familiar with the [Web Modeler API](/apis-tools/web-modeler-api/index.md) through the [OpenAPI documentation](https://modeler.cloud.camunda.io/swagger-ui/index.html). +- Make yourself familiar with the [Web Modeler API](/apis-tools/web-modeler-api/index.md) through the [OpenAPI documentation](https://modeler.camunda.io/swagger-ui/index.html). - Understand how [clusters](/components/concepts/clusters.md) work in Camunda 8. - Ensure you’ve [created a Camunda 8 account](/guides/create-account.md), or installed [Camunda 8 Self-Managed](/self-managed/about-self-managed.md). @@ -78,7 +78,7 @@ Synchronize files between Web Modeler and version control systems (VCS) and vice For automatic file synchronization, consider maintaining a secondary system of record for mapping Web Modeler projects to VCS repositories. This system also monitors the project-to-repository mapping and update timestamps. -To listen to changes in Web Modeler, you currently need to implement a polling approach that compares the update dates with the last sync dates recorded. Use the `POST /api/v1/files/search` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Files/searchFiles) with this payload to identify recently updated files: +To listen to changes in Web Modeler, you currently need to implement a polling approach that compares the update dates with the last sync dates recorded. Use the `POST /api/v1/files/search` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Files/searchFiles) with this payload to identify recently updated files: ```json title="POST /api/v1/files/search" { @@ -91,7 +91,7 @@ To listen to changes in Web Modeler, you currently need to implement a polling a } ``` -For real-time synchronization, employ a polling approach comparing update dates with last sync dates. Use the `POST /api/v1/files/search` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Files/searchFiles) with the following payload to discover recently updated files, and compare the `updated` date with your last sync date: +For real-time synchronization, employ a polling approach comparing update dates with last sync dates. Use the `POST /api/v1/files/search` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Files/searchFiles) with the following payload to discover recently updated files, and compare the `updated` date with your last sync date: ```json title="POST /api/v1/files/search" { @@ -115,7 +115,7 @@ Real-time synchronization isn't always what you need. Consider Web Modeler as a A milestone reflects a state of a file in Web Modeler with a certain level of qualification, such as being ready for deployment. You can use this property to trigger deployments when a certain milestone is created. -Currently, you have to poll for milestones to listen to new ones created. Use the `POST /api/v1/milestones/search` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Milestones/searchMilestones) with the following payload to find recently created milestones: +Currently, you have to poll for milestones to listen to new ones created. Use the `POST /api/v1/milestones/search` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Milestones/searchMilestones) with the following payload to find recently created milestones: ```json title="POST /api/v1/milestones/search" { @@ -143,7 +143,7 @@ You will receive a response similar to this, where the `fileId` indicates the fi } ``` -You have to poll for milestones to listen to new ones created. Use the `POST /api/v1/milestones/search` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Milestones/searchMilestones) and compare the `created` date with your last sync date to identify recent additions: +You have to poll for milestones to listen to new ones created. Use the `POST /api/v1/milestones/search` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Milestones/searchMilestones) and compare the `created` date with your last sync date to identify recent additions: ```json title="POST /api/v1/milestones/search" { @@ -237,10 +237,10 @@ For unit tests, select a test framework suitable for your environment. If workin ### Review stage -During reviews, use the Modeler API again to [add collaborators](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Collaborators/modifyCollaborator), or [create links to visual diffs of your milestones](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Milestones/compareMilestones), and automatically paste them into your GitHub or GitLab pull or merge requests. +During reviews, use the Modeler API again to [add collaborators](https://modeler.camunda.io/swagger-ui/index.html#/Collaborators/modifyCollaborator), or [create links to visual diffs of your milestones](https://modeler.camunda.io/swagger-ui/index.html#/Milestones/compareMilestones), and automatically paste them into your GitHub or GitLab pull or merge requests. This provides you the freedom to let reviews happen where you want them, and even include business by sharing the diff links with them in an automated fashion. -After review, use the `DELETE /api/v1/projects/{projectId}/collaborators/email` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Collaborators/deleteCollaborator) to remove collaborators again. +After review, use the `DELETE /api/v1/projects/{projectId}/collaborators/email` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Collaborators/deleteCollaborator) to remove collaborators again. #### Create a link to a visual diff for reviews @@ -248,7 +248,7 @@ Use milestones to indicate a state for review. Use the `POST /api/v1/milestones` While it is possible to do a diff of your diagrams by comparing the XML in your VCS system, this is often not very convenient, and lacks insight into process flow changes. This approach is also less effective when involving business stakeholders in the review. -The Web Modeler API addresses this by providing an endpoint to generate visual diff links for milestones. Utilize the `GET /api/v1/milestones/compare/{milestone1Id}...{milestone2Id}` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Milestones/compareMilestones) to compare two milestones. Obtain IDs for the latest milestones via the `POST /api/v1/milestones/search` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Milestones/searchMilestones), utilizing the `fileId` filter to identify the file to review. The resulting URL leads to a visual diff page similar to this: +The Web Modeler API addresses this by providing an endpoint to generate visual diff links for milestones. Utilize the `GET /api/v1/milestones/compare/{milestone1Id}...{milestone2Id}` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Milestones/compareMilestones) to compare two milestones. Obtain IDs for the latest milestones via the `POST /api/v1/milestones/search` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Milestones/searchMilestones), utilizing the `fileId` filter to identify the file to review. The resulting URL leads to a visual diff page similar to this: ![Visual diff of two milestones](img/visual-diff.png) diff --git a/versioned_docs/version-8.3/guides/getting-started-orchestrate-apis.md b/versioned_docs/version-8.3/guides/getting-started-orchestrate-apis.md index 0723de2149..05674c62a1 100644 --- a/versioned_docs/version-8.3/guides/getting-started-orchestrate-apis.md +++ b/versioned_docs/version-8.3/guides/getting-started-orchestrate-apis.md @@ -70,7 +70,7 @@ Don't want to build the process yourself? Click this button to create it from a className={clsx( "button button--outline button--secondary button--lg" )} - href="https://modeler.cloud.camunda.io/tutorial/quick-start-api-orchestration?utm_source=docs.camunda.io.gettingstarted"> + href="https://modeler.camunda.io/tutorial/quick-start-api-orchestration?utm_source=docs.camunda.io.gettingstarted"> Open model in Camunda 8 + href="https://modeler.camunda.io/tutorial/quick-start-human-tasks?utm_source=docs.camunda.io.gettingstarted"> Open model in Camunda 8 + href="https://modeler.camunda.io/tutorial/quick-start-microservices?utm_source=docs.camunda.io.gettingstarted"> Open model in Camunda 8 Beginner Time estimate: 5 minutes -This guide steps through how to migrate BPMN diagrams created in Cawemo to Camunda 8 [Web Modeler](https://modeler.cloud.camunda.io/). +This guide steps through how to migrate BPMN diagrams created in Cawemo to Camunda 8 [Web Modeler](https://modeler.camunda.io/). You should consider migrating diagrams from Cawemo to Camunda 8 Web Modeler if: diff --git a/versioned_docs/version-8.4/apis-tools/web-modeler-api/authentication.md b/versioned_docs/version-8.4/apis-tools/web-modeler-api/authentication.md index 388f3f494b..2182aee180 100644 --- a/versioned_docs/version-8.4/apis-tools/web-modeler-api/authentication.md +++ b/versioned_docs/version-8.4/apis-tools/web-modeler-api/authentication.md @@ -70,7 +70,7 @@ To authenticate for the API, generate a JWT token depending on your environment To use the JWT token in the cloud, use the following command: ```shell - curl -o - 'https://modeler.cloud.camunda.io/api/v1/info' -H 'Authorization: Bearer eyJhb...' + curl -o - 'https://modeler.camunda.io/api/v1/info' -H 'Authorization: Bearer eyJhb...' ``` When using a Self-Managed installation, you can use the following command instead: diff --git a/versioned_docs/version-8.4/apis-tools/web-modeler-api/index.md b/versioned_docs/version-8.4/apis-tools/web-modeler-api/index.md index 3b54b0b387..c31d747c98 100644 --- a/versioned_docs/version-8.4/apis-tools/web-modeler-api/index.md +++ b/versioned_docs/version-8.4/apis-tools/web-modeler-api/index.md @@ -14,7 +14,7 @@ Ensure you [authenticate](./authentication.md) before accessing the Web Modeler ## OpenAPI documentation -A detailed API description is available as [OpenAPI](https://www.openapis.org/) specification at [https://modeler.cloud.camunda.io/swagger-ui/index.html](https://modeler.cloud.camunda.io/swagger-ui/index.html) +A detailed API description is available as [OpenAPI](https://www.openapis.org/) specification at [https://modeler.camunda.io/swagger-ui/index.html](https://modeler.camunda.io/swagger-ui/index.html) for SaaS and at [http://localhost:8070/swagger-ui.html](http://localhost:8070/swagger-ui.html) for Self-Managed installations. diff --git a/versioned_docs/version-8.4/components/connectors/protocol/rest.md b/versioned_docs/version-8.4/components/connectors/protocol/rest.md index aba75cf00e..5683db47a4 100644 --- a/versioned_docs/version-8.4/components/connectors/protocol/rest.md +++ b/versioned_docs/version-8.4/components/connectors/protocol/rest.md @@ -140,7 +140,7 @@ Similarly to the Query Parameters, the **HTTP headers** can be specified using t ``` = { - Origin: "https://modeler.cloud.camunda.io/" + Origin: "https://modeler.camunda.io/" } ``` diff --git a/versioned_docs/version-8.4/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md b/versioned_docs/version-8.4/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md index 3710d57afd..441122296f 100644 --- a/versioned_docs/version-8.4/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md +++ b/versioned_docs/version-8.4/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md @@ -26,7 +26,7 @@ Each pipeline is unique. The Web Modeler API offers flexibility to tailor integr - A platform to host a version control system (VCS) such as GitHub or GitLab. - An existing pipeline or a plan to set one up using tools like [CircleCI](https://circleci.com/) or [Jenkins](https://www.jenkins.io/), cloud platforms such as [Azure DevOps Pipelines](https://azure.microsoft.com/de-de/products/devops), or built-in solutions of VCS platforms like [GitHub Actions](https://github.com/features/actions) or [GitLab's DevSecOps Lifecycle](https://about.gitlab.com/stages-devops-lifecycle/). -- Make yourself familiar with the [Web Modeler API](/apis-tools/web-modeler-api/index.md) through the [OpenAPI documentation](https://modeler.cloud.camunda.io/swagger-ui/index.html). +- Make yourself familiar with the [Web Modeler API](/apis-tools/web-modeler-api/index.md) through the [OpenAPI documentation](https://modeler.camunda.io/swagger-ui/index.html). - Understand how [clusters](/components/concepts/clusters.md) work in Camunda 8. - Ensure you’ve [created a Camunda 8 account](/guides/create-account.md), or installed [Camunda 8 Self-Managed](/self-managed/about-self-managed.md). @@ -85,7 +85,7 @@ Synchronize files between Web Modeler and version control systems (VCS) and vice For automatic file synchronization, consider maintaining a secondary system of record for mapping Web Modeler projects to VCS repositories. This system also monitors the project-to-repository mapping and update timestamps. -To listen to changes in Web Modeler, you currently need to implement a polling approach that compares the update dates with the last sync dates recorded. Use the `POST /api/v1/files/search` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Files/searchFiles) with the following payload to identify files updated after the last sync date: +To listen to changes in Web Modeler, you currently need to implement a polling approach that compares the update dates with the last sync dates recorded. Use the `POST /api/v1/files/search` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Files/searchFiles) with the following payload to identify files updated after the last sync date: ```json title="POST /api/v1/files/search" { @@ -110,7 +110,7 @@ Real-time synchronization isn't always what you need. Consider Web Modeler as a A milestone reflects a state of a file in Web Modeler with a certain level of qualification, such as being ready for deployment. You can use this property to trigger deployments when a certain milestone is created. -Currently, you have to poll for milestones to listen to new ones created. Use the `POST /api/v1/milestones/search` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Milestones/searchMilestones) with the following payload to identify milestones created after the last sync date: +Currently, you have to poll for milestones to listen to new ones created. Use the `POST /api/v1/milestones/search` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Milestones/searchMilestones) with the following payload to identify milestones created after the last sync date: ```json title="POST /api/v1/milestones/search" { @@ -220,10 +220,10 @@ For unit tests, select a test framework suitable for your environment. If workin ### Review stage -During reviews, use the Modeler API again to [add collaborators](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Collaborators/modifyCollaborator), or to [create links to visual diffs of your milestones](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Milestones/compareMilestones), and automatically paste them into your GitHub or GitLab pull or merge requests. +During reviews, use the Modeler API again to [add collaborators](https://modeler.camunda.io/swagger-ui/index.html#/Collaborators/modifyCollaborator), or to [create links to visual diffs of your milestones](https://modeler.camunda.io/swagger-ui/index.html#/Milestones/compareMilestones), and automatically paste them into your GitHub or GitLab pull or merge requests. This provides you the freedom to let reviews happen where you want them, and even include business by sharing the diff links with them in an automated fashion. -After review, use the `DELETE /api/v1/projects/{projectId}/collaborators/email` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Collaborators/deleteCollaborator) to remove collaborators again. +After review, use the `DELETE /api/v1/projects/{projectId}/collaborators/email` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Collaborators/deleteCollaborator) to remove collaborators again. #### Create a link to a visual diff for reviews @@ -231,7 +231,7 @@ Use milestones to indicate a state for review. Use the `POST /api/v1/milestones` While it is possible to do a diff of your diagrams by comparing the XML in your VCS system, this is often not very convenient, and lacks insight into process flow changes. This approach is also less effective when involving business stakeholders in the review. -The Web Modeler API addresses this by providing an endpoint to generate visual diff links for milestones. Utilize the `GET /api/v1/milestones/compare/{milestone1Id}...{milestone2Id}` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Milestones/compareMilestones) to compare two milestones. Obtain IDs for the latest milestones via the `POST /api/v1/milestones/search` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Milestones/searchMilestones), utilizing the `fileId` filter to identify the file to review. The resulting URL leads to a visual diff page similar to this: +The Web Modeler API addresses this by providing an endpoint to generate visual diff links for milestones. Utilize the `GET /api/v1/milestones/compare/{milestone1Id}...{milestone2Id}` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Milestones/compareMilestones) to compare two milestones. Obtain IDs for the latest milestones via the `POST /api/v1/milestones/search` [endpoint](https://modeler.camunda.io/swagger-ui/index.html#/Milestones/searchMilestones), utilizing the `fileId` filter to identify the file to review. The resulting URL leads to a visual diff page similar to this: ![Visual diff of two milestones](img/visual-diff.png) diff --git a/versioned_docs/version-8.4/guides/getting-started-orchestrate-apis.md b/versioned_docs/version-8.4/guides/getting-started-orchestrate-apis.md index 0723de2149..05674c62a1 100644 --- a/versioned_docs/version-8.4/guides/getting-started-orchestrate-apis.md +++ b/versioned_docs/version-8.4/guides/getting-started-orchestrate-apis.md @@ -70,7 +70,7 @@ Don't want to build the process yourself? Click this button to create it from a className={clsx( "button button--outline button--secondary button--lg" )} - href="https://modeler.cloud.camunda.io/tutorial/quick-start-api-orchestration?utm_source=docs.camunda.io.gettingstarted"> + href="https://modeler.camunda.io/tutorial/quick-start-api-orchestration?utm_source=docs.camunda.io.gettingstarted"> Open model in Camunda 8 + href="https://modeler.camunda.io/tutorial/quick-start-human-tasks?utm_source=docs.camunda.io.gettingstarted"> Open model in Camunda 8 + href="https://modeler.camunda.io/tutorial/quick-start-microservices?utm_source=docs.camunda.io.gettingstarted"> Open model in Camunda 8 + href="https://modeler.camunda.io/tutorial/quick-start-api-orchestration?utm_source=docs.camunda.io.gettingstarted"> Open model in Camunda 8 + href="https://modeler.camunda.io/tutorial/quick-start-human-tasks?utm_source=docs.camunda.io.gettingstarted"> Open model in Camunda 8 + href="https://modeler.camunda.io/tutorial/quick-start-microservices?utm_source=docs.camunda.io.gettingstarted"> Open model in Camunda 8