diff --git a/nerm/paths/workflow_actions/approval_action.yaml b/nerm/paths/workflow_actions/approval_action.yaml index 143c481..62c58c6 100644 --- a/nerm/paths/workflow_actions/approval_action.yaml +++ b/nerm/paths/workflow_actions/approval_action.yaml @@ -1,7 +1,7 @@ post: summary: Create an approval action 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: - workflow actions requestBody: diff --git a/nerm/paths/workflow_actions/auto_assign_action.yaml b/nerm/paths/workflow_actions/auto_assign_action.yaml index ea760d5..4cbc22c 100644 --- a/nerm/paths/workflow_actions/auto_assign_action.yaml +++ b/nerm/paths/workflow_actions/auto_assign_action.yaml @@ -1,7 +1,7 @@ post: summary: Create an auto assign action 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: - workflow actions requestBody: diff --git a/nerm/paths/workflow_actions/contributors_action.yaml b/nerm/paths/workflow_actions/contributors_action.yaml index b69e443..d721fbc 100644 --- a/nerm/paths/workflow_actions/contributors_action.yaml +++ b/nerm/paths/workflow_actions/contributors_action.yaml @@ -1,7 +1,7 @@ post: summary: Create a contributors action 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: - workflow actions requestBody: diff --git a/nerm/paths/workflow_actions/duplicate_prevention_action.yaml b/nerm/paths/workflow_actions/duplicate_prevention_action.yaml index 3eabc33..59ec023 100644 --- a/nerm/paths/workflow_actions/duplicate_prevention_action.yaml +++ b/nerm/paths/workflow_actions/duplicate_prevention_action.yaml @@ -1,7 +1,7 @@ post: summary: Create a duplicate prevention action 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: - workflow actions requestBody: diff --git a/nerm/paths/workflow_actions/fulfillment_action.yaml b/nerm/paths/workflow_actions/fulfillment_action.yaml index 7c2af1d..88edbf5 100644 --- a/nerm/paths/workflow_actions/fulfillment_action.yaml +++ b/nerm/paths/workflow_actions/fulfillment_action.yaml @@ -1,7 +1,7 @@ post: - summary: Create a fulfillent action + summary: Create a fulfillment action 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: - workflow actions requestBody: diff --git a/nerm/paths/workflow_actions/identity_proofing_action.yaml b/nerm/paths/workflow_actions/identity_proofing_action.yaml index c69fc56..b7ea32d 100644 --- a/nerm/paths/workflow_actions/identity_proofing_action.yaml +++ b/nerm/paths/workflow_actions/identity_proofing_action.yaml @@ -1,7 +1,7 @@ post: summary: Create an identity proofing action 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: - workflow actions requestBody: diff --git a/nerm/paths/workflow_actions/invitation_action.yaml b/nerm/paths/workflow_actions/invitation_action.yaml index 874d2f5..2ef11e9 100644 --- a/nerm/paths/workflow_actions/invitation_action.yaml +++ b/nerm/paths/workflow_actions/invitation_action.yaml @@ -1,7 +1,7 @@ post: summary: Create an invitation action 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: - workflow actions requestBody: diff --git a/nerm/paths/workflow_actions/ldap_action.yaml b/nerm/paths/workflow_actions/ldap_action.yaml index e4c1063..425b4b6 100644 --- a/nerm/paths/workflow_actions/ldap_action.yaml +++ b/nerm/paths/workflow_actions/ldap_action.yaml @@ -1,7 +1,7 @@ post: summary: Create a ldap action 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: - workflow actions requestBody: diff --git a/nerm/paths/workflow_actions/rest_api_action.yaml b/nerm/paths/workflow_actions/rest_api_action.yaml index be7a26c..dab9c38 100644 --- a/nerm/paths/workflow_actions/rest_api_action.yaml +++ b/nerm/paths/workflow_actions/rest_api_action.yaml @@ -1,7 +1,7 @@ post: summary: Create a REST API action 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: - workflow actions requestBody: diff --git a/nerm/paths/workflow_actions/review_action.yaml b/nerm/paths/workflow_actions/review_action.yaml index 3333c04..5ce8c4b 100644 --- a/nerm/paths/workflow_actions/review_action.yaml +++ b/nerm/paths/workflow_actions/review_action.yaml @@ -1,7 +1,7 @@ post: summary: Create a review action 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: - workflow actions requestBody: diff --git a/nerm/paths/workflow_actions/run_workflow_action.yaml b/nerm/paths/workflow_actions/run_workflow_action.yaml index f7b55db..5df0394 100644 --- a/nerm/paths/workflow_actions/run_workflow_action.yaml +++ b/nerm/paths/workflow_actions/run_workflow_action.yaml @@ -1,7 +1,7 @@ post: summary: Create a run workflow action 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: - workflow actions requestBody: diff --git a/nerm/paths/workflow_actions/set_attributes_action.yaml b/nerm/paths/workflow_actions/set_attributes_action.yaml index 9e1b53f..58a034f 100644 --- a/nerm/paths/workflow_actions/set_attributes_action.yaml +++ b/nerm/paths/workflow_actions/set_attributes_action.yaml @@ -1,7 +1,7 @@ post: summary: Create a set attributes action 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: - workflow actions requestBody: diff --git a/nerm/paths/workflow_actions/soap_api_action.yaml b/nerm/paths/workflow_actions/soap_api_action.yaml index 897e019..f61669e 100644 --- a/nerm/paths/workflow_actions/soap_api_action.yaml +++ b/nerm/paths/workflow_actions/soap_api_action.yaml @@ -1,7 +1,7 @@ post: summary: Create a SOAP API action 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: - workflow actions requestBody: diff --git a/nerm/paths/workflow_actions/unassign_action.yaml b/nerm/paths/workflow_actions/unassign_action.yaml index 31823a4..b9d7220 100644 --- a/nerm/paths/workflow_actions/unassign_action.yaml +++ b/nerm/paths/workflow_actions/unassign_action.yaml @@ -1,7 +1,7 @@ post: summary: Create an unassign action 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: - workflow actions requestBody: diff --git a/nerm/schemas/POST/WorkflowActions/AskSecurityQuestionAction.yaml b/nerm/schemas/POST/WorkflowActions/AskSecurityQuestionAction.yaml index 18879e8..6353a19 100644 --- a/nerm/schemas/POST/WorkflowActions/AskSecurityQuestionAction.yaml +++ b/nerm/schemas/POST/WorkflowActions/AskSecurityQuestionAction.yaml @@ -28,7 +28,7 @@ properties: required: true enum: [hours, days, login attempts, always] description: The token expiration type, coordinates with token_expiration. - example: day + example: days archived: type: boolean default: false diff --git a/nerm/schemas/POST/WorkflowActions/EmailVerificationAction.yaml b/nerm/schemas/POST/WorkflowActions/EmailVerificationAction.yaml index d1a3f4a..d67b99e 100644 --- a/nerm/schemas/POST/WorkflowActions/EmailVerificationAction.yaml +++ b/nerm/schemas/POST/WorkflowActions/EmailVerificationAction.yaml @@ -28,7 +28,7 @@ properties: required: true enum: [hours, days, login attempts, always] description: The token expiration type, coordinates with token_expiration. - example: day + example: days archived: type: boolean default: false diff --git a/nerm/schemas/POST/WorkflowActions/InvitationAction.yaml b/nerm/schemas/POST/WorkflowActions/InvitationAction.yaml index 18d7b3e..0649375 100644 --- a/nerm/schemas/POST/WorkflowActions/InvitationAction.yaml +++ b/nerm/schemas/POST/WorkflowActions/InvitationAction.yaml @@ -17,78 +17,64 @@ properties: description: If the workflow action is archived or not. example: false configuration_attributes: - type: array - items: - type: object - properties: - id: - type: string - format: uuid - description: the id. - 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: - type: boolean - example: false - description: If the invitation action should pause the parent workflow to wait for completion. - return_profile: - type: boolean - example: false - description: If the invitation action should return a profile. - portal_id: - type: string - format: uuid - description: the id of the portal. - example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 - registration_workflow_id: - type: string - format: uuid - description: the id of the registration workflow. - 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: - type: string - format: uuid - description: the id of the profile type. - example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 - validate_completed_registration: - type: boolean - example: false - description: If the action should validate against completed registrations by email address. - validate_open_registration: - type: boolean - example: false - description: If the action should validate against open registrations by email address. + type: object + properties: + id: + type: string + format: uuid + description: the id. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + wait_for_completion: + type: boolean + example: false + description: If the invitation action should pause the parent workflow to wait for completion. + return_profile: + type: boolean + example: false + description: If the invitation action should return a profile. + portal_id: + type: string + format: uuid + description: the id of the portal. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + registration_workflow_id: + type: string + format: uuid + description: the id of the registration workflow. + 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 + validate_completed_registration: + type: boolean + example: false + description: If the action should validate against completed registrations by email address. + validate_open_registration: + type: boolean + example: false + description: If the action should validate against open registrations by email address. workflow_action_email_attributes: - type: array - items: - type: object - properties: - id: - type: string - format: uuid - description: the id. - example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 - workflow_action_id: - type: string - format: uuid - description: the id of the workflow action. - example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 - email_id: - type: string - format: uuid - description: the id of the email. - example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 - type: - type: string - description: the type of email. - enum: [StandardEmail, PerformerNotificationEmail, ApprovalEmail, RejectionEmail] - example: StandardEmail \ No newline at end of file + type: object + properties: + id: + type: string + format: uuid + description: the id. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + workflow_action_id: + type: string + format: uuid + description: the id of the workflow action. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + email_id: + type: string + format: uuid + description: the id of the email. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + type: + type: string + description: the type of email. + enum: [StandardEmail, PerformerNotificationEmail, ApprovalEmail, RejectionEmail] + example: StandardEmail \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/LdapAction.yaml b/nerm/schemas/POST/WorkflowActions/LdapAction.yaml index 5c81c02..0d83ae5 100644 --- a/nerm/schemas/POST/WorkflowActions/LdapAction.yaml +++ b/nerm/schemas/POST/WorkflowActions/LdapAction.yaml @@ -23,67 +23,61 @@ properties: description: the type of store. example: Local ldap_action_user_roles_attributes: - type: array - items: - type: object - properties: - id: - type: string - format: uuid - description: the id. - example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 - role_id: - type: string - format: uuid - description: the id of the role. - example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + type: object + properties: + id: + type: string + format: uuid + description: the id. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + role_id: + type: string + format: uuid + description: the id of the role. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 workflow_action_value_builders_attributes: - type: array - items: - type: object - properties: - id: - type: string - format: uuid - description: the id. - example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 - workflow_action_id: - type: string - format: uuid - description: the id of the workflow action. - example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 - value_builder_id: - type: string - format: uuid - description: the id of the value builder. - example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 - position: - type: integer - format: int32 - description: the position of the value builder attribute. - example: 1 + type: object + properties: + id: + type: string + format: uuid + description: the id. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + workflow_action_id: + type: string + format: uuid + description: the id of the workflow action. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + value_builder_id: + type: string + format: uuid + description: the id of the value builder. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + position: + type: integer + format: int32 + description: the position of the value builder attribute. + example: 1 workflow_action_directory_groups_attributes: - type: array - items: - type: object - properties: - id: - type: string - format: uuid - description: the id. - example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 - directory_id: - type: string - format: uuid - description: the id of the directory. - example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 - group_label: - type: string - format: text - description: the group label. - example: Admin - group_dn: - type: string - format: text - description: the group dn. - example: group \ No newline at end of file + type: object + properties: + id: + type: string + format: uuid + description: the id. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + directory_id: + type: string + format: uuid + description: the id of the directory. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + group_label: + type: string + format: text + description: the group label. + example: Admin + group_dn: + type: string + format: text + description: the group dn. + example: group \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/NotificationAction.yaml b/nerm/schemas/POST/WorkflowActions/NotificationAction.yaml index b7e2b4b..96cf57c 100644 --- a/nerm/schemas/POST/WorkflowActions/NotificationAction.yaml +++ b/nerm/schemas/POST/WorkflowActions/NotificationAction.yaml @@ -31,27 +31,25 @@ properties: description: If the workflow action is archived or not. example: false workflow_action_email_attributes: - type: array - items: - type: object - properties: - id: - type: string - format: uuid - description: the id. - example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 - workflow_action_id: - type: string - format: uuid - description: the id of the workflow action. - example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 - email_id: - type: string - format: uuid - description: the id of the email. - example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 - type: - type: string - enum: [StandardEmail] - description: the type of email. - example: StandardEmail \ No newline at end of file + type: object + properties: + id: + type: string + format: uuid + description: the id. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + workflow_action_id: + type: string + format: uuid + description: the id of the workflow action. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + email_id: + type: string + format: uuid + description: the id of the email. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + type: + type: string + enum: [StandardEmail] + description: the type of email. + example: StandardEmail \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/RunWorkflowAction.yaml b/nerm/schemas/POST/WorkflowActions/RunWorkflowAction.yaml index 7ea59ff..12ad7cf 100644 --- a/nerm/schemas/POST/WorkflowActions/RunWorkflowAction.yaml +++ b/nerm/schemas/POST/WorkflowActions/RunWorkflowAction.yaml @@ -17,45 +17,38 @@ properties: description: If the workflow action is archived or not. example: false configuration_attributes: - type: array - items: - type: object - properties: - id: - type: string - format: uuid - description: the id. - 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: - type: boolean - description: If the parent workflow should wait for the child to complete. - example: false - profile_to_send: - type: string - enum: [none, current, attribute, profile_type] - description: the profile the parent should send to the child workflow. - example: current - return_profile: - type: boolean - description: if the child workflow should return a profile. - example: false - run_workflow_action_id: - type: string - format: uuid - description: the id of the child workflow to run. - 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: - type: string - format: uuid - description: the id of the profile type. - example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 \ No newline at end of file + type: object + properties: + id: + type: string + format: uuid + description: the id. + 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: + type: boolean + description: If the parent workflow should wait for the child to complete. + example: false + profile_to_send: + type: string + enum: [none, current, attribute, profile_type] + description: the profile the parent should send to the child workflow. + example: current + return_profile: + type: boolean + description: if the child workflow should return a profile. + example: false + run_workflow_action_id: + type: string + format: uuid + description: the id of the child workflow to run. + 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 \ No newline at end of file