NEROCKET-73 small api fixes for the nerm workflow actions routes

This commit is contained in:
ktorre22
2023-08-25 13:29:26 -04:00
parent f9a19ed700
commit 9dd43f5316
20 changed files with 190 additions and 219 deletions

View File

@@ -1,7 +1,7 @@
post: post:
summary: Create an approval action summary: Create an approval action
operationId: createApprovalAction operationId: createApprovalAction
description: Create an approval action. Coordinate with workflow_action_performers to set up performers. Coordinate with workflow_action_roles to set up performers by role. Coordinate with workflow_action_performer_notification_email for performer email config. Coordinate with workflow_action_approval_email for approval email config. Coordinate with workflow_action_rejection_email for rejection email config. description: Create an approval action. Coordinate with workflow_action_performers to set up performers. Coordinate with workflow_action_roles to set up performers by role. Coordinate with workflow_action_performer_notification_email for performer email config. Coordinate with workflow_action_approval_email for approval email config. Coordinate with workflow_action_rejection_email for rejection email config. These configurations must be created for this action to be successfully setup.
tags: tags:
- workflow actions - workflow actions
requestBody: requestBody:

View File

@@ -1,7 +1,7 @@
post: post:
summary: Create an auto assign action summary: Create an auto assign action
operationId: createAutoAssignAction operationId: createAutoAssignAction
description: Create an auto assign action. Coordinate with workflow_action_roles to assign roles. description: Create an auto assign action. Coordinate with workflow_action_roles to assign roles. These configurations must be created for this action to be successfully setup.
tags: tags:
- workflow actions - workflow actions
requestBody: requestBody:

View File

@@ -1,7 +1,7 @@
post: post:
summary: Create a contributors action summary: Create a contributors action
operationId: createContributorsAction operationId: createContributorsAction
description: Create a contributors action. Coordinate with workflow_action_performers to set up performers. Coordinate with workflow_action_roles to set up performers by role. Coordinate with workflow_action_performer_notification_email for performer email config. description: Create a contributors action. Coordinate with workflow_action_performers to set up performers. Coordinate with workflow_action_roles to set up performers by role. Coordinate with workflow_action_performer_notification_email for performer email config. These configurations must be created for this action to be successfully setup.
tags: tags:
- workflow actions - workflow actions
requestBody: requestBody:

View File

@@ -1,7 +1,7 @@
post: post:
summary: Create a duplicate prevention action summary: Create a duplicate prevention action
operationId: createDuplicatePreventionAction operationId: createDuplicatePreventionAction
description: Create a duplicate prevention action. Coordinate with duplicatation_prevention_attributes to set up duplicate matching. Coordinate with workflow_action_performers to set up performers. Coordinate with workflow_action_roles to set up performers by role. Coordinate with workflow_action_performer_notification_email for performer email config. description: Create a duplicate prevention action. Coordinate with duplicatation_prevention_attributes to set up duplicate matching. Coordinate with workflow_action_performers to set up performers. Coordinate with workflow_action_roles to set up performers by role. Coordinate with workflow_action_performer_notification_email for performer email config. These configurations must be created for this action to be successfully setup.
tags: tags:
- workflow actions - workflow actions
requestBody: requestBody:

View File

@@ -1,7 +1,7 @@
post: post:
summary: Create a fulfillent action summary: Create a fulfillment action
operationId: createFulfillmentAction operationId: createFulfillmentAction
description: Create a fulfillment action. Coordinate with workflow_action_performers to set up performers. Coordinate with workflow_action_roles to set up performers by role. Coordinate with workflow_action_performer_notification_email for performer email config. description: Create a fulfillment action. Coordinate with workflow_action_performers to set up performers. Coordinate with workflow_action_roles to set up performers by role. Coordinate with workflow_action_performer_notification_email for performer email config. These configurations must be created for this action to be successfully setup.
tags: tags:
- workflow actions - workflow actions
requestBody: requestBody:

View File

@@ -1,7 +1,7 @@
post: post:
summary: Create an identity proofing action summary: Create an identity proofing action
operationId: createIdentityProofingAction operationId: createIdentityProofingAction
description: Create an identity proofing action. Coordinates with identity_proofing_action_configuration for configuration. Coordinates with identity_proofing_action_mappings for mapping. description: Create an identity proofing action. Coordinates with identity_proofing_action_configuration for configuration. Coordinates with identity_proofing_action_mappings for mapping. These configurations must be created for this action to be successfully setup.
tags: tags:
- workflow actions - workflow actions
requestBody: requestBody:

View File

@@ -1,7 +1,7 @@
post: post:
summary: Create an invitation action summary: Create an invitation action
operationId: createInvitationAction operationId: createInvitationAction
description: Create an invitation action. Coordinate with workflow_action_pause_action if action is to wait for completion. description: Create an invitation action. Coordinate with workflow_action_pause_action if action is to wait for completion. These configurations must be created for this action to be successfully setup.
tags: tags:
- workflow actions - workflow actions
requestBody: requestBody:

View File

@@ -1,7 +1,7 @@
post: post:
summary: Create a ldap action summary: Create a ldap action
operationId: createLdapAction operationId: createLdapAction
description: Create a ldap action. Coordinate with workflow_action_performers to set up performers. Coordinate with workflow_action_roles to set up performers by role. description: Create a ldap action. Coordinate with workflow_action_performers to set up performers. Coordinate with workflow_action_roles to set up performers by role. These configurations must be created for this action to be successfully setup.
tags: tags:
- workflow actions - workflow actions
requestBody: requestBody:

View File

@@ -1,7 +1,7 @@
post: post:
summary: Create a REST API action summary: Create a REST API action
operationId: createRestApiAction operationId: createRestApiAction
description: Create a REST API action. Coordinate with rest_api_action_configuration for configuration. Coordinate with api_configuration_attributes for status mapping attributes. description: Create a REST API action. Coordinate with rest_api_action_configuration for configuration. Coordinate with api_configuration_attributes for status mapping attributes. These configurations must be created for this action to be successfully setup.
tags: tags:
- workflow actions - workflow actions
requestBody: requestBody:

View File

@@ -1,7 +1,7 @@
post: post:
summary: Create a review action summary: Create a review action
operationId: createReviewAction operationId: createReviewAction
description: Create a review action. Coordinate with workflow_action_performer_notification_email for performer email config. description: Create a review action. Coordinate with workflow_action_performer_notification_email for performer email config. These configurations must be created for this action to be successfully setup.
tags: tags:
- workflow actions - workflow actions
requestBody: requestBody:

View File

@@ -1,7 +1,7 @@
post: post:
summary: Create a run workflow action summary: Create a run workflow action
operationId: createRunWorkflowAction operationId: createRunWorkflowAction
description: Create a run workflow action. Coordinate with configuration_profile_attribute. description: Create a run workflow action. Coordinate with configuration_profile_attribute. These configurations must be created for this action to be successfully setup.
tags: tags:
- workflow actions - workflow actions
requestBody: requestBody:

View File

@@ -1,7 +1,7 @@
post: post:
summary: Create a set attributes action summary: Create a set attributes action
operationId: createSetAttributesAction operationId: createSetAttributesAction
description: Create a set attributes action. Coordinate with workflow_action_set_attributes for the attribute configuration. description: Create a set attributes action. Coordinate with workflow_action_set_attributes for the attribute configuration. These configurations must be created for this action to be successfully setup.
tags: tags:
- workflow actions - workflow actions
requestBody: requestBody:

View File

@@ -1,7 +1,7 @@
post: post:
summary: Create a SOAP API action summary: Create a SOAP API action
operationId: createSoapApiAction operationId: createSoapApiAction
description: Create a SOAP API action. Coordinates with soap_api_action_configuration for configuration. Coordinates with api_configuration_attributes. description: Create a SOAP API action. Coordinates with soap_api_action_configuration for configuration. Coordinates with api_configuration_attributes. These configurations must be created for this action to be successfully setup.
tags: tags:
- workflow actions - workflow actions
requestBody: requestBody:

View File

@@ -1,7 +1,7 @@
post: post:
summary: Create an unassign action summary: Create an unassign action
operationId: createUnassignAction operationId: createUnassignAction
description: Create an unassign action. Coordinate with workflow_action_roles to assign roles. description: Create an unassign action. Coordinate with workflow_action_roles to assign roles. These configurations must be created for this action to be successfully setup.
tags: tags:
- workflow actions - workflow actions
requestBody: requestBody:

View File

@@ -28,7 +28,7 @@ properties:
required: true required: true
enum: [hours, days, login attempts, always] enum: [hours, days, login attempts, always]
description: The token expiration type, coordinates with token_expiration. description: The token expiration type, coordinates with token_expiration.
example: day example: days
archived: archived:
type: boolean type: boolean
default: false default: false

View File

@@ -28,7 +28,7 @@ properties:
required: true required: true
enum: [hours, days, login attempts, always] enum: [hours, days, login attempts, always]
description: The token expiration type, coordinates with token_expiration. description: The token expiration type, coordinates with token_expiration.
example: day example: days
archived: archived:
type: boolean type: boolean
default: false default: false

View File

@@ -17,8 +17,6 @@ properties:
description: If the workflow action is archived or not. description: If the workflow action is archived or not.
example: false example: false
configuration_attributes: configuration_attributes:
type: array
items:
type: object type: object
properties: properties:
id: id:
@@ -26,11 +24,6 @@ properties:
format: uuid format: uuid
description: the id. description: the id.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
workflow_id:
type: string
format: uuid
description: the id of the workflow.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
wait_for_completion: wait_for_completion:
type: boolean type: boolean
example: false example: false
@@ -54,11 +47,6 @@ properties:
format: uuid format: uuid
description: the id of the email attribute. description: the id of the email attribute.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
profile_type_id:
type: string
format: uuid
description: the id of the profile type.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
validate_completed_registration: validate_completed_registration:
type: boolean type: boolean
example: false example: false
@@ -68,8 +56,6 @@ properties:
example: false example: false
description: If the action should validate against open registrations by email address. description: If the action should validate against open registrations by email address.
workflow_action_email_attributes: workflow_action_email_attributes:
type: array
items:
type: object type: object
properties: properties:
id: id:

View File

@@ -23,8 +23,6 @@ properties:
description: the type of store. description: the type of store.
example: Local example: Local
ldap_action_user_roles_attributes: ldap_action_user_roles_attributes:
type: array
items:
type: object type: object
properties: properties:
id: id:
@@ -38,8 +36,6 @@ properties:
description: the id of the role. description: the id of the role.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
workflow_action_value_builders_attributes: workflow_action_value_builders_attributes:
type: array
items:
type: object type: object
properties: properties:
id: id:
@@ -63,8 +59,6 @@ properties:
description: the position of the value builder attribute. description: the position of the value builder attribute.
example: 1 example: 1
workflow_action_directory_groups_attributes: workflow_action_directory_groups_attributes:
type: array
items:
type: object type: object
properties: properties:
id: id:

View File

@@ -31,8 +31,6 @@ properties:
description: If the workflow action is archived or not. description: If the workflow action is archived or not.
example: false example: false
workflow_action_email_attributes: workflow_action_email_attributes:
type: array
items:
type: object type: object
properties: properties:
id: id:

View File

@@ -17,8 +17,6 @@ properties:
description: If the workflow action is archived or not. description: If the workflow action is archived or not.
example: false example: false
configuration_attributes: configuration_attributes:
type: array
items:
type: object type: object
properties: properties:
id: id:
@@ -49,11 +47,6 @@ properties:
format: uuid format: uuid
description: the id of the child workflow to run. description: the id of the child workflow to run.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
email_attribute_id:
type: string
format: uuid
description: the id of the email attribute.
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
profile_type_id: profile_type_id:
type: string type: string
format: uuid format: uuid