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.
feat(openapi): add historic identity link endpoints
* adds all historic identity link logs endpoints * adds default date format link where missing for other endpoints related to CAM-11561
- Loading branch information
Showing
12 changed files
with
325 additions
and
30 deletions.
There are no files selected for viewing
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
69 changes: 69 additions & 0 deletions
69
engine-rest/engine-rest-openapi/src/main/templates/lib/commons/history-identity-link.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,69 @@ | ||
| <#-- Generated From File: camunda-docs-manual/public/reference/rest/history/identity-links/get-identity-link-query/index.html --> | ||
|
|
||
| <#assign sortByValues = [ | ||
| '"time"', | ||
| '"type"', | ||
| '"userId"', | ||
| '"groupId"', | ||
| '"taskId"', | ||
| '"processDefinitionId"', | ||
| '"processDefinitionKey"', | ||
| '"operationType"', | ||
| '"assignerId"', | ||
| '"tenantId"' | ||
| ]> | ||
|
|
||
| <#assign params = { | ||
| "type": { | ||
| "type": "string", | ||
| "desc": "Restricts to identity links that have the given type (candidate/assignee/owner)." | ||
| }, | ||
| "userId": { | ||
| "type": "string", | ||
| "desc": "Restricts to identity links that have the given user id." | ||
| }, | ||
| "groupId": { | ||
| "type": "string", | ||
| "desc": "Restricts to identity links that have the given group id." | ||
| }, | ||
| "dateBefore": { | ||
| "type": "string", | ||
| "format": "date-time", | ||
| "desc": "Restricts to identity links that have the time before the given time." | ||
| }, | ||
| "dateAfter": { | ||
| "type": "string", | ||
| "format": "date-time", | ||
| "desc": "Restricts to identity links that have the time after the given time." | ||
| }, | ||
| "taskId": { | ||
| "type": "string", | ||
| "desc": "Restricts to identity links that have the given task id." | ||
| }, | ||
| "processDefinitionId": { | ||
| "type": "string", | ||
| "desc": "Restricts to identity links that have the given process definition id." | ||
| }, | ||
| "processDefinitionKey": { | ||
| "type": "string", | ||
| "desc": "Restricts to identity links that have the given process definition key." | ||
| }, | ||
| "operationType": { | ||
| "type": "string", | ||
| "desc": "Restricts to identity links that have the given operationType (add/delete)." | ||
| }, | ||
| "assignerId": { | ||
| "type": "string", | ||
| "desc": "Restricts to identity links that have the given assigner id." | ||
| }, | ||
| "tenantIdIn": { | ||
| "type": "array", | ||
| "itemType": "string", | ||
| "desc": "Filter by a comma-separated list of tenant ids." | ||
| }, | ||
| "withoutTenantId": { | ||
| "type": "boolean", | ||
| "desc": "Only include historic identity links that belong to no tenant. 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
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
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
90 changes: 90 additions & 0 deletions
90
...n/templates/models/org/camunda/bpm/engine/rest/dto/history/HistoricIdentityLinkLogDto.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,90 @@ | ||
| <#-- Generated From File: camunda-docs-manual/public/reference/rest/history/identity-links/get-identity-link-query/index.html --> | ||
| <#macro dto_macro docsUrl=""> | ||
| <@lib.dto > | ||
|
|
||
| <@lib.property | ||
| name = "id" | ||
| type = "string" | ||
| desc = "Id of the Historic identity link entry." | ||
| /> | ||
|
|
||
| <@lib.property | ||
| name = "time" | ||
| type = "string" | ||
| format = "date-time" | ||
| desc = "The time when the identity link is logged. | ||
| [Default format](${docsUrl}/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`." | ||
| /> | ||
|
|
||
| <@lib.property | ||
| name = "type" | ||
| type = "string" | ||
| desc = "The type of identity link (candidate/assignee/owner)." | ||
| /> | ||
|
|
||
| <@lib.property | ||
| name = "userId" | ||
| type = "string" | ||
| desc = "The id of the user/assignee." | ||
| /> | ||
|
|
||
| <@lib.property | ||
| name = "groupId" | ||
| type = "string" | ||
| desc = "The id of the group." | ||
| /> | ||
|
|
||
| <@lib.property | ||
| name = "taskId" | ||
| type = "string" | ||
| desc = "The id of the task." | ||
| /> | ||
|
|
||
| <@lib.property | ||
| name = "processDefinitionId" | ||
| type = "string" | ||
| desc = "The id of the process definition." | ||
| /> | ||
|
|
||
| <@lib.property | ||
| name = "processDefinitionKey" | ||
| type = "string" | ||
| desc = "The key of the process definition." | ||
| /> | ||
|
|
||
| <@lib.property | ||
| name = "operationType" | ||
| type = "string" | ||
| desc = "Type of operation (add/delete)." | ||
| /> | ||
|
|
||
| <@lib.property | ||
| name = "assignerId" | ||
| type = "string" | ||
| desc = "The id of the assigner." | ||
| /> | ||
|
|
||
| <@lib.property | ||
| name = "tenantId" | ||
| type = "string" | ||
| desc = "The id of the tenant." | ||
| /> | ||
|
|
||
| <@lib.property | ||
| name = "removalTime" | ||
| type = "string" | ||
| format = "date-time" | ||
| desc = "The time after which the identity link should be removed by the History Cleanup job. | ||
| [Default format](${docsUrl}/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`." | ||
| /> | ||
|
|
||
| <@lib.property | ||
| name = "rootProcessInstanceId" | ||
| type = "string" | ||
| desc = "The process instance id of the root process instance that initiated the process | ||
| containing this identity link." | ||
| last = true | ||
| /> | ||
|
|
||
| </@lib.dto> | ||
| </#macro> |
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
53 changes: 53 additions & 0 deletions
53
...rest/engine-rest-openapi/src/main/templates/paths/history/identity-link-log/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,53 @@ | ||
| <#-- Generated From File: camunda-docs-manual/public/reference/rest/history/identity-links/get-identity-link-query-count/index.html --> | ||
| <#macro endpoint_macro docsUrl=""> | ||
| { | ||
| <@lib.endpointInfo | ||
| id = "getHistoricIdentityLinksCount" | ||
| tag = "Historic Identity Link Log" | ||
| summary = "Get Identity Link Log Count" | ||
| desc = "Queries for the number of historic identity link logs that fulfill the given | ||
| parameters. Takes the same parameters as the | ||
| [Get Identity-Link-Logs](${docsUrl}/reference/rest/history/identity-links/get-identity-link-query/) | ||
| method." | ||
| /> | ||
|
|
||
| "parameters" : [ | ||
|
|
||
| <#assign last = true > | ||
| <#include "/lib/commons/history-identity-link.ftl" > | ||
| <@lib.parameters | ||
| object = params | ||
| last = last | ||
| /> | ||
|
|
||
| ], | ||
|
|
||
| "responses": { | ||
|
|
||
| <@lib.response | ||
| code = "200" | ||
| dto = "CountResultDto" | ||
| desc = "Request successful." | ||
| examples = ['"example-1": { | ||
| "summary": "GET `/history/identity-link-log/count?taskId=aTaskId`", | ||
| "description": "GET `/history/identity-link-log/count?taskId=aTaskId`", | ||
| "value": { | ||
| "count": 2 | ||
| } | ||
| }'] | ||
| /> | ||
|
|
||
| <@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.