Skip to content

Commit

Permalink
feat: add migration guide for decision requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
nathansandi committed Dec 19, 2024
1 parent 79c9023 commit e1666a5
Showing 1 changed file with 64 additions and 0 deletions.
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` was 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 attribute remains the same.

</TabItem>

<TabItem value='output-adjustments'>

- Attributes attribute `id` was 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`

The endpoint attributes remains the same.

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

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

0 comments on commit e1666a5

Please sign in to comment.