From e1666a50c0d545dc63f823f86ca6e7ce64a88130 Mon Sep 17 00:00:00 2001 From: Nathanyel Sandi Date: Thu, 19 Dec 2024 11:02:44 -0300 Subject: [PATCH 1/3] feat: add migration guide for decision requirements --- .../migrate-to-camunda-api.md | 64 +++++++++++++++++++ 1 file changed, 64 insertions(+) diff --git a/docs/apis-tools/migration-manuals/migrate-to-camunda-api.md b/docs/apis-tools/migration-manuals/migrate-to-camunda-api.md index a9b4bf9626c..8353d76a148 100644 --- a/docs/apis-tools/migration-manuals/migrate-to-camunda-api.md +++ b/docs/apis-tools/migration-manuals/migrate-to-camunda-api.md @@ -106,6 +106,70 @@ The following conventions apply to all attributes: +### Operate + +#### Search Decision Requirements + +- **V1 endpoint**: `POST /v1/drd/search` +- **V2 endpoint**: `POST /v2/decision-requirements/search` + + + + + +- Filter attribute `id` and `key` removed + - Use filter attribute `decisionRequirementsKey` + + + + + +- Attributes attribute `id` was removed +- The attribute `key` was replaced to `decisionRequirementsKey` + + + + + +#### Get Decision Requirements by Key + +- **V1 endpoint**: `GET /v1/drd/:key` +- **V2 endpoint**: `GET /v2/decision-requirements/:decisionRequirementsKey` + + + + + +- The request parameters attribute remains the same. + + + + + +- Attributes attribute `id` was removed +- The attribute `key` was replaced to `decisionRequirementsKey` + + + + + +#### Get decision requirements as XML by key + +- **V1 endpoint**: `GET /v1/drd/:key/xml` +- **V2 endpoint**: `GET /v2/decision-requirements/:decisionRequirementsKey/xml` + +The endpoint attributes remains the same. + From a229c1d830861638496239368e61989e5710a3e4 Mon Sep 17 00:00:00 2001 From: Nathanyel Sandi Date: Thu, 19 Dec 2024 11:08:46 -0300 Subject: [PATCH 2/3] fix: grammar --- .../migration-manuals/migrate-to-camunda-api.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/apis-tools/migration-manuals/migrate-to-camunda-api.md b/docs/apis-tools/migration-manuals/migrate-to-camunda-api.md index 8353d76a148..387f450d0a2 100644 --- a/docs/apis-tools/migration-manuals/migrate-to-camunda-api.md +++ b/docs/apis-tools/migration-manuals/migrate-to-camunda-api.md @@ -129,7 +129,7 @@ The following conventions apply to all attributes: -- Attributes attribute `id` was removed +- Attributes attribute `id` has been removed. - The attribute `key` was replaced to `decisionRequirementsKey` @@ -150,13 +150,13 @@ The following conventions apply to all attributes: -- The request parameters attribute remains the same. +- The request parameters attributes remain unchanged. -- Attributes attribute `id` was removed +- Attributes attribute `id` has been removed. - The attribute `key` was replaced to `decisionRequirementsKey` @@ -168,7 +168,7 @@ The following conventions apply to all attributes: - **V1 endpoint**: `GET /v1/drd/:key/xml` - **V2 endpoint**: `GET /v2/decision-requirements/:decisionRequirementsKey/xml` -The endpoint attributes remains the same. +There are no changes to the request or response for this endpoint. From 1f201206aebaa37b4218cdfd5b843dff34c9bb64 Mon Sep 17 00:00:00 2001 From: christinaausley <84338309+christinaausley@users.noreply.github.com> Date: Mon, 23 Dec 2024 07:54:07 -0700 Subject: [PATCH 3/3] style(formatting): sentence case headers --- docs/apis-tools/migration-manuals/migrate-to-camunda-api.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/apis-tools/migration-manuals/migrate-to-camunda-api.md b/docs/apis-tools/migration-manuals/migrate-to-camunda-api.md index 387f450d0a2..c510008b343 100644 --- a/docs/apis-tools/migration-manuals/migrate-to-camunda-api.md +++ b/docs/apis-tools/migration-manuals/migrate-to-camunda-api.md @@ -108,7 +108,7 @@ The following conventions apply to all attributes: ### Operate -#### Search Decision Requirements +#### Search decision requirements - **V1 endpoint**: `POST /v1/drd/search` - **V2 endpoint**: `POST /v2/decision-requirements/search` @@ -136,7 +136,7 @@ The following conventions apply to all attributes: -#### Get Decision Requirements by Key +#### Get decision requirements by key - **V1 endpoint**: `GET /v1/drd/:key` - **V2 endpoint**: `GET /v2/decision-requirements/:decisionRequirementsKey`