NEROCKET-72 adding api specs.

nerm/openapi.yaml

@@ -10,6 +10,7 @@ servers:
   - url: https://{tenantName}.nonemployee.com/api
     variables:
       tenantName:
+        default: acmeco
         description: Tenant name assigned to customer
 
 paths:
@@ -102,6 +103,21 @@ paths:
     $ref: "./paths/role_profiles_id.yaml"
   /role_profile/{id}:
     $ref: "./paths/role_profile_id.yaml"
+# Workflows
+  /workflows/create_workflow:
+    $ref: "./paths/workflows/create_workflows.yaml"
+  /workflows/update_workflow:
+    $ref: "./paths/workflows/update_workflows.yaml"
+  /workflows/batch_workflow:
+    $ref: "./paths/workflows/batch_workflows.yaml"
+  /workflows/automated_workflow:
+    $ref: "./paths/workflows/automated_workflows.yaml"
+  /workflows/registration_workflow:
+    $ref: "./paths/workflows/registration_workflows.yaml"
+  /workflows/login_workflow:
+    $ref: "./paths/workflows/login_workflows.yaml"
+  /workflows/password_reset_workflow:
+    $ref: "./paths/workflows/password_reset_workflows.yaml"
 # Workflow Sessions
   /workflow_sessions:
     $ref: "./paths/workflow_sessions.yaml"
@@ -126,11 +142,11 @@ paths:
     $ref: "./paths/job_status.yaml"
 
 security:
-  BearerAuth: []
+  - bearerAuth : []
 
 components:
   securitySchemes:
-    BearerAuth:
+    bearerAuth:
       type: http
       scheme: bearer
-      bearerFormat: Token token=<your token>
+      bearerFormat: Token token=your token

nerm/paths/workflows/automated_workflows.yaml

@@ -0,0 +1,17 @@
+post:
+  summary: Create an automated workflow
+  operationId: postAutomatedWorkflow
+  description: Create an automated workflow
+  tags:
+    - workflows
+  parameters:
+    - $ref: "../../parameters/query/run.yaml"
+  requestBody:
+    $ref: "../../requestBodies/POST/Workflows/AutomatedWorkflow.yaml"
+  responses:
+    '200':
+      $ref: "../../responses/Workflow.yaml"
+    '400':
+      $ref: "../../responses/400.yaml"
+    '500':
+      $ref: "../../responses/500.yaml"

nerm/paths/workflows/batch_workflows.yaml

@@ -0,0 +1,17 @@
+post:
+  summary: Create a batch workflow
+  operationId: postBatchWorkflow
+  description: Create a batch workflow
+  tags:
+    - workflows
+  parameters:
+    - $ref: "../../parameters/query/run.yaml"
+  requestBody:
+    $ref: "../../requestBodies/POST/Workflows/BatchWorkflow.yaml"
+  responses:
+    '200':
+      $ref: "../../responses/Workflow.yaml"
+    '400':
+      $ref: "../../responses/400.yaml"
+    '500':
+      $ref: "../../responses/500.yaml"

nerm/paths/workflows/create_workflows.yaml

@@ -0,0 +1,17 @@
+post:
+  summary: Create a create workflow
+  operationId: postCreateWorkflow
+  description: Create a create workflow
+  tags:
+    - workflows
+  parameters:
+    - $ref: "../../parameters/query/run.yaml"
+  requestBody:
+    $ref: "../../requestBodies/POST/Workflows/CreateWorkflow.yaml"
+  responses:
+    '200':
+      $ref: "../../responses/Workflow.yaml"
+    '400':
+      $ref: "../../responses/400.yaml"
+    '500':
+      $ref: "../../responses/500.yaml"

nerm/paths/workflows/login_workflows.yaml

@@ -0,0 +1,17 @@
+post:
+  summary: Create a login workflow
+  operationId: postLoginWorkflow
+  description: Create a login workflow
+  tags:
+    - workflows
+  parameters:
+    - $ref: "../../parameters/query/run.yaml"
+  requestBody:
+    $ref: "../../requestBodies/POST/Workflows/LoginWorkflow.yaml"
+  responses:
+    '200':
+      $ref: "../../responses/Workflow.yaml"
+    '400':
+      $ref: "../../responses/400.yaml"
+    '500':
+      $ref: "../../responses/500.yaml"

nerm/paths/workflows/password_reset_workflows.yaml

@@ -0,0 +1,17 @@
+post:
+  summary: Create a password reset workflow
+  operationId: postPasswordUpdateWorkflow
+  description: Create a password reset workflow
+  tags:
+    - workflows
+  parameters:
+    - $ref: "../../parameters/query/run.yaml"
+  requestBody:
+    $ref: "../../requestBodies/POST/Workflows/LoginWorkflow.yaml"
+  responses:
+    '200':
+      $ref: "../../responses/Workflow.yaml"
+    '400':
+      $ref: "../../responses/400.yaml"
+    '500':
+      $ref: "../../responses/500.yaml"

nerm/paths/workflows/registration_workflows.yaml

@@ -0,0 +1,17 @@
+post:
+  summary: Create a registration workflow
+  operationId: postRegistrationWorkflow
+  description: Create a registration workflow
+  tags:
+    - workflows
+  parameters:
+    - $ref: "../../parameters/query/run.yaml"
+  requestBody:
+    $ref: "../../requestBodies/POST/Workflows/CreateWorkflow.yaml"
+  responses:
+    '200':
+      $ref: "../../responses/Workflow.yaml"
+    '400':
+      $ref: "../../responses/400.yaml"
+    '500':
+      $ref: "../../responses/500.yaml"

nerm/paths/workflows/update_workflows.yaml

@@ -0,0 +1,17 @@
+post:
+  summary: Create an update workflow
+  operationId: postUpdateWorkflow
+  description: Create an update workflow
+  tags:
+    - workflows
+  parameters:
+    - $ref: "../../parameters/query/run.yaml"
+  requestBody:
+    $ref: "../../requestBodies/POST/Workflows/UpdateWorkflow.yaml"
+  responses:
+    '200':
+      $ref: "../../responses/Workflow.yaml"
+    '400':
+      $ref: "../../responses/400.yaml"
+    '500':
+      $ref: "../../responses/500.yaml"

nerm/requestBodies/POST/Workflows/AutomatedWorkflow.yaml

@@ -0,0 +1,9 @@
+required: true
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        workflow_session:
+          type: object
+          $ref: "../../../schemas/POST/Workflows/AutomatedWorkflow.yaml"

nerm/requestBodies/POST/Workflows/BatchWorkflow.yaml

@@ -0,0 +1,9 @@
+required: true
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        workflow_session:
+          type: object
+          $ref: "../../../schemas/POST/Workflows/BatchWorkflow.yaml"

nerm/requestBodies/POST/Workflows/CreateWorkflow.yaml

@@ -0,0 +1,9 @@
+required: true
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        workflow_session:
+          type: object
+          $ref: "../../../schemas/POST/Workflows/CreateWorkflow.yaml"

nerm/requestBodies/POST/Workflows/LoginWorkflow.yaml

@@ -0,0 +1,9 @@
+required: true
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        workflow_session:
+          type: object
+          $ref: "../../../schemas/POST/Workflows/LoginWorkflow.yaml"

nerm/requestBodies/POST/Workflows/UpdateWorkflow.yaml

@@ -0,0 +1,9 @@
+required: true
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        workflow_session:
+          type: object
+          $ref: "../../../schemas/POST/Workflows/UpdateWorkflow.yaml"

nerm/responses/Workflow.yaml

@@ -0,0 +1,9 @@
+description: Expected response to a valid request
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        workflow:
+          type: object
+          $ref: '../schemas/GET/WorkflowSession.yaml'

nerm/schemas/GET/Workflow.yaml

@@ -0,0 +1,67 @@
+type: object
+properties:
+  id:
+    type: string
+    format: uuid
+    readOnly: true
+  archived:
+    type: boolean
+    default: false
+  archived_on:
+    type: string
+    format: date-time
+  created_at:
+    type: string
+    format: date-time
+    readOnly: true
+  description:
+    type: string
+  legacy_id:
+    type: string
+    format: uuid
+  name:
+    type: string
+  ne_attribute_id:
+    type: string
+    format: uuid
+  options:
+    type: object
+    properties:
+      all_profiles:
+        type: string
+        enum: ["true", "false"]
+      multiple_requests:
+        type: string
+        enum: ["true", "false"]
+      expiration_time:
+        type: integer
+        minimum: 1
+  position:
+    type: integer
+    minimum: 1
+  profile_status:
+    type: string
+  profile_type_id:
+    type: string
+    format: uuid
+  runs_other_workflows:
+    type: boolean
+    default: false
+  status:
+    type: string
+    enum: [Enabled, Disabled]
+  uid:
+    type: string
+    minLength: 32
+    maxLength: 32
+    readOnly: true
+  updated_at:
+    type: string
+    format: date-time
+    readOnly: true
+  url:
+    type: string
+    format: uuid
+  allow_block_permissions:
+    type: boolean
+    default: false

nerm/schemas/POST/Workflows/AutomatedWorkflow.yaml

@@ -0,0 +1,22 @@
+type: object
+properties:
+  profile_type_id:
+    type: string
+    format: uuid
+    required: true
+  status:
+    type: string
+    enum: [Enabled, Disabled]
+    required: true
+  uid:
+    type: string
+    required: true
+  name:
+    type: string
+    required: true
+  condition_rule_ids:
+    type: array
+    items:
+      type: string
+      format: uuid
+    description: The ProfileTypeRule this workflow will be working with.

nerm/schemas/POST/Workflows/BatchWorkflow.yaml

@@ -0,0 +1,27 @@
+type: object
+properties:
+  profile_type_id:
+    type: string
+    format: uuid
+    required: true
+  status:
+    type: string
+    enum: [Enabled, Disabled]
+    required: true
+  uid:
+    type: string
+    required: true
+  name:
+    type: string
+    required: true
+  options:
+    type: object
+    properties:
+      all_profiles:
+        type: string
+        enum: ["true", "false"]
+        required: true
+      multiple_requests:
+        type: string
+        enum: ["true", "false"]
+        required: true

nerm/schemas/POST/Workflows/CreateWorkflow.yaml

@@ -0,0 +1,16 @@
+type: object
+properties:
+  profile_type_id:
+    type: string
+    format: uuid
+    required: true
+  status:
+    type: string
+    enum: [Enabled, Disabled]
+    required: true
+  uid:
+    type: string
+    required: true
+  name:
+    type: string
+    required: true

nerm/schemas/POST/Workflows/LoginWorkflow.yaml

@@ -0,0 +1,23 @@
+type: object
+properties:
+  profile_type_id:
+    type: string
+    format: uuid
+    required: true
+  status:
+    type: string
+    enum: [Enabled, Disabled]
+    required: true
+  uid:
+    type: string
+    required: true
+  name:
+    type: string
+    required: true
+  options:
+    type: object
+    properties:
+      expiration_time:
+        type: integer
+        minimum: 1
+        required: true

nerm/schemas/POST/Workflows/UpdateWorkflow.yaml

@@ -0,0 +1,19 @@
+type: object
+properties:
+  profile_type_id:
+    type: string
+    format: uuid
+    required: true
+  status:
+    type: string
+    enum: [Enabled, Disabled]
+    required: true
+  uid:
+    type: string
+    required: true
+  name:
+    type: string
+    required: true
+  profile_status:
+    type: string
+    required: true