Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add migration guide for decision requirements #4796

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 64 additions & 0 deletions docs/apis-tools/migration-manuals/migrate-to-camunda-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,70 @@ The following conventions apply to all attributes:

</Tabs>

### Operate

#### Search decision requirements

- **V1 endpoint**: `POST /v1/drd/search`
- **V2 endpoint**: `POST /v2/decision-requirements/search`

<Tabs groupId="post-decision-requirements" defaultValue="input-adjustments" queryString values={
[
{label: 'Input adjustments', value: 'input-adjustments', },
{label: 'Output adjustments', value: 'output-adjustments', },
]
}>

<TabItem value='input-adjustments'>

- Filter attribute `id` and `key` removed
- Use filter attribute `decisionRequirementsKey`

</TabItem>

<TabItem value='output-adjustments'>

- Attributes attribute `id` has been removed.
- The attribute `key` was replaced to `decisionRequirementsKey`

</TabItem>

</Tabs>

#### Get decision requirements by key

- **V1 endpoint**: `GET /v1/drd/:key`
- **V2 endpoint**: `GET /v2/decision-requirements/:decisionRequirementsKey`

<Tabs groupId="get-decision-requirements" defaultValue="input-adjustments" queryString values={
[
{label: 'Input adjustments', value: 'input-adjustments', },
{label: 'Output adjustments', value: 'output-adjustments', },
]
}>

<TabItem value='input-adjustments'>

- The request parameters attributes remain unchanged.

</TabItem>

<TabItem value='output-adjustments'>

- Attributes attribute `id` has been removed.
- The attribute `key` was replaced to `decisionRequirementsKey`

</TabItem>

</Tabs>

#### Get decision requirements as XML by key

- **V1 endpoint**: `GET /v1/drd/:key/xml`
- **V2 endpoint**: `GET /v2/decision-requirements/:decisionRequirementsKey/xml`

There are no changes to the request or response for this endpoint.

<!--- TODO: insert output adjustments --->

<!--- TODO: open questions and related resources --->
Expand Down
Loading