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

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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

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

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
+    type: object
-    items: 
+    properties:
-      type: object
+      id:
-      properties:
+        type: string
-        id:
+        format: uuid
-          type: string
+        description: the id.
-          format: uuid
+        example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
-          description: the id.
+      wait_for_completion:
-          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
+        type: boolean
-        workflow_id:
+        example: false
-          type: string
+        description: If the invitation action should pause the parent workflow to wait for completion.
-          format: uuid
+      return_profile:
-          description: the id of the workflow.
+        type: boolean
-          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
+        example: false
-        wait_for_completion:
+        description: If the invitation action should return a profile.
-          type: boolean
+      portal_id:
-          example: false
+        type: string
-          description: If the invitation action should pause the parent workflow to wait for completion.
+        format: uuid
-        return_profile:
+        description: the id of the portal.
-          type: boolean
+        example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
-          example: false
+      registration_workflow_id:
-          description: If the invitation action should return a profile.
+        type: string
-        portal_id:
+        format: uuid
-          type: string
+        description: the id of the registration workflow.
-          format: uuid
+        example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
-          description: the id of the portal.
+      email_attribute_id:
-          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
+        type: string
-        registration_workflow_id:
+        format: uuid
-          type: string
+        description: the id of the email attribute.
-          format: uuid
+        example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
-          description: the id of the registration workflow.
+      validate_completed_registration:
-          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
+        type: boolean
-        email_attribute_id:
+        example: false
-          type: string
+        description: If the action should validate against completed registrations by email address.
-          format: uuid
+      validate_open_registration:
-          description: the id of the email attribute.
+        type: boolean
-          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
+        example: false
-        profile_type_id:
+        description: If the action should validate against open registrations by email address.
-          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.
   workflow_action_email_attributes:
-    type: array
+    type: object
-    items: 
+    properties:
-      type: object
+      id:
-      properties:
+        type: string
-        id:
+        format: uuid
-          type: string
+        description: the id.
-          format: uuid
+        example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
-          description: the id.
+      workflow_action_id:
-          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
+        type: string
-        workflow_action_id:
+        format: uuid
-          type: string
+        description: the id of the workflow action.
-          format: uuid
+        example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
-          description: the id of the workflow action.
+      email_id:
-          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
+        type: string
-        email_id:
+        format: uuid
-          type: string
+        description: the id of the email.
-          format: uuid
+        example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
-          description: the id of the email.
+      type:
-          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
+        type: string
-        type:
+        description: the type of email.
-          type: string
+        enum: [StandardEmail, PerformerNotificationEmail, ApprovalEmail, RejectionEmail]
-          description: the type of email.
+        example: StandardEmail
-          enum: [StandardEmail, PerformerNotificationEmail, ApprovalEmail, RejectionEmail]
-          example: StandardEmail

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
+    type: object
-    items: 
+    properties:
-      type: object
+      id:
-      properties:
+        type: string
-        id:
+        format: uuid
-          type: string
+        description: the id.
-          format: uuid
+        example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
-          description: the id.
+      role_id:
-          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
+        type: string
-        role_id:
+        format: uuid
-          type: string
+        description: the id of the role.
-          format: uuid
+        example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
-          description: the id of the role.
-          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
   workflow_action_value_builders_attributes:
-    type: array
+    type: object
-    items: 
+    properties:
-      type: object
+      id:
-      properties:
+        type: string
-        id:
+        format: uuid
-          type: string
+        description: the id.
-          format: uuid
+        example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
-          description: the id.
+      workflow_action_id:
-          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
+        type: string
-        workflow_action_id:
+        format: uuid
-          type: string
+        description: the id of the workflow action.
-          format: uuid
+        example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
-          description: the id of the workflow action.
+      value_builder_id:
-          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
+        type: string
-        value_builder_id:
+        format: uuid
-          type: string
+        description: the id of the value builder.
-          format: uuid
+        example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
-          description: the id of the value builder.
+      position:
-          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
+        type: integer
-        position:
+        format: int32
-          type: integer
+        description: the position of the value builder attribute.
-          format: int32
+        example: 1
-          description: the position of the value builder attribute.
-          example: 1
   workflow_action_directory_groups_attributes:
-    type: array
+    type: object
-    items: 
+    properties:
-      type: object
+      id:
-      properties:
+        type: string
-        id:
+        format: uuid
-          type: string
+        description: the id.
-          format: uuid
+        example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
-          description: the id.
+      directory_id:
-          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
+        type: string
-        directory_id:
+        format: uuid
-          type: string
+        description: the id of the directory.
-          format: uuid
+        example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
-          description: the id of the directory.
+      group_label:
-          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
+        type: string
-        group_label:
+        format: text
-          type: string
+        description: the group label.
-          format: text
+        example: Admin
-          description: the group label.
+      group_dn:
-          example: Admin
+        type: string
-        group_dn:
+        format: text
-          type: string
+        description: the group dn.
-          format: text
+        example: group
-          description: the group dn.
-          example: group

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
+    type: object
-    items: 
+    properties:
-      type: object
+      id:
-      properties:
+        type: string
-        id:
+        format: uuid
-          type: string
+        description: the id.
-          format: uuid
+        example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
-          description: the id.
+      workflow_action_id:
-          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
+        type: string
-        workflow_action_id:
+        format: uuid
-          type: string
+        description: the id of the workflow action.
-          format: uuid
+        example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
-          description: the id of the workflow action.
+      email_id:
-          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
+        type: string
-        email_id:
+        format: uuid
-          type: string
+        description: the id of the email.
-          format: uuid
+        example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
-          description: the id of the email.
+      type:
-          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
+        type: string
-        type:
+        enum: [StandardEmail]
-          type: string
+        description: the type of email.
-          enum: [StandardEmail]
+        example: StandardEmail
-          description: the type of email.
-          example: StandardEmail

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
+    type: object
-    items: 
+    properties:
-      type: object
+      id:
-      properties:
+        type: string
-        id:
+        format: uuid
-          type: string
+        description: the id.
-          format: uuid
+        example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
-          description: the id.
+      workflow_id:
-          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
+        type: string
-        workflow_id:
+        format: uuid
-          type: string
+        description: the id of the workflow.
-          format: uuid
+        example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
-          description: the id of the workflow.
+      wait_for_completion:
-          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
+        type: boolean
-        wait_for_completion:
+        description: If the parent workflow should wait for the child to complete.
-          type: boolean
+        example: false
-          description: If the parent workflow should wait for the child to complete.
+      profile_to_send:
-          example: false
+        type: string
-        profile_to_send:
+        enum: [none, current, attribute, profile_type]
-          type: string
+        description: the profile the parent should send to the child workflow.
-          enum: [none, current, attribute, profile_type]
+        example: current
-          description: the profile the parent should send to the child workflow.
+      return_profile:
-          example: current
+        type: boolean
-        return_profile:
+        description: if the child workflow should return a profile.
-          type: boolean
+        example: false
-          description: if the child workflow should return a profile.
+      run_workflow_action_id:
-          example: false
+        type: string
-        run_workflow_action_id:
+        format: uuid
-          type: string
+        description: the id of the child workflow to run.
-          format: uuid
+        example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
-          description: the id of the child workflow to run.
+      profile_type_id:
-          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
+        type: string
-        email_attribute_id:
+        format: uuid
-          type: string
+        description: the id of the profile type.
-          format: uuid
+        example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
-          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