forked from camunda/camunda-bpm-platform
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* adds all DRD endpoints * adds a `binary` option for media type responses which is needed for image responses for DRD diagram endpoints related to CAM-11534
- Loading branch information
Showing
16 changed files
with
884 additions
and
1 deletion.
There are no files selected for viewing
89 changes: 89 additions & 0 deletions
89
...t/engine-rest-openapi/src/main/templates/lib/commons/decision-requirements-definition.ftl
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,89 @@ | ||
<#-- Generated From File: camunda-docs-manual/public/reference/rest/decision-requirements-definition/get-query/index.html --> | ||
|
||
<#assign sortByValues = [ | ||
'"id"', | ||
'"key"', | ||
'"name"', | ||
'"version"', | ||
'"deploymentId"', | ||
'"category"', | ||
'"tenantId"' | ||
]> | ||
|
||
<#assign params = { | ||
"decisionRequirementsDefinitionId": { | ||
"type": "string", | ||
"desc": "Filter by decision requirements definition id." | ||
}, | ||
"decisionRequirementsDefinitionIdIn": { | ||
"type": "array", | ||
"itemType": "string", | ||
"desc": "Filter by decision requirements definition ids." | ||
}, | ||
"name": { | ||
"type": "string", | ||
"desc": "Filter by decision requirements definition name." | ||
}, | ||
"nameLike": { | ||
"type": "string", | ||
"desc": "Filter by decision requirements definition names that the parameter is a substring of." | ||
}, | ||
"deploymentId": { | ||
"type": "string", | ||
"desc": "Filter by the id of the deployment a decision requirement definition belongs to." | ||
}, | ||
"key": { | ||
"type": "string", | ||
"desc": "Filter by decision requirements definition key, i.e., the id in the DMN 1.3 XML. Exact | ||
match." | ||
}, | ||
"keyLike": { | ||
"type": "string", | ||
"desc": "Filter by decision requirements definition keys that the parameter is a substring of." | ||
}, | ||
"category": { | ||
"type": "string", | ||
"desc": "Filter by decision requirements definition category. Exact match." | ||
}, | ||
"categoryLike": { | ||
"type": "string", | ||
"desc": "Filter by decision requirements definition categories that the parameter is a substring | ||
of." | ||
}, | ||
"version": { | ||
"type": "integer", | ||
"format": "int32", | ||
"desc": "Filter by decision requirements definition version." | ||
}, | ||
"latestVersion": { | ||
"type": "boolean", | ||
"desc": "Only include those decision requirements definitions that are latest versions. Value may | ||
only be `true`, as `false` is the default behavior." | ||
}, | ||
"resourceName": { | ||
"type": "string", | ||
"desc": "Filter by the name of the decision requirements definition resource. Exact match." | ||
}, | ||
"resourceNameLike": { | ||
"type": "string", | ||
"desc": "Filter by names of those decision requirements definition resources that the parameter is | ||
a substring of." | ||
}, | ||
"tenantIdIn": { | ||
"type": "array", | ||
"itemType": "string", | ||
"desc": "Filter by a comma-separated list of tenant ids. A decision requirements definition must | ||
have one of the given tenant ids." | ||
}, | ||
"withoutTenantId": { | ||
"type": "boolean", | ||
"desc": "Only include decision requirements definitions which belong to no tenant. Value may only | ||
be `true`, as `false` is the default behavior." | ||
}, | ||
"includeDecisionRequirementsDefinitionsWithoutTenantId": { | ||
"type": "boolean", | ||
"desc": "Include decision requirements definitions which belong to no tenant. Can be used in | ||
combination with `tenantIdIn`. Value may only be `true`, as `false` is the | ||
default behavior." | ||
} | ||
}> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
57 changes: 57 additions & 0 deletions
57
...emplates/models/org/camunda/bpm/engine/rest/dto/dmn/DecisionRequirementsDefinitionDto.ftl
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
<#-- Generated From File: camunda-docs-manual/public/reference/rest/decision-requirements-definition/get-query/index.html --> | ||
<#macro dto_macro docsUrl=""> | ||
<@lib.dto > | ||
|
||
<@lib.property | ||
name = "id" | ||
type = "string" | ||
desc = "The id of the decision requirements definition." | ||
/> | ||
|
||
<@lib.property | ||
name = "key" | ||
type = "string" | ||
desc = "The key of the decision requirements definition." | ||
/> | ||
|
||
<@lib.property | ||
name = "category" | ||
type = "string" | ||
desc = "The category of the decision requirements definition." | ||
/> | ||
|
||
<@lib.property | ||
name = "name" | ||
type = "string" | ||
desc = "The name of the decision requirements definition." | ||
/> | ||
|
||
<@lib.property | ||
name = "version" | ||
type = "integer" | ||
format = "int32" | ||
desc = "The version of the decision requirements definition that the engine assigned to | ||
it." | ||
/> | ||
|
||
<@lib.property | ||
name = "resource" | ||
type = "string" | ||
desc = "The file name of the decision requirements definition." | ||
/> | ||
|
||
<@lib.property | ||
name = "deploymentId" | ||
type = "string" | ||
desc = "The deployment id of the decision requirements definition." | ||
/> | ||
|
||
<@lib.property | ||
name = "tenantId" | ||
type = "string" | ||
desc = "The tenant id of the decision requirements definition." | ||
last = true | ||
/> | ||
|
||
</@lib.dto> | ||
</#macro> |
21 changes: 21 additions & 0 deletions
21
...lates/models/org/camunda/bpm/engine/rest/dto/dmn/DecisionRequirementsDefinitionXmlDto.ftl
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
<#-- Generated From File: camunda-docs-manual/public/reference/rest/decision-requirements-definition/get-xml/index.html --> | ||
<#macro dto_macro docsUrl=""> | ||
<@lib.dto > | ||
|
||
<@lib.property | ||
name = "id" | ||
type = "string" | ||
desc = "The id of the decision requirements definition." | ||
/> | ||
|
||
<@lib.property | ||
name = "dmnXml" | ||
type = "string" | ||
desc = "An escaped XML string containing the XML that this decision requirements definition | ||
was deployed with. Carriage returns, line feeds and quotation marks | ||
are escaped." | ||
last = true | ||
/> | ||
|
||
</@lib.dto> | ||
</#macro> |
54 changes: 54 additions & 0 deletions
54
...gine-rest-openapi/src/main/templates/paths/decision-requirements-definition/count/get.ftl
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
<#-- Generated From File: camunda-docs-manual/public/reference/rest/decision-requirements-definition/get-query-count/index.html --> | ||
<#macro endpoint_macro docsUrl=""> | ||
{ | ||
<@lib.endpointInfo | ||
id = "getDecisionRequirementsDefinitionsCount" | ||
tag = "Decision Requirements Definition" | ||
summary = "Get Decision Requirements Definition Count" | ||
desc = "Requests the number of decision requirements definitions that fulfill the query | ||
criteria. | ||
Takes the same filtering parameters as the | ||
[Get Decision Requirements Definitions](${docsUrl}/reference/rest/decision-requirements-definition/get-query/) | ||
method." | ||
/> | ||
|
||
"parameters" : [ | ||
|
||
<#assign last = true > | ||
<#include "/lib/commons/decision-requirements-definition.ftl" > | ||
<@lib.parameters | ||
object = params | ||
last = last | ||
/> | ||
|
||
], | ||
|
||
"responses": { | ||
|
||
<@lib.response | ||
code = "200" | ||
dto = "CountResultDto" | ||
desc = "Request successful." | ||
examples = ['"example-1": { | ||
"summary": "GET `/decision-requirements-definition/count?key=dish`", | ||
"description": "GET `/decision-requirements-definition/count?key=dish`", | ||
"value": { | ||
"count": 1 | ||
} | ||
}'] | ||
/> | ||
|
||
<@lib.response | ||
code = "400" | ||
dto = "ExceptionDto" | ||
desc = "Returned if some of the query parameters are invalid, for example if | ||
a `sortOrder` parameter is supplied, but no `sortBy`. See the | ||
[Introduction](${docsUrl}/reference/rest/overview/#error-handling) | ||
for the error response format." | ||
last = true | ||
/> | ||
|
||
} | ||
|
||
} | ||
</#macro> |
67 changes: 67 additions & 0 deletions
67
...est/engine-rest-openapi/src/main/templates/paths/decision-requirements-definition/get.ftl
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
<#-- Generated From File: camunda-docs-manual/public/reference/rest/decision-requirements-definition/get-query/index.html --> | ||
<#macro endpoint_macro docsUrl=""> | ||
{ | ||
<@lib.endpointInfo | ||
id = "getDecisionRequirementsDefinitions" | ||
tag = "Decision Requirements Definition" | ||
summary = "Get Decision Requirements Definitions" | ||
desc = "Queries for decision requirements definitions that fulfill given parameters. | ||
Parameters may be the properties of decision requirements definitions, such as the name, | ||
key or version. The size of the result set can be retrieved by using the | ||
[Get Decision Requirements Definition Count](${docsUrl}/reference/rest/decision-requirements-definition/get-query-count/) | ||
method." | ||
/> | ||
|
||
"parameters" : [ | ||
|
||
<#assign last = false > | ||
<#include "/lib/commons/decision-requirements-definition.ftl" > | ||
<@lib.parameters | ||
object = params | ||
last = last | ||
/> | ||
<#include "/lib/commons/sort-params.ftl"> | ||
<#assign last = true > | ||
<#include "/lib/commons/pagination-params.ftl"> | ||
|
||
], | ||
|
||
"responses": { | ||
|
||
<@lib.response | ||
code = "200" | ||
dto = "DecisionRequirementsDefinitionDto" | ||
array = true | ||
desc = "Request successful." | ||
examples = ['"example-1": { | ||
"summary": "GET `/decision-requirements-definition?key=dish&sortBy=version&sortOrder=asc`", | ||
"description": "GET `/decision-requirements-definition?key=dish&sortBy=version&sortOrder=asc`", | ||
"value": [ | ||
{ | ||
"id": "dish:1:c633c195-41b7-11e6-b0ef-00aa004d0001", | ||
"key": "dish", | ||
"category": "drd-test", | ||
"name": "Dish", | ||
"version": 1, | ||
"resource": "dish.dmn", | ||
"deploymentId": "c627175e-41b7-11e6-b0ef-00aa004d0001", | ||
"tenantId": null | ||
} | ||
] | ||
}'] | ||
/> | ||
|
||
<@lib.response | ||
code = "400" | ||
dto = "ExceptionDto" | ||
desc = "Returned if some of the query parameters are invalid, for example if | ||
a `sortOrder` parameter is supplied, but no `sortBy`. See the | ||
[Introduction](${docsUrl}/reference/rest/overview/#error-handling) | ||
for the error response format." | ||
last = true | ||
/> | ||
|
||
} | ||
|
||
} | ||
</#macro> |
Oops, something went wrong.