The REST API documentation about deployment creation should be integrated

[alessandrocavalli]

Acceptance Criteria (Required on creation)

In the deployment/create REST API, the documentation states:

  <@lib.property
        name = "deploy-changed-only"
        type = "boolean"
        defaultValue = 'false'
        desc = "A flag indicating whether the process engine should perform duplicate checking on a per-resource basis.
                If set to true, only those resources that have actually changed are deployed.
                Checks are made against resources included previous deployments of the same name and only against the latest versions of those resources.
                If set to true, the option enable-duplicate-filtering is overridden and set to true." />

    <@lib.property
        name = "enable-duplicate-filtering"
        type = "boolean"
        defaultValue = 'false'
        desc = "A flag indicating whether the process engine should perform duplicate checking for the deployment or not.
                This allows you to check if a deployment with the same name and the same resouces already exists and
                if true, not create a new deployment but instead return the existing deployment. The default value is false." />

but since the deployment-source is also used to check if the deployment is new or not, it would be nice to modify it adding "and source" after the words "of the same name"

  <@lib.property
        name = "deploy-changed-only"
        type = "boolean"
        defaultValue = 'false'
        desc = "A flag indicating whether the process engine should perform duplicate checking on a per-resource basis.
                If set to true, only those resources that have actually changed are deployed.
                Checks are made against resources included previous deployments of the same name and source and only against the latest versions of those resources.
                If set to true, the option enable-duplicate-filtering is overridden and set to true." />

    <@lib.property
        name = "enable-duplicate-filtering"
        type = "boolean"
        defaultValue = 'false'
        desc = "A flag indicating whether the process engine should perform duplicate checking for the deployment or not.
                This allows you to check if a deployment with the same name and source and the same resouces already exists and
                if true, not create a new deployment but instead return the existing deployment. The default value is false." />

Hints

Links

engine-rest/engine-rest-openapi/src/main/templates/models/org/camunda/bpm/engine/rest/dto/MultiFormDeploymentDto.ftl

Breakdown

Pull Requests

Beta Give feedback

No tasks being tracked yet.

Dev2QA handover

• Does this ticket need a QA test and the testing goals are not clear from the description? Add a Dev2QA handover comment