diff --git a/nerm/parameters/query/exclude_attributes.yaml b/nerm/parameters/query/exclude_attributes.yaml index 7d93aa0a..a033bb09 100644 --- a/nerm/parameters/query/exclude_attributes.yaml +++ b/nerm/parameters/query/exclude_attributes.yaml @@ -4,4 +4,6 @@ description: Allows for optimization by not returning the associated attribute d required: false schema: type: boolean - default: false \ No newline at end of file + default: false + example: false + \ No newline at end of file diff --git a/nerm/parameters/query/name.yaml b/nerm/parameters/query/name.yaml index 140b4efa..b70b4d71 100644 --- a/nerm/parameters/query/name.yaml +++ b/nerm/parameters/query/name.yaml @@ -3,4 +3,6 @@ in: query description: object name for filtering required: false schema: - type: string \ No newline at end of file + type: string + example: name + \ No newline at end of file diff --git a/nerm/parameters/query/profile_type_id.yaml b/nerm/parameters/query/profile_type_id.yaml index 65075491..f4454b36 100644 --- a/nerm/parameters/query/profile_type_id.yaml +++ b/nerm/parameters/query/profile_type_id.yaml @@ -4,4 +4,6 @@ description: Profile Type ID for filtering required: false schema: type: string - format: uuid \ No newline at end of file + format: uuid + example: 79ed1cb6-9977-4965-9bfe-f2bcc242523e + \ No newline at end of file diff --git a/nerm/parameters/query/status.yaml b/nerm/parameters/query/status.yaml index f02190b7..bc29d15b 100644 --- a/nerm/parameters/query/status.yaml +++ b/nerm/parameters/query/status.yaml @@ -4,4 +4,6 @@ description: status value for filtering required: false schema: type: string - enum: [Active, Inactive, On Leave, Terminated] \ No newline at end of file + enum: [Active, Inactive, On Leave, Terminated] + example: Active + \ No newline at end of file diff --git a/nerm/paths/profiles.yaml b/nerm/paths/profiles.yaml index e9e06c16..9b872801 100644 --- a/nerm/paths/profiles.yaml +++ b/nerm/paths/profiles.yaml @@ -20,7 +20,7 @@ get: $ref: "../responses/500.yaml" post: summary: Create multiple profiles - operationId: postProfiles + operationId: createProfiles description: Create multiple profiles tags: - profiles @@ -28,7 +28,7 @@ post: $ref: "../requestBodies/POST/Profiles.yaml" responses: '200': - $ref: "../responses/ProfilesJob.yaml" + $ref: "../responses/Profiles.yaml" '400': $ref: "../responses/400.yaml" '500': @@ -43,7 +43,7 @@ patch: $ref: "../requestBodies/PATCH/Profiles.yaml" responses: '200': - $ref: "../responses/ProfilesJob.yaml" + $ref: "../responses/Profiles.yaml" '400': $ref: "../responses/400.yaml" '500': diff --git a/nerm/schemas/GET/Profile.yaml b/nerm/schemas/GET/Profile.yaml index 111460b7..58a9ddef 100644 --- a/nerm/schemas/GET/Profile.yaml +++ b/nerm/schemas/GET/Profile.yaml @@ -51,6 +51,17 @@ properties: text_attribute_uid: static text date_attribute_uid: 01/15/2020 profile_select_attribute_uid: Profile Name + profile_search_attribute_uid: Profile Name + multiple_profile_search_attribute_uid: Profile Name,Second Profile Name,Third Profile Name multiple_profile_select_attribute_uid: Profile Name,Second Profile Name,Third Profile Name - contributor_select_attribute_uid: User Name - multiple_contributor_select_attribute_uid: User Name,Second User Name,Third User Name \ No newline at end of file + contributor_select_attribute_uid: User Name (user_email@test.com) + contributor_search_attribute_uid: User Name (user_email@test.com) + multiple_contributor_search_attribute_uid: User Name (user_email@test.com),Second User Name (user_email@test.com),Third User Name (user_email@test.com) + owner_select_attribute_uid: User Name (user_email@test.com) + owner_search_attribute_uid: User Name (user_email@test.com) + dropdown_attribute_uid: yes, no + tags_attribute_uid: yes, no + checkbox_attribute_uid: yes, no + text_area_uid: static text + radio_attribute_uid: yes, no + \ No newline at end of file diff --git a/nerm/schemas/GET/WorkflowSession.yaml b/nerm/schemas/GET/WorkflowSession.yaml index 786dcef1..4b51b822 100644 --- a/nerm/schemas/GET/WorkflowSession.yaml +++ b/nerm/schemas/GET/WorkflowSession.yaml @@ -4,42 +4,67 @@ properties: type: string format: uuid readOnly: true + description: The objects ID. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 uid: type: string minLength: 32 maxLength: 32 readOnly: true + description: The objects UID. + example: wsUid workflow_id: type: string format: uuid + description: The workflow id. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 requester_id: type: string format: uuid + description: The requester's id. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 requester_type: type: string enum: [User, NeprofileUser, NeaccessUser] + description: The requester type. + example: User profile_id: type: string format: uuid + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 description: The profile this workflow session will be working with. Only Applicable for Update workflows profile_ids: type: array items: type: string format: uuid + example: 59ed1cb6-9977-4965-9bfe-f2bcc242523e, 89ed1cb6-9977-4965-9bfe-f2bcc242523e description: The profiles this workflow session will be working with. Only Applicable for Batch workflows status: type: string enum: [api_request_sent, approved, assigned, attempting_to_start_workflow, AUTH-STATUS1, AUTH-STATUS2, AUTH-STATUS3, AUTH-STATUS4, AUTH-STATUS5, AUTH-STATUS6, AUTH-STATUS7, AUTH-STATUS8, AUTH-STATUS9, auto_assigned, batch_completed, checking_for_duplicates, closed, completed, courion_add, courion_extend, courion_terminate, courion_update, duplicates_resolved, failed, fulfilled, invitation_sent, ldap_provided, new, non_employee_created, non_employee_updated, notified, pending_approval, pending_assignment, pending_courion_add, pending_courion_extend, pending_courion_terminate, pending_courion_update, pending_creation, pending_fulfillment, pending_ldap, pending_notification, pending_profile_select, pending_request, pending_review, pending_status_change, pending_stored_procedure, pending_trigger, pending_update, processing, profile_check_complete, profiles_selected, rejected, requested, reviewed, soap_request_sent, started_workflow, status_changed, stored_procedure, un_assigned, waiting_on_workflow, workflow_changed] example: completed + description: The status of the workflow session. attributes: type: object additionalProperties: type: string + description: The attributes asscoiated with the workflow session. example: text_attribute_uid: static text date_attribute_uid: 01/15/2020 profile_select_attribute_uid: Profile Name + profile_search_attribute_uid: Profile Name + multiple_profile_search_attribute_uid: Profile Name,Second Profile Name,Third Profile Name multiple_profile_select_attribute_uid: Profile Name,Second Profile Name,Third Profile Name - contributor_select_attribute_uid: User Name - multiple_contributor_select_attribute_uid: User Name,Second User Name,Third User Name \ No newline at end of file + contributor_select_attribute_uid: User Name (user_email@test.com) + contributor_search_attribute_uid: User Name (user_email@test.com) + multiple_contributor_search_attribute_uid: User Name (user_email@test.com),Second User Name (user_email@test.com),Third User Name (user_email@test.com) + owner_select_attribute_uid: User Name (user_email@test.com) + owner_search_attribute_uid: User Name (user_email@test.com) + dropdown_attribute_uid: yes, no + tags_attribute_uid: yes, no + checkbox_attribute_uid: yes, no + text_area_uid: static text + radio_attribute_uid: yes, no + \ No newline at end of file diff --git a/nerm/schemas/PATCH/Profile.yaml b/nerm/schemas/PATCH/Profile.yaml index 0a4c5f64..ff248182 100644 --- a/nerm/schemas/PATCH/Profile.yaml +++ b/nerm/schemas/PATCH/Profile.yaml @@ -2,26 +2,48 @@ type: object properties: name: type: string + description: The profile name. + example: First Last profile_type_id: type: string format: uuid + description: The profile type id. + example: 79ed1cb6-9977-4965-9bfe-f2bcc2424444 status: type: string enum: [Active, Inactive, On Leave, Terminated] + description: The profile status. + example: Active id_proofing_status: type: string enum: [pending, pass, fail] + description: The id proofing status of the profile. + example: pass archived: type: boolean default: false + description: Describes whether the profile is archived or not. + example: false attributes: type: object + description: The attributes associated with the profile. additionalProperties: type: string example: text_attribute_uid: static text date_attribute_uid: 01/15/2020 - profile_select_attribute_uid: Profile Name - multiple_profile_select_attribute_uid: Profile Name,Second Profile Name,Third Profile Name - contributor_select_attribute_uid: User Name - multiple_contributor_select_attribute_uid: User Name,Second User Name,Third User Name \ No newline at end of file + profile_select_attribute_uid: 79ed1cb6-9977-4965-9bfe-f2bcc242523e + multiple_profile_select_attribute_uid: 59ed1cb6-9977-4965-9bfe-f2bcc242523e, 89ed1cb6-9977-4965-9bfe-f2bcc242523e + profile_search_attribute_uid: 79ed1cb6-9977-4965-9bfe-f2bcc242523e + multiple_profile_search_attribute_uid: 59ed1cb6-9977-4965-9bfe-f2bcc242523e, 89ed1cb6-9977-4965-9bfe-f2bcc242523e + contributor_select_attribute_uid: 49ed1cb6-9977-4965-9bfe-f2bcc2425244 + contributor_search_attribute_uid: 49ed1cb6-9977-4965-9bfe-f2bcc2425244 + multiple_contributor_search_attribute_uid: 59ed1cb6-9977-4965-9bfe-f2bcc242523e, 89ed1cb6-9977-4965-9bfe-f2bcc242523e + owner_select_attribute_uid: 79ed1cb6-9977-4965-9bfe-f2bcc242523e + owner_search_attribute_uid: 79ed1cb6-9977-4965-9bfe-f2bcc242523e + dropdown_attribute_uid: yes, no + tags_attribute_uid: yes, no + checkbox_attribute_uid: yes, no + text_area_uid: static text + radio_attribute_uid: yes, no + \ No newline at end of file diff --git a/nerm/schemas/PATCH/Profiles.yaml b/nerm/schemas/PATCH/Profiles.yaml index caab35a5..6272d41b 100644 --- a/nerm/schemas/PATCH/Profiles.yaml +++ b/nerm/schemas/PATCH/Profiles.yaml @@ -3,28 +3,52 @@ properties: id: type: string format: uuid + description: The profile ID. + example: 79ed1cb6-8888-4965-9bfe-f2bcc242523e name: type: string + description: The profile name. + example: First Last profile_type_id: type: string format: uuid + description: The profile type id. + example: 79ed1cb6-9977-4965-9bfe-f2bcc2424444 status: type: string enum: [Active, Inactive, On Leave, Terminated] + description: The profile status. + example: Active id_proofing_status: type: string enum: [pending, pass, fail] + description: The id proofing status of the profile. + example: pass archived: type: boolean default: false + description: Describes whether the profile is archived or not. + example: false attributes: type: object additionalProperties: type: string + description: The attributes associated with the profile. example: text_attribute_uid: static text date_attribute_uid: 01/15/2020 - profile_select_attribute_uid: Profile Name - multiple_profile_select_attribute_uid: Profile Name,Second Profile Name,Third Profile Name - contributor_select_attribute_uid: User Name - multiple_contributor_select_attribute_uid: User Name,Second User Name,Third User Name \ No newline at end of file + profile_select_attribute_uid: 79ed1cb6-9977-4965-9bfe-f2bcc242523e + multiple_profile_select_attribute_uid: 59ed1cb6-9977-4965-9bfe-f2bcc242523e, 89ed1cb6-9977-4965-9bfe-f2bcc242523e + profile_search_attribute_uid: 79ed1cb6-9977-4965-9bfe-f2bcc242523e + multiple_profile_search_attribute_uid: 59ed1cb6-9977-4965-9bfe-f2bcc242523e, 89ed1cb6-9977-4965-9bfe-f2bcc242523e + contributor_select_attribute_uid: 49ed1cb6-9977-4965-9bfe-f2bcc2425244 + contributor_search_attribute_uid: 49ed1cb6-9977-4965-9bfe-f2bcc2425244 + multiple_contributor_search_attribute_uid: 59ed1cb6-9977-4965-9bfe-f2bcc242523e, 89ed1cb6-9977-4965-9bfe-f2bcc242523e + owner_select_attribute_uid: 79ed1cb6-9977-4965-9bfe-f2bcc242523e + owner_search_attribute_uid: 79ed1cb6-9977-4965-9bfe-f2bcc242523e + dropdown_attribute_uid: yes, no + tags_attribute_uid: yes, no + checkbox_attribute_uid: yes, no + text_area_uid: static text + radio_attribute_uid: yes, no + \ No newline at end of file diff --git a/nerm/schemas/PATCH/WorkflowSession.yaml b/nerm/schemas/PATCH/WorkflowSession.yaml index 90d9fad7..7f636c00 100644 --- a/nerm/schemas/PATCH/WorkflowSession.yaml +++ b/nerm/schemas/PATCH/WorkflowSession.yaml @@ -3,34 +3,55 @@ properties: workflow_id: type: string format: uuid + description: The workflow id. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 requester_id: type: string format: uuid + description: The requester's id. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 requester_type: type: string enum: [User, NeprofileUser, NeaccessUser] + description: The requester type. + example: User profile_id: type: string format: uuid description: The profile this workflow session will be working with. Only Applicable for Update workflows + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 profile_ids: type: array items: type: string format: uuid description: The profiles this workflow session will be working with. Only Applicable for Batch workflows + example: 59ed1cb6-9977-4965-9bfe-f2bcc242523e, 89ed1cb6-9977-4965-9bfe-f2bcc242523e status: type: string enum: [api_request_sent, approved, assigned, attempting_to_start_workflow, AUTH-STATUS1, AUTH-STATUS2, AUTH-STATUS3, AUTH-STATUS4, AUTH-STATUS5, AUTH-STATUS6, AUTH-STATUS7, AUTH-STATUS8, AUTH-STATUS9, auto_assigned, batch_completed, checking_for_duplicates, closed, completed, courion_add, courion_extend, courion_terminate, courion_update, duplicates_resolved, failed, fulfilled, invitation_sent, ldap_provided, new, non_employee_created, non_employee_updated, notified, pending_approval, pending_assignment, pending_courion_add, pending_courion_extend, pending_courion_terminate, pending_courion_update, pending_creation, pending_fulfillment, pending_ldap, pending_notification, pending_profile_select, pending_request, pending_review, pending_status_change, pending_stored_procedure, pending_trigger, pending_update, processing, profile_check_complete, profiles_selected, rejected, requested, reviewed, soap_request_sent, started_workflow, status_changed, stored_procedure, un_assigned, waiting_on_workflow, workflow_changed] example: completed + description: The status of the workflow session. attributes: type: object additionalProperties: type: string + description: The attributes asscoiated with the workflow session. example: text_attribute_uid: static text date_attribute_uid: 01/15/2020 - profile_select_attribute_uid: Profile Name - multiple_profile_select_attribute_uid: Profile Name,Second Profile Name,Third Profile Name - contributor_select_attribute_uid: User Name - multiple_contributor_select_attribute_uid: User Name,Second User Name,Third User Name \ No newline at end of file + profile_select_attribute_uid: 79ed1cb6-9977-4965-9bfe-f2bcc242523e + multiple_profile_select_attribute_uid: 59ed1cb6-9977-4965-9bfe-f2bcc242523e, 89ed1cb6-9977-4965-9bfe-f2bcc242523e + profile_search_attribute_uid: 79ed1cb6-9977-4965-9bfe-f2bcc242523e + multiple_profile_search_attribute_uid: 59ed1cb6-9977-4965-9bfe-f2bcc242523e, 89ed1cb6-9977-4965-9bfe-f2bcc242523e + contributor_select_attribute_uid: 49ed1cb6-9977-4965-9bfe-f2bcc2425244 + contributor_search_attribute_uid: 49ed1cb6-9977-4965-9bfe-f2bcc2425244 + multiple_contributor_search_attribute_uid: 59ed1cb6-9977-4965-9bfe-f2bcc242523e, 89ed1cb6-9977-4965-9bfe-f2bcc242523e + owner_select_attribute_uid: 79ed1cb6-9977-4965-9bfe-f2bcc242523e + owner_search_attribute_uid: 79ed1cb6-9977-4965-9bfe-f2bcc242523e + dropdown_attribute_uid: yes, no + tags_attribute_uid: yes, no + checkbox_attribute_uid: yes, no + text_area_uid: static text + radio_attribute_uid: yes, no + \ No newline at end of file diff --git a/nerm/schemas/POST/Profile.yaml b/nerm/schemas/POST/Profile.yaml index d54aa6cd..3e49f56c 100644 --- a/nerm/schemas/POST/Profile.yaml +++ b/nerm/schemas/POST/Profile.yaml @@ -2,28 +2,50 @@ type: object properties: name: type: string + description: The profile name. + example: First Last profile_type_id: type: string format: uuid required: true + description: The profile type id. + example: 79ed1cb6-9977-4965-9bfe-f2bcc2424444 status: type: string enum: [Active, Inactive, On Leave, Terminated] required: true + description: The profile status. + example: Active id_proofing_status: type: string enum: [pending, pass, fail] + description: The id proofing status of the profile. + example: pass archived: type: boolean default: false + description: Describes whether the profile is archived or not. + example: false attributes: type: object + description: The attributes associated with the profile. additionalProperties: type: string example: text_attribute_uid: static text date_attribute_uid: 01/15/2020 - profile_select_attribute_uid: Profile Name - multiple_profile_select_attribute_uid: Profile Name,Second Profile Name,Third Profile Name - contributor_select_attribute_uid: User Name - multiple_contributor_select_attribute_uid: User Name,Second User Name,Third User Name \ No newline at end of file + profile_select_attribute_uid: 79ed1cb6-9977-4965-9bfe-f2bcc242523e + multiple_profile_select_attribute_uid: 59ed1cb6-9977-4965-9bfe-f2bcc242523e, 89ed1cb6-9977-4965-9bfe-f2bcc242523e + profile_search_attribute_uid: 79ed1cb6-9977-4965-9bfe-f2bcc242523e + multiple_profile_search_attribute_uid: 59ed1cb6-9977-4965-9bfe-f2bcc242523e, 89ed1cb6-9977-4965-9bfe-f2bcc242523e + contributor_select_attribute_uid: 49ed1cb6-9977-4965-9bfe-f2bcc2425244 + contributor_search_attribute_uid: 49ed1cb6-9977-4965-9bfe-f2bcc2425244 + multiple_contributor_search_attribute_uid: 59ed1cb6-9977-4965-9bfe-f2bcc242523e, 89ed1cb6-9977-4965-9bfe-f2bcc242523e + owner_select_attribute_uid: 79ed1cb6-9977-4965-9bfe-f2bcc242523e + owner_search_attribute_uid: 79ed1cb6-9977-4965-9bfe-f2bcc242523e + dropdown_attribute_uid: yes, no + tags_attribute_uid: yes, no + checkbox_attribute_uid: yes, no + text_area_uid: static text + radio_attribute_uid: yes, no + \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowSession.yaml b/nerm/schemas/POST/WorkflowSession.yaml index 016cfc45..5a7b7e8d 100644 --- a/nerm/schemas/POST/WorkflowSession.yaml +++ b/nerm/schemas/POST/WorkflowSession.yaml @@ -4,32 +4,52 @@ properties: type: string format: uuid required: true + description: The workflow id. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 requester_id: type: string format: uuid required: true + description: The requester's id. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 requester_type: type: string enum: [User, NeprofileUser, NeaccessUser] required: true + description: The requester type. + example: User profile_id: type: string format: uuid description: The profile this workflow session will be working with. Only Applicable for Update workflows + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 profile_ids: type: array items: type: string format: uuid + example: 59ed1cb6-9977-4965-9bfe-f2bcc242523e, 89ed1cb6-9977-4965-9bfe-f2bcc242523e description: The profiles this workflow session will be working with. Only Applicable for Batch workflows attributes: type: object + description: The attributes asscoiated with the workflow session. additionalProperties: type: string example: text_attribute_uid: static text date_attribute_uid: 01/15/2020 - profile_select_attribute_uid: Profile Name - multiple_profile_select_attribute_uid: Profile Name,Second Profile Name,Third Profile Name - contributor_select_attribute_uid: User Name - multiple_contributor_select_attribute_uid: User Name,Second User Name,Third User Name \ No newline at end of file + profile_select_attribute_uid: 79ed1cb6-9977-4965-9bfe-f2bcc242523e + multiple_profile_select_attribute_uid: 59ed1cb6-9977-4965-9bfe-f2bcc242523e, 89ed1cb6-9977-4965-9bfe-f2bcc242523e + profile_search_attribute_uid: 79ed1cb6-9977-4965-9bfe-f2bcc242523e + multiple_profile_search_attribute_uid: 59ed1cb6-9977-4965-9bfe-f2bcc242523e, 89ed1cb6-9977-4965-9bfe-f2bcc242523e + contributor_select_attribute_uid: 49ed1cb6-9977-4965-9bfe-f2bcc2425244 + contributor_search_attribute_uid: 49ed1cb6-9977-4965-9bfe-f2bcc2425244 + multiple_contributor_search_attribute_uid: 59ed1cb6-9977-4965-9bfe-f2bcc242523e, 89ed1cb6-9977-4965-9bfe-f2bcc242523e + owner_select_attribute_uid: 79ed1cb6-9977-4965-9bfe-f2bcc242523e + owner_search_attribute_uid: 79ed1cb6-9977-4965-9bfe-f2bcc242523e + dropdown_attribute_uid: yes, no + tags_attribute_uid: yes, no + checkbox_attribute_uid: yes, no + text_area_uid: static text + radio_attribute_uid: yes, no + \ No newline at end of file