From ff8a6c277e25d9bd10bfa160fcda0faeace8f7a9 Mon Sep 17 00:00:00 2001 From: ktorre22 Date: Wed, 23 Aug 2023 12:12:13 -0400 Subject: [PATCH 1/2] NEROCKET-73 rebase settle --- nerm/openapi.yaml | 57 +++++++++++++++ .../workflow_actions/approval_action.yaml | 15 ++++ .../ask_security_question_action.yaml | 15 ++++ .../workflow_actions/auto_assign_action.yaml | 15 ++++ .../workflow_actions/batch_update_action.yaml | 15 ++++ .../close_session_action.yaml | 15 ++++ .../workflow_actions/contributors_action.yaml | 15 ++++ .../create_profile_action.yaml | 15 ++++ .../duplicate_prevention_action.yaml | 15 ++++ .../email_verification_action.yaml | 15 ++++ .../workflow_actions/fulfillment_action.yaml | 15 ++++ .../identity_proofing_action.yaml | 15 ++++ .../workflow_actions/invitation_action.yaml | 15 ++++ nerm/paths/workflow_actions/ldap_action.yaml | 15 ++++ .../workflow_actions/notification_action.yaml | 15 ++++ .../password_reset_action.yaml | 15 ++++ .../profile_check_action.yaml | 15 ++++ .../profile_select_action.yaml | 15 ++++ .../workflow_actions/request_action.yaml | 15 ++++ .../workflow_actions/rest_api_action.yaml | 15 ++++ .../paths/workflow_actions/review_action.yaml | 15 ++++ .../workflow_actions/run_workflow_action.yaml | 15 ++++ .../set_attributes_action.yaml | 15 ++++ .../set_security_question_action.yaml | 15 ++++ .../workflow_actions/soap_api_action.yaml | 15 ++++ .../status_change_action.yaml | 15 ++++ .../workflow_actions/unassign_action.yaml | 15 ++++ .../update_profile_action.yaml | 15 ++++ .../username_password_action.yaml | 15 ++++ .../POST/WorkflowActions/ApprovalAction.yaml | 9 +++ .../AskSecurityQuestionAction.yaml | 9 +++ .../WorkflowActions/AutoAssignAction.yaml | 9 +++ .../WorkflowActions/BatchUpdateAction.yaml | 9 +++ .../WorkflowActions/CloseSessionAction.yaml | 9 +++ .../WorkflowActions/ContributorsAction.yaml | 9 +++ .../WorkflowActions/CreateProfileAction.yaml | 9 +++ .../DuplicatePreventionAction.yaml | 9 +++ .../EmailVerificationAction.yaml | 9 +++ .../WorkflowActions/FulfillmentAction.yaml | 9 +++ .../IdentityProofingAction.yaml | 9 +++ .../WorkflowActions/InvitationAction.yaml | 9 +++ .../POST/WorkflowActions/LdapAction.yaml | 9 +++ .../WorkflowActions/NotificationAction.yaml | 9 +++ .../WorkflowActions/PasswordResetAction.yaml | 9 +++ .../WorkflowActions/ProfileCheckAction.yaml | 9 +++ .../WorkflowActions/ProfileSelectAction.yaml | 9 +++ .../POST/WorkflowActions/RequestAction.yaml | 9 +++ .../POST/WorkflowActions/RestApiAction.yaml | 9 +++ .../POST/WorkflowActions/ReviewAction.yaml | 9 +++ .../WorkflowActions/RunWorkflowAction.yaml | 9 +++ .../WorkflowActions/SetAttributesAction.yaml | 9 +++ .../SetSecurityQuestionAction.yaml | 9 +++ .../POST/WorkflowActions/SoapApiAction.yaml | 9 +++ .../WorkflowActions/StatusChangeAction.yaml | 9 +++ .../POST/WorkflowActions/UnassignAction.yaml | 9 +++ .../WorkflowActions/UpdateProfileAction.yaml | 9 +++ .../UsernamePasswordAction.yaml | 9 +++ nerm/responses/WorkflowAction.yaml | 9 +++ nerm/schemas/GET/WorkflowAction.yaml | 55 +++++++++++++++ .../POST/WorkflowActions/ApprovalAction.yaml | 31 ++++++++ .../AskSecurityQuestionAction.yaml | 33 +++++++++ .../WorkflowActions/AutoAssignAction.yaml | 22 ++++++ .../WorkflowActions/BatchUpdateAction.yaml | 17 +++++ .../WorkflowActions/CloseSessionAction.yaml | 17 +++++ .../WorkflowActions/ContributorsAction.yaml | 35 ++++++++++ .../WorkflowActions/CreateProfileAction.yaml | 21 ++++++ .../DuplicatePreventionAction.yaml | 33 +++++++++ .../EmailVerificationAction.yaml | 33 +++++++++ .../WorkflowActions/FulfillmentAction.yaml | 27 +++++++ .../IdentityProofingAction.yaml | 17 +++++ .../WorkflowActions/InvitationAction.yaml | 70 +++++++++++++++++++ .../POST/WorkflowActions/LdapAction.yaml | 69 ++++++++++++++++++ .../WorkflowActions/NotificationAction.yaml | 49 +++++++++++++ .../WorkflowActions/PasswordResetAction.yaml | 17 +++++ .../WorkflowActions/ProfileCheckAction.yaml | 33 +++++++++ .../WorkflowActions/ProfileSelectAction.yaml | 17 +++++ .../POST/WorkflowActions/RequestAction.yaml | 27 +++++++ .../POST/WorkflowActions/RestApiAction.yaml | 17 +++++ .../POST/WorkflowActions/ReviewAction.yaml | 27 +++++++ .../WorkflowActions/RunWorkflowAction.yaml | 47 +++++++++++++ .../WorkflowActions/SetAttributesAction.yaml | 17 +++++ .../SetSecurityQuestionAction.yaml | 22 ++++++ .../POST/WorkflowActions/SoapApiAction.yaml | 17 +++++ .../WorkflowActions/StatusChangeAction.yaml | 24 +++++++ .../POST/WorkflowActions/UnassignAction.yaml | 17 +++++ .../WorkflowActions/UpdateProfileAction.yaml | 17 +++++ .../UsernamePasswordAction.yaml | 17 +++++ 87 files changed, 1583 insertions(+) create mode 100644 nerm/paths/workflow_actions/approval_action.yaml create mode 100644 nerm/paths/workflow_actions/ask_security_question_action.yaml create mode 100644 nerm/paths/workflow_actions/auto_assign_action.yaml create mode 100644 nerm/paths/workflow_actions/batch_update_action.yaml create mode 100644 nerm/paths/workflow_actions/close_session_action.yaml create mode 100644 nerm/paths/workflow_actions/contributors_action.yaml create mode 100644 nerm/paths/workflow_actions/create_profile_action.yaml create mode 100644 nerm/paths/workflow_actions/duplicate_prevention_action.yaml create mode 100644 nerm/paths/workflow_actions/email_verification_action.yaml create mode 100644 nerm/paths/workflow_actions/fulfillment_action.yaml create mode 100644 nerm/paths/workflow_actions/identity_proofing_action.yaml create mode 100644 nerm/paths/workflow_actions/invitation_action.yaml create mode 100644 nerm/paths/workflow_actions/ldap_action.yaml create mode 100644 nerm/paths/workflow_actions/notification_action.yaml create mode 100644 nerm/paths/workflow_actions/password_reset_action.yaml create mode 100644 nerm/paths/workflow_actions/profile_check_action.yaml create mode 100644 nerm/paths/workflow_actions/profile_select_action.yaml create mode 100644 nerm/paths/workflow_actions/request_action.yaml create mode 100644 nerm/paths/workflow_actions/rest_api_action.yaml create mode 100644 nerm/paths/workflow_actions/review_action.yaml create mode 100644 nerm/paths/workflow_actions/run_workflow_action.yaml create mode 100644 nerm/paths/workflow_actions/set_attributes_action.yaml create mode 100644 nerm/paths/workflow_actions/set_security_question_action.yaml create mode 100644 nerm/paths/workflow_actions/soap_api_action.yaml create mode 100644 nerm/paths/workflow_actions/status_change_action.yaml create mode 100644 nerm/paths/workflow_actions/unassign_action.yaml create mode 100644 nerm/paths/workflow_actions/update_profile_action.yaml create mode 100644 nerm/paths/workflow_actions/username_password_action.yaml create mode 100644 nerm/requestBodies/POST/WorkflowActions/ApprovalAction.yaml create mode 100644 nerm/requestBodies/POST/WorkflowActions/AskSecurityQuestionAction.yaml create mode 100644 nerm/requestBodies/POST/WorkflowActions/AutoAssignAction.yaml create mode 100644 nerm/requestBodies/POST/WorkflowActions/BatchUpdateAction.yaml create mode 100644 nerm/requestBodies/POST/WorkflowActions/CloseSessionAction.yaml create mode 100644 nerm/requestBodies/POST/WorkflowActions/ContributorsAction.yaml create mode 100644 nerm/requestBodies/POST/WorkflowActions/CreateProfileAction.yaml create mode 100644 nerm/requestBodies/POST/WorkflowActions/DuplicatePreventionAction.yaml create mode 100644 nerm/requestBodies/POST/WorkflowActions/EmailVerificationAction.yaml create mode 100644 nerm/requestBodies/POST/WorkflowActions/FulfillmentAction.yaml create mode 100644 nerm/requestBodies/POST/WorkflowActions/IdentityProofingAction.yaml create mode 100644 nerm/requestBodies/POST/WorkflowActions/InvitationAction.yaml create mode 100644 nerm/requestBodies/POST/WorkflowActions/LdapAction.yaml create mode 100644 nerm/requestBodies/POST/WorkflowActions/NotificationAction.yaml create mode 100644 nerm/requestBodies/POST/WorkflowActions/PasswordResetAction.yaml create mode 100644 nerm/requestBodies/POST/WorkflowActions/ProfileCheckAction.yaml create mode 100644 nerm/requestBodies/POST/WorkflowActions/ProfileSelectAction.yaml create mode 100644 nerm/requestBodies/POST/WorkflowActions/RequestAction.yaml create mode 100644 nerm/requestBodies/POST/WorkflowActions/RestApiAction.yaml create mode 100644 nerm/requestBodies/POST/WorkflowActions/ReviewAction.yaml create mode 100644 nerm/requestBodies/POST/WorkflowActions/RunWorkflowAction.yaml create mode 100644 nerm/requestBodies/POST/WorkflowActions/SetAttributesAction.yaml create mode 100644 nerm/requestBodies/POST/WorkflowActions/SetSecurityQuestionAction.yaml create mode 100644 nerm/requestBodies/POST/WorkflowActions/SoapApiAction.yaml create mode 100644 nerm/requestBodies/POST/WorkflowActions/StatusChangeAction.yaml create mode 100644 nerm/requestBodies/POST/WorkflowActions/UnassignAction.yaml create mode 100644 nerm/requestBodies/POST/WorkflowActions/UpdateProfileAction.yaml create mode 100644 nerm/requestBodies/POST/WorkflowActions/UsernamePasswordAction.yaml create mode 100644 nerm/responses/WorkflowAction.yaml create mode 100644 nerm/schemas/GET/WorkflowAction.yaml create mode 100644 nerm/schemas/POST/WorkflowActions/ApprovalAction.yaml create mode 100644 nerm/schemas/POST/WorkflowActions/AskSecurityQuestionAction.yaml create mode 100644 nerm/schemas/POST/WorkflowActions/AutoAssignAction.yaml create mode 100644 nerm/schemas/POST/WorkflowActions/BatchUpdateAction.yaml create mode 100644 nerm/schemas/POST/WorkflowActions/CloseSessionAction.yaml create mode 100644 nerm/schemas/POST/WorkflowActions/ContributorsAction.yaml create mode 100644 nerm/schemas/POST/WorkflowActions/CreateProfileAction.yaml create mode 100644 nerm/schemas/POST/WorkflowActions/DuplicatePreventionAction.yaml create mode 100644 nerm/schemas/POST/WorkflowActions/EmailVerificationAction.yaml create mode 100644 nerm/schemas/POST/WorkflowActions/FulfillmentAction.yaml create mode 100644 nerm/schemas/POST/WorkflowActions/IdentityProofingAction.yaml create mode 100644 nerm/schemas/POST/WorkflowActions/InvitationAction.yaml create mode 100644 nerm/schemas/POST/WorkflowActions/LdapAction.yaml create mode 100644 nerm/schemas/POST/WorkflowActions/NotificationAction.yaml create mode 100644 nerm/schemas/POST/WorkflowActions/PasswordResetAction.yaml create mode 100644 nerm/schemas/POST/WorkflowActions/ProfileCheckAction.yaml create mode 100644 nerm/schemas/POST/WorkflowActions/ProfileSelectAction.yaml create mode 100644 nerm/schemas/POST/WorkflowActions/RequestAction.yaml create mode 100644 nerm/schemas/POST/WorkflowActions/RestApiAction.yaml create mode 100644 nerm/schemas/POST/WorkflowActions/ReviewAction.yaml create mode 100644 nerm/schemas/POST/WorkflowActions/RunWorkflowAction.yaml create mode 100644 nerm/schemas/POST/WorkflowActions/SetAttributesAction.yaml create mode 100644 nerm/schemas/POST/WorkflowActions/SetSecurityQuestionAction.yaml create mode 100644 nerm/schemas/POST/WorkflowActions/SoapApiAction.yaml create mode 100644 nerm/schemas/POST/WorkflowActions/StatusChangeAction.yaml create mode 100644 nerm/schemas/POST/WorkflowActions/UnassignAction.yaml create mode 100644 nerm/schemas/POST/WorkflowActions/UpdateProfileAction.yaml create mode 100644 nerm/schemas/POST/WorkflowActions/UsernamePasswordAction.yaml diff --git a/nerm/openapi.yaml b/nerm/openapi.yaml index 7eba320..941c83f 100644 --- a/nerm/openapi.yaml +++ b/nerm/openapi.yaml @@ -118,6 +118,63 @@ paths: $ref: "./paths/workflows/login_workflow.yaml" /workflows/password_reset_workflows: $ref: "./paths/workflows/password_reset_workflow.yaml" +# Workflow Actions + /workflow_actions/approval_actions: + $ref: "./paths/workflow_actions/approval_action.yaml" + /workflow_actions/ask_security_question_actions: + $ref: "./paths/workflow_actions/ask_security_question_action.yaml" + /workflow_actions/auto_assign_actions: + $ref: "./paths/workflow_actions/auto_assign_action.yaml" + /workflow_actions/batch_update_actions: + $ref: "./paths/workflow_actions/batch_update_action.yaml" + /workflow_actions/close_session_actions: + $ref: "./paths/workflow_actions/close_session_action.yaml" + /workflow_actions/contributors_actions: + $ref: "./paths/workflow_actions/contributors_action.yaml" + /workflow_actions/create_profile_actions: + $ref: "./paths/workflow_actions/create_profile_action.yaml" + /workflow_actions/duplicate_prevention_actions: + $ref: "./paths/workflow_actions/duplicate_prevention_action.yaml" + /workflow_actions/email_verification_actions: + $ref: "./paths/workflow_actions/email_verification_action.yaml" + /workflow_actions/fulfillment_actions: + $ref: "./paths/workflow_actions/fulfillment_action.yaml" + /workflow_actions/identity_proofing_actions: + $ref: "./paths/workflow_actions/identity_proofing_action.yaml" + /workflow_actions/invitation_actions: + $ref: "./paths/workflow_actions/invitation_action.yaml" + /workflow_actions/ldap_actions: + $ref: "./paths/workflow_actions/ldap_action.yaml" + /workflow_actions/notification_actions: + $ref: "./paths/workflow_actions/notification_action.yaml" + /workflow_actions/password_reset_actions: + $ref: "./paths/workflow_actions/password_reset_action.yaml" + /workflow_actions/profile_check_actions: + $ref: "./paths/workflow_actions/profile_check_action.yaml" + /workflow_actions/profile_select_actions: + $ref: "./paths/workflow_actions/profile_select_action.yaml" + /workflow_actions/request_actions: + $ref: "./paths/workflow_actions/request_action.yaml" + /workflow_actions/rest_api_actions: + $ref: "./paths/workflow_actions/rest_api_action.yaml" + /workflow_actions/review_actions: + $ref: "./paths/workflow_actions/review_action.yaml" + /workflow_actions/run_workflow_actions: + $ref: "./paths/workflow_actions/run_workflow_action.yaml" + /workflow_actions/set_attributes_actions: + $ref: "./paths/workflow_actions/set_attributes_action.yaml" + /workflow_actions/set_security_question_actions: + $ref: "./paths/workflow_actions/set_security_question_action.yaml" + /workflow_actions/soap_api_actions: + $ref: "./paths/workflow_actions/soap_api_action.yaml" + /workflow_actions/status_change_actions: + $ref: "./paths/workflow_actions/status_change_action.yaml" + /workflow_actions/unassign_actions: + $ref: "./paths/workflow_actions/unassign_action.yaml" + /workflow_actions/update_profile_actions: + $ref: "./paths/workflow_actions/update_profile_action.yaml" + /workflow_actions/username_password_actions: + $ref: "./paths/workflow_actions/username_password_action.yaml" # Workflow Sessions /workflow_sessions: $ref: "./paths/workflow_sessions.yaml" diff --git a/nerm/paths/workflow_actions/approval_action.yaml b/nerm/paths/workflow_actions/approval_action.yaml new file mode 100644 index 0000000..143c481 --- /dev/null +++ b/nerm/paths/workflow_actions/approval_action.yaml @@ -0,0 +1,15 @@ +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. + tags: + - workflow actions + requestBody: + $ref: "../../requestBodies/POST/WorkflowActions/ApprovalAction.yaml" + responses: + '200': + $ref: "../../responses/WorkflowAction.yaml" + '400': + $ref: "../../responses/400.yaml" + '500': + $ref: "../../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/workflow_actions/ask_security_question_action.yaml b/nerm/paths/workflow_actions/ask_security_question_action.yaml new file mode 100644 index 0000000..551e3bf --- /dev/null +++ b/nerm/paths/workflow_actions/ask_security_question_action.yaml @@ -0,0 +1,15 @@ +post: + summary: Create an ask security question action + operationId: createAskSecurityQuestionAction + description: Create an ask security question action + tags: + - workflow actions + requestBody: + $ref: "../../requestBodies/POST/WorkflowActions/AskSecurityQuestionAction.yaml" + responses: + '200': + $ref: "../../responses/WorkflowAction.yaml" + '400': + $ref: "../../responses/400.yaml" + '500': + $ref: "../../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/workflow_actions/auto_assign_action.yaml b/nerm/paths/workflow_actions/auto_assign_action.yaml new file mode 100644 index 0000000..ea760d5 --- /dev/null +++ b/nerm/paths/workflow_actions/auto_assign_action.yaml @@ -0,0 +1,15 @@ +post: + summary: Create an auto assign action + operationId: createAutoAssignAction + description: Create an auto assign action. Coordinate with workflow_action_roles to assign roles. + tags: + - workflow actions + requestBody: + $ref: "../../requestBodies/POST/WorkflowActions/AutoAssignAction.yaml" + responses: + '200': + $ref: "../../responses/WorkflowAction.yaml" + '400': + $ref: "../../responses/400.yaml" + '500': + $ref: "../../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/workflow_actions/batch_update_action.yaml b/nerm/paths/workflow_actions/batch_update_action.yaml new file mode 100644 index 0000000..ce2231f --- /dev/null +++ b/nerm/paths/workflow_actions/batch_update_action.yaml @@ -0,0 +1,15 @@ +post: + summary: Create a batch update action + operationId: createBatchUpdateAction + description: Create a batch update action + tags: + - workflow actions + requestBody: + $ref: "../../requestBodies/POST/WorkflowActions/BatchUpdateAction.yaml" + responses: + '200': + $ref: "../../responses/WorkflowAction.yaml" + '400': + $ref: "../../responses/400.yaml" + '500': + $ref: "../../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/workflow_actions/close_session_action.yaml b/nerm/paths/workflow_actions/close_session_action.yaml new file mode 100644 index 0000000..2379ad9 --- /dev/null +++ b/nerm/paths/workflow_actions/close_session_action.yaml @@ -0,0 +1,15 @@ +post: + summary: Create a close session action + operationId: createCloseSessionAction + description: Create a close session action + tags: + - workflow actions + requestBody: + $ref: "../../requestBodies/POST/WorkflowActions/CloseSessionAction.yaml" + responses: + '200': + $ref: "../../responses/WorkflowAction.yaml" + '400': + $ref: "../../responses/400.yaml" + '500': + $ref: "../../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/workflow_actions/contributors_action.yaml b/nerm/paths/workflow_actions/contributors_action.yaml new file mode 100644 index 0000000..b69e443 --- /dev/null +++ b/nerm/paths/workflow_actions/contributors_action.yaml @@ -0,0 +1,15 @@ +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. + tags: + - workflow actions + requestBody: + $ref: "../../requestBodies/POST/WorkflowActions/ContributorsAction.yaml" + responses: + '200': + $ref: "../../responses/WorkflowAction.yaml" + '400': + $ref: "../../responses/400.yaml" + '500': + $ref: "../../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/workflow_actions/create_profile_action.yaml b/nerm/paths/workflow_actions/create_profile_action.yaml new file mode 100644 index 0000000..f8e4d57 --- /dev/null +++ b/nerm/paths/workflow_actions/create_profile_action.yaml @@ -0,0 +1,15 @@ +post: + summary: Create a create profile action + operationId: createCreateProfileAction + description: Create a create profile action + tags: + - workflow actions + requestBody: + $ref: "../../requestBodies/POST/WorkflowActions/CreateProfileAction.yaml" + responses: + '200': + $ref: "../../responses/WorkflowAction.yaml" + '400': + $ref: "../../responses/400.yaml" + '500': + $ref: "../../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/workflow_actions/duplicate_prevention_action.yaml b/nerm/paths/workflow_actions/duplicate_prevention_action.yaml new file mode 100644 index 0000000..3eabc33 --- /dev/null +++ b/nerm/paths/workflow_actions/duplicate_prevention_action.yaml @@ -0,0 +1,15 @@ +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. + tags: + - workflow actions + requestBody: + $ref: "../../requestBodies/POST/WorkflowActions/DuplicatePreventionAction.yaml" + responses: + '200': + $ref: "../../responses/WorkflowAction.yaml" + '400': + $ref: "../../responses/400.yaml" + '500': + $ref: "../../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/workflow_actions/email_verification_action.yaml b/nerm/paths/workflow_actions/email_verification_action.yaml new file mode 100644 index 0000000..0b6f54c --- /dev/null +++ b/nerm/paths/workflow_actions/email_verification_action.yaml @@ -0,0 +1,15 @@ +post: + summary: Create an email verification action + operationId: createEmailVerificationAction + description: Create an email verification action + tags: + - workflow actions + requestBody: + $ref: "../../requestBodies/POST/WorkflowActions/EmailVerificationAction.yaml" + responses: + '200': + $ref: "../../responses/WorkflowAction.yaml" + '400': + $ref: "../../responses/400.yaml" + '500': + $ref: "../../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/workflow_actions/fulfillment_action.yaml b/nerm/paths/workflow_actions/fulfillment_action.yaml new file mode 100644 index 0000000..7c2af1d --- /dev/null +++ b/nerm/paths/workflow_actions/fulfillment_action.yaml @@ -0,0 +1,15 @@ +post: + summary: Create a fulfillent 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. + tags: + - workflow actions + requestBody: + $ref: "../../requestBodies/POST/WorkflowActions/FulfillmentAction.yaml" + responses: + '200': + $ref: "../../responses/WorkflowAction.yaml" + '400': + $ref: "../../responses/400.yaml" + '500': + $ref: "../../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/workflow_actions/identity_proofing_action.yaml b/nerm/paths/workflow_actions/identity_proofing_action.yaml new file mode 100644 index 0000000..c69fc56 --- /dev/null +++ b/nerm/paths/workflow_actions/identity_proofing_action.yaml @@ -0,0 +1,15 @@ +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. + tags: + - workflow actions + requestBody: + $ref: "../../requestBodies/POST/WorkflowActions/IdentityProofingAction.yaml" + responses: + '200': + $ref: "../../responses/WorkflowAction.yaml" + '400': + $ref: "../../responses/400.yaml" + '500': + $ref: "../../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/workflow_actions/invitation_action.yaml b/nerm/paths/workflow_actions/invitation_action.yaml new file mode 100644 index 0000000..874d2f5 --- /dev/null +++ b/nerm/paths/workflow_actions/invitation_action.yaml @@ -0,0 +1,15 @@ +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. + tags: + - workflow actions + requestBody: + $ref: "../../requestBodies/POST/WorkflowActions/InvitationAction.yaml" + responses: + '200': + $ref: "../../responses/WorkflowAction.yaml" + '400': + $ref: "../../responses/400.yaml" + '500': + $ref: "../../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/workflow_actions/ldap_action.yaml b/nerm/paths/workflow_actions/ldap_action.yaml new file mode 100644 index 0000000..220f90d --- /dev/null +++ b/nerm/paths/workflow_actions/ldap_action.yaml @@ -0,0 +1,15 @@ +post: + summary: Create a ldap action + operationId: createLdapAction + description: Create a ldap action + tags: + - workflow actions + requestBody: + $ref: "../../requestBodies/POST/WorkflowActions/LdapAction.yaml" + responses: + '200': + $ref: "../../responses/WorkflowAction.yaml" + '400': + $ref: "../../responses/400.yaml" + '500': + $ref: "../../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/workflow_actions/notification_action.yaml b/nerm/paths/workflow_actions/notification_action.yaml new file mode 100644 index 0000000..e21d760 --- /dev/null +++ b/nerm/paths/workflow_actions/notification_action.yaml @@ -0,0 +1,15 @@ +post: + summary: Create a notification action + operationId: createNotificationAction + description: Create a notification action + tags: + - workflow actions + requestBody: + $ref: "../../requestBodies/POST/WorkflowActions/NotificationAction.yaml" + responses: + '200': + $ref: "../../responses/WorkflowAction.yaml" + '400': + $ref: "../../responses/400.yaml" + '500': + $ref: "../../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/workflow_actions/password_reset_action.yaml b/nerm/paths/workflow_actions/password_reset_action.yaml new file mode 100644 index 0000000..1c2a075 --- /dev/null +++ b/nerm/paths/workflow_actions/password_reset_action.yaml @@ -0,0 +1,15 @@ +post: + summary: Create a password reset action + operationId: createPasswordResetAction + description: Create a password reset action + tags: + - workflow actions + requestBody: + $ref: "../../requestBodies/POST/WorkflowActions/PasswordResetAction.yaml" + responses: + '200': + $ref: "../../responses/WorkflowAction.yaml" + '400': + $ref: "../../responses/400.yaml" + '500': + $ref: "../../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/workflow_actions/profile_check_action.yaml b/nerm/paths/workflow_actions/profile_check_action.yaml new file mode 100644 index 0000000..4fcda34 --- /dev/null +++ b/nerm/paths/workflow_actions/profile_check_action.yaml @@ -0,0 +1,15 @@ +post: + summary: Create a profile check action + operationId: createProfileCheckAction + description: Create a profile check action + tags: + - workflow actions + requestBody: + $ref: "../../requestBodies/POST/WorkflowActions/ProfileCheckAction.yaml" + responses: + '200': + $ref: "../../responses/WorkflowAction.yaml" + '400': + $ref: "../../responses/400.yaml" + '500': + $ref: "../../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/workflow_actions/profile_select_action.yaml b/nerm/paths/workflow_actions/profile_select_action.yaml new file mode 100644 index 0000000..ecfffba --- /dev/null +++ b/nerm/paths/workflow_actions/profile_select_action.yaml @@ -0,0 +1,15 @@ +post: + summary: Create a profile select action + operationId: createProfileSelectAction + description: Create a profile select action + tags: + - workflow actions + requestBody: + $ref: "../../requestBodies/POST/WorkflowActions/ProfileSelectAction.yaml" + responses: + '200': + $ref: "../../responses/WorkflowAction.yaml" + '400': + $ref: "../../responses/400.yaml" + '500': + $ref: "../../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/workflow_actions/request_action.yaml b/nerm/paths/workflow_actions/request_action.yaml new file mode 100644 index 0000000..b4a926e --- /dev/null +++ b/nerm/paths/workflow_actions/request_action.yaml @@ -0,0 +1,15 @@ +post: + summary: Create a request action + operationId: createRequestAction + description: Create a request action + tags: + - workflow actions + requestBody: + $ref: "../../requestBodies/POST/WorkflowActions/RequestAction.yaml" + responses: + '200': + $ref: "../../responses/WorkflowAction.yaml" + '400': + $ref: "../../responses/400.yaml" + '500': + $ref: "../../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/workflow_actions/rest_api_action.yaml b/nerm/paths/workflow_actions/rest_api_action.yaml new file mode 100644 index 0000000..be7a26c --- /dev/null +++ b/nerm/paths/workflow_actions/rest_api_action.yaml @@ -0,0 +1,15 @@ +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. + tags: + - workflow actions + requestBody: + $ref: "../../requestBodies/POST/WorkflowActions/RestApiAction.yaml" + responses: + '200': + $ref: "../../responses/WorkflowAction.yaml" + '400': + $ref: "../../responses/400.yaml" + '500': + $ref: "../../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/workflow_actions/review_action.yaml b/nerm/paths/workflow_actions/review_action.yaml new file mode 100644 index 0000000..3333c04 --- /dev/null +++ b/nerm/paths/workflow_actions/review_action.yaml @@ -0,0 +1,15 @@ +post: + summary: Create a review action + operationId: createReviewAction + description: Create a review action. Coordinate with workflow_action_performer_notification_email for performer email config. + tags: + - workflow actions + requestBody: + $ref: "../../requestBodies/POST/WorkflowActions/ReviewAction.yaml" + responses: + '200': + $ref: "../../responses/WorkflowAction.yaml" + '400': + $ref: "../../responses/400.yaml" + '500': + $ref: "../../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/workflow_actions/run_workflow_action.yaml b/nerm/paths/workflow_actions/run_workflow_action.yaml new file mode 100644 index 0000000..f7b55db --- /dev/null +++ b/nerm/paths/workflow_actions/run_workflow_action.yaml @@ -0,0 +1,15 @@ +post: + summary: Create a run workflow action + operationId: createRunWorkflowAction + description: Create a run workflow action. Coordinate with configuration_profile_attribute. + tags: + - workflow actions + requestBody: + $ref: "../../requestBodies/POST/WorkflowActions/RunWorkflowAction.yaml" + responses: + '200': + $ref: "../../responses/WorkflowAction.yaml" + '400': + $ref: "../../responses/400.yaml" + '500': + $ref: "../../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/workflow_actions/set_attributes_action.yaml b/nerm/paths/workflow_actions/set_attributes_action.yaml new file mode 100644 index 0000000..9e1b53f --- /dev/null +++ b/nerm/paths/workflow_actions/set_attributes_action.yaml @@ -0,0 +1,15 @@ +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. + tags: + - workflow actions + requestBody: + $ref: "../../requestBodies/POST/WorkflowActions/SetAttributesAction.yaml" + responses: + '200': + $ref: "../../responses/WorkflowAction.yaml" + '400': + $ref: "../../responses/400.yaml" + '500': + $ref: "../../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/workflow_actions/set_security_question_action.yaml b/nerm/paths/workflow_actions/set_security_question_action.yaml new file mode 100644 index 0000000..efd6a7c --- /dev/null +++ b/nerm/paths/workflow_actions/set_security_question_action.yaml @@ -0,0 +1,15 @@ +post: + summary: Create a set security question action + operationId: createSetSecurityQuestionAction + description: Create a set security question action + tags: + - workflow actions + requestBody: + $ref: "../../requestBodies/POST/WorkflowActions/SetSecurityQuestionAction.yaml" + responses: + '200': + $ref: "../../responses/WorkflowAction.yaml" + '400': + $ref: "../../responses/400.yaml" + '500': + $ref: "../../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/workflow_actions/soap_api_action.yaml b/nerm/paths/workflow_actions/soap_api_action.yaml new file mode 100644 index 0000000..897e019 --- /dev/null +++ b/nerm/paths/workflow_actions/soap_api_action.yaml @@ -0,0 +1,15 @@ +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. + tags: + - workflow actions + requestBody: + $ref: "../../requestBodies/POST/WorkflowActions/SoapApiAction.yaml" + responses: + '200': + $ref: "../../responses/WorkflowAction.yaml" + '400': + $ref: "../../responses/400.yaml" + '500': + $ref: "../../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/workflow_actions/status_change_action.yaml b/nerm/paths/workflow_actions/status_change_action.yaml new file mode 100644 index 0000000..bd7ec97 --- /dev/null +++ b/nerm/paths/workflow_actions/status_change_action.yaml @@ -0,0 +1,15 @@ +post: + summary: Create a status change action + operationId: createStatusChangeAction + description: Create a status change action + tags: + - workflow actions + requestBody: + $ref: "../../requestBodies/POST/WorkflowActions/StatusChangeAction.yaml" + responses: + '200': + $ref: "../../responses/WorkflowAction.yaml" + '400': + $ref: "../../responses/400.yaml" + '500': + $ref: "../../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/workflow_actions/unassign_action.yaml b/nerm/paths/workflow_actions/unassign_action.yaml new file mode 100644 index 0000000..31823a4 --- /dev/null +++ b/nerm/paths/workflow_actions/unassign_action.yaml @@ -0,0 +1,15 @@ +post: + summary: Create an unassign action + operationId: createUnassignAction + description: Create an unassign action. Coordinate with workflow_action_roles to assign roles. + tags: + - workflow actions + requestBody: + $ref: "../../requestBodies/POST/WorkflowActions/UnassignAction.yaml" + responses: + '200': + $ref: "../../responses/WorkflowAction.yaml" + '400': + $ref: "../../responses/400.yaml" + '500': + $ref: "../../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/workflow_actions/update_profile_action.yaml b/nerm/paths/workflow_actions/update_profile_action.yaml new file mode 100644 index 0000000..e4a543a --- /dev/null +++ b/nerm/paths/workflow_actions/update_profile_action.yaml @@ -0,0 +1,15 @@ +post: + summary: Create an update profile action + operationId: createUpdateProfileAction + description: Create an update profile action + tags: + - workflow actions + requestBody: + $ref: "../../requestBodies/POST/WorkflowActions/UpdateProfileAction.yaml" + responses: + '200': + $ref: "../../responses/WorkflowAction.yaml" + '400': + $ref: "../../responses/400.yaml" + '500': + $ref: "../../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/workflow_actions/username_password_action.yaml b/nerm/paths/workflow_actions/username_password_action.yaml new file mode 100644 index 0000000..4177971 --- /dev/null +++ b/nerm/paths/workflow_actions/username_password_action.yaml @@ -0,0 +1,15 @@ +post: + summary: Create a username password action + operationId: createUsernamePasswordAction + description: Create a username password action + tags: + - workflow actions + requestBody: + $ref: "../../requestBodies/POST/WorkflowActions/UsernamePasswordAction.yaml" + responses: + '200': + $ref: "../../responses/WorkflowAction.yaml" + '400': + $ref: "../../responses/400.yaml" + '500': + $ref: "../../responses/500.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/WorkflowActions/ApprovalAction.yaml b/nerm/requestBodies/POST/WorkflowActions/ApprovalAction.yaml new file mode 100644 index 0000000..e2e5033 --- /dev/null +++ b/nerm/requestBodies/POST/WorkflowActions/ApprovalAction.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + $ref: "../../../schemas/POST/WorkflowActions/ApprovalAction.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/WorkflowActions/AskSecurityQuestionAction.yaml b/nerm/requestBodies/POST/WorkflowActions/AskSecurityQuestionAction.yaml new file mode 100644 index 0000000..cd3fa3d --- /dev/null +++ b/nerm/requestBodies/POST/WorkflowActions/AskSecurityQuestionAction.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + $ref: "../../../schemas/POST/WorkflowActions/AskSecurityQuestionAction.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/WorkflowActions/AutoAssignAction.yaml b/nerm/requestBodies/POST/WorkflowActions/AutoAssignAction.yaml new file mode 100644 index 0000000..38d5f3d --- /dev/null +++ b/nerm/requestBodies/POST/WorkflowActions/AutoAssignAction.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + $ref: "../../../schemas/POST/WorkflowActions/AutoAssignAction.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/WorkflowActions/BatchUpdateAction.yaml b/nerm/requestBodies/POST/WorkflowActions/BatchUpdateAction.yaml new file mode 100644 index 0000000..02de576 --- /dev/null +++ b/nerm/requestBodies/POST/WorkflowActions/BatchUpdateAction.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + $ref: "../../../schemas/POST/WorkflowActions/BatchUpdateAction.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/WorkflowActions/CloseSessionAction.yaml b/nerm/requestBodies/POST/WorkflowActions/CloseSessionAction.yaml new file mode 100644 index 0000000..3a58445 --- /dev/null +++ b/nerm/requestBodies/POST/WorkflowActions/CloseSessionAction.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + $ref: "../../../schemas/POST/WorkflowActions/CloseSessionAction.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/WorkflowActions/ContributorsAction.yaml b/nerm/requestBodies/POST/WorkflowActions/ContributorsAction.yaml new file mode 100644 index 0000000..d13eb28 --- /dev/null +++ b/nerm/requestBodies/POST/WorkflowActions/ContributorsAction.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + $ref: "../../../schemas/POST/WorkflowActions/ContributorsAction.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/WorkflowActions/CreateProfileAction.yaml b/nerm/requestBodies/POST/WorkflowActions/CreateProfileAction.yaml new file mode 100644 index 0000000..eb6b376 --- /dev/null +++ b/nerm/requestBodies/POST/WorkflowActions/CreateProfileAction.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + $ref: "../../../schemas/POST/WorkflowActions/CreateProfileAction.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/WorkflowActions/DuplicatePreventionAction.yaml b/nerm/requestBodies/POST/WorkflowActions/DuplicatePreventionAction.yaml new file mode 100644 index 0000000..afe9ddd --- /dev/null +++ b/nerm/requestBodies/POST/WorkflowActions/DuplicatePreventionAction.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + $ref: "../../../schemas/POST/WorkflowActions/DuplicatePreventionAction.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/WorkflowActions/EmailVerificationAction.yaml b/nerm/requestBodies/POST/WorkflowActions/EmailVerificationAction.yaml new file mode 100644 index 0000000..b5f1bd7 --- /dev/null +++ b/nerm/requestBodies/POST/WorkflowActions/EmailVerificationAction.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + $ref: "../../../schemas/POST/WorkflowActions/EmailVerificationAction.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/WorkflowActions/FulfillmentAction.yaml b/nerm/requestBodies/POST/WorkflowActions/FulfillmentAction.yaml new file mode 100644 index 0000000..372e436 --- /dev/null +++ b/nerm/requestBodies/POST/WorkflowActions/FulfillmentAction.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + $ref: "../../../schemas/POST/WorkflowActions/FulfillmentAction.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/WorkflowActions/IdentityProofingAction.yaml b/nerm/requestBodies/POST/WorkflowActions/IdentityProofingAction.yaml new file mode 100644 index 0000000..91f519f --- /dev/null +++ b/nerm/requestBodies/POST/WorkflowActions/IdentityProofingAction.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + $ref: "../../../schemas/POST/WorkflowActions/IdentityProofingAction.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/WorkflowActions/InvitationAction.yaml b/nerm/requestBodies/POST/WorkflowActions/InvitationAction.yaml new file mode 100644 index 0000000..39112c4 --- /dev/null +++ b/nerm/requestBodies/POST/WorkflowActions/InvitationAction.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + $ref: "../../../schemas/POST/WorkflowActions/InvitationAction.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/WorkflowActions/LdapAction.yaml b/nerm/requestBodies/POST/WorkflowActions/LdapAction.yaml new file mode 100644 index 0000000..cb7e41b --- /dev/null +++ b/nerm/requestBodies/POST/WorkflowActions/LdapAction.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + $ref: "../../../schemas/POST/WorkflowActions/LdapAction.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/WorkflowActions/NotificationAction.yaml b/nerm/requestBodies/POST/WorkflowActions/NotificationAction.yaml new file mode 100644 index 0000000..5875850 --- /dev/null +++ b/nerm/requestBodies/POST/WorkflowActions/NotificationAction.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + $ref: "../../../schemas/POST/WorkflowActions/NotificationAction.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/WorkflowActions/PasswordResetAction.yaml b/nerm/requestBodies/POST/WorkflowActions/PasswordResetAction.yaml new file mode 100644 index 0000000..689bef2 --- /dev/null +++ b/nerm/requestBodies/POST/WorkflowActions/PasswordResetAction.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + $ref: "../../../schemas/POST/WorkflowActions/PasswordResetAction.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/WorkflowActions/ProfileCheckAction.yaml b/nerm/requestBodies/POST/WorkflowActions/ProfileCheckAction.yaml new file mode 100644 index 0000000..55338ae --- /dev/null +++ b/nerm/requestBodies/POST/WorkflowActions/ProfileCheckAction.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + $ref: "../../../schemas/POST/WorkflowActions/ProfileCheckAction.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/WorkflowActions/ProfileSelectAction.yaml b/nerm/requestBodies/POST/WorkflowActions/ProfileSelectAction.yaml new file mode 100644 index 0000000..77aed8d --- /dev/null +++ b/nerm/requestBodies/POST/WorkflowActions/ProfileSelectAction.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + $ref: "../../../schemas/POST/WorkflowActions/ProfileSelectAction.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/WorkflowActions/RequestAction.yaml b/nerm/requestBodies/POST/WorkflowActions/RequestAction.yaml new file mode 100644 index 0000000..fb56498 --- /dev/null +++ b/nerm/requestBodies/POST/WorkflowActions/RequestAction.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + $ref: "../../../schemas/POST/WorkflowActions/RequestAction.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/WorkflowActions/RestApiAction.yaml b/nerm/requestBodies/POST/WorkflowActions/RestApiAction.yaml new file mode 100644 index 0000000..a1d7868 --- /dev/null +++ b/nerm/requestBodies/POST/WorkflowActions/RestApiAction.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + $ref: "../../../schemas/POST/WorkflowActions/RestApiAction.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/WorkflowActions/ReviewAction.yaml b/nerm/requestBodies/POST/WorkflowActions/ReviewAction.yaml new file mode 100644 index 0000000..90ddfaf --- /dev/null +++ b/nerm/requestBodies/POST/WorkflowActions/ReviewAction.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + $ref: "../../../schemas/POST/WorkflowActions/ReviewAction.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/WorkflowActions/RunWorkflowAction.yaml b/nerm/requestBodies/POST/WorkflowActions/RunWorkflowAction.yaml new file mode 100644 index 0000000..0f9c9db --- /dev/null +++ b/nerm/requestBodies/POST/WorkflowActions/RunWorkflowAction.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + $ref: "../../../schemas/POST/WorkflowActions/RunWorkflowAction.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/WorkflowActions/SetAttributesAction.yaml b/nerm/requestBodies/POST/WorkflowActions/SetAttributesAction.yaml new file mode 100644 index 0000000..3a0e609 --- /dev/null +++ b/nerm/requestBodies/POST/WorkflowActions/SetAttributesAction.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + $ref: "../../../schemas/POST/WorkflowActions/SetAttributesAction.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/WorkflowActions/SetSecurityQuestionAction.yaml b/nerm/requestBodies/POST/WorkflowActions/SetSecurityQuestionAction.yaml new file mode 100644 index 0000000..91f1c93b --- /dev/null +++ b/nerm/requestBodies/POST/WorkflowActions/SetSecurityQuestionAction.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + $ref: "../../../schemas/POST/WorkflowActions/SetSecurityQuestionAction.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/WorkflowActions/SoapApiAction.yaml b/nerm/requestBodies/POST/WorkflowActions/SoapApiAction.yaml new file mode 100644 index 0000000..4dc1f0b --- /dev/null +++ b/nerm/requestBodies/POST/WorkflowActions/SoapApiAction.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + $ref: "../../../schemas/POST/WorkflowActions/SoapApiAction.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/WorkflowActions/StatusChangeAction.yaml b/nerm/requestBodies/POST/WorkflowActions/StatusChangeAction.yaml new file mode 100644 index 0000000..299694d --- /dev/null +++ b/nerm/requestBodies/POST/WorkflowActions/StatusChangeAction.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + $ref: "../../../schemas/POST/WorkflowActions/StatusChangeAction.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/WorkflowActions/UnassignAction.yaml b/nerm/requestBodies/POST/WorkflowActions/UnassignAction.yaml new file mode 100644 index 0000000..52b3d75 --- /dev/null +++ b/nerm/requestBodies/POST/WorkflowActions/UnassignAction.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + $ref: "../../../schemas/POST/WorkflowActions/UnassignAction.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/WorkflowActions/UpdateProfileAction.yaml b/nerm/requestBodies/POST/WorkflowActions/UpdateProfileAction.yaml new file mode 100644 index 0000000..c40bacd --- /dev/null +++ b/nerm/requestBodies/POST/WorkflowActions/UpdateProfileAction.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + $ref: "../../../schemas/POST/WorkflowActions/UpdateProfileAction.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/WorkflowActions/UsernamePasswordAction.yaml b/nerm/requestBodies/POST/WorkflowActions/UsernamePasswordAction.yaml new file mode 100644 index 0000000..63f7a16 --- /dev/null +++ b/nerm/requestBodies/POST/WorkflowActions/UsernamePasswordAction.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + $ref: "../../../schemas/POST/WorkflowActions/UsernamePasswordAction.yaml" \ No newline at end of file diff --git a/nerm/responses/WorkflowAction.yaml b/nerm/responses/WorkflowAction.yaml new file mode 100644 index 0000000..38c2b29 --- /dev/null +++ b/nerm/responses/WorkflowAction.yaml @@ -0,0 +1,9 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + $ref: '../schemas/GET/WorkflowAction.yaml' \ No newline at end of file diff --git a/nerm/schemas/GET/WorkflowAction.yaml b/nerm/schemas/GET/WorkflowAction.yaml new file mode 100644 index 0000000..c7ae0e6 --- /dev/null +++ b/nerm/schemas/GET/WorkflowAction.yaml @@ -0,0 +1,55 @@ +type: object +properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: false + description: The description of the workflow action. + example: Require approval from another user or a group of users with a specific role. + page_id: + type: string + format: uuid + required: true + description: The page the workflow action should render. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + add_requester_as_owner: + type: boolean + default: true + description: If the requester should be added as the owner of the profile to be created. + email_attribute_id: + type: string + format: uuid + required: false + description: The attribute storing the email address for the workflow action. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + email_addresses: + type: array + required: false + items: + type: string + format: text + description: The email addresses for the workflow action. + example: ["johndoe@gmail.com", "janedoe@gmail.com"] + new_status: + type: string + format: text + required: false + description: The new status for the Status Change workflow action. + example: Active, Inactive, On Leave, Terminated + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + skippable: + type: boolean + default: false + description: If the workflow action is skippable or not. + requires_comment: + type: boolean + default: false + description: If the workflow action requires a comment or not. \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/ApprovalAction.yaml b/nerm/schemas/POST/WorkflowActions/ApprovalAction.yaml new file mode 100644 index 0000000..62bcf3e --- /dev/null +++ b/nerm/schemas/POST/WorkflowActions/ApprovalAction.yaml @@ -0,0 +1,31 @@ +type: object +properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: false + description: The description of the workflow action. + example: Require approval from another user or a group of users with a specific role. + page_id: + type: string + format: uuid + required: true + description: The page the workflow action should render. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + skippable: + type: boolean + default: false + description: If the workflow action is skippable or not. + requires_comment: + type: boolean + default: false + description: If the workflow action requires a comment or not. \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/AskSecurityQuestionAction.yaml b/nerm/schemas/POST/WorkflowActions/AskSecurityQuestionAction.yaml new file mode 100644 index 0000000..3396b7c --- /dev/null +++ b/nerm/schemas/POST/WorkflowActions/AskSecurityQuestionAction.yaml @@ -0,0 +1,33 @@ +type: object +properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Prompt the user to answer some personal security questions. + number_of_questions: + type: integer + required: true + description: The number of questions the user should answer upon login. + example: 1 + token_expiration: + type: integer + required: true + description: The token expiration time, coordinates with token_expiration_type. + example: 1 + token_expiration_type: + type: string + required: true + enum: [hours, days, login attempts, always] + description: The token expiration type, coordinates with token_expiration. + example: day + archived: + type: boolean + default: false + description: If the workflow action is archived or not. \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/AutoAssignAction.yaml b/nerm/schemas/POST/WorkflowActions/AutoAssignAction.yaml new file mode 100644 index 0000000..4f80baa --- /dev/null +++ b/nerm/schemas/POST/WorkflowActions/AutoAssignAction.yaml @@ -0,0 +1,22 @@ +type: object +properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Automatically assigns contributors to this profile. + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + 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. \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/BatchUpdateAction.yaml b/nerm/schemas/POST/WorkflowActions/BatchUpdateAction.yaml new file mode 100644 index 0000000..0cb12c8 --- /dev/null +++ b/nerm/schemas/POST/WorkflowActions/BatchUpdateAction.yaml @@ -0,0 +1,17 @@ +type: object +properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Updates a batch of profiles with all attributes collected during the workflow. + archived: + type: boolean + default: false + description: If the workflow action is archived or not. \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/CloseSessionAction.yaml b/nerm/schemas/POST/WorkflowActions/CloseSessionAction.yaml new file mode 100644 index 0000000..9320757 --- /dev/null +++ b/nerm/schemas/POST/WorkflowActions/CloseSessionAction.yaml @@ -0,0 +1,17 @@ +type: object +properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Closes the current workflow session. + archived: + type: boolean + default: false + description: If the workflow action is archived or not. \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/ContributorsAction.yaml b/nerm/schemas/POST/WorkflowActions/ContributorsAction.yaml new file mode 100644 index 0000000..fccdbf3 --- /dev/null +++ b/nerm/schemas/POST/WorkflowActions/ContributorsAction.yaml @@ -0,0 +1,35 @@ +type: object +properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Have the requester determine the contributors or owner of the profile. + owner: + type: string + required: false + enum: [true, false] + description: If the assignment option should be an owner. Owner, Contributors, or Roles must be chosen. + example: "true" + contributors: + type: string + required: false + enum: [true, false] + description: If the assignment option should be contributors. Owner, Contributors, or Roles must be chosen. + example: "true" + roles: + type: string + required: false + enum: [true, false] + description: If the assignment option should be roles. Owner, Contributors, or Roles must be chosen. + example: "true" + archived: + type: boolean + default: false + description: If the workflow action is archived or not. \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/CreateProfileAction.yaml b/nerm/schemas/POST/WorkflowActions/CreateProfileAction.yaml new file mode 100644 index 0000000..ae56ca8 --- /dev/null +++ b/nerm/schemas/POST/WorkflowActions/CreateProfileAction.yaml @@ -0,0 +1,21 @@ +type: object +properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Creates a profile with all attributes collected during the workflow. + add_requester_as_owner: + type: boolean + default: true + description: If the requester should be added as the owner of the profile to be created. + archived: + type: boolean + default: false + description: If the workflow action is archived or not. \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/DuplicatePreventionAction.yaml b/nerm/schemas/POST/WorkflowActions/DuplicatePreventionAction.yaml new file mode 100644 index 0000000..1a9fdee --- /dev/null +++ b/nerm/schemas/POST/WorkflowActions/DuplicatePreventionAction.yaml @@ -0,0 +1,33 @@ +type: object +properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Allows a user to select an already existing profile, or create a new one for the request. + search_scope: + type: string + required: true + enum: ["all", "current"] + description: The search scope of the profiles to check against. + example: "current" + ne_attribute_ids: + type: array + required: false + description: An array of ne_attribute_ids. + example: ["33f072dd-13b4-41e1-8ea0-16f2a59b57c8"] + handle_id: + type: string + required: false + description: The handle id. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + archived: + type: boolean + default: false + description: If the workflow action is archived or not. \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/EmailVerificationAction.yaml b/nerm/schemas/POST/WorkflowActions/EmailVerificationAction.yaml new file mode 100644 index 0000000..a06640d --- /dev/null +++ b/nerm/schemas/POST/WorkflowActions/EmailVerificationAction.yaml @@ -0,0 +1,33 @@ +type: object +properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Have the user verify their email address. + email_expiration: + type: integer + required: true + description: The email expiration time, in minutes. + example: 20 + token_expiration: + type: integer + required: true + description: The token expiration time, coordinates with token_expiration_type. + example: 1 + token_expiration_type: + type: string + required: true + enum: [hours, days, login attempts, always] + description: The token expiration type, coordinates with token_expiration. + example: day + archived: + type: boolean + default: false + description: If the workflow action is archived or not. diff --git a/nerm/schemas/POST/WorkflowActions/FulfillmentAction.yaml b/nerm/schemas/POST/WorkflowActions/FulfillmentAction.yaml new file mode 100644 index 0000000..8a13f2e --- /dev/null +++ b/nerm/schemas/POST/WorkflowActions/FulfillmentAction.yaml @@ -0,0 +1,27 @@ +type: object +properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Have another user or group provide information for the profile. + page_id: + type: string + format: uuid + required: false + description: The page the workflow action should render. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + requires_comment: + type: boolean + default: false + description: If the workflow action requires a comment or not. \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/IdentityProofingAction.yaml b/nerm/schemas/POST/WorkflowActions/IdentityProofingAction.yaml new file mode 100644 index 0000000..488e5f4 --- /dev/null +++ b/nerm/schemas/POST/WorkflowActions/IdentityProofingAction.yaml @@ -0,0 +1,17 @@ +type: object +properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Have the user account associated with this profile validate the identity data. + archived: + type: boolean + default: false + description: If the workflow action is archived or not. \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/InvitationAction.yaml b/nerm/schemas/POST/WorkflowActions/InvitationAction.yaml new file mode 100644 index 0000000..8cf4cf1 --- /dev/null +++ b/nerm/schemas/POST/WorkflowActions/InvitationAction.yaml @@ -0,0 +1,70 @@ +type: object +properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Creates a registration session associated with an email address + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + configuration_attributes: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + workflow_id: + type: string + format: uuid + wait_for_completion: + type: boolean + example: false + return_profile: + type: boolean + example: false + portal_id: + type: string + format: uuid + registration_workflow_id: + type: string + format: uuid + email_attribute_id: + type: string + format: uuid + profile_type_id: + type: string + format: uuid + validate_completed_registration: + type: boolean + example: false + validate_open_registration: + type: boolean + example: false + workflow_action_email_attributes: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + workflow_action_id: + type: string + format: uuid + email_id: + type: string + format: uuid + type: + type: string + 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 new file mode 100644 index 0000000..da1e1cc --- /dev/null +++ b/nerm/schemas/POST/WorkflowActions/LdapAction.yaml @@ -0,0 +1,69 @@ +type: object +properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Create a Collaboration user account for this profile. + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + store_type: + type: string + required: true + example: Local, Directory + ldap_action_user_roles_attributes: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + role_id: + type: string + format: uuid + workflow_action_value_builders_attributes: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + workflow_action_id: + type: string + format: uuid + value_builder_id: + type: string + format: uuid + position: + type: integer + example: 1 + workflow_action_directory_groups_attributes: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + directory_id: + type: string + format: uuid + group_label: + type: string + format: text + 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 \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/NotificationAction.yaml b/nerm/schemas/POST/WorkflowActions/NotificationAction.yaml new file mode 100644 index 0000000..2e34d45 --- /dev/null +++ b/nerm/schemas/POST/WorkflowActions/NotificationAction.yaml @@ -0,0 +1,49 @@ +type: object +properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Send a notification to a group of users. + email_attribute_id: + type: string + format: uuid + required: false + description: The attribute storing the email address for the workflow action. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + email_addresses: + type: array + required: false + items: + type: string + format: text + description: The email addresses for the workflow action. + example: ["johndoe@gmail.com", "janedoe@gmail.com"] + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + workflow_action_email_attributes: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + workflow_action_id: + type: string + format: uuid + email_id: + type: string + format: uuid + type: + type: string + enum: [StandardEmail] + example: StandardEmail \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/PasswordResetAction.yaml b/nerm/schemas/POST/WorkflowActions/PasswordResetAction.yaml new file mode 100644 index 0000000..42d1591 --- /dev/null +++ b/nerm/schemas/POST/WorkflowActions/PasswordResetAction.yaml @@ -0,0 +1,17 @@ +type: object +properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Prompt the user to reset their password. + archived: + type: boolean + default: false + description: If the workflow action is archived or not. \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/ProfileCheckAction.yaml b/nerm/schemas/POST/WorkflowActions/ProfileCheckAction.yaml new file mode 100644 index 0000000..cb8a03c --- /dev/null +++ b/nerm/schemas/POST/WorkflowActions/ProfileCheckAction.yaml @@ -0,0 +1,33 @@ +type: object +properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Finds a profile based on selected attributes and values found in the session. + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + ne_attribute_ids: + type: array + required: false + description: An array of ne_attribute_ids. + example: ["33f072dd-13b4-41e1-8ea0-16f2a59b57c8"] + handle_type: + type: string + required: false + enum: [session, attribute] + description: The handle type for what should happen if an existing profile is found. + example: session + handle_id: + type: string + required: false + description: The handle id. When handle type is session, this is the session id. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/ProfileSelectAction.yaml b/nerm/schemas/POST/WorkflowActions/ProfileSelectAction.yaml new file mode 100644 index 0000000..9bd0136 --- /dev/null +++ b/nerm/schemas/POST/WorkflowActions/ProfileSelectAction.yaml @@ -0,0 +1,17 @@ +type: object +properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Select the profiles that you want to run this workflow for. + archived: + type: boolean + default: false + description: If the workflow action is archived or not. \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/RequestAction.yaml b/nerm/schemas/POST/WorkflowActions/RequestAction.yaml new file mode 100644 index 0000000..f311ccf --- /dev/null +++ b/nerm/schemas/POST/WorkflowActions/RequestAction.yaml @@ -0,0 +1,27 @@ +type: object +properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Provides the requester a page with forms. + page_id: + type: string + format: uuid + required: false + description: The page the workflow action should render. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + requires_comment: + type: boolean + default: false + description: If the workflow action requires a comment or not. \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/RestApiAction.yaml b/nerm/schemas/POST/WorkflowActions/RestApiAction.yaml new file mode 100644 index 0000000..5b857f1 --- /dev/null +++ b/nerm/schemas/POST/WorkflowActions/RestApiAction.yaml @@ -0,0 +1,17 @@ +type: object +properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Makes a request to a Restful API. + archived: + type: boolean + default: false + description: If the workflow action is archived or not. \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/ReviewAction.yaml b/nerm/schemas/POST/WorkflowActions/ReviewAction.yaml new file mode 100644 index 0000000..109a831 --- /dev/null +++ b/nerm/schemas/POST/WorkflowActions/ReviewAction.yaml @@ -0,0 +1,27 @@ +type: object +properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Allows the requester to review. + page_id: + type: string + format: uuid + required: false + description: The page the workflow action should render. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + requires_comment: + type: boolean + default: false + description: If the workflow action requires a comment or not. diff --git a/nerm/schemas/POST/WorkflowActions/RunWorkflowAction.yaml b/nerm/schemas/POST/WorkflowActions/RunWorkflowAction.yaml new file mode 100644 index 0000000..b2f0373 --- /dev/null +++ b/nerm/schemas/POST/WorkflowActions/RunWorkflowAction.yaml @@ -0,0 +1,47 @@ +type: object +properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Runs another workflow with the ability to pass data in between. + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + configuration_attributes: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + workflow_id: + type: string + format: uuid + wait_for_completion: + type: boolean + example: false + profile_to_send: + type: string + enum: [none, current, attribute, profile_type] + example: current + return_profile: + type: boolean + example: false + run_workflow_action_id: + type: string + format: uuid + email_attribute_id: + type: string + format: uuid + profile_type_id: + type: string + format: uuid \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/SetAttributesAction.yaml b/nerm/schemas/POST/WorkflowActions/SetAttributesAction.yaml new file mode 100644 index 0000000..a95b76b --- /dev/null +++ b/nerm/schemas/POST/WorkflowActions/SetAttributesAction.yaml @@ -0,0 +1,17 @@ +type: object +properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Set attribute(s) to a specific value. + archived: + type: boolean + default: false + description: If the workflow action is archived or not. \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/SetSecurityQuestionAction.yaml b/nerm/schemas/POST/WorkflowActions/SetSecurityQuestionAction.yaml new file mode 100644 index 0000000..2265000 --- /dev/null +++ b/nerm/schemas/POST/WorkflowActions/SetSecurityQuestionAction.yaml @@ -0,0 +1,22 @@ +type: object +properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Prompt the user to provide some personal security questions and answers. + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + number_of_questions: + type: integer + required: true + description: The number of questions the user should answer upon login. + example: 1 \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/SoapApiAction.yaml b/nerm/schemas/POST/WorkflowActions/SoapApiAction.yaml new file mode 100644 index 0000000..c32e9ed --- /dev/null +++ b/nerm/schemas/POST/WorkflowActions/SoapApiAction.yaml @@ -0,0 +1,17 @@ +type: object +properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Makes a request to a SOAP API. + archived: + type: boolean + default: false + description: If the workflow action is archived or not. \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/StatusChangeAction.yaml b/nerm/schemas/POST/WorkflowActions/StatusChangeAction.yaml new file mode 100644 index 0000000..e5aaced --- /dev/null +++ b/nerm/schemas/POST/WorkflowActions/StatusChangeAction.yaml @@ -0,0 +1,24 @@ +type: object +properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Changes the status of a non-employee. + new_status: + type: string + format: text + required: false + enum: [Active, Inactive, On Leave, Terminated] + description: The new status for the Status Change workflow action. + example: Active + archived: + type: boolean + default: false + description: If the workflow action is archived or not. \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/UnassignAction.yaml b/nerm/schemas/POST/WorkflowActions/UnassignAction.yaml new file mode 100644 index 0000000..c19b0ae --- /dev/null +++ b/nerm/schemas/POST/WorkflowActions/UnassignAction.yaml @@ -0,0 +1,17 @@ +type: object +properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Un-assigns roles from a profile. + archived: + type: boolean + default: false + description: If the workflow action is archived or not. \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/UpdateProfileAction.yaml b/nerm/schemas/POST/WorkflowActions/UpdateProfileAction.yaml new file mode 100644 index 0000000..a7a8c7a --- /dev/null +++ b/nerm/schemas/POST/WorkflowActions/UpdateProfileAction.yaml @@ -0,0 +1,17 @@ +type: object +properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Updates a profile with all attributes collected during the workflow. + archived: + type: boolean + default: false + description: If the workflow action is archived or not. \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/UsernamePasswordAction.yaml b/nerm/schemas/POST/WorkflowActions/UsernamePasswordAction.yaml new file mode 100644 index 0000000..f09f1ad --- /dev/null +++ b/nerm/schemas/POST/WorkflowActions/UsernamePasswordAction.yaml @@ -0,0 +1,17 @@ +type: object +properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Prompt the user for their username and password. + archived: + type: boolean + default: false + description: If the workflow action is archived or not. \ No newline at end of file From 586d1573be7e3ea2943c3adf81750d56dfcc7271 Mon Sep 17 00:00:00 2001 From: ktorre22 Date: Wed, 23 Aug 2023 15:05:25 -0400 Subject: [PATCH 2/2] NEROCKET-73 linting fixes --- .../ask_security_question_action.yaml | 2 +- nerm/paths/workflow_actions/ldap_action.yaml | 2 +- .../set_security_question_action.yaml | 2 +- nerm/schemas/GET/WorkflowAction.yaml | 6 +++- .../POST/WorkflowActions/ApprovalAction.yaml | 5 +++- .../AskSecurityQuestionAction.yaml | 5 +++- .../WorkflowActions/AutoAssignAction.yaml | 4 ++- .../WorkflowActions/BatchUpdateAction.yaml | 3 +- .../WorkflowActions/CloseSessionAction.yaml | 3 +- .../WorkflowActions/ContributorsAction.yaml | 3 +- .../WorkflowActions/CreateProfileAction.yaml | 4 ++- .../DuplicatePreventionAction.yaml | 3 +- .../EmailVerificationAction.yaml | 3 ++ .../WorkflowActions/FulfillmentAction.yaml | 4 ++- .../IdentityProofingAction.yaml | 3 +- .../WorkflowActions/InvitationAction.yaml | 24 ++++++++++++++++ .../POST/WorkflowActions/LdapAction.yaml | 28 ++++++++++++++++--- .../WorkflowActions/NotificationAction.yaml | 10 ++++++- .../WorkflowActions/PasswordResetAction.yaml | 3 +- .../WorkflowActions/ProfileCheckAction.yaml | 1 + .../WorkflowActions/ProfileSelectAction.yaml | 3 +- .../POST/WorkflowActions/RequestAction.yaml | 4 ++- .../POST/WorkflowActions/RestApiAction.yaml | 3 +- .../POST/WorkflowActions/ReviewAction.yaml | 2 ++ .../WorkflowActions/RunWorkflowAction.yaml | 16 ++++++++++- .../WorkflowActions/SetAttributesAction.yaml | 3 +- .../SetSecurityQuestionAction.yaml | 2 ++ .../POST/WorkflowActions/SoapApiAction.yaml | 3 +- .../WorkflowActions/StatusChangeAction.yaml | 3 +- .../POST/WorkflowActions/UnassignAction.yaml | 3 +- .../WorkflowActions/UpdateProfileAction.yaml | 3 +- .../UsernamePasswordAction.yaml | 3 +- 32 files changed, 136 insertions(+), 30 deletions(-) diff --git a/nerm/paths/workflow_actions/ask_security_question_action.yaml b/nerm/paths/workflow_actions/ask_security_question_action.yaml index 551e3bf..442fe5d 100644 --- a/nerm/paths/workflow_actions/ask_security_question_action.yaml +++ b/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: diff --git a/nerm/paths/workflow_actions/ldap_action.yaml b/nerm/paths/workflow_actions/ldap_action.yaml index 220f90d..e4c1063 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 + 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: diff --git a/nerm/paths/workflow_actions/set_security_question_action.yaml b/nerm/paths/workflow_actions/set_security_question_action.yaml index efd6a7c..396e41b 100644 --- a/nerm/paths/workflow_actions/set_security_question_action.yaml +++ b/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: diff --git a/nerm/schemas/GET/WorkflowAction.yaml b/nerm/schemas/GET/WorkflowAction.yaml index c7ae0e6..674b653 100644 --- a/nerm/schemas/GET/WorkflowAction.yaml +++ b/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. \ No newline at end of file + description: If the workflow action requires a comment or not. + example: false \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/ApprovalAction.yaml b/nerm/schemas/POST/WorkflowActions/ApprovalAction.yaml index 62bcf3e..bfef9b5 100644 --- a/nerm/schemas/POST/WorkflowActions/ApprovalAction.yaml +++ b/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. \ No newline at end of file + description: If the workflow action requires a comment or not. + example: false \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/AskSecurityQuestionAction.yaml b/nerm/schemas/POST/WorkflowActions/AskSecurityQuestionAction.yaml index 3396b7c..18879e8 100644 --- a/nerm/schemas/POST/WorkflowActions/AskSecurityQuestionAction.yaml +++ b/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. \ No newline at end of file + description: If the workflow action is archived or not. + example: false \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/AutoAssignAction.yaml b/nerm/schemas/POST/WorkflowActions/AutoAssignAction.yaml index 4f80baa..02bd543 100644 --- a/nerm/schemas/POST/WorkflowActions/AutoAssignAction.yaml +++ b/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. \ No newline at end of file + 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 \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/BatchUpdateAction.yaml b/nerm/schemas/POST/WorkflowActions/BatchUpdateAction.yaml index 0cb12c8..cb90fd7 100644 --- a/nerm/schemas/POST/WorkflowActions/BatchUpdateAction.yaml +++ b/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. \ No newline at end of file + description: If the workflow action is archived or not. + example: false \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/CloseSessionAction.yaml b/nerm/schemas/POST/WorkflowActions/CloseSessionAction.yaml index 9320757..268493f 100644 --- a/nerm/schemas/POST/WorkflowActions/CloseSessionAction.yaml +++ b/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. \ No newline at end of file + description: If the workflow action is archived or not. + example: false \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/ContributorsAction.yaml b/nerm/schemas/POST/WorkflowActions/ContributorsAction.yaml index fccdbf3..e9885d4 100644 --- a/nerm/schemas/POST/WorkflowActions/ContributorsAction.yaml +++ b/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. \ No newline at end of file + description: If the workflow action is archived or not. + example: false \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/CreateProfileAction.yaml b/nerm/schemas/POST/WorkflowActions/CreateProfileAction.yaml index ae56ca8..16e8650 100644 --- a/nerm/schemas/POST/WorkflowActions/CreateProfileAction.yaml +++ b/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. \ No newline at end of file + description: If the workflow action is archived or not. + example: false \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/DuplicatePreventionAction.yaml b/nerm/schemas/POST/WorkflowActions/DuplicatePreventionAction.yaml index 1a9fdee..4a99771 100644 --- a/nerm/schemas/POST/WorkflowActions/DuplicatePreventionAction.yaml +++ b/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. \ No newline at end of file + description: If the workflow action is archived or not. + example: false \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/EmailVerificationAction.yaml b/nerm/schemas/POST/WorkflowActions/EmailVerificationAction.yaml index a06640d..d1a3f4a 100644 --- a/nerm/schemas/POST/WorkflowActions/EmailVerificationAction.yaml +++ b/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 diff --git a/nerm/schemas/POST/WorkflowActions/FulfillmentAction.yaml b/nerm/schemas/POST/WorkflowActions/FulfillmentAction.yaml index 8a13f2e..76af727 100644 --- a/nerm/schemas/POST/WorkflowActions/FulfillmentAction.yaml +++ b/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. \ No newline at end of file + description: If the workflow action requires a comment or not. + example: false \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/IdentityProofingAction.yaml b/nerm/schemas/POST/WorkflowActions/IdentityProofingAction.yaml index 488e5f4..8c225ef 100644 --- a/nerm/schemas/POST/WorkflowActions/IdentityProofingAction.yaml +++ b/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. \ No newline at end of file + description: If the workflow action is archived or not. + example: false \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/InvitationAction.yaml b/nerm/schemas/POST/WorkflowActions/InvitationAction.yaml index 8cf4cf1..18d7b3e 100644 --- a/nerm/schemas/POST/WorkflowActions/InvitationAction.yaml +++ b/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 \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/LdapAction.yaml b/nerm/schemas/POST/WorkflowActions/LdapAction.yaml index da1e1cc..5c81c02 100644 --- a/nerm/schemas/POST/WorkflowActions/LdapAction.yaml +++ b/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 \ No newline at end of file + 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 2e34d45..b7e2b4b 100644 --- a/nerm/schemas/POST/WorkflowActions/NotificationAction.yaml +++ b/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 \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/PasswordResetAction.yaml b/nerm/schemas/POST/WorkflowActions/PasswordResetAction.yaml index 42d1591..dd20f99 100644 --- a/nerm/schemas/POST/WorkflowActions/PasswordResetAction.yaml +++ b/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. \ No newline at end of file + description: If the workflow action is archived or not. + example: false \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/ProfileCheckAction.yaml b/nerm/schemas/POST/WorkflowActions/ProfileCheckAction.yaml index cb8a03c..b9e032c 100644 --- a/nerm/schemas/POST/WorkflowActions/ProfileCheckAction.yaml +++ b/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 diff --git a/nerm/schemas/POST/WorkflowActions/ProfileSelectAction.yaml b/nerm/schemas/POST/WorkflowActions/ProfileSelectAction.yaml index 9bd0136..8ac767c 100644 --- a/nerm/schemas/POST/WorkflowActions/ProfileSelectAction.yaml +++ b/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. \ No newline at end of file + description: If the workflow action is archived or not. + example: false \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/RequestAction.yaml b/nerm/schemas/POST/WorkflowActions/RequestAction.yaml index f311ccf..ffca3f8 100644 --- a/nerm/schemas/POST/WorkflowActions/RequestAction.yaml +++ b/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. \ No newline at end of file + description: If the workflow action requires a comment or not. + example: false \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/RestApiAction.yaml b/nerm/schemas/POST/WorkflowActions/RestApiAction.yaml index 5b857f1..4d1f46c 100644 --- a/nerm/schemas/POST/WorkflowActions/RestApiAction.yaml +++ b/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. \ No newline at end of file + description: If the workflow action is archived or not. + example: false \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/ReviewAction.yaml b/nerm/schemas/POST/WorkflowActions/ReviewAction.yaml index 109a831..4b50ce2 100644 --- a/nerm/schemas/POST/WorkflowActions/ReviewAction.yaml +++ b/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 diff --git a/nerm/schemas/POST/WorkflowActions/RunWorkflowAction.yaml b/nerm/schemas/POST/WorkflowActions/RunWorkflowAction.yaml index b2f0373..7ea59ff 100644 --- a/nerm/schemas/POST/WorkflowActions/RunWorkflowAction.yaml +++ b/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 \ No newline at end of file + format: uuid + description: the id of the profile type. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/SetAttributesAction.yaml b/nerm/schemas/POST/WorkflowActions/SetAttributesAction.yaml index a95b76b..645ecfe 100644 --- a/nerm/schemas/POST/WorkflowActions/SetAttributesAction.yaml +++ b/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. \ No newline at end of file + description: If the workflow action is archived or not. + example: false \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/SetSecurityQuestionAction.yaml b/nerm/schemas/POST/WorkflowActions/SetSecurityQuestionAction.yaml index 2265000..0f49825 100644 --- a/nerm/schemas/POST/WorkflowActions/SetSecurityQuestionAction.yaml +++ b/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 \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/SoapApiAction.yaml b/nerm/schemas/POST/WorkflowActions/SoapApiAction.yaml index c32e9ed..868e221 100644 --- a/nerm/schemas/POST/WorkflowActions/SoapApiAction.yaml +++ b/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. \ No newline at end of file + description: If the workflow action is archived or not. + example: false \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/StatusChangeAction.yaml b/nerm/schemas/POST/WorkflowActions/StatusChangeAction.yaml index e5aaced..c055ab4 100644 --- a/nerm/schemas/POST/WorkflowActions/StatusChangeAction.yaml +++ b/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. \ No newline at end of file + description: If the workflow action is archived or not. + example: false \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/UnassignAction.yaml b/nerm/schemas/POST/WorkflowActions/UnassignAction.yaml index c19b0ae..02c9be5 100644 --- a/nerm/schemas/POST/WorkflowActions/UnassignAction.yaml +++ b/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. \ No newline at end of file + description: If the workflow action is archived or not. + example: false \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/UpdateProfileAction.yaml b/nerm/schemas/POST/WorkflowActions/UpdateProfileAction.yaml index a7a8c7a..f7cb094 100644 --- a/nerm/schemas/POST/WorkflowActions/UpdateProfileAction.yaml +++ b/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. \ No newline at end of file + description: If the workflow action is archived or not. + example: false \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowActions/UsernamePasswordAction.yaml b/nerm/schemas/POST/WorkflowActions/UsernamePasswordAction.yaml index f09f1ad..e82d97f 100644 --- a/nerm/schemas/POST/WorkflowActions/UsernamePasswordAction.yaml +++ b/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. \ No newline at end of file + description: If the workflow action is archived or not. + example: false \ No newline at end of file