diff --git a/nerm/openapi.yaml b/nerm/openapi.yaml new file mode 100644 index 0000000..e024e75 --- /dev/null +++ b/nerm/openapi.yaml @@ -0,0 +1,119 @@ +openapi: "3.0.0" +info: + version: 1.0.0 + title: SecZetta Lifecycle API + description: The Lifecycle API can be used to access and modify various resources in your environment. + license: + name: MIT +paths: +# Users + /user: + $ref: "./paths/user.yaml" + /users: + $ref: "./paths/users.yaml" + /users/{id}: + $ref: "./paths/users_id.yaml" + /users/{id}/avatar: + $ref: "./paths/users_id_avatar.yaml" +# User Manager Relationships + /user_manager: + $ref: "./paths/user_manager.yaml" + /user_managers: + $ref: "./paths/user_managers.yaml" + /user_managers/{id}: + $ref: "./paths/user_managers_id.yaml" +# Roles + /roles: + $ref: "./paths/roles.yaml" + /role: + $ref: "./paths/role.yaml" + /roles/{id}: + $ref: "./paths/roles_id.yaml" +# User Roles + /user_role: + $ref: "./paths/user_role.yaml" + /user_roles: + $ref: "./paths/user_roles.yaml" + /user_roles/{id}: + $ref: "./paths/user_roles_id.yaml" + /user_role/{id}: + $ref: "./paths/user_role_id.yaml" +# Attributes + /ne_attributes: + $ref: "./paths/ne_attributes.yaml" + /ne_attributes/{id}: + $ref: "./paths/ne_attributes_id.yaml" + /ne_attribute_option: + $ref: "./paths/ne_attribute_option.yaml" + /ne_attribute_options: + $ref: "./paths/ne_attribute_options.yaml" + /ne_attribute_options/{id}: + $ref: "./paths/ne_attribute_options_id.yaml" +# Profile Types + /profile_type: + $ref: "./paths/profile_type.yaml" + /profile_types: + $ref: "./paths/profile_types.yaml" + /profile_types/{id}: + $ref: "./paths/profile_types_id.yaml" +# Profiles + /profile: + $ref: "./paths/profile.yaml" + /profiles: + $ref: "./paths/profiles.yaml" + /profiles/{id}: + $ref: "./paths/profiles_id.yaml" + /profiles/{id}/upload/{attribute_id}: + $ref: "./paths/profiles_id_upload_attribute_id.yaml" + /profiles/{id}/avatar: + $ref: "./paths/profiles_id_avatar.yaml" +# Risk Scores + /risk_scores: + $ref: "./paths/risk_scores.yaml" + /risk_scores/{id}: + $ref: "./paths/risk_scores_id.yaml" +# Risk Levels + /risk_levels: + $ref: "./paths/risk_levels.yaml" + /risk_levels/{id}: + $ref: "./paths/risk_levels_id.yaml" +# User Contributor Relationships + /user_profile: + $ref: "./paths/user_profile.yaml" + /user_profiles: + $ref: "./paths/user_profiles.yaml" + /user_profiles/{id}: + $ref: "./paths/user_profiles_id.yaml" + /user_profile/{id}: + $ref: "./paths/user_profile_id.yaml" +# Role Contributor Relationships + /role_profile: + $ref: "./paths/role_profile.yaml" + /role_profiles: + $ref: "./paths/role_profiles.yaml" + /role_profiles/{id}: + $ref: "./paths/role_profiles_id.yaml" + /role_profile/{id}: + $ref: "./paths/role_profile_id.yaml" +# Workflow Sessions + /workflow_sessions: + $ref: "./paths/workflow_sessions.yaml" + /workflow_sessions/{id}: + $ref: "./paths/workflow_sessions_id.yaml" + /workflow_sessions/{id}/upload/{attribute_id}: + $ref: "./paths/workflow_sessions_id_upload_attribute_id.yaml" +# Identity Proofing Results + /identity_proofing_results: + $ref: "./paths/identity_proofing_results.yaml" +# Advanced Search + /advanced_search: + $ref: "./paths/advanced_search.yaml" + /advanced_search/run: + $ref: "./paths/advanced_search_run.yaml" + /advanced_search/{id}: + $ref: "./paths/advanced_search_id.yaml" + /advanced_search/{id}/run: + $ref: "./paths/advanced_search_id_run.yaml" +# Jobs + /job_status: + $ref: "./paths/job_status.yaml" \ No newline at end of file diff --git a/nerm/parameters/_index.yaml b/nerm/parameters/_index.yaml new file mode 100644 index 0000000..3576a3d --- /dev/null +++ b/nerm/parameters/_index.yaml @@ -0,0 +1,60 @@ +# Path +id: + $ref: './path/id.yaml' +attribute_id: + $ref: './path/attribute_id.yaml' +# Query +limit: + $ref: './query/limit.yaml' +offset: + $ref: './query/offset.yaml' +user_id: + $ref: './query/user_id.yaml' +manager_id: + $ref: './query/manager_id.yaml' +role_id: + $ref: './query/role_id.yaml' +label: + $ref: './query/label.yaml' +data_type: + $ref: './query/data_type.yaml' +ne_attribute_id: + $ref: './query/ne_attribute_id.yaml' +option: + $ref: './query/option.yaml' +name: + $ref: './query/name.yaml' +archived: + $ref: './query/archived.yaml' +profile_type_id: + $ref: './query/profile_type_id.yaml' +status: + $ref: './query/status.yaml' +object_id: + $ref: './query/object_id.yaml' +object_type: + $ref: './query/object_type.yaml' +overall_risk_level_id: + $ref: './query/overall_risk_level_id.yaml' +impact_risk_level_id: + $ref: './query/impact_risk_level_id.yaml' +probability_risk_level_id: + $ref: './query/probability_risk_level_id.yaml' +profile_id: + $ref: './query/profile_id.yaml' +relationship_type: + $ref: './query/relationship_type.yaml' +uid: + $ref: './query/uid.yaml' +workflow_id: + $ref: './query/workflow_id.yaml' +requester_id: + $ref: './query/requester_id.yaml' +status_uid: + $ref: './query/status_uid.yaml' +workflow_session_id: + $ref: './query/workflow_session_id.yaml' +result: + $ref: './query/result.yaml' +metadata: + $ref: './query/metadata.yaml' \ No newline at end of file diff --git a/nerm/parameters/path/attribute_id.yaml b/nerm/parameters/path/attribute_id.yaml new file mode 100644 index 0000000..bd5d28e --- /dev/null +++ b/nerm/parameters/path/attribute_id.yaml @@ -0,0 +1,7 @@ +name: attribute_id +in: path +description: The id of the attachment attribute +required: true +schema: + type: string + format: uuid \ No newline at end of file diff --git a/nerm/parameters/path/id.yaml b/nerm/parameters/path/id.yaml new file mode 100644 index 0000000..76361e7 --- /dev/null +++ b/nerm/parameters/path/id.yaml @@ -0,0 +1,7 @@ +name: id +in: path +description: ID of the object to retrieve or update +required: true +schema: + type: string + format: uuid \ No newline at end of file diff --git a/nerm/parameters/query/archived.yaml b/nerm/parameters/query/archived.yaml new file mode 100644 index 0000000..3ca1144 --- /dev/null +++ b/nerm/parameters/query/archived.yaml @@ -0,0 +1,7 @@ +name: archived +in: query +description: Filter by archive status +required: false +schema: + type: boolean + default: false \ No newline at end of file diff --git a/nerm/parameters/query/data_type.yaml b/nerm/parameters/query/data_type.yaml new file mode 100644 index 0000000..07ff572 --- /dev/null +++ b/nerm/parameters/query/data_type.yaml @@ -0,0 +1,7 @@ +name: data_type +in: query +description: The attribute data type to filter by +required: false +schema: + type: string + enum: [text field, text area, drop-down, radio buttons, check boxes, date, tags, attachment, profile select, profile search, owner select, owner search, contributor select, contributor search] \ No newline at end of file diff --git a/nerm/parameters/query/email.yaml b/nerm/parameters/query/email.yaml new file mode 100644 index 0000000..e7a35b6 --- /dev/null +++ b/nerm/parameters/query/email.yaml @@ -0,0 +1,7 @@ +name: email +in: query +description: The user email to search by +required: false +schema: + type: string + format: email \ No newline at end of file diff --git a/nerm/parameters/query/exclude_attributes.yaml b/nerm/parameters/query/exclude_attributes.yaml new file mode 100644 index 0000000..7d93aa0 --- /dev/null +++ b/nerm/parameters/query/exclude_attributes.yaml @@ -0,0 +1,7 @@ +name: exclude_attributes +in: query +description: Allows for optimization by not returning the associated attribute data for the returned profiles +required: false +schema: + type: boolean + default: false \ No newline at end of file diff --git a/nerm/parameters/query/impact_risk_level_id.yaml b/nerm/parameters/query/impact_risk_level_id.yaml new file mode 100644 index 0000000..7aa5afa --- /dev/null +++ b/nerm/parameters/query/impact_risk_level_id.yaml @@ -0,0 +1,7 @@ +name: impact_risk_level_id +in: query +description: Impact risk level to filter by +required: false +schema: + type: string + format: uuid \ No newline at end of file diff --git a/nerm/parameters/query/job_id.yaml b/nerm/parameters/query/job_id.yaml new file mode 100644 index 0000000..bc9b2f3 --- /dev/null +++ b/nerm/parameters/query/job_id.yaml @@ -0,0 +1,6 @@ +name: job_id +in: query +description: The id of the job returned from a POST or PATCH endpoint that resulted in a job being created +required: true +schema: + type: string \ No newline at end of file diff --git a/nerm/parameters/query/label.yaml b/nerm/parameters/query/label.yaml new file mode 100644 index 0000000..e22136c --- /dev/null +++ b/nerm/parameters/query/label.yaml @@ -0,0 +1,6 @@ +name: label +in: query +description: The attribute label to filter by +required: false +schema: + type: string \ No newline at end of file diff --git a/nerm/parameters/query/login.yaml b/nerm/parameters/query/login.yaml new file mode 100644 index 0000000..086e079 --- /dev/null +++ b/nerm/parameters/query/login.yaml @@ -0,0 +1,6 @@ +name: login +in: query +description: The user login to search by +required: false +schema: + type: string \ No newline at end of file diff --git a/nerm/parameters/query/manager_id.yaml b/nerm/parameters/query/manager_id.yaml new file mode 100644 index 0000000..95e8a59 --- /dev/null +++ b/nerm/parameters/query/manager_id.yaml @@ -0,0 +1,7 @@ +name: manager_id +in: query +description: The ID of a user for filtering +required: false +schema: + type: string + format: uuid \ No newline at end of file diff --git a/nerm/parameters/query/metadata.yaml b/nerm/parameters/query/metadata.yaml new file mode 100644 index 0000000..3a4a026 --- /dev/null +++ b/nerm/parameters/query/metadata.yaml @@ -0,0 +1,7 @@ +name: metadata +in: query +description: Returns batching metadata in the response +required: false +schema: + type: boolean + default: false \ No newline at end of file diff --git a/nerm/parameters/query/name.yaml b/nerm/parameters/query/name.yaml new file mode 100644 index 0000000..140b4ef --- /dev/null +++ b/nerm/parameters/query/name.yaml @@ -0,0 +1,6 @@ +name: name +in: query +description: object name for filtering +required: false +schema: + type: string \ No newline at end of file diff --git a/nerm/parameters/query/ne_attribute_id.yaml b/nerm/parameters/query/ne_attribute_id.yaml new file mode 100644 index 0000000..6780d09 --- /dev/null +++ b/nerm/parameters/query/ne_attribute_id.yaml @@ -0,0 +1,7 @@ +name: ne_attribute_id +in: query +description: ID of an attribute for filtering +required: false +schema: + type: string + format: uuid \ No newline at end of file diff --git a/nerm/parameters/query/object_id.yaml b/nerm/parameters/query/object_id.yaml new file mode 100644 index 0000000..d2ccd7a --- /dev/null +++ b/nerm/parameters/query/object_id.yaml @@ -0,0 +1,7 @@ +name: object_id +in: query +description: ID of an object for filtering. Used along with object_type +required: false +schema: + type: string + format: uuid \ No newline at end of file diff --git a/nerm/parameters/query/object_type.yaml b/nerm/parameters/query/object_type.yaml new file mode 100644 index 0000000..73e610f --- /dev/null +++ b/nerm/parameters/query/object_type.yaml @@ -0,0 +1,7 @@ +name: object_type +in: query +description: Type of object that object_id represents +required: false +schema: + type: string + enum: [Profile, WorkflowSession] \ No newline at end of file diff --git a/nerm/parameters/query/option.yaml b/nerm/parameters/query/option.yaml new file mode 100644 index 0000000..68a2c52 --- /dev/null +++ b/nerm/parameters/query/option.yaml @@ -0,0 +1,6 @@ +name: option +in: query +description: attribute option label for filtering +required: false +schema: + type: string \ No newline at end of file diff --git a/nerm/parameters/query/overall_risk_level_id.yaml b/nerm/parameters/query/overall_risk_level_id.yaml new file mode 100644 index 0000000..4856932 --- /dev/null +++ b/nerm/parameters/query/overall_risk_level_id.yaml @@ -0,0 +1,7 @@ +name: overall_risk_level_id +in: query +description: Overall risk level to filter by +required: false +schema: + type: string + format: uuid \ No newline at end of file diff --git a/nerm/parameters/query/probability_risk_level_id.yaml b/nerm/parameters/query/probability_risk_level_id.yaml new file mode 100644 index 0000000..a793f6b --- /dev/null +++ b/nerm/parameters/query/probability_risk_level_id.yaml @@ -0,0 +1,7 @@ +name: probability_risk_level_id +in: query +description: Probability risk level to filter by +required: false +schema: + type: string + format: uuid \ No newline at end of file diff --git a/nerm/parameters/query/profile_id.yaml b/nerm/parameters/query/profile_id.yaml new file mode 100644 index 0000000..4a78801 --- /dev/null +++ b/nerm/parameters/query/profile_id.yaml @@ -0,0 +1,7 @@ +name: profile_id +in: query +description: Profile ID to filter by +required: false +schema: + type: string + format: uuid \ No newline at end of file diff --git a/nerm/parameters/query/profile_type_id.yaml b/nerm/parameters/query/profile_type_id.yaml new file mode 100644 index 0000000..6507549 --- /dev/null +++ b/nerm/parameters/query/profile_type_id.yaml @@ -0,0 +1,7 @@ +name: profile_type_id +in: query +description: Profile Type ID for filtering +required: false +schema: + type: string + format: uuid \ No newline at end of file diff --git a/nerm/parameters/query/query.yaml b/nerm/parameters/query/query.yaml new file mode 100644 index 0000000..c584b3c --- /dev/null +++ b/nerm/parameters/query/query.yaml @@ -0,0 +1,18 @@ +name: query +in: query +description: Allows for pagination and sorting. +required: false +schema: + type: object + properties: + limit: + type: integer + example: 100 + offset: + type: integer + example: 50 + order: + type: string + example: created_at +style: deepObject +explode: true diff --git a/nerm/parameters/query/relationship_type.yaml b/nerm/parameters/query/relationship_type.yaml new file mode 100644 index 0000000..a6f953d --- /dev/null +++ b/nerm/parameters/query/relationship_type.yaml @@ -0,0 +1,7 @@ +name: relationship_type +in: query +description: Type of user contributor relationship to filter by +required: false +schema: + type: string + enum: [owner, contributor] \ No newline at end of file diff --git a/nerm/parameters/query/requester_id.yaml b/nerm/parameters/query/requester_id.yaml new file mode 100644 index 0000000..f1ce95e --- /dev/null +++ b/nerm/parameters/query/requester_id.yaml @@ -0,0 +1,7 @@ +name: requester_id +in: query +description: Requester ID for filtering +required: false +schema: + type: string + format: uuid \ No newline at end of file diff --git a/nerm/parameters/query/result.yaml b/nerm/parameters/query/result.yaml new file mode 100644 index 0000000..8f3fdcb --- /dev/null +++ b/nerm/parameters/query/result.yaml @@ -0,0 +1,7 @@ +name: result +in: query +description: ID Proofing Result to filter by +required: false +schema: + type: string + enum: [pass, fail] \ No newline at end of file diff --git a/nerm/parameters/query/role_id.yaml b/nerm/parameters/query/role_id.yaml new file mode 100644 index 0000000..abb841b --- /dev/null +++ b/nerm/parameters/query/role_id.yaml @@ -0,0 +1,7 @@ +name: role_id +in: query +description: The ID of a role for filtering +required: false +schema: + type: string + format: uuid \ No newline at end of file diff --git a/nerm/parameters/query/run.yaml b/nerm/parameters/query/run.yaml new file mode 100644 index 0000000..cf53c5f --- /dev/null +++ b/nerm/parameters/query/run.yaml @@ -0,0 +1,7 @@ +name: run +in: query +description: Will run the created/updated workflow session if successful +required: false +schema: + type: boolean + default: false \ No newline at end of file diff --git a/nerm/parameters/query/status.yaml b/nerm/parameters/query/status.yaml new file mode 100644 index 0000000..f02190b --- /dev/null +++ b/nerm/parameters/query/status.yaml @@ -0,0 +1,7 @@ +name: status +in: query +description: status value for filtering +required: false +schema: + type: string + enum: [Active, Inactive, On Leave, Terminated] \ No newline at end of file diff --git a/nerm/parameters/query/title.yaml b/nerm/parameters/query/title.yaml new file mode 100644 index 0000000..617ea14 --- /dev/null +++ b/nerm/parameters/query/title.yaml @@ -0,0 +1,6 @@ +name: title +in: query +description: The user title to search by +required: false +schema: + type: string \ No newline at end of file diff --git a/nerm/parameters/query/uid.yaml b/nerm/parameters/query/uid.yaml new file mode 100644 index 0000000..4f5408a --- /dev/null +++ b/nerm/parameters/query/uid.yaml @@ -0,0 +1,8 @@ +name: uid +in: query +description: Workflow session uid for filtering +required: false +schema: + type: string + minLength: 32 + maxLength: 32 \ No newline at end of file diff --git a/nerm/parameters/query/user_id.yaml b/nerm/parameters/query/user_id.yaml new file mode 100644 index 0000000..439b3e3 --- /dev/null +++ b/nerm/parameters/query/user_id.yaml @@ -0,0 +1,7 @@ +name: user_id +in: query +description: The ID of a user for filtering +required: false +schema: + type: string + format: uuid \ No newline at end of file diff --git a/nerm/parameters/query/workflow_id.yaml b/nerm/parameters/query/workflow_id.yaml new file mode 100644 index 0000000..43b42fb --- /dev/null +++ b/nerm/parameters/query/workflow_id.yaml @@ -0,0 +1,7 @@ +name: workflow_id +in: query +description: Workflow ID for filtering +required: false +schema: + type: string + format: uuid \ No newline at end of file diff --git a/nerm/parameters/query/workflow_session_id.yaml b/nerm/parameters/query/workflow_session_id.yaml new file mode 100644 index 0000000..bac2602 --- /dev/null +++ b/nerm/parameters/query/workflow_session_id.yaml @@ -0,0 +1,7 @@ +name: workflow_session_id +in: query +description: Workflow Session ID to filter by +required: false +schema: + type: string + format: uuid \ No newline at end of file diff --git a/nerm/parameters/query/workflow_session_status.yaml b/nerm/parameters/query/workflow_session_status.yaml new file mode 100644 index 0000000..95e920c --- /dev/null +++ b/nerm/parameters/query/workflow_session_status.yaml @@ -0,0 +1,70 @@ +name: status +in: query +description: filter by workflow session status +required: false +schema: + type: string + enum: [ + "waiting on workflow", + "identity proofing completed", + "new", + "closing", + "pending request", + "requested", + "pending approval", + "approved", + "pending notification", + "notified", + "pending review", + "reviewed", + "pending trigger", + "stored procedure", + "pending status change", + "status changed", + "pending update", + "non employee updated", + "non employee created", + "pending creation", + "rejected", + "pending assignment", + "assigned", + "default", + "failed", + "un assigned", + "auto assigned", + "ldap provided", + "pending ldap", + "pending fulfillment", + "pending stored procedure", + "pending courion add", + "fulfilled", + "pending courion update", + "courion add", + "pending courion_extend", + "courion update", + "pending courion terminate", + "courion extend", + "pending profile select", + "courion terminate", + "batch completed", + "profiles selected", + "answered questions", + "pending questions", + "attempting to start workflow", + "started workflow", + "profile check complete", + "completed", + "processing", + "pending set attribute", + "invitation sent", + "action skipped", + "api request sent", + "attribute set", + "disabled", + "duplicates resolved", + "soap request sent", + "checking for duplicates", + "pending identity proofing", + "closed", + "workflow changed" + ] \ No newline at end of file diff --git a/nerm/paths/advanced_search.yaml b/nerm/paths/advanced_search.yaml new file mode 100644 index 0000000..513fda0 --- /dev/null +++ b/nerm/paths/advanced_search.yaml @@ -0,0 +1,20 @@ +get: + summary: Get saved advanced search queries + operationId: getAdvancedSearch + description: Get saved advanced search queries + tags: + - advanced search + responses: + '200': + $ref: "../responses/AdvancedSearches.yaml" +post: + summary: Save an advanced search query for later use + operationId: postAdvancedSearch + description: Save an advanced search query for later use + tags: + - advanced search + requestBody: + $ref: "../requestBodies/POST/AdvancedSearch.yaml" + responses: + '200': + $ref: "../responses/AdvancedSearch.yaml" \ No newline at end of file diff --git a/nerm/paths/advanced_search_id.yaml b/nerm/paths/advanced_search_id.yaml new file mode 100644 index 0000000..4525f18 --- /dev/null +++ b/nerm/paths/advanced_search_id.yaml @@ -0,0 +1,13 @@ +patch: + summary: Update a saved advanced search query + operationId: patchAdvancedSearch + description: Update a saved advanced search query + tags: + - advanced search + parameters: + - $ref: "../parameters/path/id.yaml" + requestBody: + $ref: "../requestBodies/PATCH/AdvancedSearch.yaml" + responses: + '200': + $ref: "../responses/AdvancedSearch.yaml" \ No newline at end of file diff --git a/nerm/paths/advanced_search_id_run.yaml b/nerm/paths/advanced_search_id_run.yaml new file mode 100644 index 0000000..4167b85 --- /dev/null +++ b/nerm/paths/advanced_search_id_run.yaml @@ -0,0 +1,12 @@ +get: + summary: Run a saved advanced search query + operationId: runAdvancedSearchbyID + description: Run a saved advanced search query + tags: + - advanced search + parameters: + - $ref: "../parameters/path/id.yaml" + - $ref: "../parameters/query/query.yaml" + responses: + '200': + $ref: "../responses/Profiles.yaml" \ No newline at end of file diff --git a/nerm/paths/advanced_search_run.yaml b/nerm/paths/advanced_search_run.yaml new file mode 100644 index 0000000..b6a8b3c --- /dev/null +++ b/nerm/paths/advanced_search_run.yaml @@ -0,0 +1,13 @@ +post: + summary: Run an advanced search for profiles, without saving the query + operationId: runAdvancedSearch + description: Run an advanced search for profiles, without saving the query + tags: + - advanced search + parameters: + - $ref: "../parameters/query/query.yaml" + requestBody: + $ref: "../requestBodies/POST/AdvancedSearch.yaml" + responses: + '200': + $ref: "../responses/Profiles.yaml" \ No newline at end of file diff --git a/nerm/paths/identity_proofing_results.yaml b/nerm/paths/identity_proofing_results.yaml new file mode 100644 index 0000000..f0e2d03 --- /dev/null +++ b/nerm/paths/identity_proofing_results.yaml @@ -0,0 +1,15 @@ +get: + summary: Get identity proofing result data in bulk + operationId: getIdentityProofingResults + description: This endpoint can retrieve identity proofing result data in bulk from Lifecycle + tags: + - identity proofing results + parameters: + - $ref: "../parameters/query/query.yaml" + - $ref: "../parameters/query/profile_id.yaml" + - $ref: "../parameters/query/workflow_session_id.yaml" + - $ref: "../parameters/query/result.yaml" + - $ref: "../parameters/query/metadata.yaml" + responses: + '200': + $ref: "../responses/IdentityProofingResults.yaml" \ No newline at end of file diff --git a/nerm/paths/job_status.yaml b/nerm/paths/job_status.yaml new file mode 100644 index 0000000..7eb53d8 --- /dev/null +++ b/nerm/paths/job_status.yaml @@ -0,0 +1,15 @@ +get: + summary: Get the status of a bulk job + operationId: getJobStatus + description: Get the status of a bulk job + tags: + - job status + parameters: + - $ref: "../parameters/query/job_id.yaml" + responses: + '200': + $ref: "../responses/Job.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" diff --git a/nerm/paths/ne_attribute_option.yaml b/nerm/paths/ne_attribute_option.yaml new file mode 100644 index 0000000..bf5cf08 --- /dev/null +++ b/nerm/paths/ne_attribute_option.yaml @@ -0,0 +1,13 @@ +post: + summary: Add a value to an option based attribute + operationId: postAttributeOption + description: Add a value to an option based attribute + tags: + - attribute options + requestBody: + $ref: "../requestBodies/POST/AttributeOption.yaml" + responses: + '200': + $ref: "../responses/AttributeOption.yaml" + '405': + $ref: "../responses/InvalidInput.yaml" \ No newline at end of file diff --git a/nerm/paths/ne_attribute_options.yaml b/nerm/paths/ne_attribute_options.yaml new file mode 100644 index 0000000..458e5dc --- /dev/null +++ b/nerm/paths/ne_attribute_options.yaml @@ -0,0 +1,48 @@ +get: + summary: Get option based attribute values + operationId: getAttributeOptions + description: Get option based attribute values + tags: + - attribute options + parameters: + - $ref: "../parameters/query/query.yaml" + - $ref: "../parameters/query/ne_attribute_id.yaml" +# - $ref: "../parameters/query/option.yaml" - Not implemented as of 4.16.2 + - $ref: "../parameters/query/metadata.yaml" + responses: + '200': + $ref: "../responses/AttributeOptions_Meta.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +post: + summary: Create multiple new option based attribute values + operationId: postAttributeOptions + description: Create multiple new option based attribute values + tags: + - attribute options + requestBody: + $ref: "../requestBodies/POST/AttributeOptions.yaml" + responses: + '200': + $ref: "../responses/AttributeOptionsJob.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +patch: + summary: Update multiple option based attribute values + operationId: patchAttributeOptions + description: Update multiple option based attribute values + tags: + - attribute options + requestBody: + $ref: "../requestBodies/PATCH/AttributeOptions.yaml" + responses: + '200': + $ref: "../responses/AttributeOptionsJob.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/ne_attribute_options_id.yaml b/nerm/paths/ne_attribute_options_id.yaml new file mode 100644 index 0000000..13b6280 --- /dev/null +++ b/nerm/paths/ne_attribute_options_id.yaml @@ -0,0 +1,47 @@ +get: + summary: Find option based attribute value by id + operationId: getAttributeOption + description: Info for a specific option based attribute value + tags: + - attribute options + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/AttributeOption.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +patch: + summary: Update a option based attribute value by id + operationId: patchAttributeOption + description: Update a option based attribute value by id + tags: + - attribute options + parameters: + - $ref: "../parameters/path/id.yaml" + requestBody: + $ref: "../requestBodies/PATCH/AttributeOption.yaml" + responses: + '200': + $ref: "../responses/AttributeOption.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +delete: + summary: Delete a option based attribute value by id + operationId: deleteAttributeOption + description: Delete a option based attribute value by id + tags: + - attribute options + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/DeleteConfirmation.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/ne_attributes.yaml b/nerm/paths/ne_attributes.yaml new file mode 100644 index 0000000..ded0911 --- /dev/null +++ b/nerm/paths/ne_attributes.yaml @@ -0,0 +1,18 @@ +get: + summary: Get attribute data in bulk + operationId: getAttributes + description: This endpoint can retrieve attribute data in bulk from Lifecycle or you can search for attributes using parameters + tags: + - attributes + parameters: + - $ref: "../parameters/query/query.yaml" + - $ref: "../parameters/query/label.yaml" + - $ref: "../parameters/query/data_type.yaml" + - $ref: "../parameters/query/metadata.yaml" + responses: + '200': + $ref: "../responses/Attributes_Meta.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/ne_attributes_id.yaml b/nerm/paths/ne_attributes_id.yaml new file mode 100644 index 0000000..ff2982a --- /dev/null +++ b/nerm/paths/ne_attributes_id.yaml @@ -0,0 +1,15 @@ +get: + summary: Find attribute data by id + operationId: getAttribute + description: Info for a specific attribute + tags: + - attributes + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/Attribute.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/profile.yaml b/nerm/paths/profile.yaml new file mode 100644 index 0000000..0694060 --- /dev/null +++ b/nerm/paths/profile.yaml @@ -0,0 +1,15 @@ +post: + summary: Create a profile + operationId: postProfile + description: Create a profile + tags: + - profiles + requestBody: + $ref: "../requestBodies/POST/Profile.yaml" + responses: + '200': + $ref: "../responses/Profile.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/profile_type.yaml b/nerm/paths/profile_type.yaml new file mode 100644 index 0000000..cb3de27 --- /dev/null +++ b/nerm/paths/profile_type.yaml @@ -0,0 +1,15 @@ +post: + summary: Create a profile type + operationId: postProfileType + description: Create a profile type + tags: + - profile types + requestBody: + $ref: "../requestBodies/POST/ProfileType.yaml" + responses: + '200': + $ref: "../responses/ProfileType.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/profile_types.yaml b/nerm/paths/profile_types.yaml new file mode 100644 index 0000000..b9ef12c --- /dev/null +++ b/nerm/paths/profile_types.yaml @@ -0,0 +1,18 @@ +get: + summary: Get profile types + operationId: getProfileTypes + description: Get option based attribute values + tags: + - profile types + parameters: + - $ref: "../parameters/query/query.yaml" + - $ref: "../parameters/query/name.yaml" + - $ref: "../parameters/query/archived.yaml" + - $ref: "../parameters/query/metadata.yaml" + responses: + '200': + $ref: "../responses/ProfileTypes_Meta.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" diff --git a/nerm/paths/profile_types_id.yaml b/nerm/paths/profile_types_id.yaml new file mode 100644 index 0000000..d7c2d7b --- /dev/null +++ b/nerm/paths/profile_types_id.yaml @@ -0,0 +1,48 @@ +get: + summary: Find profile type by id + operationId: getProfileType + description: Find profile type by id + tags: + - profile types + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/ProfileType.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +patch: + summary: Update a profile type by id + operationId: patchProfileType + description: Update a profile type by id + tags: + - profile types + parameters: + - $ref: "../parameters/path/id.yaml" + requestBody: + $ref: "../requestBodies/PATCH/ProfileType.yaml" + responses: + '200': + $ref: "../responses/ProfileType.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +# There is a foregin key constraint due to a profile profile_type_id dependency +delete: + summary: Delete profile type + operationId: deleteProfileType + description: Delete a profile type. All profiles of that type must first be destroyed before the profile type can be destroyed. + tags: + - profile types + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/info.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/profiles.yaml b/nerm/paths/profiles.yaml new file mode 100644 index 0000000..e9e06c1 --- /dev/null +++ b/nerm/paths/profiles.yaml @@ -0,0 +1,65 @@ +get: + summary: Get profiles + operationId: getProfiles + description: Get profiles + tags: + - profiles + parameters: + - $ref: "../parameters/query/query.yaml" + - $ref: "../parameters/query/exclude_attributes.yaml" + - $ref: "../parameters/query/name.yaml" + - $ref: "../parameters/query/profile_type_id.yaml" + - $ref: "../parameters/query/status.yaml" + - $ref: "../parameters/query/metadata.yaml" + responses: + '200': + $ref: "../responses/Profiles_Meta.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +post: + summary: Create multiple profiles + operationId: postProfiles + description: Create multiple profiles + tags: + - profiles + requestBody: + $ref: "../requestBodies/POST/Profiles.yaml" + responses: + '200': + $ref: "../responses/ProfilesJob.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +patch: + summary: Update multiple profiles + operationId: patchProfiles + description: Update multiple profiles + tags: + - profiles + requestBody: + $ref: "../requestBodies/PATCH/Profiles.yaml" + responses: + '200': + $ref: "../responses/ProfilesJob.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +delete: + summary: Delete multiple profiles + operationId: deleteProfiles + description: Delete multiple profiles + tags: + - profiles + requestBody: + $ref: "../requestBodies/DELETE/Profiles.yaml" + responses: + '200': + $ref: "../responses/ProfilesJob.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/profiles_id.yaml b/nerm/paths/profiles_id.yaml new file mode 100644 index 0000000..3b76b4a --- /dev/null +++ b/nerm/paths/profiles_id.yaml @@ -0,0 +1,32 @@ +get: + summary: Find profile by id + operationId: getProfile + description: Find profile by id + tags: + - profiles + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/Profile.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +patch: + summary: Update a profile by id + operationId: patchProfile + description: Update a profile by id + tags: + - profiles + parameters: + - $ref: "../parameters/path/id.yaml" + requestBody: + $ref: "../requestBodies/PATCH/Profile.yaml" + responses: + '200': + $ref: "../responses/Profile.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/profiles_id_avatar.yaml b/nerm/paths/profiles_id_avatar.yaml new file mode 100644 index 0000000..0c209a0 --- /dev/null +++ b/nerm/paths/profiles_id_avatar.yaml @@ -0,0 +1,32 @@ +get: + summary: Retrieves the URL of the profile avatar + operationId: getProfileAvatar + description: Retrieves the URL of the profile avatar + tags: + - profiles + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/Url.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +post: + summary: Uploads a new profile avatar + operationId: postProfileAvatar + description: Uploads a new profile avatar + tags: + - profiles + parameters: + - $ref: "../parameters/path/id.yaml" + requestBody: + $ref: "../requestBodies/POST/File.yaml" + responses: + '200': + $ref: "../responses/Url.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/profiles_id_upload_attribute_id.yaml b/nerm/paths/profiles_id_upload_attribute_id.yaml new file mode 100644 index 0000000..f61597b --- /dev/null +++ b/nerm/paths/profiles_id_upload_attribute_id.yaml @@ -0,0 +1,34 @@ +get: + summary: Retrieves the URL of an attachment attribute value from a profile + operationId: getProfileUpload + description: Retrieves the URL of an attachment attribute value from a profile + tags: + - profiles + parameters: + - $ref: "../parameters/path/id.yaml" + - $ref: "../parameters/path/attribute_id.yaml" + responses: + '200': + $ref: "../responses/Url.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +post: + summary: Uploads a new attachment attribute value to a profile + operationId: postProfileUpload + description: Uploads a new attachment attribute value to a profile + tags: + - profiles + parameters: + - $ref: "../parameters/path/id.yaml" + - $ref: "../parameters/path/attribute_id.yaml" + requestBody: + $ref: "../requestBodies/POST/File.yaml" + responses: + '200': + $ref: "../responses/Url.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/risk_levels.yaml b/nerm/paths/risk_levels.yaml new file mode 100644 index 0000000..936af71 --- /dev/null +++ b/nerm/paths/risk_levels.yaml @@ -0,0 +1,17 @@ +get: + summary: Get risk level data in bulk + operationId: getRiskLevels + description: This endpoint can retrieve risk level data in bulk from Lifecycle + tags: + - risk levels + parameters: + - $ref: "../parameters/query/query.yaml" + - $ref: "../parameters/query/label.yaml" + - $ref: "../parameters/query/metadata.yaml" + responses: + '200': + $ref: "../responses/RiskLevels_Meta.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/risk_levels_id.yaml b/nerm/paths/risk_levels_id.yaml new file mode 100644 index 0000000..6a6eae1 --- /dev/null +++ b/nerm/paths/risk_levels_id.yaml @@ -0,0 +1,15 @@ +get: + summary: Find risk level data by id + operationId: getRiskLevel + description: Find risk level data by id + tags: + - risk levels + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/RiskLevel.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/risk_scores.yaml b/nerm/paths/risk_scores.yaml new file mode 100644 index 0000000..4c5f010 --- /dev/null +++ b/nerm/paths/risk_scores.yaml @@ -0,0 +1,21 @@ +get: + summary: Get risk score data in bulk + operationId: getRiskScores + description: This endpoint can retrieve risk score data in bulk from Lifecycle + tags: + - risk scores + parameters: + - $ref: "../parameters/query/query.yaml" + - $ref: "../parameters/query/object_id.yaml" + - $ref: "../parameters/query/object_type.yaml" + - $ref: "../parameters/query/overall_risk_level_id.yaml" + - $ref: "../parameters/query/impact_risk_level_id.yaml" + - $ref: "../parameters/query/probability_risk_level_id.yaml" + - $ref: "../parameters/query/metadata.yaml" + responses: + '200': + $ref: "../responses/RiskScores.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/risk_scores_id.yaml b/nerm/paths/risk_scores_id.yaml new file mode 100644 index 0000000..ff90d04 --- /dev/null +++ b/nerm/paths/risk_scores_id.yaml @@ -0,0 +1,15 @@ +get: + summary: Find risk score data by id + operationId: getRiskScore + description: Find risk score data by id + tags: + - risk scores + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/RiskScore.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/role.yaml b/nerm/paths/role.yaml new file mode 100644 index 0000000..c624e12 --- /dev/null +++ b/nerm/paths/role.yaml @@ -0,0 +1,15 @@ +post: + summary: Create a new role + operationId: postRole + description: Create a new role + tags: + - roles + requestBody: + $ref: "../requestBodies/POST/Role.yaml" + responses: + '200': + $ref: "../responses/Role.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/role_profile.yaml b/nerm/paths/role_profile.yaml new file mode 100644 index 0000000..3cdf0aa --- /dev/null +++ b/nerm/paths/role_profile.yaml @@ -0,0 +1,13 @@ +post: + summary: Create a role-profile contributor relationship + operationId: postRoleProfile + description: Create a role-profile contributor relationship + tags: + - role profiles + requestBody: + $ref: "../requestBodies/POST/RoleProfile.yaml" + responses: + '200': + $ref: "../responses/RoleProfile.yaml" + '405': + $ref: "../responses/InvalidInput.yaml" \ No newline at end of file diff --git a/nerm/paths/role_profile_id.yaml b/nerm/paths/role_profile_id.yaml new file mode 100644 index 0000000..768951e --- /dev/null +++ b/nerm/paths/role_profile_id.yaml @@ -0,0 +1,19 @@ +delete: + summary: Delete a role profile assignment + operationId: deleteRoleProfile + description: Delete a role profile assignment + tags: + - role profiles + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + description: "Role profile was destroyed" + content: + application/json: + schema: + type: object + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/role_profiles.yaml b/nerm/paths/role_profiles.yaml new file mode 100644 index 0000000..7212de6 --- /dev/null +++ b/nerm/paths/role_profiles.yaml @@ -0,0 +1,48 @@ +get: + summary: Get role-profile contributor relationships + operationId: getRoleProfiles + description: Get role-profile contributor relationships + tags: + - role profiles + parameters: + - $ref: "../parameters/query/query.yaml" + - $ref: "../parameters/query/role_id.yaml" + - $ref: "../parameters/query/profile_id.yaml" + - $ref: "../parameters/query/metadata.yaml" + responses: + '200': + $ref: "../responses/RoleProfiles_Meta.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +post: + summary: Create multiple role-profile contributor relationships + operationId: postRoleProfiles + description: Create multiple role-profile contributor relationships + tags: + - role profiles + requestBody: + $ref: "../requestBodies/POST/RoleProfiles.yaml" + responses: + '200': + $ref: "../responses/RoleProfilesJob.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +patch: + summary: Update multiple role-profile contributor relationships + operationId: patchRoleProfiles + description: Update multiple role-profile contributor relationships + tags: + - role profiles + requestBody: + $ref: "../requestBodies/PATCH/RoleProfiles.yaml" + responses: + '200': + $ref: "../responses/RoleProfilesJob.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/role_profiles_id.yaml b/nerm/paths/role_profiles_id.yaml new file mode 100644 index 0000000..4e3be32 --- /dev/null +++ b/nerm/paths/role_profiles_id.yaml @@ -0,0 +1,32 @@ +get: + summary: Find role-profile contributor relationship by id + operationId: getRoleProfile + description: Find role-profile contributor relationship by id + tags: + - role profiles + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/RoleProfile.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +patch: + summary: Update a role-profile contributor relationship by id + operationId: patchRoleProfile + description: Update a role-profile contributor relationship by id + tags: + - role profiles + parameters: + - $ref: "../parameters/path/id.yaml" + requestBody: + $ref: "../requestBodies/PATCH/RoleProfile.yaml" + responses: + '200': + $ref: "../responses/RoleProfile.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/roles.yaml b/nerm/paths/roles.yaml new file mode 100644 index 0000000..e7fa5f7 --- /dev/null +++ b/nerm/paths/roles.yaml @@ -0,0 +1,46 @@ +get: + summary: Get roles + operationId: getRoles + description: This endpoint can retrieve roles from NERM. Optionally you can provide parameters to filter results. + tags: + - roles + parameters: + - $ref: "../parameters/query/query.yaml" + - $ref: "../parameters/query/metadata.yaml" + responses: + '200': + $ref: "../responses/Roles_Meta.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +post: + summary: Create multiple new roles + operationId: postRoles + description: Create multiple new users + tags: + - roles + requestBody: + $ref: "../requestBodies/POST/Roles.yaml" + responses: + '200': + $ref: "../responses/RolesJob.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +patch: + summary: Update multiple roles + operationId: patchRoles + description: Update multiple users + tags: + - roles + requestBody: + $ref: "../requestBodies/PATCH/Roles.yaml" + responses: + '200': + $ref: "../responses/RolesJob.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/roles_id.yaml b/nerm/paths/roles_id.yaml new file mode 100644 index 0000000..567954c --- /dev/null +++ b/nerm/paths/roles_id.yaml @@ -0,0 +1,32 @@ +get: + summary: Find role by id + operationId: getRole + description: Info for a specific user role + tags: + - roles + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/Role.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +patch: + summary: Update an existing role + operationId: patchRole + description: Update an existing role + tags: + - roles + requestBody: + $ref: "../requestBodies/PATCH/Role.yaml" + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/Role.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/user.yaml b/nerm/paths/user.yaml new file mode 100644 index 0000000..ed1b22a --- /dev/null +++ b/nerm/paths/user.yaml @@ -0,0 +1,15 @@ +post: + summary: Create a new user + operationId: postUser + description: Create a new user + tags: + - users + requestBody: + $ref: "../requestBodies/POST/User.yaml" + responses: + '200': + $ref: "../responses/User.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/user_manager.yaml b/nerm/paths/user_manager.yaml new file mode 100644 index 0000000..21c6e9d --- /dev/null +++ b/nerm/paths/user_manager.yaml @@ -0,0 +1,15 @@ +post: + summary: Create a new user-manager relationship + operationId: postUserManager + description: Create a new user-manager relationship + tags: + - user managers + requestBody: + $ref: "../requestBodies/POST/UserManager.yaml" + responses: + '200': + $ref: "../responses/UserManager.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/user_managers.yaml b/nerm/paths/user_managers.yaml new file mode 100644 index 0000000..8b5a283 --- /dev/null +++ b/nerm/paths/user_managers.yaml @@ -0,0 +1,48 @@ +get: + summary: Get user-manager relationships + operationId: getUserManagers + description: This endpoint can retrieve user-manager relationships from Lifecycle or you can search for user-manager relationships using parameters + tags: + - user managers + parameters: + - $ref: "../parameters/query/query.yaml" + - $ref: "../parameters/query/user_id.yaml" + - $ref: "../parameters/query/manager_id.yaml" + - $ref: "../parameters/query/metadata.yaml" + responses: + '200': + $ref: "../responses/UserManagers_Meta.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +post: + summary: Create multiple new user-manager relationships + operationId: postUserManagers + description: Create multiple new user-manager relationships + tags: + - user managers + requestBody: + $ref: "../requestBodies/POST/UserManagers.yaml" + responses: + '200': + $ref: "../responses/UserManagersJob.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +patch: + summary: Update multiple user-manager relationships + operationId: patchUserManagers + description: Update multiple user-manager relationships + tags: + - user managers + requestBody: + $ref: "../requestBodies/PATCH/UserManagers.yaml" + responses: + '200': + $ref: "../responses/UserManagersJob.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/user_managers_id.yaml b/nerm/paths/user_managers_id.yaml new file mode 100644 index 0000000..4446a96 --- /dev/null +++ b/nerm/paths/user_managers_id.yaml @@ -0,0 +1,32 @@ +get: + summary: Find user-manager relationship by id + operationId: getUserManager + description: Info for a specific user-manager relationship + tags: + - user managers + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/UserManager.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +patch: + summary: Update a user-manager relationship by id + operationId: patchUserManager + description: Update a user-manager relationship by id + tags: + - user managers + requestBody: + $ref: "../requestBodies/PATCH/UserManager.yaml" + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/UserManager.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/user_profile.yaml b/nerm/paths/user_profile.yaml new file mode 100644 index 0000000..22a5cb9 --- /dev/null +++ b/nerm/paths/user_profile.yaml @@ -0,0 +1,13 @@ +post: + summary: Create a user-profile contributor relationship + operationId: postUserProfile + description: Create a user-profile contributor relationship + tags: + - user profiles + requestBody: + $ref: "../requestBodies/POST/UserProfile.yaml" + responses: + '200': + $ref: "../responses/UserProfile.yaml" + '405': + $ref: "../responses/InvalidInput.yaml" \ No newline at end of file diff --git a/nerm/paths/user_profile_id.yaml b/nerm/paths/user_profile_id.yaml new file mode 100644 index 0000000..2b44951 --- /dev/null +++ b/nerm/paths/user_profile_id.yaml @@ -0,0 +1,19 @@ +delete: + summary: Delete a user profile assignment + operationId: deleteUserProfile + description: Delete a user profile assignment + tags: + - user profiles + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + description: "User profile was destroyed" + content: + application/json: + schema: + type: object + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/user_profiles.yaml b/nerm/paths/user_profiles.yaml new file mode 100644 index 0000000..dc74e9b --- /dev/null +++ b/nerm/paths/user_profiles.yaml @@ -0,0 +1,50 @@ +get: + summary: Get user-profile contributor relationships + operationId: getUserProfiles + description: Get user-profile contributor relationships + tags: + - user profiles + parameters: + - $ref: "../parameters/query/query.yaml" + - $ref: "../parameters/query/user_id.yaml" + - $ref: "../parameters/query/ne_attribute_id.yaml" + - $ref: "../parameters/query/profile_id.yaml" + - $ref: "../parameters/query/relationship_type.yaml" + - $ref: "../parameters/query/metadata.yaml" + responses: + '200': + $ref: "../responses/UserProfiles_Meta.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +post: + summary: Create multiple user-profile contributor relationships + operationId: postUserProfiles + description: Create multiple user-profile contributor relationships + tags: + - user profiles + requestBody: + $ref: "../requestBodies/POST/UserProfiles.yaml" + responses: + '200': + $ref: "../responses/UserProfilesJob.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +patch: + summary: Update multiple user-profile contributor relationships + operationId: patchUserProfiles + description: Update multiple user-profile contributor relationships + tags: + - user profiles + requestBody: + $ref: "../requestBodies/PATCH/UserProfiles.yaml" + responses: + '200': + $ref: "../responses/UserProfilesJob.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/user_profiles_id.yaml b/nerm/paths/user_profiles_id.yaml new file mode 100644 index 0000000..f5299a0 --- /dev/null +++ b/nerm/paths/user_profiles_id.yaml @@ -0,0 +1,32 @@ +get: + summary: Find user-profile contributor relationship by id + operationId: getUserProfile + description: Find user-profile contributor relationship by id + tags: + - user profiles + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/UserProfile.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +patch: + summary: Update a user-profile contributor relationship by id + operationId: patchUserProfile + description: Update a user-profile contributor relationship by id + tags: + - user profiles + parameters: + - $ref: "../parameters/path/id.yaml" + requestBody: + $ref: "../requestBodies/PATCH/UserProfile.yaml" + responses: + '200': + $ref: "../responses/UserProfile.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/user_role.yaml b/nerm/paths/user_role.yaml new file mode 100644 index 0000000..033b306 --- /dev/null +++ b/nerm/paths/user_role.yaml @@ -0,0 +1,15 @@ +post: + summary: Assign a new role to a user + operationId: postUserRole + description: Assign a new role to a user + tags: + - user roles + requestBody: + $ref: "../requestBodies/POST/UserRole.yaml" + responses: + '200': + $ref: "../responses/UserRole.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/user_role_id.yaml b/nerm/paths/user_role_id.yaml new file mode 100644 index 0000000..70a7e90 --- /dev/null +++ b/nerm/paths/user_role_id.yaml @@ -0,0 +1,19 @@ +delete: + summary: Delete a user role assignment + operationId: deleteUserRole + description: Delete a user role assignment + tags: + - user roles + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + description: "User role was destroyed" + content: + application/json: + schema: + type: object + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/user_roles.yaml b/nerm/paths/user_roles.yaml new file mode 100644 index 0000000..55dffe5 --- /dev/null +++ b/nerm/paths/user_roles.yaml @@ -0,0 +1,48 @@ +get: + summary: Get user role pairings + operationId: getUserRoles + description: This endpoint can retrieve user role pairings from Lifecycle or you can search for user role pairings using parameters + tags: + - user roles + parameters: + - $ref: "../parameters/query/query.yaml" + - $ref: "../parameters/query/user_id.yaml" + - $ref: "../parameters/query/role_id.yaml" + - $ref: "../parameters/query/metadata.yaml" + responses: + '200': + $ref: "../responses/UserRoles_Meta.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +post: + summary: Create multiple new user role pairings + operationId: postUserRoles + description: Create multiple new user role pairings + tags: + - user roles + requestBody: + $ref: "../requestBodies/POST/UserRoles.yaml" + responses: + '200': + $ref: "../responses/UserRolesJob.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +patch: + summary: Update multiple user role pairings + operationId: patchUserRoles + description: Update multiple user role pairings + tags: + - user roles + requestBody: + $ref: "../requestBodies/PATCH/UserRoles.yaml" + responses: + '200': + $ref: "../responses/UserRolesJob.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/user_roles_id.yaml b/nerm/paths/user_roles_id.yaml new file mode 100644 index 0000000..7a74e7e --- /dev/null +++ b/nerm/paths/user_roles_id.yaml @@ -0,0 +1,32 @@ +get: + summary: Find user role pairing by id + operationId: getUserRole + description: Info for a specific user role pairing + tags: + - user roles + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/UserRole.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +patch: + summary: Update a user role pairing by id + operationId: patchUserRole + description: Update a user role pairing by id + tags: + - user roles + requestBody: + $ref: "../requestBodies/PATCH/UserRole.yaml" + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/UserRole.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/users.yaml b/nerm/paths/users.yaml new file mode 100644 index 0000000..4f15bf6 --- /dev/null +++ b/nerm/paths/users.yaml @@ -0,0 +1,51 @@ +get: + summary: Get users + operationId: getUsers + description: This endpoint can retrieve users from Lifecycle or you can search for users using parameters + tags: + - users + parameters: + - $ref: "../parameters/query/query.yaml" + - $ref: "../parameters/query/name.yaml" + - $ref: "../parameters/query/login.yaml" + - $ref: "../parameters/query/title.yaml" + - $ref: "../parameters/query/status.yaml" + - $ref: "../parameters/query/email.yaml" + - $ref: "../parameters/query/metadata.yaml" + responses: + '200': + $ref: "../responses/Users_Meta.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +post: + summary: Create multiple new users + operationId: postUsers + description: Create multiple new users + tags: + - users + requestBody: + $ref: "../requestBodies/POST/Users.yaml" + responses: + '200': + $ref: "../responses/UsersJob.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +patch: + summary: Update multiple users + operationId: patchUsers + description: Update multiple users + tags: + - users + requestBody: + $ref: "../requestBodies/PATCH/Users.yaml" + responses: + '200': + $ref: "../responses/UsersJob.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/users_id.yaml b/nerm/paths/users_id.yaml new file mode 100644 index 0000000..4c998a0 --- /dev/null +++ b/nerm/paths/users_id.yaml @@ -0,0 +1,47 @@ +get: + summary: Find user by id + operationId: getUser + description: Info for a specific user + tags: + - users + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/User.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +patch: + summary: Update a user by id + operationId: patchUser + description: Update a user by id + tags: + - users + parameters: + - $ref: "../parameters/path/id.yaml" + requestBody: + $ref: "../requestBodies/PATCH/User.yaml" + responses: + '200': + $ref: "../responses/User.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +delete: + summary: Delete a user + operationId: deleteUser + description: Delete a user + tags: + - users + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/info.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" diff --git a/nerm/paths/users_id_avatar.yaml b/nerm/paths/users_id_avatar.yaml new file mode 100644 index 0000000..bb603c3 --- /dev/null +++ b/nerm/paths/users_id_avatar.yaml @@ -0,0 +1,32 @@ +get: + summary: Retrieves the URL of the user avatar + operationId: getUserAvatar + description: Retrieves the URL of the user avatar + tags: + - users + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/Url.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +post: + summary: Uploads a new user avatar + operationId: postUserAvatar + description: Uploads a new user avatar + tags: + - users + parameters: + - $ref: "../parameters/path/id.yaml" + requestBody: + $ref: "../requestBodies/POST/File.yaml" + responses: + '200': + $ref: "../responses/Url.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/workflow_sessions.yaml b/nerm/paths/workflow_sessions.yaml new file mode 100644 index 0000000..e53e34d --- /dev/null +++ b/nerm/paths/workflow_sessions.yaml @@ -0,0 +1,38 @@ +get: + summary: Get workflow sessions + operationId: getWorkflowSessions + description: Get workflow sessions + tags: + - workflow sessions + parameters: + - $ref: "../parameters/query/query.yaml" + - $ref: "../parameters/query/profile_id.yaml" + - $ref: "../parameters/query/uid.yaml" + - $ref: "../parameters/query/workflow_id.yaml" + - $ref: "../parameters/query/requester_id.yaml" + - $ref: "../parameters/query/workflow_session_status.yaml" + - $ref: "../parameters/query/metadata.yaml" + responses: + '200': + $ref: "../responses/WorkflowSessions_Meta.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +post: + summary: Create a workflow session + operationId: postWorkflowSession + description: Create a workflow session + tags: + - workflow sessions + parameters: + - $ref: "../parameters/query/run.yaml" + requestBody: + $ref: "../requestBodies/POST/WorkflowSession.yaml" + responses: + '200': + $ref: "../responses/WorkflowSession.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/workflow_sessions_id.yaml b/nerm/paths/workflow_sessions_id.yaml new file mode 100644 index 0000000..65f8ea4 --- /dev/null +++ b/nerm/paths/workflow_sessions_id.yaml @@ -0,0 +1,33 @@ +get: + summary: Find workflow session by id + operationId: getWorkflowSession + description: Find workflow session by id + tags: + - workflow sessions + parameters: + - $ref: "../parameters/path/id.yaml" + responses: + '200': + $ref: "../responses/WorkflowSession.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +patch: + summary: Update a workflow session by id + operationId: patchWorkflowSession + description: Update a workflow session by id + tags: + - workflow sessions + parameters: + - $ref: "../parameters/path/id.yaml" + - $ref: "../parameters/query/run.yaml" + requestBody: + $ref: "../requestBodies/PATCH/WorkflowSession.yaml" + responses: + '200': + $ref: "../responses/WorkflowSession.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/nerm/paths/workflow_sessions_id_upload_attribute_id.yaml b/nerm/paths/workflow_sessions_id_upload_attribute_id.yaml new file mode 100644 index 0000000..e94c2ad --- /dev/null +++ b/nerm/paths/workflow_sessions_id_upload_attribute_id.yaml @@ -0,0 +1,34 @@ +get: + summary: Retrieves the URL of an attachment attribute value from a workflow session + operationId: getWorkflowSessionUpload + description: Retrieves the URL of an attachment attribute value from a workflow session + tags: + - workflow sessions + parameters: + - $ref: "../parameters/path/id.yaml" + - $ref: "../parameters/path/attribute_id.yaml" + responses: + '200': + $ref: "../responses/Url.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" +post: + summary: Uploads a new attachment attribute value to a workflow session + operationId: postWorkflowSessionUpload + description: Uploads a new attachment attribute value to a workflow session + tags: + - workflow sessions + parameters: + - $ref: "../parameters/path/id.yaml" + - $ref: "../parameters/path/attribute_id.yaml" + requestBody: + $ref: "../requestBodies/POST/File.yaml" + responses: + '200': + $ref: "../responses/Url.yaml" + '400': + $ref: "../responses/400.yaml" + '500': + $ref: "../responses/500.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/DELETE/Profiles.yaml b/nerm/requestBodies/DELETE/Profiles.yaml new file mode 100644 index 0000000..e1d0d31 --- /dev/null +++ b/nerm/requestBodies/DELETE/Profiles.yaml @@ -0,0 +1,14 @@ +required: true +content: + application/json: + schema: + type: object + properties: + profiles: + type: array + items: + type: object + properties: + id: + type: string + format: uuid \ No newline at end of file diff --git a/nerm/requestBodies/PATCH/AdvancedSearch.yaml b/nerm/requestBodies/PATCH/AdvancedSearch.yaml new file mode 100644 index 0000000..9bad165 --- /dev/null +++ b/nerm/requestBodies/PATCH/AdvancedSearch.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + advanced_search: + type: object + $ref: "../../schemas/PATCH/AdvancedSearch.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/PATCH/AttributeOption.yaml b/nerm/requestBodies/PATCH/AttributeOption.yaml new file mode 100644 index 0000000..be9673b --- /dev/null +++ b/nerm/requestBodies/PATCH/AttributeOption.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + ne_attribute_option: + type: object + $ref: "../../schemas/PATCH/AttributeOption.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/PATCH/AttributeOptions.yaml b/nerm/requestBodies/PATCH/AttributeOptions.yaml new file mode 100644 index 0000000..16d430d --- /dev/null +++ b/nerm/requestBodies/PATCH/AttributeOptions.yaml @@ -0,0 +1,10 @@ +required: true +content: + application/json: + schema: + type: object + properties: + ne_attribute_options: + type: array + items: + $ref: "../../schemas/PATCH/AttributeOptions.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/PATCH/Profile.yaml b/nerm/requestBodies/PATCH/Profile.yaml new file mode 100644 index 0000000..cf1ae5f --- /dev/null +++ b/nerm/requestBodies/PATCH/Profile.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + profile: + type: object + $ref: "../../schemas/PATCH/Profile.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/PATCH/ProfileType.yaml b/nerm/requestBodies/PATCH/ProfileType.yaml new file mode 100644 index 0000000..4bc6e6a --- /dev/null +++ b/nerm/requestBodies/PATCH/ProfileType.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + profile_type: + type: object + $ref: "../../schemas/PATCH/ProfileType.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/PATCH/Profiles.yaml b/nerm/requestBodies/PATCH/Profiles.yaml new file mode 100644 index 0000000..f989864 --- /dev/null +++ b/nerm/requestBodies/PATCH/Profiles.yaml @@ -0,0 +1,10 @@ +required: true +content: + application/json: + schema: + type: object + properties: + profiles: + type: array + items: + $ref: "../../schemas/PATCH/Profiles.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/PATCH/Role.yaml b/nerm/requestBodies/PATCH/Role.yaml new file mode 100644 index 0000000..1478477 --- /dev/null +++ b/nerm/requestBodies/PATCH/Role.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + role: + type: object + $ref: "../../schemas/PATCH/Role.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/PATCH/RoleProfile.yaml b/nerm/requestBodies/PATCH/RoleProfile.yaml new file mode 100644 index 0000000..a36f729 --- /dev/null +++ b/nerm/requestBodies/PATCH/RoleProfile.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + role_profile: + type: object + $ref: "../../schemas/PATCH/RoleProfile.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/PATCH/RoleProfiles.yaml b/nerm/requestBodies/PATCH/RoleProfiles.yaml new file mode 100644 index 0000000..106e9dc --- /dev/null +++ b/nerm/requestBodies/PATCH/RoleProfiles.yaml @@ -0,0 +1,10 @@ +required: true +content: + application/json: + schema: + type: object + properties: + role_profiles: + type: array + items: + $ref: "../../schemas/PATCH/RoleProfiles.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/PATCH/Roles.yaml b/nerm/requestBodies/PATCH/Roles.yaml new file mode 100644 index 0000000..de96b50 --- /dev/null +++ b/nerm/requestBodies/PATCH/Roles.yaml @@ -0,0 +1,10 @@ +required: true +content: + application/json: + schema: + type: object + properties: + roles: + type: array + items: + $ref: "../../schemas/PATCH/Role.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/PATCH/User.yaml b/nerm/requestBodies/PATCH/User.yaml new file mode 100644 index 0000000..f690eb4 --- /dev/null +++ b/nerm/requestBodies/PATCH/User.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + user: + type: object + $ref: "../../schemas/PATCH/User.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/PATCH/UserManager.yaml b/nerm/requestBodies/PATCH/UserManager.yaml new file mode 100644 index 0000000..a304f86 --- /dev/null +++ b/nerm/requestBodies/PATCH/UserManager.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + user_manager: + type: object + $ref: "../../schemas/PATCH/UserManager.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/PATCH/UserManagers.yaml b/nerm/requestBodies/PATCH/UserManagers.yaml new file mode 100644 index 0000000..7fcd196 --- /dev/null +++ b/nerm/requestBodies/PATCH/UserManagers.yaml @@ -0,0 +1,10 @@ +required: true +content: + application/json: + schema: + type: object + properties: + user_managers: + type: array + items: + $ref: "../../schemas/PATCH/UserManagers.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/PATCH/UserProfile.yaml b/nerm/requestBodies/PATCH/UserProfile.yaml new file mode 100644 index 0000000..caa1ef0 --- /dev/null +++ b/nerm/requestBodies/PATCH/UserProfile.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + user_profile: + type: object + $ref: "../../schemas/PATCH/UserProfile.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/PATCH/UserProfiles.yaml b/nerm/requestBodies/PATCH/UserProfiles.yaml new file mode 100644 index 0000000..213b358 --- /dev/null +++ b/nerm/requestBodies/PATCH/UserProfiles.yaml @@ -0,0 +1,10 @@ +required: true +content: + application/json: + schema: + type: object + properties: + user_profiles: + type: array + items: + $ref: "../../schemas/PATCH/UserProfiles.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/PATCH/UserRole.yaml b/nerm/requestBodies/PATCH/UserRole.yaml new file mode 100644 index 0000000..0c5a293 --- /dev/null +++ b/nerm/requestBodies/PATCH/UserRole.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + user_role: + type: object + $ref: "../../schemas/PATCH/UserRole.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/PATCH/UserRoles.yaml b/nerm/requestBodies/PATCH/UserRoles.yaml new file mode 100644 index 0000000..80f5683 --- /dev/null +++ b/nerm/requestBodies/PATCH/UserRoles.yaml @@ -0,0 +1,10 @@ +required: true +content: + application/json: + schema: + type: object + properties: + user_roles: + type: array + items: + $ref: "../../schemas/PATCH/UserRoles.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/PATCH/Users.yaml b/nerm/requestBodies/PATCH/Users.yaml new file mode 100644 index 0000000..931b1da --- /dev/null +++ b/nerm/requestBodies/PATCH/Users.yaml @@ -0,0 +1,10 @@ +required: true +content: + application/json: + schema: + type: object + properties: + users: + type: array + items: + $ref: "../../schemas/PATCH/User.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/PATCH/WorkflowSession.yaml b/nerm/requestBodies/PATCH/WorkflowSession.yaml new file mode 100644 index 0000000..8385507 --- /dev/null +++ b/nerm/requestBodies/PATCH/WorkflowSession.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + workflow_session: + type: object + $ref: "../../schemas/PATCH/WorkflowSession.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/AdvancedSearch.yaml b/nerm/requestBodies/POST/AdvancedSearch.yaml new file mode 100644 index 0000000..5971cfb --- /dev/null +++ b/nerm/requestBodies/POST/AdvancedSearch.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + advanced_search: + type: object + $ref: "../../schemas/POST/AdvancedSearch.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/AttributeOption.yaml b/nerm/requestBodies/POST/AttributeOption.yaml new file mode 100644 index 0000000..da0ce72 --- /dev/null +++ b/nerm/requestBodies/POST/AttributeOption.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + ne_attribute_option: + type: object + $ref: "../../schemas/POST/AttributeOption.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/AttributeOptions.yaml b/nerm/requestBodies/POST/AttributeOptions.yaml new file mode 100644 index 0000000..56e17fb --- /dev/null +++ b/nerm/requestBodies/POST/AttributeOptions.yaml @@ -0,0 +1,10 @@ +required: true +content: + application/json: + schema: + type: object + properties: + ne_attribute_options: + type: array + items: + $ref: "../../schemas/POST/AttributeOption.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/File.yaml b/nerm/requestBodies/POST/File.yaml new file mode 100644 index 0000000..2917e62 --- /dev/null +++ b/nerm/requestBodies/POST/File.yaml @@ -0,0 +1,9 @@ +required: true +content: + multipart/form-data: + schema: + type: object + properties: + file: + type: string + format: binary \ No newline at end of file diff --git a/nerm/requestBodies/POST/Profile.yaml b/nerm/requestBodies/POST/Profile.yaml new file mode 100644 index 0000000..163d76f --- /dev/null +++ b/nerm/requestBodies/POST/Profile.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + profile: + type: object + $ref: "../../schemas/POST/Profile.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/ProfileType.yaml b/nerm/requestBodies/POST/ProfileType.yaml new file mode 100644 index 0000000..6547387 --- /dev/null +++ b/nerm/requestBodies/POST/ProfileType.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + profile_type: + type: object + $ref: "../../schemas/POST/ProfileType.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/Profiles.yaml b/nerm/requestBodies/POST/Profiles.yaml new file mode 100644 index 0000000..a8da490 --- /dev/null +++ b/nerm/requestBodies/POST/Profiles.yaml @@ -0,0 +1,10 @@ +required: true +content: + application/json: + schema: + type: object + properties: + profiles: + type: array + items: + $ref: "../../schemas/POST/Profile.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/Role.yaml b/nerm/requestBodies/POST/Role.yaml new file mode 100644 index 0000000..483b957 --- /dev/null +++ b/nerm/requestBodies/POST/Role.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + role: + type: object + $ref: "../../schemas/POST/Role.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/RoleProfile.yaml b/nerm/requestBodies/POST/RoleProfile.yaml new file mode 100644 index 0000000..37eb1b7 --- /dev/null +++ b/nerm/requestBodies/POST/RoleProfile.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + role_profile: + type: object + $ref: "../../schemas/POST/RoleProfile.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/RoleProfiles.yaml b/nerm/requestBodies/POST/RoleProfiles.yaml new file mode 100644 index 0000000..b19d2e4 --- /dev/null +++ b/nerm/requestBodies/POST/RoleProfiles.yaml @@ -0,0 +1,10 @@ +required: true +content: + application/json: + schema: + type: object + properties: + role_profiles: + type: array + items: + $ref: "../../schemas/POST/RoleProfile.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/Roles.yaml b/nerm/requestBodies/POST/Roles.yaml new file mode 100644 index 0000000..c45a8a9 --- /dev/null +++ b/nerm/requestBodies/POST/Roles.yaml @@ -0,0 +1,10 @@ +required: true +content: + application/json: + schema: + type: object + properties: + roles: + type: array + items: + $ref: "../../schemas/POST/Role.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/User.yaml b/nerm/requestBodies/POST/User.yaml new file mode 100644 index 0000000..500c3f5 --- /dev/null +++ b/nerm/requestBodies/POST/User.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + user: + type: object + $ref: "../../schemas/POST/User.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/UserManager.yaml b/nerm/requestBodies/POST/UserManager.yaml new file mode 100644 index 0000000..bd75bf6 --- /dev/null +++ b/nerm/requestBodies/POST/UserManager.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + user_manager: + type: object + $ref: "../../schemas/POST/UserManager.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/UserManagers.yaml b/nerm/requestBodies/POST/UserManagers.yaml new file mode 100644 index 0000000..1759e31 --- /dev/null +++ b/nerm/requestBodies/POST/UserManagers.yaml @@ -0,0 +1,10 @@ +required: true +content: + application/json: + schema: + type: object + properties: + user_managers: + type: array + items: + $ref: "../../schemas/POST/UserManager.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/UserProfile.yaml b/nerm/requestBodies/POST/UserProfile.yaml new file mode 100644 index 0000000..400a495 --- /dev/null +++ b/nerm/requestBodies/POST/UserProfile.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + user_profile: + type: object + $ref: "../../schemas/POST/UserProfile.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/UserProfiles.yaml b/nerm/requestBodies/POST/UserProfiles.yaml new file mode 100644 index 0000000..fd37e3f --- /dev/null +++ b/nerm/requestBodies/POST/UserProfiles.yaml @@ -0,0 +1,10 @@ +required: true +content: + application/json: + schema: + type: object + properties: + user_profiles: + type: array + items: + $ref: "../../schemas/POST/UserProfile.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/UserRole.yaml b/nerm/requestBodies/POST/UserRole.yaml new file mode 100644 index 0000000..04972af --- /dev/null +++ b/nerm/requestBodies/POST/UserRole.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + user_role: + type: object + $ref: "../../schemas/POST/UserRole.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/UserRoles.yaml b/nerm/requestBodies/POST/UserRoles.yaml new file mode 100644 index 0000000..a724895 --- /dev/null +++ b/nerm/requestBodies/POST/UserRoles.yaml @@ -0,0 +1,10 @@ +required: true +content: + application/json: + schema: + type: object + properties: + user_roles: + type: array + items: + $ref: "../../schemas/POST/UserRole.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/Users.yaml b/nerm/requestBodies/POST/Users.yaml new file mode 100644 index 0000000..8117813 --- /dev/null +++ b/nerm/requestBodies/POST/Users.yaml @@ -0,0 +1,10 @@ +required: true +content: + application/json: + schema: + type: object + properties: + users: + type: array + items: + $ref: "../../schemas/POST/User.yaml" \ No newline at end of file diff --git a/nerm/requestBodies/POST/WorkflowSession.yaml b/nerm/requestBodies/POST/WorkflowSession.yaml new file mode 100644 index 0000000..fc088c6 --- /dev/null +++ b/nerm/requestBodies/POST/WorkflowSession.yaml @@ -0,0 +1,9 @@ +required: true +content: + application/json: + schema: + type: object + properties: + workflow_session: + type: object + $ref: "../../schemas/POST/WorkflowSession.yaml" \ No newline at end of file diff --git a/nerm/responses/400.yaml b/nerm/responses/400.yaml new file mode 100644 index 0000000..ce2b72a --- /dev/null +++ b/nerm/responses/400.yaml @@ -0,0 +1,7 @@ +description: Bad Request - unable to complete. +content: + application/json: + schema: + oneOf: + - $ref: "./InvalidJson.yaml" + - $ref: "./ValidationErrors.yaml" \ No newline at end of file diff --git a/nerm/responses/404.yaml b/nerm/responses/404.yaml new file mode 100644 index 0000000..e69de29 diff --git a/nerm/responses/500.yaml b/nerm/responses/500.yaml new file mode 100644 index 0000000..82a9336 --- /dev/null +++ b/nerm/responses/500.yaml @@ -0,0 +1,9 @@ +description: Internal Server Error - returned on unhandled exceptions. +content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: "Sorry something went wrong" \ No newline at end of file diff --git a/nerm/responses/AdvancedSearch.yaml b/nerm/responses/AdvancedSearch.yaml new file mode 100644 index 0000000..c119e8c --- /dev/null +++ b/nerm/responses/AdvancedSearch.yaml @@ -0,0 +1,9 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + advanced_search: + type: object + $ref: '../schemas/GET/AdvancedSearch.yaml' \ No newline at end of file diff --git a/nerm/responses/AdvancedSearches.yaml b/nerm/responses/AdvancedSearches.yaml new file mode 100644 index 0000000..8699cf7 --- /dev/null +++ b/nerm/responses/AdvancedSearches.yaml @@ -0,0 +1,10 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + advanced_search: + type: array + items: + $ref: '../schemas/GET/AdvancedSearch.yaml' \ No newline at end of file diff --git a/nerm/responses/Attribute.yaml b/nerm/responses/Attribute.yaml new file mode 100644 index 0000000..9d6e9f7 --- /dev/null +++ b/nerm/responses/Attribute.yaml @@ -0,0 +1,9 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + ne_attribute: + type: object + $ref: '../schemas/GET/Attribute.yaml' \ No newline at end of file diff --git a/nerm/responses/AttributeOption.yaml b/nerm/responses/AttributeOption.yaml new file mode 100644 index 0000000..736f456 --- /dev/null +++ b/nerm/responses/AttributeOption.yaml @@ -0,0 +1,9 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + ne_attribute_option: + type: object + $ref: '../schemas/GET/AttributeOption.yaml' \ No newline at end of file diff --git a/nerm/responses/AttributeOptions.yaml b/nerm/responses/AttributeOptions.yaml new file mode 100644 index 0000000..0ebb655 --- /dev/null +++ b/nerm/responses/AttributeOptions.yaml @@ -0,0 +1,10 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + ne_attribute_options: + type: array + items: + $ref: '../schemas/GET/AttributeOption.yaml' \ No newline at end of file diff --git a/nerm/responses/AttributeOptionsJob.yaml b/nerm/responses/AttributeOptionsJob.yaml new file mode 100644 index 0000000..0b805eb --- /dev/null +++ b/nerm/responses/AttributeOptionsJob.yaml @@ -0,0 +1,7 @@ +description: Expected response to a valid request +content: + application/json: + schema: + oneOf: + - $ref: '../schemas/GET/AttributeOptions.yaml' + - $ref: '../schemas/Job.yaml' \ No newline at end of file diff --git a/nerm/responses/AttributeOptions_Meta.yaml b/nerm/responses/AttributeOptions_Meta.yaml new file mode 100644 index 0000000..15fe958 --- /dev/null +++ b/nerm/responses/AttributeOptions_Meta.yaml @@ -0,0 +1,12 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + ne_attribute_options: + type: array + items: + $ref: '../schemas/GET/AttributeOption.yaml' + _metadata: + $ref: '../schemas/Metadata.yaml' \ No newline at end of file diff --git a/nerm/responses/Attributes.yaml b/nerm/responses/Attributes.yaml new file mode 100644 index 0000000..ca4664e --- /dev/null +++ b/nerm/responses/Attributes.yaml @@ -0,0 +1,10 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + ne_attributes: + type: array + items: + $ref: '../schemas/GET/Attribute.yaml' \ No newline at end of file diff --git a/nerm/responses/Attributes_Meta.yaml b/nerm/responses/Attributes_Meta.yaml new file mode 100644 index 0000000..6539afb --- /dev/null +++ b/nerm/responses/Attributes_Meta.yaml @@ -0,0 +1,12 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + ne_attributes: + type: array + items: + $ref: '../schemas/GET/Attribute.yaml' + _metadata: + $ref: '../schemas/Metadata.yaml' \ No newline at end of file diff --git a/nerm/responses/DeleteConfirmation.yaml b/nerm/responses/DeleteConfirmation.yaml new file mode 100644 index 0000000..e4e29e3 --- /dev/null +++ b/nerm/responses/DeleteConfirmation.yaml @@ -0,0 +1,9 @@ +description: Confirmation of a deleted object +content: + application/json: + schema: + type: object + properties: + info: + type: string + default: "The option '{Option Value}' has been deleted" diff --git a/nerm/responses/IdentityProofingResults.yaml b/nerm/responses/IdentityProofingResults.yaml new file mode 100644 index 0000000..807d6e0 --- /dev/null +++ b/nerm/responses/IdentityProofingResults.yaml @@ -0,0 +1,12 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + identity_proofing_results: + type: array + items: + $ref: '../schemas/GET/IdentityProofingResult.yaml' + _metadata: + $ref: '../schemas/Metadata.yaml' \ No newline at end of file diff --git a/nerm/responses/Info.yaml b/nerm/responses/Info.yaml new file mode 100644 index 0000000..183e2bb --- /dev/null +++ b/nerm/responses/Info.yaml @@ -0,0 +1,9 @@ +description: "Info about the operation" +content: + application/json: + schema: + type: object + properties: + info: + description: A message confirming the operation + example: object deleted \ No newline at end of file diff --git a/nerm/responses/InvalidInput.yaml b/nerm/responses/InvalidInput.yaml new file mode 100644 index 0000000..a3a597a --- /dev/null +++ b/nerm/responses/InvalidInput.yaml @@ -0,0 +1 @@ +description: Invalid input \ No newline at end of file diff --git a/nerm/responses/InvalidJson.yaml b/nerm/responses/InvalidJson.yaml new file mode 100644 index 0000000..8198454 --- /dev/null +++ b/nerm/responses/InvalidJson.yaml @@ -0,0 +1,4 @@ +type: object +properties: + error: + example: "Invalid JSON syntax. Please check your syntax and try again." \ No newline at end of file diff --git a/nerm/responses/Job.yaml b/nerm/responses/Job.yaml new file mode 100644 index 0000000..88fbfa7 --- /dev/null +++ b/nerm/responses/Job.yaml @@ -0,0 +1,32 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + uid: + type: string + format: uuid + status: + type: string + # enum: ["complete", "queued"] + example: "complete" + job_type: + type: string + example: import + job_data: + type: array + items: + type: object + properties: + user_id: + type: string + format: uuid + manager_id: + type: string + format: uuid + errors: + type: array + items: + type: string + example: Validation error for record in job \ No newline at end of file diff --git a/nerm/responses/Profile.yaml b/nerm/responses/Profile.yaml new file mode 100644 index 0000000..23293c5 --- /dev/null +++ b/nerm/responses/Profile.yaml @@ -0,0 +1,9 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + profile: + type: object + $ref: '../schemas/GET/Profile.yaml' \ No newline at end of file diff --git a/nerm/responses/ProfileType.yaml b/nerm/responses/ProfileType.yaml new file mode 100644 index 0000000..cf5e0e1 --- /dev/null +++ b/nerm/responses/ProfileType.yaml @@ -0,0 +1,9 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + profile_type: + type: object + $ref: '../schemas/GET/ProfileType.yaml' \ No newline at end of file diff --git a/nerm/responses/ProfileTypes.yaml b/nerm/responses/ProfileTypes.yaml new file mode 100644 index 0000000..ec9926b --- /dev/null +++ b/nerm/responses/ProfileTypes.yaml @@ -0,0 +1,10 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + profile_types: + type: array + items: + $ref: '../schemas/GET/ProfileType.yaml' \ No newline at end of file diff --git a/nerm/responses/ProfileTypes_Meta.yaml b/nerm/responses/ProfileTypes_Meta.yaml new file mode 100644 index 0000000..dc1a1f2 --- /dev/null +++ b/nerm/responses/ProfileTypes_Meta.yaml @@ -0,0 +1,12 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + profile_types: + type: array + items: + $ref: '../schemas/GET/ProfileType.yaml' + _metadata: + $ref: '../schemas/Metadata.yaml' \ No newline at end of file diff --git a/nerm/responses/Profiles.yaml b/nerm/responses/Profiles.yaml new file mode 100644 index 0000000..bd7b9f8 --- /dev/null +++ b/nerm/responses/Profiles.yaml @@ -0,0 +1,10 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + profiles: + type: array + items: + $ref: '../schemas/GET/Profile.yaml' \ No newline at end of file diff --git a/nerm/responses/ProfilesJob.yaml b/nerm/responses/ProfilesJob.yaml new file mode 100644 index 0000000..0360931 --- /dev/null +++ b/nerm/responses/ProfilesJob.yaml @@ -0,0 +1,7 @@ +description: Expected response to a valid request +content: + application/json: + schema: + oneOf: + - $ref: '../schemas/GET/Profiles.yaml' + - $ref: '../schemas/Job.yaml' \ No newline at end of file diff --git a/nerm/responses/Profiles_Meta.yaml b/nerm/responses/Profiles_Meta.yaml new file mode 100644 index 0000000..799402f --- /dev/null +++ b/nerm/responses/Profiles_Meta.yaml @@ -0,0 +1,12 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + profiles: + type: array + items: + $ref: '../schemas/GET/Profile.yaml' + _metadata: + $ref: '../schemas/Metadata.yaml' \ No newline at end of file diff --git a/nerm/responses/RiskLevel.yaml b/nerm/responses/RiskLevel.yaml new file mode 100644 index 0000000..0dcbce5 --- /dev/null +++ b/nerm/responses/RiskLevel.yaml @@ -0,0 +1,9 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + risk_level: + type: object + $ref: '../schemas/GET/RiskLevel.yaml' \ No newline at end of file diff --git a/nerm/responses/RiskLevels_Meta.yaml b/nerm/responses/RiskLevels_Meta.yaml new file mode 100644 index 0000000..4e91089 --- /dev/null +++ b/nerm/responses/RiskLevels_Meta.yaml @@ -0,0 +1,12 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + risk_levels: + type: array + items: + $ref: '../schemas/GET/RiskLevel.yaml' + _metadata: + $ref: '../schemas/Metadata.yaml' \ No newline at end of file diff --git a/nerm/responses/RiskScore.yaml b/nerm/responses/RiskScore.yaml new file mode 100644 index 0000000..8189858 --- /dev/null +++ b/nerm/responses/RiskScore.yaml @@ -0,0 +1,9 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + risk_score: + type: object + $ref: '../schemas/GET/RiskScore.yaml' \ No newline at end of file diff --git a/nerm/responses/RiskScores.yaml b/nerm/responses/RiskScores.yaml new file mode 100644 index 0000000..9b422a1 --- /dev/null +++ b/nerm/responses/RiskScores.yaml @@ -0,0 +1,12 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + risk_scores: + type: array + items: + $ref: '../schemas/GET/RiskScore.yaml' + _metadata: + $ref: '../schemas/Metadata.yaml' \ No newline at end of file diff --git a/nerm/responses/Role.yaml b/nerm/responses/Role.yaml new file mode 100644 index 0000000..e600861 --- /dev/null +++ b/nerm/responses/Role.yaml @@ -0,0 +1,9 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + role: + type: object + $ref: '../schemas/GET/Role.yaml' \ No newline at end of file diff --git a/nerm/responses/RoleProfile.yaml b/nerm/responses/RoleProfile.yaml new file mode 100644 index 0000000..791126d --- /dev/null +++ b/nerm/responses/RoleProfile.yaml @@ -0,0 +1,9 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + role_profile: + type: object + $ref: '../schemas/GET/RoleProfile.yaml' \ No newline at end of file diff --git a/nerm/responses/RoleProfiles.yaml b/nerm/responses/RoleProfiles.yaml new file mode 100644 index 0000000..15e2487 --- /dev/null +++ b/nerm/responses/RoleProfiles.yaml @@ -0,0 +1,10 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + role_profiles: + type: array + items: + $ref: '../schemas/GET/RoleProfile.yaml' \ No newline at end of file diff --git a/nerm/responses/RoleProfilesJob.yaml b/nerm/responses/RoleProfilesJob.yaml new file mode 100644 index 0000000..d59230d --- /dev/null +++ b/nerm/responses/RoleProfilesJob.yaml @@ -0,0 +1,7 @@ +description: Expected response to a valid request +content: + application/json: + schema: + oneOf: + - $ref: '../schemas/GET/RoleProfiles.yaml' + - $ref: '../schemas/Job.yaml' \ No newline at end of file diff --git a/nerm/responses/RoleProfiles_Meta.yaml b/nerm/responses/RoleProfiles_Meta.yaml new file mode 100644 index 0000000..b534baa --- /dev/null +++ b/nerm/responses/RoleProfiles_Meta.yaml @@ -0,0 +1,12 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + role_profiles: + type: array + items: + $ref: '../schemas/GET/RoleProfile.yaml' + _metadata: + $ref: '../schemas/Metadata.yaml' \ No newline at end of file diff --git a/nerm/responses/RolesJob.yaml b/nerm/responses/RolesJob.yaml new file mode 100644 index 0000000..13c17fe --- /dev/null +++ b/nerm/responses/RolesJob.yaml @@ -0,0 +1,7 @@ +description: Expected response to a valid request +content: + application/json: + schema: + oneOf: + - $ref: '../schemas/GET/Roles.yaml' + - $ref: '../schemas/Job.yaml' \ No newline at end of file diff --git a/nerm/responses/Roles_Meta.yaml b/nerm/responses/Roles_Meta.yaml new file mode 100644 index 0000000..15ebcad --- /dev/null +++ b/nerm/responses/Roles_Meta.yaml @@ -0,0 +1,12 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + roles: + type: array + items: + $ref: '../schemas/GET/Role.yaml' + _metadata: + $ref: '../schemas/Metadata.yaml' \ No newline at end of file diff --git a/nerm/responses/Url.yaml b/nerm/responses/Url.yaml new file mode 100644 index 0000000..327c8c5 --- /dev/null +++ b/nerm/responses/Url.yaml @@ -0,0 +1,5 @@ +description: Expected response to a valid request +content: + application/json: + schema: + $ref: "../schemas/Url.yaml" \ No newline at end of file diff --git a/nerm/responses/User.yaml b/nerm/responses/User.yaml new file mode 100644 index 0000000..de40bad --- /dev/null +++ b/nerm/responses/User.yaml @@ -0,0 +1,9 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + user: + type: object + $ref: '../schemas/GET/User.yaml' \ No newline at end of file diff --git a/nerm/responses/UserManager.yaml b/nerm/responses/UserManager.yaml new file mode 100644 index 0000000..d21c355 --- /dev/null +++ b/nerm/responses/UserManager.yaml @@ -0,0 +1,9 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + user_manager: + type: object + $ref: '../schemas/GET/UserManager.yaml' \ No newline at end of file diff --git a/nerm/responses/UserManagersJob.yaml b/nerm/responses/UserManagersJob.yaml new file mode 100644 index 0000000..48f7552 --- /dev/null +++ b/nerm/responses/UserManagersJob.yaml @@ -0,0 +1,7 @@ +description: Expected response to a valid request +content: + application/json: + schema: + oneOf: + - $ref: '../schemas/Job.yaml' + - $ref: '../schemas/GET/UserManagers.yaml' \ No newline at end of file diff --git a/nerm/responses/UserManagers_Meta.yaml b/nerm/responses/UserManagers_Meta.yaml new file mode 100644 index 0000000..85bc9d1 --- /dev/null +++ b/nerm/responses/UserManagers_Meta.yaml @@ -0,0 +1,12 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + user_managers: + type: array + items: + $ref: '../schemas/GET/UserManager.yaml' + _metadata: + $ref: '../schemas/Metadata.yaml' \ No newline at end of file diff --git a/nerm/responses/UserProfile.yaml b/nerm/responses/UserProfile.yaml new file mode 100644 index 0000000..3d243f5 --- /dev/null +++ b/nerm/responses/UserProfile.yaml @@ -0,0 +1,9 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + user_profile: + type: object + $ref: '../schemas/GET/UserProfile.yaml' \ No newline at end of file diff --git a/nerm/responses/UserProfiles.yaml b/nerm/responses/UserProfiles.yaml new file mode 100644 index 0000000..2cf068d --- /dev/null +++ b/nerm/responses/UserProfiles.yaml @@ -0,0 +1,10 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + user_profiles: + type: array + items: + $ref: '../schemas/GET/UserProfile.yaml' \ No newline at end of file diff --git a/nerm/responses/UserProfilesJob.yaml b/nerm/responses/UserProfilesJob.yaml new file mode 100644 index 0000000..ebe071e --- /dev/null +++ b/nerm/responses/UserProfilesJob.yaml @@ -0,0 +1,7 @@ +description: Expected response to a valid request +content: + application/json: + schema: + oneOf: + - $ref: '../schemas/GET/UserProfiles.yaml' + - $ref: '../schemas/Job.yaml' \ No newline at end of file diff --git a/nerm/responses/UserProfiles_Meta.yaml b/nerm/responses/UserProfiles_Meta.yaml new file mode 100644 index 0000000..76efc87 --- /dev/null +++ b/nerm/responses/UserProfiles_Meta.yaml @@ -0,0 +1,12 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + user_profiles: + type: array + items: + $ref: '../schemas/GET/UserProfile.yaml' + _metadata: + $ref: '../schemas/Metadata.yaml' \ No newline at end of file diff --git a/nerm/responses/UserRole.yaml b/nerm/responses/UserRole.yaml new file mode 100644 index 0000000..0b73dbd --- /dev/null +++ b/nerm/responses/UserRole.yaml @@ -0,0 +1,9 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + user_role: + type: object + $ref: '../schemas/GET/UserRole.yaml' \ No newline at end of file diff --git a/nerm/responses/UserRoles.yaml b/nerm/responses/UserRoles.yaml new file mode 100644 index 0000000..62c09b3 --- /dev/null +++ b/nerm/responses/UserRoles.yaml @@ -0,0 +1,10 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + user_roles: + type: array + items: + $ref: '../schemas/GET/UserRole.yaml' \ No newline at end of file diff --git a/nerm/responses/UserRolesJob.yaml b/nerm/responses/UserRolesJob.yaml new file mode 100644 index 0000000..e3f732b --- /dev/null +++ b/nerm/responses/UserRolesJob.yaml @@ -0,0 +1,7 @@ +description: Expected response to a valid request +content: + application/json: + schema: + oneOf: + - $ref: '../schemas/GET/UserRoles.yaml' + - $ref: '../schemas/Job.yaml' \ No newline at end of file diff --git a/nerm/responses/UserRoles_Meta.yaml b/nerm/responses/UserRoles_Meta.yaml new file mode 100644 index 0000000..8b8bce1 --- /dev/null +++ b/nerm/responses/UserRoles_Meta.yaml @@ -0,0 +1,12 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + user_roles: + type: array + items: + $ref: '../schemas/GET/UserRole.yaml' + _metadata: + $ref: '../schemas/Metadata.yaml' \ No newline at end of file diff --git a/nerm/responses/UsersJob.yaml b/nerm/responses/UsersJob.yaml new file mode 100644 index 0000000..18d7e26 --- /dev/null +++ b/nerm/responses/UsersJob.yaml @@ -0,0 +1,7 @@ +description: Expected response to a valid request +content: + application/json: + schema: + oneOf: + - $ref: '../schemas/GET/Users.yaml' + - $ref: '../schemas/Job.yaml' \ No newline at end of file diff --git a/nerm/responses/Users_Meta.yaml b/nerm/responses/Users_Meta.yaml new file mode 100644 index 0000000..37a6913 --- /dev/null +++ b/nerm/responses/Users_Meta.yaml @@ -0,0 +1,12 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + users: + type: array + items: + $ref: '../schemas/GET/User.yaml' + _metadata: + $ref: '../schemas/Metadata.yaml' \ No newline at end of file diff --git a/nerm/responses/ValidationErrors.yaml b/nerm/responses/ValidationErrors.yaml new file mode 100644 index 0000000..719b4f1 --- /dev/null +++ b/nerm/responses/ValidationErrors.yaml @@ -0,0 +1,7 @@ +type: object +properties: + error: + example: "The failed to create/update" + errors: + example: + attribute: "can't be blank" \ No newline at end of file diff --git a/nerm/responses/WorkflowSession.yaml b/nerm/responses/WorkflowSession.yaml new file mode 100644 index 0000000..bbe4d90 --- /dev/null +++ b/nerm/responses/WorkflowSession.yaml @@ -0,0 +1,9 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + workflow_session: + type: object + $ref: '../schemas/GET/WorkflowSession.yaml' \ No newline at end of file diff --git a/nerm/responses/WorkflowSessions.yaml b/nerm/responses/WorkflowSessions.yaml new file mode 100644 index 0000000..1e53862 --- /dev/null +++ b/nerm/responses/WorkflowSessions.yaml @@ -0,0 +1,10 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + workflow_sessions: + type: array + items: + $ref: '../schemas/GET/WorkflowSession.yaml' \ No newline at end of file diff --git a/nerm/responses/WorkflowSessions_Meta.yaml b/nerm/responses/WorkflowSessions_Meta.yaml new file mode 100644 index 0000000..69bece6 --- /dev/null +++ b/nerm/responses/WorkflowSessions_Meta.yaml @@ -0,0 +1,12 @@ +description: Expected response to a valid request +content: + application/json: + schema: + type: object + properties: + workflow_sessions: + type: array + items: + $ref: '../schemas/GET/WorkflowSession.yaml' + _metadata: + $ref: '../schemas/Metadata.yaml' \ No newline at end of file diff --git a/nerm/responses/_index.yaml b/nerm/responses/_index.yaml new file mode 100644 index 0000000..0fae492 --- /dev/null +++ b/nerm/responses/_index.yaml @@ -0,0 +1,63 @@ +# 200 +User: + $ref: './User.yaml' +Users: + $ref: './Users.yaml' +UserManager: + $ref: './UserManager.yaml' +UserManagers: + $ref: './UserManagers.yaml' +UserRole: + $ref: './UserRole.yaml' +UserRoles: + $ref: './UserRoles.yaml' +Attribute: + $ref: './Attribute.yaml' +Attributes: + $ref: './Attributes.yaml' +AttributeOption: + $ref: './AttributeOption.yaml' +AttributeOptions: + $ref: './AttributeOptions.yaml' +ProfileType: + $ref: './ProfileType.yaml' +ProfileTypes: + $ref: './ProfileTypes.yaml' +Profile: + $ref: './Profile.yaml' +Profiles: + $ref: './Profiles.yaml' +RiskScore: + $ref: './RiskScore.yaml' +RiskScores: + $ref: './RiskScores.yaml' +RiskLevel: + $ref: './RiskLevel.yaml' +RiskLevels: + $ref: './RiskLevels.yaml' +UserProfile: + $ref: './UserProfile.yaml' +UserProfiles: + $ref: './UserProfiles.yaml' +RoleProfile: + $ref: './RoleProfile.yaml' +RoleProfiles: + $ref: './RoleProfiles.yaml' +WorkflowSession: + $ref: './WorkflowSession.yaml' +WorkflowSessions: + $ref: './WorkflowSessions.yaml' +IdentityProofingResults: + $ref: './IdentityProofingResults.yaml' +AdvancedSearch: + $ref: './AdvancedSearch.yaml' +AdvancedSearches: + $ref: './AdvancedSearches.yaml' +# Special +Url: + $ref: './Url.yaml' +DeleteConfirmation: + $ref: './DeleteConfirmation.yaml' +# 405 +InvalidInput: + $ref: './InvalidInput.yaml' \ No newline at end of file diff --git a/nerm/schemas/GET/AdvancedSearch.yaml b/nerm/schemas/GET/AdvancedSearch.yaml new file mode 100644 index 0000000..488d7c6 --- /dev/null +++ b/nerm/schemas/GET/AdvancedSearch.yaml @@ -0,0 +1,24 @@ +type: object +properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + label: + type: string + condition_rules_attributes: + type: array + items: + anyOf: + - $ref: "./ProfileTypeRule.yaml" + - $ref: "./ProfileStatusRule.yaml" + - $ref: "./ProfileAttributeRuleString.yaml" + - $ref: "./ProfileAttributeRuleDate.yaml" + - $ref: "./ProfileAttributeRuleId.yaml" + - $ref: "./RiskRule.yaml" + diff --git a/nerm/schemas/GET/Attribute.yaml b/nerm/schemas/GET/Attribute.yaml new file mode 100644 index 0000000..f87dd0c --- /dev/null +++ b/nerm/schemas/GET/Attribute.yaml @@ -0,0 +1,70 @@ +type: object +properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + label: + type: string + description: + type: string + tool_tip: + type: string + crypt: + type: boolean + archived: + type: boolean + archived_on: + type: string + format: date-time + readOnly: true + created_at: + type: string + format: date-time + readOnly: true + updated_at: + type: string + format: date-time + readOnly: true + date_format: + type: string + enum: [mm/dd/yyyy, mm-dd-yyyy, dd/mm/yyyy, dd-mm-yyyy, yyyy/mm/dd, yyyy-mm-dd] + selectable_status: + type: string + risk_score_setting: + type: string + risk_type: + type: string + ownership_driver: + type: boolean + allow_multiple_selections: + type: boolean + filtered_by_ne_attribute: + type: boolean + filtering_ne_attribute_id: + type: string + format: uuid + ne_attribute_filter_id: + type: string + format: uuid + reverse_association_attribute_id: + type: string + format: uuid + profile_type_id: + type: string + format: uuid + legacy_id: + type: integer + tmp_created_at: + type: string + format: date-time + readOnly: true + tmp_updated_at: + type: string + format: date-time + readOnly: true \ No newline at end of file diff --git a/nerm/schemas/GET/AttributeOption.yaml b/nerm/schemas/GET/AttributeOption.yaml new file mode 100644 index 0000000..a9e909d --- /dev/null +++ b/nerm/schemas/GET/AttributeOption.yaml @@ -0,0 +1,16 @@ +type: object +properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + ne_attribute_id: + type: string + format: uuid + option: + type: string \ No newline at end of file diff --git a/nerm/schemas/GET/AttributeOptions.yaml b/nerm/schemas/GET/AttributeOptions.yaml new file mode 100644 index 0000000..f38fb3f --- /dev/null +++ b/nerm/schemas/GET/AttributeOptions.yaml @@ -0,0 +1,6 @@ +type: object +properties: + ne_attribute_options: + type: array + items: + $ref: '../GET/AttributeOption.yaml' \ No newline at end of file diff --git a/nerm/schemas/GET/IdentityProofingResult.yaml b/nerm/schemas/GET/IdentityProofingResult.yaml new file mode 100644 index 0000000..dca88f1 --- /dev/null +++ b/nerm/schemas/GET/IdentityProofingResult.yaml @@ -0,0 +1,33 @@ +type: object +properties: + id: + type: string + format: uuid + readOnly: true + identity_proofing_action_id: + type: string + format: uuid + workflow_session_id: + type: string + format: uuid + profile_id: + type: string + format: uuid + proofing_workflow: + type: string + format: uuid + result: + type: string + enum: [pending, pass, fail] + proofing_attributes: + type: object + additionalProperties: + type: string + example: + result: approve + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time \ No newline at end of file diff --git a/nerm/schemas/GET/Profile.yaml b/nerm/schemas/GET/Profile.yaml new file mode 100644 index 0000000..98cb335 --- /dev/null +++ b/nerm/schemas/GET/Profile.yaml @@ -0,0 +1,39 @@ +type: object +properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + name: + type: string + profile_type_id: + type: string + format: uuid + status: + type: string + enum: [Active, Inactive, On Leave, Terminated] + id_proofing_status: + type: string + enum: [pending, pass, fail] + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + attributes: + type: object + 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 diff --git a/nerm/schemas/GET/ProfileAttributeRuleDate.yaml b/nerm/schemas/GET/ProfileAttributeRuleDate.yaml new file mode 100644 index 0000000..60f510a --- /dev/null +++ b/nerm/schemas/GET/ProfileAttributeRuleDate.yaml @@ -0,0 +1,45 @@ +type: object +properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + type: + type: string + required: true + enum: [ProfileAttributeRule] + condition_object_type: + type: string + required: true + enum: [DateAttribute] + condition_object_id: + type: string + format: uuid + secondary_attribute_type: + type: string + enum: [DateAttribute] + secondary_attribute_id: + type: string + format: uuid + comparison_operator: + type: string + enum: ['>', '<', 'after', 'before'] + value: + type: string + required: true + enum: ['Today', ''] + secondary_value: + type: string + enum: ['after', 'before'] + tertiary_value: + type: string + example: 30 + + + + diff --git a/nerm/schemas/GET/ProfileAttributeRuleId.yaml b/nerm/schemas/GET/ProfileAttributeRuleId.yaml new file mode 100644 index 0000000..f5044e0 --- /dev/null +++ b/nerm/schemas/GET/ProfileAttributeRuleId.yaml @@ -0,0 +1,31 @@ +type: object +properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + type: + type: string + required: true + enum: [ProfileAttributeRule] + condition_object_type: + type: string + required: true + enum: [ProfileSelectAttribute, ProfileSearchAttribute, OwnerSelectAttribute, OwnerSearchAttribute, ContributorSelectAttribute, ContributorSearchAttribute] + condition_object_id: + type: string + required: true + format: uuid + comparison_operator: + type: string + required: true + enum: ['include?', 'exclude?'] + value: + type: string + required: true + format: uuid diff --git a/nerm/schemas/GET/ProfileAttributeRuleString.yaml b/nerm/schemas/GET/ProfileAttributeRuleString.yaml new file mode 100644 index 0000000..27d2d63 --- /dev/null +++ b/nerm/schemas/GET/ProfileAttributeRuleString.yaml @@ -0,0 +1,31 @@ +type: object +properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + type: + type: string + required: true + enum: [ProfileAttributeRule] + condition_object_type: + type: string + required: true + enum: [TextFieldAttribute, TextAreaAttribute] + condition_object_id: + type: string + required: true + format: uuid + comparison_operator: + type: string + required: true + enum: ['==', '!=', '>', '<', 'start_with?', 'end_with?', 'include?'] + value: + type: string + required: true + example: Some value diff --git a/nerm/schemas/GET/ProfileStatusRule.yaml b/nerm/schemas/GET/ProfileStatusRule.yaml new file mode 100644 index 0000000..d0ed664 --- /dev/null +++ b/nerm/schemas/GET/ProfileStatusRule.yaml @@ -0,0 +1,22 @@ +type: object +properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + type: + type: string + required: true + enum: [ProfileStatusRule] + comparison_operator: + type: string + enum: ['==', '!='] + value: + type: string + enum: [Active, Inactive, Leave of absence, Terminated] + \ No newline at end of file diff --git a/nerm/schemas/GET/ProfileType.yaml b/nerm/schemas/GET/ProfileType.yaml new file mode 100644 index 0000000..1b88fc1 --- /dev/null +++ b/nerm/schemas/GET/ProfileType.yaml @@ -0,0 +1,61 @@ +type: object +properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + name: + type: string + bypass_dup_protection: + type: boolean + archived: + type: boolean + permitted_role_ids: + type: array + items: + type: string + format: uuid + profile_type_dup_attributes: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + uid: + type: string + minLength: 32 + maxLength: 32 + profile_type_id: + type: string + format: uuid + ne_attribute_id: + type: string + format: uuid + profile_type_namings: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + uid: + type: string + minLength: 32 + maxLength: 32 + profile_type_id: + type: string + format: uuid + ne_attribute_id: + type: string + format: uuid + order: + type: integer + minimum: 0 diff --git a/nerm/schemas/GET/ProfileTypeRule.yaml b/nerm/schemas/GET/ProfileTypeRule.yaml new file mode 100644 index 0000000..d6174cb --- /dev/null +++ b/nerm/schemas/GET/ProfileTypeRule.yaml @@ -0,0 +1,22 @@ +type: object +properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + type: + type: string + required: true + enum: [ProfileTypeRule] + comparison_operator: + type: string + enum: ['==', '!='] + value: + type: string + format: uuid + \ No newline at end of file diff --git a/nerm/schemas/GET/Profiles.yaml b/nerm/schemas/GET/Profiles.yaml new file mode 100644 index 0000000..396514f --- /dev/null +++ b/nerm/schemas/GET/Profiles.yaml @@ -0,0 +1,6 @@ +type: object +properties: + profiles: + type: array + items: + $ref: '../GET/Profile.yaml' \ No newline at end of file diff --git a/nerm/schemas/GET/RiskLevel.yaml b/nerm/schemas/GET/RiskLevel.yaml new file mode 100644 index 0000000..1b3736a --- /dev/null +++ b/nerm/schemas/GET/RiskLevel.yaml @@ -0,0 +1,19 @@ +type: object +properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + label: + type: string + points: + type: number + multipleOf: 0.01 + order: + type: integer + minimum: 0 \ No newline at end of file diff --git a/nerm/schemas/GET/RiskRule.yaml b/nerm/schemas/GET/RiskRule.yaml new file mode 100644 index 0000000..177fc91 --- /dev/null +++ b/nerm/schemas/GET/RiskRule.yaml @@ -0,0 +1,27 @@ +type: object +properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + type: + type: string + required: true + enum: [RiskRule] + comparison_operator: + type: string + enum: ['==', '>', '<'] + value: + type: string + summary: id of the Risk Level being compared against + required: true + format: uuid + secondary_value: + type: string + required: true + enum: [OverallRisk] diff --git a/nerm/schemas/GET/RiskScore.yaml b/nerm/schemas/GET/RiskScore.yaml new file mode 100644 index 0000000..929d381 --- /dev/null +++ b/nerm/schemas/GET/RiskScore.yaml @@ -0,0 +1,35 @@ +type: object +properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + object_id: + type: string + format: uuid + object_type: + type: string + enum: [Profile, WorkflowSession] + overall_score: + type: number + multipleOf: 0.01 + overall_risk_level_id: + type: string + format: uuid + impact_score: + type: number + multipleOf: 0.01 + impact_risk_level_id: + type: string + format: uuid + probability_score: + type: number + multipleOf: 0.01 + probability_risk_level_id: + type: string + format: uuid \ No newline at end of file diff --git a/nerm/schemas/GET/Role.yaml b/nerm/schemas/GET/Role.yaml new file mode 100644 index 0000000..359eca3 --- /dev/null +++ b/nerm/schemas/GET/Role.yaml @@ -0,0 +1,20 @@ +type: object +properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + example: "sponsors_role" + name: + type: string + example: "Sponsors" + groups: + type: array + items: + type: string + example: "ad_group_name" \ No newline at end of file diff --git a/nerm/schemas/GET/RoleProfile.yaml b/nerm/schemas/GET/RoleProfile.yaml new file mode 100644 index 0000000..e20debd --- /dev/null +++ b/nerm/schemas/GET/RoleProfile.yaml @@ -0,0 +1,17 @@ +type: object +properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + role_id: + type: string + format: uuid + profile_id: + type: string + format: uuid \ No newline at end of file diff --git a/nerm/schemas/GET/RoleProfiles.yaml b/nerm/schemas/GET/RoleProfiles.yaml new file mode 100644 index 0000000..0577d72 --- /dev/null +++ b/nerm/schemas/GET/RoleProfiles.yaml @@ -0,0 +1,6 @@ +type: object +properties: + role_profiles: + type: array + items: + $ref: '../GET/RoleProfile.yaml' \ No newline at end of file diff --git a/nerm/schemas/GET/Roles.yaml b/nerm/schemas/GET/Roles.yaml new file mode 100644 index 0000000..d9205af --- /dev/null +++ b/nerm/schemas/GET/Roles.yaml @@ -0,0 +1,6 @@ +type: object +properties: + roles: + type: array + items: + $ref: '../GET/Role.yaml' \ No newline at end of file diff --git a/nerm/schemas/GET/User.yaml b/nerm/schemas/GET/User.yaml new file mode 100644 index 0000000..e3941ae --- /dev/null +++ b/nerm/schemas/GET/User.yaml @@ -0,0 +1,37 @@ +type: object +properties: + id: + type: string + format: uuid + readonly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readonly: true + name: + type: string + email: + type: string + format: email + type: + type: string + enum: [NeprofileUser, NeaccessUser] + default: NeprofileUser + title: + type: string + status: + type: string + enum: [Active, Disabled] + login: + type: string + last_login: + type: string + format: date-time + readOnly: true + cookies_accepted_at: + type: string + format: date-time + readOnly: true + preferred_language: + type: string \ No newline at end of file diff --git a/nerm/schemas/GET/UserManager.yaml b/nerm/schemas/GET/UserManager.yaml new file mode 100644 index 0000000..29adf82 --- /dev/null +++ b/nerm/schemas/GET/UserManager.yaml @@ -0,0 +1,17 @@ +type: object +properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + user_id: + type: string + format: uuid + manager_id: + type: string + format: uuid \ No newline at end of file diff --git a/nerm/schemas/GET/UserManagers.yaml b/nerm/schemas/GET/UserManagers.yaml new file mode 100644 index 0000000..2dcff40 --- /dev/null +++ b/nerm/schemas/GET/UserManagers.yaml @@ -0,0 +1,6 @@ +type: object +properties: + user_managers: + type: array + items: + $ref: '../GET/UserManager.yaml' \ No newline at end of file diff --git a/nerm/schemas/GET/UserProfile.yaml b/nerm/schemas/GET/UserProfile.yaml new file mode 100644 index 0000000..c9a9f6b --- /dev/null +++ b/nerm/schemas/GET/UserProfile.yaml @@ -0,0 +1,23 @@ +type: object +properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + user_id: + type: string + format: uuid + profile_id: + type: string + format: uuid + ne_attribute_id: + type: string + format: uuid + relationship_type: + type: string + enum: [owner, contributor] \ No newline at end of file diff --git a/nerm/schemas/GET/UserProfiles.yaml b/nerm/schemas/GET/UserProfiles.yaml new file mode 100644 index 0000000..48e42dd --- /dev/null +++ b/nerm/schemas/GET/UserProfiles.yaml @@ -0,0 +1,6 @@ +type: object +properties: + user_profiles: + type: array + items: + $ref: '../GET/UserProfile.yaml' \ No newline at end of file diff --git a/nerm/schemas/GET/UserRole.yaml b/nerm/schemas/GET/UserRole.yaml new file mode 100644 index 0000000..93f7378 --- /dev/null +++ b/nerm/schemas/GET/UserRole.yaml @@ -0,0 +1,17 @@ +type: object +properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + user_id: + type: string + format: uuid + role_id: + type: string + format: uuid \ No newline at end of file diff --git a/nerm/schemas/GET/UserRoles.yaml b/nerm/schemas/GET/UserRoles.yaml new file mode 100644 index 0000000..fe14e78 --- /dev/null +++ b/nerm/schemas/GET/UserRoles.yaml @@ -0,0 +1,6 @@ +type: object +properties: + user_roles: + type: array + items: + $ref: '../GET/UserRole.yaml' \ No newline at end of file diff --git a/nerm/schemas/GET/Users.yaml b/nerm/schemas/GET/Users.yaml new file mode 100644 index 0000000..395cdec --- /dev/null +++ b/nerm/schemas/GET/Users.yaml @@ -0,0 +1,6 @@ +type: object +properties: + users: + type: array + items: + $ref: '../GET/User.yaml' \ No newline at end of file diff --git a/nerm/schemas/GET/WorkflowSession.yaml b/nerm/schemas/GET/WorkflowSession.yaml new file mode 100644 index 0000000..786dcef --- /dev/null +++ b/nerm/schemas/GET/WorkflowSession.yaml @@ -0,0 +1,45 @@ +type: object +properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + workflow_id: + type: string + format: uuid + requester_id: + type: string + format: uuid + requester_type: + type: string + enum: [User, NeprofileUser, NeaccessUser] + profile_id: + type: string + format: uuid + description: The profile this workflow session will be working with. Only Applicable for Update workflows + profile_ids: + type: array + items: + type: string + format: uuid + 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 + attributes: + type: object + 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 diff --git a/nerm/schemas/Job.yaml b/nerm/schemas/Job.yaml new file mode 100644 index 0000000..9b38b72 --- /dev/null +++ b/nerm/schemas/Job.yaml @@ -0,0 +1,17 @@ +type: object +properties: + info: + type: string + example: "job has started" + job_status: + type: object + properties: + job_id: + type: string + example: "3ce88e47ad6dba2ddf349d21" + status: + type: string + example: "queued" + status: + type: int + example: 200 \ No newline at end of file diff --git a/nerm/schemas/Metadata.yaml b/nerm/schemas/Metadata.yaml new file mode 100644 index 0000000..aab30cd --- /dev/null +++ b/nerm/schemas/Metadata.yaml @@ -0,0 +1,14 @@ +type: object +properties: + limit: + type: integer + offset: + type: integer + total: + type: integer + next: + type: string + example: /endpoint?limit=10&offset=60 + previous: + type: string + example: /endpoint?limit=10&offset=40 \ No newline at end of file diff --git a/nerm/schemas/PATCH/AdvancedSearch.yaml b/nerm/schemas/PATCH/AdvancedSearch.yaml new file mode 100644 index 0000000..57a8d14 --- /dev/null +++ b/nerm/schemas/PATCH/AdvancedSearch.yaml @@ -0,0 +1,17 @@ +type: object +properties: + id: + type: string + format: uuid + label: + type: string + condition_rules_attributes: + type: array + items: + anyOf: + - $ref: "./ProfileTypeRule.yaml" + - $ref: "./ProfileStatusRule.yaml" + - $ref: "./ProfileAttributeRuleString.yaml" + - $ref: "./ProfileAttributeRuleDate.yaml" + - $ref: "./ProfileAttributeRuleId.yaml" + - $ref: "./RiskRule.yaml" diff --git a/nerm/schemas/PATCH/AttributeOption.yaml b/nerm/schemas/PATCH/AttributeOption.yaml new file mode 100644 index 0000000..303e9c1 --- /dev/null +++ b/nerm/schemas/PATCH/AttributeOption.yaml @@ -0,0 +1,7 @@ +type: object +properties: + ne_attribute_id: + type: string + format: uuid + option: + type: string \ No newline at end of file diff --git a/nerm/schemas/PATCH/AttributeOptions.yaml b/nerm/schemas/PATCH/AttributeOptions.yaml new file mode 100644 index 0000000..36cf6ac --- /dev/null +++ b/nerm/schemas/PATCH/AttributeOptions.yaml @@ -0,0 +1,10 @@ +type: object +properties: + id: + type: string + format: uuid + ne_attribute_id: + type: string + format: uuid + option: + type: string \ No newline at end of file diff --git a/nerm/schemas/PATCH/Profile.yaml b/nerm/schemas/PATCH/Profile.yaml new file mode 100644 index 0000000..0a4c5f6 --- /dev/null +++ b/nerm/schemas/PATCH/Profile.yaml @@ -0,0 +1,27 @@ +type: object +properties: + name: + type: string + profile_type_id: + type: string + format: uuid + status: + type: string + enum: [Active, Inactive, On Leave, Terminated] + id_proofing_status: + type: string + enum: [pending, pass, fail] + archived: + type: boolean + default: false + attributes: + type: object + 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 diff --git a/nerm/schemas/PATCH/ProfileAttributeRuleDate.yaml b/nerm/schemas/PATCH/ProfileAttributeRuleDate.yaml new file mode 100644 index 0000000..324dc9b --- /dev/null +++ b/nerm/schemas/PATCH/ProfileAttributeRuleDate.yaml @@ -0,0 +1,48 @@ +type: object +properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + type: + type: string + required: true + enum: [ProfileAttributeRule] + condition_object_type: + type: string + required: true + enum: [DateAttribute] + condition_object_id: + type: string + format: uuid + secondary_attribute_type: + type: string + enum: [DateAttribute] + secondary_attribute_id: + type: string + format: uuid + comparison_operator: + type: string + enum: ['>', '<', 'after', 'before'] + value: + type: string + required: true + enum: ['Today', ''] + secondary_value: + type: string + enum: ['after', 'before'] + tertiary_value: + type: string + example: 30 + _destroy: + type: boolean + default: false + + + + diff --git a/nerm/schemas/PATCH/ProfileAttributeRuleId.yaml b/nerm/schemas/PATCH/ProfileAttributeRuleId.yaml new file mode 100644 index 0000000..6803852 --- /dev/null +++ b/nerm/schemas/PATCH/ProfileAttributeRuleId.yaml @@ -0,0 +1,34 @@ +type: object +properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + type: + type: string + required: true + enum: [ProfileAttributeRule] + condition_object_type: + type: string + required: true + enum: [ProfileSelectAttribute, ProfileSearchAttribute, OwnerSelectAttribute, OwnerSearchAttribute, ContributorSelectAttribute, ContributorSearchAttribute] + condition_object_id: + type: string + required: true + format: uuid + comparison_operator: + type: string + required: true + enum: ['include?', 'exclude?'] + value: + type: string + required: true + format: uuid + _destroy: + type: boolean + default: false diff --git a/nerm/schemas/PATCH/ProfileAttributeRuleString.yaml b/nerm/schemas/PATCH/ProfileAttributeRuleString.yaml new file mode 100644 index 0000000..e9b4a3b --- /dev/null +++ b/nerm/schemas/PATCH/ProfileAttributeRuleString.yaml @@ -0,0 +1,34 @@ +type: object +properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + type: + type: string + required: true + enum: [ProfileAttributeRule] + condition_object_type: + type: string + required: true + enum: [TextFieldAttribute, TextAreaAttribute] + condition_object_id: + type: string + required: true + format: uuid + comparison_operator: + type: string + required: true + enum: ['==', '!=', '>', '<', 'start_with?', 'end_with?', 'include?'] + value: + type: string + required: true + example: Some value + _destroy: + type: boolean + default: false diff --git a/nerm/schemas/PATCH/ProfileStatusRule.yaml b/nerm/schemas/PATCH/ProfileStatusRule.yaml new file mode 100644 index 0000000..969676c --- /dev/null +++ b/nerm/schemas/PATCH/ProfileStatusRule.yaml @@ -0,0 +1,20 @@ +type: object +properties: + id: + type: string + format: uuid + readOnly: true + type: + type: string + required: true + enum: [ProfileStatusRule] + comparison_operator: + type: string + enum: ['==', '!='] + value: + type: string + enum: [Active, Inactive, Leave of absence, Terminated] + _destroy: + type: boolean + default: false + \ No newline at end of file diff --git a/nerm/schemas/PATCH/ProfileType.yaml b/nerm/schemas/PATCH/ProfileType.yaml new file mode 100644 index 0000000..935d9bf --- /dev/null +++ b/nerm/schemas/PATCH/ProfileType.yaml @@ -0,0 +1,52 @@ +type: object +properties: + name: + type: string + bypass_dup_protection: + type: boolean + archived: + type: boolean + permitted_role_ids: + type: array + items: + type: string + format: uuid + profile_type_dup_attributes: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + uid: + type: string + minLength: 32 + maxLength: 32 + profile_type_id: + type: string + format: uuid + ne_attribute_id: + type: string + format: uuid + profile_type_namings: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + uid: + type: string + minLength: 32 + maxLength: 32 + profile_type_id: + type: string + format: uuid + ne_attribute_id: + type: string + format: uuid + order: + type: integer + minimum: 0 diff --git a/nerm/schemas/PATCH/ProfileTypeRule.yaml b/nerm/schemas/PATCH/ProfileTypeRule.yaml new file mode 100644 index 0000000..2d15111 --- /dev/null +++ b/nerm/schemas/PATCH/ProfileTypeRule.yaml @@ -0,0 +1,20 @@ +type: object +properties: + id: + type: string + format: uuid + readOnly: true + type: + type: string + required: true + enum: [ProfileTypeRule] + comparison_operator: + type: string + enum: ['==', '!='] + value: + type: string + format: uuid + _destroy: + type: boolean + default: false + \ No newline at end of file diff --git a/nerm/schemas/PATCH/Profiles.yaml b/nerm/schemas/PATCH/Profiles.yaml new file mode 100644 index 0000000..caab35a --- /dev/null +++ b/nerm/schemas/PATCH/Profiles.yaml @@ -0,0 +1,30 @@ +type: object +properties: + id: + type: string + format: uuid + name: + type: string + profile_type_id: + type: string + format: uuid + status: + type: string + enum: [Active, Inactive, On Leave, Terminated] + id_proofing_status: + type: string + enum: [pending, pass, fail] + archived: + type: boolean + default: false + attributes: + type: object + 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 diff --git a/nerm/schemas/PATCH/RiskRule.yaml b/nerm/schemas/PATCH/RiskRule.yaml new file mode 100644 index 0000000..21b67c2 --- /dev/null +++ b/nerm/schemas/PATCH/RiskRule.yaml @@ -0,0 +1,30 @@ +type: object +properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + type: + type: string + required: true + enum: [RiskRule] + comparison_operator: + type: string + enum: ['==', '>', '<'] + value: + type: string + summary: id of the Risk Level being compared against + required: true + format: uuid + secondary_value: + type: string + required: true + enum: [OverallRisk] + _destroy: + type: boolean + default: false diff --git a/nerm/schemas/PATCH/Role.yaml b/nerm/schemas/PATCH/Role.yaml new file mode 100644 index 0000000..c596b34 --- /dev/null +++ b/nerm/schemas/PATCH/Role.yaml @@ -0,0 +1,13 @@ +type: object +properties: + type: + type: string + enum: [NeprofileRole, NeaccessRole] + name: + type: string + example: "Sponsors" + groups: + type: array + items: + type: string + example: "ad_group_name" \ No newline at end of file diff --git a/nerm/schemas/PATCH/RoleProfile.yaml b/nerm/schemas/PATCH/RoleProfile.yaml new file mode 100644 index 0000000..88b907b --- /dev/null +++ b/nerm/schemas/PATCH/RoleProfile.yaml @@ -0,0 +1,8 @@ +type: object +properties: + role_id: + type: string + format: uuid + profile_id: + type: string + format: uuid \ No newline at end of file diff --git a/nerm/schemas/PATCH/RoleProfiles.yaml b/nerm/schemas/PATCH/RoleProfiles.yaml new file mode 100644 index 0000000..c2a75ac --- /dev/null +++ b/nerm/schemas/PATCH/RoleProfiles.yaml @@ -0,0 +1,11 @@ +type: object +properties: + id: + type: string + format: uuid + role_id: + type: string + format: uuid + profile_id: + type: string + format: uuid \ No newline at end of file diff --git a/nerm/schemas/PATCH/User.yaml b/nerm/schemas/PATCH/User.yaml new file mode 100644 index 0000000..28e2b8e --- /dev/null +++ b/nerm/schemas/PATCH/User.yaml @@ -0,0 +1,31 @@ +type: object +properties: + id: + type: string + format: uuid + required: true + writeOnly: true + name: + type: string + email: + type: string + format: email + type: + type: string + enum: [NeprofileUser, NeaccessUser] + default: NeprofileUser + profile_id: + type: string + format: uuid + title: + type: string + status: + type: string + enum: [Active, Disabled] + login: + type: string + admin: + type: boolean + group_strings: + type: string + example: "Administrator_group,Developer_group" \ No newline at end of file diff --git a/nerm/schemas/PATCH/UserManager.yaml b/nerm/schemas/PATCH/UserManager.yaml new file mode 100644 index 0000000..b47647b --- /dev/null +++ b/nerm/schemas/PATCH/UserManager.yaml @@ -0,0 +1,8 @@ +type: object +properties: + user_id: + type: string + format: uuid + manager_id: + type: string + format: uuid \ No newline at end of file diff --git a/nerm/schemas/PATCH/UserManagers.yaml b/nerm/schemas/PATCH/UserManagers.yaml new file mode 100644 index 0000000..e04a8ba --- /dev/null +++ b/nerm/schemas/PATCH/UserManagers.yaml @@ -0,0 +1,11 @@ +type: object +properties: + id: + type: string + format: uuid + user_id: + type: string + format: uuid + manager_id: + type: string + format: uuid \ No newline at end of file diff --git a/nerm/schemas/PATCH/UserProfile.yaml b/nerm/schemas/PATCH/UserProfile.yaml new file mode 100644 index 0000000..679b0cc --- /dev/null +++ b/nerm/schemas/PATCH/UserProfile.yaml @@ -0,0 +1,14 @@ +type: object +properties: + user_id: + type: string + format: uuid + profile_id: + type: string + format: uuid + ne_attribute_id: + type: string + format: uuid + relationship_type: + type: string + enum: [owner, contributor] \ No newline at end of file diff --git a/nerm/schemas/PATCH/UserProfiles.yaml b/nerm/schemas/PATCH/UserProfiles.yaml new file mode 100644 index 0000000..8133d61 --- /dev/null +++ b/nerm/schemas/PATCH/UserProfiles.yaml @@ -0,0 +1,17 @@ +type: object +properties: + id: + type: string + format: uuid + user_id: + type: string + format: uuid + profile_id: + type: string + format: uuid + ne_attribute_id: + type: string + format: uuid + relationship_type: + type: string + enum: [owner, contributor] \ No newline at end of file diff --git a/nerm/schemas/PATCH/UserRole.yaml b/nerm/schemas/PATCH/UserRole.yaml new file mode 100644 index 0000000..ec36728 --- /dev/null +++ b/nerm/schemas/PATCH/UserRole.yaml @@ -0,0 +1,8 @@ +type: object +properties: + user_id: + type: string + format: uuid + role_id: + type: string + format: uuid \ No newline at end of file diff --git a/nerm/schemas/PATCH/UserRoles.yaml b/nerm/schemas/PATCH/UserRoles.yaml new file mode 100644 index 0000000..02acd5c --- /dev/null +++ b/nerm/schemas/PATCH/UserRoles.yaml @@ -0,0 +1,11 @@ +type: object +properties: + id: + type: string + format: uuid + user_id: + type: string + format: uuid + role_id: + type: string + format: uuid \ No newline at end of file diff --git a/nerm/schemas/PATCH/WorkflowSession.yaml b/nerm/schemas/PATCH/WorkflowSession.yaml new file mode 100644 index 0000000..90d9fad --- /dev/null +++ b/nerm/schemas/PATCH/WorkflowSession.yaml @@ -0,0 +1,36 @@ +type: object +properties: + workflow_id: + type: string + format: uuid + requester_id: + type: string + format: uuid + requester_type: + type: string + enum: [User, NeprofileUser, NeaccessUser] + profile_id: + type: string + format: uuid + description: The profile this workflow session will be working with. Only Applicable for Update workflows + profile_ids: + type: array + items: + type: string + format: uuid + 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 + attributes: + type: object + 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 diff --git a/nerm/schemas/POST/AdvancedSearch.yaml b/nerm/schemas/POST/AdvancedSearch.yaml new file mode 100644 index 0000000..7f91e21 --- /dev/null +++ b/nerm/schemas/POST/AdvancedSearch.yaml @@ -0,0 +1,14 @@ +type: object +properties: + label: + type: string + condition_rules_attributes: + type: array + items: + anyOf: + - $ref: "./ProfileTypeRule.yaml" + - $ref: "./ProfileStatusRule.yaml" + - $ref: "./ProfileAttributeRuleString.yaml" + - $ref: "./ProfileAttributeRuleDate.yaml" + - $ref: "./ProfileAttributeRuleId.yaml" + - $ref: "./RiskRule.yaml" diff --git a/nerm/schemas/POST/AttributeOption.yaml b/nerm/schemas/POST/AttributeOption.yaml new file mode 100644 index 0000000..303e9c1 --- /dev/null +++ b/nerm/schemas/POST/AttributeOption.yaml @@ -0,0 +1,7 @@ +type: object +properties: + ne_attribute_id: + type: string + format: uuid + option: + type: string \ No newline at end of file diff --git a/nerm/schemas/POST/Profile.yaml b/nerm/schemas/POST/Profile.yaml new file mode 100644 index 0000000..d54aa6c --- /dev/null +++ b/nerm/schemas/POST/Profile.yaml @@ -0,0 +1,29 @@ +type: object +properties: + name: + type: string + profile_type_id: + type: string + format: uuid + required: true + status: + type: string + enum: [Active, Inactive, On Leave, Terminated] + required: true + id_proofing_status: + type: string + enum: [pending, pass, fail] + archived: + type: boolean + default: false + attributes: + type: object + 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 diff --git a/nerm/schemas/POST/ProfileAttributeRuleDate.yaml b/nerm/schemas/POST/ProfileAttributeRuleDate.yaml new file mode 100644 index 0000000..6a7390d --- /dev/null +++ b/nerm/schemas/POST/ProfileAttributeRuleDate.yaml @@ -0,0 +1,36 @@ +type: object +properties: + type: + type: string + required: true + enum: [ProfileAttributeRule] + condition_object_type: + type: string + required: true + enum: [DateAttribute] + condition_object_id: + type: string + format: uuid + secondary_attribute_type: + type: string + enum: [DateAttribute] + secondary_attribute_id: + type: string + format: uuid + comparison_operator: + type: string + enum: ['>', '<', 'after', 'before'] + value: + type: string + required: true + enum: ['Today', ''] + secondary_value: + type: string + enum: ['after', 'before'] + tertiary_value: + type: string + example: 30 + + + + diff --git a/nerm/schemas/POST/ProfileAttributeRuleId.yaml b/nerm/schemas/POST/ProfileAttributeRuleId.yaml new file mode 100644 index 0000000..bb40225 --- /dev/null +++ b/nerm/schemas/POST/ProfileAttributeRuleId.yaml @@ -0,0 +1,22 @@ +type: object +properties: + type: + type: string + required: true + enum: [ProfileAttributeRule] + condition_object_type: + type: string + required: true + enum: [ProfileSelectAttribute, ProfileSearchAttribute, OwnerSelectAttribute, OwnerSearchAttribute, ContributorSelectAttribute, ContributorSearchAttribute] + condition_object_id: + type: string + required: true + format: uuid + comparison_operator: + type: string + required: true + enum: ['include?', 'exclude?'] + value: + type: string + required: true + format: uuid diff --git a/nerm/schemas/POST/ProfileAttributeRuleString.yaml b/nerm/schemas/POST/ProfileAttributeRuleString.yaml new file mode 100644 index 0000000..5242ad1 --- /dev/null +++ b/nerm/schemas/POST/ProfileAttributeRuleString.yaml @@ -0,0 +1,22 @@ +type: object +properties: + type: + type: string + required: true + enum: [ProfileAttributeRule] + condition_object_type: + type: string + required: true + enum: [TextFieldAttribute, TextAreaAttribute] + condition_object_id: + type: string + required: true + format: uuid + comparison_operator: + type: string + required: true + enum: ['==', '!=', '>', '<', 'start_with?', 'end_with?', 'include?'] + value: + type: string + required: true + example: Some value diff --git a/nerm/schemas/POST/ProfileStatusRule.yaml b/nerm/schemas/POST/ProfileStatusRule.yaml new file mode 100644 index 0000000..e7bcf92 --- /dev/null +++ b/nerm/schemas/POST/ProfileStatusRule.yaml @@ -0,0 +1,14 @@ +type: object +properties: + type: + type: string + required: true + enum: [ProfileStatusRule] + comparison_operator: + type: string + required: true + enum: ['==', '!='] + value: + type: string + required: true + enum: [Active, Inactive, Leave of absence, Terminated] diff --git a/nerm/schemas/POST/ProfileType.yaml b/nerm/schemas/POST/ProfileType.yaml new file mode 100644 index 0000000..f19fe6e --- /dev/null +++ b/nerm/schemas/POST/ProfileType.yaml @@ -0,0 +1,54 @@ +type: object +properties: + name: + type: string + bypass_dup_protection: + type: boolean + default: false + archived: + type: boolean + default: false + permitted_role_ids: + type: array + items: + type: string + format: uuid + profile_type_dup_attributes: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + uid: + type: string + minLength: 32 + maxLength: 32 + profile_type_id: + type: string + format: uuid + ne_attribute_id: + type: string + format: uuid + profile_type_namings: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + uid: + type: string + minLength: 32 + maxLength: 32 + profile_type_id: + type: string + format: uuid + ne_attribute_id: + type: string + format: uuid + order: + type: integer + minimum: 0 diff --git a/nerm/schemas/POST/ProfileTypeRule.yaml b/nerm/schemas/POST/ProfileTypeRule.yaml new file mode 100644 index 0000000..66efe7c --- /dev/null +++ b/nerm/schemas/POST/ProfileTypeRule.yaml @@ -0,0 +1,14 @@ +type: object +properties: + type: + type: string + required: true + enum: [ProfileTypeRule] + comparison_operator: + type: string + required: true + enum: ['==', '!='] + value: + type: string + required: true + format: uuid diff --git a/nerm/schemas/POST/RiskRule.yaml b/nerm/schemas/POST/RiskRule.yaml new file mode 100644 index 0000000..3d63b85 --- /dev/null +++ b/nerm/schemas/POST/RiskRule.yaml @@ -0,0 +1,18 @@ +type: object +properties: + type: + type: string + required: true + enum: [RiskRule] + comparison_operator: + type: string + enum: ['==', '>', '<'] + value: + type: string + summary: id of the Risk Level being compared against + required: true + format: uuid + secondary_value: + type: string + required: true + enum: [OverallRisk] diff --git a/nerm/schemas/POST/Role.yaml b/nerm/schemas/POST/Role.yaml new file mode 100644 index 0000000..6ce215b --- /dev/null +++ b/nerm/schemas/POST/Role.yaml @@ -0,0 +1,18 @@ +type: object +properties: + uid: + type: string + minLength: 32 + maxLength: 32 + example: "sponsors_role" + type: + type: string + enum: [NeprofileRole, NeaccessRole] + name: + type: string + example: "Sponsors" + groups: + type: array + items: + type: string + example: "ad_group_name" \ No newline at end of file diff --git a/nerm/schemas/POST/RoleProfile.yaml b/nerm/schemas/POST/RoleProfile.yaml new file mode 100644 index 0000000..88b907b --- /dev/null +++ b/nerm/schemas/POST/RoleProfile.yaml @@ -0,0 +1,8 @@ +type: object +properties: + role_id: + type: string + format: uuid + profile_id: + type: string + format: uuid \ No newline at end of file diff --git a/nerm/schemas/POST/User.yaml b/nerm/schemas/POST/User.yaml new file mode 100644 index 0000000..a27db3c --- /dev/null +++ b/nerm/schemas/POST/User.yaml @@ -0,0 +1,31 @@ +type: object +properties: + name: + type: string + required: true + email: + type: string + format: email + required: true + type: + type: string + enum: ['NeprofileUser', 'NeaccessUser'] + default: NeprofileUser + profile_id: + type: string + format: uuid + title: + type: string + status: + type: string + enum: [Active, Disabled] + required: true + login: + type: string + required: true + admin: + type: boolean + default: false + group_strings: + type: string + example: "Administrator_group,Developer_group" \ No newline at end of file diff --git a/nerm/schemas/POST/UserManager.yaml b/nerm/schemas/POST/UserManager.yaml new file mode 100644 index 0000000..b47647b --- /dev/null +++ b/nerm/schemas/POST/UserManager.yaml @@ -0,0 +1,8 @@ +type: object +properties: + user_id: + type: string + format: uuid + manager_id: + type: string + format: uuid \ No newline at end of file diff --git a/nerm/schemas/POST/UserProfile.yaml b/nerm/schemas/POST/UserProfile.yaml new file mode 100644 index 0000000..679b0cc --- /dev/null +++ b/nerm/schemas/POST/UserProfile.yaml @@ -0,0 +1,14 @@ +type: object +properties: + user_id: + type: string + format: uuid + profile_id: + type: string + format: uuid + ne_attribute_id: + type: string + format: uuid + relationship_type: + type: string + enum: [owner, contributor] \ No newline at end of file diff --git a/nerm/schemas/POST/UserRole.yaml b/nerm/schemas/POST/UserRole.yaml new file mode 100644 index 0000000..ec36728 --- /dev/null +++ b/nerm/schemas/POST/UserRole.yaml @@ -0,0 +1,8 @@ +type: object +properties: + user_id: + type: string + format: uuid + role_id: + type: string + format: uuid \ No newline at end of file diff --git a/nerm/schemas/POST/WorkflowSession.yaml b/nerm/schemas/POST/WorkflowSession.yaml new file mode 100644 index 0000000..016cfc4 --- /dev/null +++ b/nerm/schemas/POST/WorkflowSession.yaml @@ -0,0 +1,35 @@ +type: object +properties: + workflow_id: + type: string + format: uuid + required: true + requester_id: + type: string + format: uuid + required: true + requester_type: + type: string + enum: [User, NeprofileUser, NeaccessUser] + required: true + profile_id: + type: string + format: uuid + description: The profile this workflow session will be working with. Only Applicable for Update workflows + profile_ids: + type: array + items: + type: string + format: uuid + description: The profiles this workflow session will be working with. Only Applicable for Batch workflows + attributes: + type: object + 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 diff --git a/nerm/schemas/Placeholder.yaml b/nerm/schemas/Placeholder.yaml new file mode 100644 index 0000000..8d90375 --- /dev/null +++ b/nerm/schemas/Placeholder.yaml @@ -0,0 +1,4 @@ +type: object +properties: + placeholder: + type: string \ No newline at end of file diff --git a/nerm/schemas/Url.yaml b/nerm/schemas/Url.yaml new file mode 100644 index 0000000..596ce1a --- /dev/null +++ b/nerm/schemas/Url.yaml @@ -0,0 +1,6 @@ +type: object +properties: + url: + type: string + format: url + readOnly: true \ No newline at end of file diff --git a/nerm/schemas/_index.yaml b/nerm/schemas/_index.yaml new file mode 100644 index 0000000..952a737 --- /dev/null +++ b/nerm/schemas/_index.yaml @@ -0,0 +1,36 @@ +Url: + $ref: './Url.yaml' +User: + $ref: './GET/User.yaml' +UserManager: + $ref: './GET/UserManager.yaml' +UserRole: + $ref: './GET/UserRole.yaml' +Attribute: + $ref: './GET/Attribute.yaml' +AttributeOption: + $ref: './GET/AttributeOption.yaml' +ProfileType: + $ref: './GET/ProfileType.yaml' +Profile: + $ref: './GET/Profile.yaml' +RiskScore: + $ref: './GET/RiskScore.yaml' +RiskLevel: + $ref: './GET/RiskLevel.yaml' +UserProfile: + $ref: './GET/UserProfile.yaml' +RoleProfile: + $ref: './GET/RoleProfile.yaml' +WorkflowSession: + $ref: './GET/WorkflowSession.yaml' +IdentityProofingResult: + $ref: './GET/IdentityProofingResult.yaml' +AdvancedSearch: + $ref: './GET/AdvancedSearch.yaml' +ConditionRulesAttribute-ProfileTypeRule: + $ref: './GET/ProfileTypeRule.yaml' +ConditionRulesAttribute-ProfileStatusRule: + $ref: './GET/ProfileStatusRule.yaml' +ConditionRulesAttribute-ProfileAttributeRule: + $ref: './GET/ProfileAttributeRule.yaml' \ No newline at end of file