NEROCKET-73 linting fixes

nerm/paths/workflow_actions/ask_security_question_action.yaml

@@ -1,5 +1,5 @@
 post:
-  summary: Create an ask security question action
+  summary: Create ask security question action
   operationId: createAskSecurityQuestionAction
   description: Create an ask security question action
   tags:

nerm/paths/workflow_actions/ldap_action.yaml

@@ -1,7 +1,7 @@
 post:
   summary: Create a ldap action
   operationId: createLdapAction
-  description: Create a ldap action
+  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.
   tags:
     - workflow actions
   requestBody:

nerm/paths/workflow_actions/set_security_question_action.yaml

@@ -1,5 +1,5 @@
 post:
-  summary: Create a set security question action
+  summary: Create set security question action
   operationId: createSetSecurityQuestionAction
   description: Create a set security question action
   tags:

nerm/schemas/GET/WorkflowAction.yaml

@@ -21,6 +21,7 @@ properties:
     type: boolean
     default: true
     description: If the requester should be added as the owner of the profile to be created.
+    example: true
   email_attribute_id:
     type: string
     format: uuid
@@ -45,11 +46,14 @@ properties:
     type: boolean
     default: false
     description: If the workflow action is archived or not.
+    example: false
   skippable:
     type: boolean
     default: false
     description: If the workflow action is skippable or not.
+    example: false
   requires_comment:
     type: boolean
     default: false
-    description: If the workflow action requires a comment or not.
+    description: If the workflow action requires a comment or not.
+    example: false

nerm/schemas/POST/WorkflowActions/ApprovalAction.yaml

@@ -21,11 +21,14 @@ properties:
     type: boolean
     default: false
     description: If the workflow action is archived or not.
+    example: false
   skippable:
     type: boolean
     default: false
     description: If the workflow action is skippable or not.
+    example: false
   requires_comment:
     type: boolean
     default: false
-    description: If the workflow action requires a comment or not.
+    description: If the workflow action requires a comment or not.
+    example: false

nerm/schemas/POST/WorkflowActions/AskSecurityQuestionAction.yaml

@@ -13,11 +13,13 @@ properties:
     example: Prompt the user to answer some personal security questions.
   number_of_questions:
     type: integer
+    format: int32
     required: true
     description: The number of questions the user should answer upon login.
     example: 1
   token_expiration:
     type: integer
+    format: int32
     required: true
     description: The token expiration time, coordinates with token_expiration_type.
     example: 1
@@ -30,4 +32,5 @@ properties:
   archived:
     type: boolean
     default: false
-    description: If the workflow action is archived or not.
+    description: If the workflow action is archived or not.
+    example: false

nerm/schemas/POST/WorkflowActions/AutoAssignAction.yaml

@@ -15,8 +15,10 @@ properties:
     type: boolean
     default: false
     description: If the workflow action is archived or not.
+    example: false
   contributor_attr:
     type: string
     format: uuid
     required: false
-    description: The id of the contributor attribute for contributors from another profile. If workflow_action_roles are not associated to this object, this is required.
+    description: The id of the contributor attribute for contributors from another profile. If workflow_action_roles are not associated to this object, this is required.
+    example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8

nerm/schemas/POST/WorkflowActions/BatchUpdateAction.yaml

@@ -14,4 +14,5 @@ properties:
   archived:
     type: boolean
     default: false
-    description: If the workflow action is archived or not.
+    description: If the workflow action is archived or not.
+    example: false

nerm/schemas/POST/WorkflowActions/CloseSessionAction.yaml

@@ -14,4 +14,5 @@ properties:
   archived:
     type: boolean
     default: false
-    description: If the workflow action is archived or not.
+    description: If the workflow action is archived or not.
+    example: false

nerm/schemas/POST/WorkflowActions/ContributorsAction.yaml

@@ -32,4 +32,5 @@ properties:
   archived:
     type: boolean
     default: false
-    description: If the workflow action is archived or not.
+    description: If the workflow action is archived or not.
+    example: false

nerm/schemas/POST/WorkflowActions/CreateProfileAction.yaml

@@ -15,7 +15,9 @@ properties:
     type: boolean
     default: true
     description: If the requester should be added as the owner of the profile to be created.
+    example: true
   archived:
     type: boolean
     default: false
-    description: If the workflow action is archived or not.
+    description: If the workflow action is archived or not.
+    example: false

nerm/schemas/POST/WorkflowActions/DuplicatePreventionAction.yaml

@@ -30,4 +30,5 @@ properties:
   archived:
     type: boolean
     default: false
-    description: If the workflow action is archived or not.
+    description: If the workflow action is archived or not.
+    example: false

nerm/schemas/POST/WorkflowActions/EmailVerificationAction.yaml

@@ -13,11 +13,13 @@ properties:
     example: Have the user verify their email address.
   email_expiration:
     type: integer
+    format: int32
     required: true
     description: The email expiration time, in minutes.
     example: 20
   token_expiration:
     type: integer
+    format: int32
     required: true
     description: The token expiration time, coordinates with token_expiration_type.
     example: 1
@@ -31,3 +33,4 @@ properties:
     type: boolean
     default: false
     description: If the workflow action is archived or not.
+    example: false

nerm/schemas/POST/WorkflowActions/FulfillmentAction.yaml

@@ -21,7 +21,9 @@ properties:
     type: boolean
     default: false
     description: If the workflow action is archived or not.
+    example: false
   requires_comment:
     type: boolean
     default: false
-    description: If the workflow action requires a comment or not.
+    description: If the workflow action requires a comment or not.
+    example: false

nerm/schemas/POST/WorkflowActions/IdentityProofingAction.yaml

@@ -14,4 +14,5 @@ properties:
   archived:
     type: boolean
     default: false
-    description: If the workflow action is archived or not.
+    description: If the workflow action is archived or not.
+    example: false

nerm/schemas/POST/WorkflowActions/InvitationAction.yaml

@@ -15,6 +15,7 @@ properties:
     type: boolean
     default: false
     description: If the workflow action is archived or not.
+    example: false
   configuration_attributes:
     type: array
     items: 
@@ -23,33 +24,49 @@ 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.
   workflow_action_email_attributes:
     type: array
     items: 
@@ -58,13 +75,20 @@ 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

nerm/schemas/POST/WorkflowActions/LdapAction.yaml

@@ -15,10 +15,13 @@ properties:
     type: boolean
     default: false
     description: If the workflow action is archived or not.
+    example: false
   store_type:
     type: string
     required: true
-    example: Local, Directory
+    enum: [Local, Directory]
+    description: the type of store.
+    example: Local
   ldap_action_user_roles_attributes:
     type: array
     items: 
@@ -27,9 +30,13 @@ 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: 
@@ -38,14 +45,22 @@ 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
@@ -55,15 +70,20 @@ 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
-
-#coordinate with workflow_action_performers to set up performers
-#coordinate with workflow_action_roles to set up performers by role
+          description: the group dn.
+          example: group

nerm/schemas/POST/WorkflowActions/NotificationAction.yaml

@@ -28,7 +28,8 @@ properties:
   archived:
     type: boolean
     default: false
-    description: If the workflow action is archived or not.    
+    description: If the workflow action is archived or not.  
+    example: false  
   workflow_action_email_attributes:
     type: array
     items: 
@@ -37,13 +38,20 @@ 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

nerm/schemas/POST/WorkflowActions/PasswordResetAction.yaml

@@ -14,4 +14,5 @@ properties:
   archived:
     type: boolean
     default: false
-    description: If the workflow action is archived or not.
+    description: If the workflow action is archived or not.
+    example: false

nerm/schemas/POST/WorkflowActions/ProfileCheckAction.yaml

@@ -15,6 +15,7 @@ properties:
     type: boolean
     default: false
     description: If the workflow action is archived or not.
+    example: false
   ne_attribute_ids:
     type: array
     required: false

nerm/schemas/POST/WorkflowActions/ProfileSelectAction.yaml

@@ -14,4 +14,5 @@ properties:
   archived:
     type: boolean
     default: false
-    description: If the workflow action is archived or not.
+    description: If the workflow action is archived or not.
+    example: false

nerm/schemas/POST/WorkflowActions/RequestAction.yaml

@@ -21,7 +21,9 @@ properties:
     type: boolean
     default: false
     description: If the workflow action is archived or not.
+    example: false
   requires_comment:
     type: boolean
     default: false
-    description: If the workflow action requires a comment or not.
+    description: If the workflow action requires a comment or not.
+    example: false

nerm/schemas/POST/WorkflowActions/RestApiAction.yaml

@@ -14,4 +14,5 @@ properties:
   archived:
     type: boolean
     default: false
-    description: If the workflow action is archived or not.
+    description: If the workflow action is archived or not.
+    example: false

nerm/schemas/POST/WorkflowActions/ReviewAction.yaml

@@ -21,7 +21,9 @@ properties:
     type: boolean
     default: false
     description: If the workflow action is archived or not.
+    example: false
   requires_comment:
     type: boolean
     default: false
     description: If the workflow action requires a comment or not.
+    example: false

nerm/schemas/POST/WorkflowActions/RunWorkflowAction.yaml

@@ -15,6 +15,7 @@ properties:
     type: boolean
     default: false
     description: If the workflow action is archived or not.
+    example: false
   configuration_attributes:
     type: array
     items: 
@@ -23,25 +24,38 @@ 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
+          format: uuid
+          description: the id of the profile type.
+          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8

nerm/schemas/POST/WorkflowActions/SetAttributesAction.yaml

@@ -14,4 +14,5 @@ properties:
   archived:
     type: boolean
     default: false
-    description: If the workflow action is archived or not.
+    description: If the workflow action is archived or not.
+    example: false

nerm/schemas/POST/WorkflowActions/SetSecurityQuestionAction.yaml

@@ -15,8 +15,10 @@ properties:
     type: boolean
     default: false
     description: If the workflow action is archived or not.
+    example: false
   number_of_questions:
     type: integer
+    format: int32
     required: true
     description: The number of questions the user should answer upon login.
     example: 1

nerm/schemas/POST/WorkflowActions/SoapApiAction.yaml

@@ -14,4 +14,5 @@ properties:
   archived:
     type: boolean
     default: false
-    description: If the workflow action is archived or not.
+    description: If the workflow action is archived or not.
+    example: false

nerm/schemas/POST/WorkflowActions/StatusChangeAction.yaml

@@ -21,4 +21,5 @@ properties:
   archived:
     type: boolean
     default: false
-    description: If the workflow action is archived or not.
+    description: If the workflow action is archived or not.
+    example: false

nerm/schemas/POST/WorkflowActions/UnassignAction.yaml

@@ -14,4 +14,5 @@ properties:
   archived:
     type: boolean
     default: false
-    description: If the workflow action is archived or not.
+    description: If the workflow action is archived or not.
+    example: false

nerm/schemas/POST/WorkflowActions/UpdateProfileAction.yaml

@@ -14,4 +14,5 @@ properties:
   archived:
     type: boolean
     default: false
-    description: If the workflow action is archived or not.
+    description: If the workflow action is archived or not.
+    example: false

nerm/schemas/POST/WorkflowActions/UsernamePasswordAction.yaml

@@ -14,4 +14,5 @@ properties:
   archived:
     type: boolean
     default: false
-    description: If the workflow action is archived or not.
+    description: If the workflow action is archived or not.
+    example: false