Resolve issues in Job structure (#204)

* fix issues with job structure

* correct the endpoint for resource lookups

Author: mattoni

components/schemas/errors/ErrorEnvelope.yml

@@ -7,7 +7,7 @@ required:
 properties:
   error:
     $ref: Error.yml
-  data:
-    description: Data will always be `null` here.
-    type: object
-    nullable: true
+  # data:
+  #   description: Data will always be `null` here.
+  #   type: object
+  #   nullable: true

components/schemas/jobs/Job.yml

@@ -50,7 +50,7 @@ properties:
     description: An array of job tasks.
     type: array
     items:
-      "$ref": "./JobTasks.yml"
+      "$ref": ./JobTask.yml
   expires:
     description: A timestamp for when the job expires.
     "$ref": "../DateTime.yml"

components/schemas/jobs/JobState.yml

@@ -1,17 +1,27 @@
 title: JobState
-allOf:
-  - required:
-      - current
+type: object
+required:
+  - current
+  - error
+properties:
+  current:
+    description: The current state of the job.
+    type: string
+    enum:
+      - new
+      - queued
+      - error
+      - scheduled
+      - expired
+      - running
+      - completed
+  changed:
+    $ref: "../DateTime.yml"
+  error:
+    type: object
+    nullable: true
+    description: An error, if any, that has occurred for this job.
     properties:
-      current:
-        description: The current state of the job.
+      message:
         type: string
-        enum:
-          - new
-          - queued
-          - error
-          - scheduled
-          - expired
-          - running
-          - completed
-  - "$ref": "../State.yml"
+        description: Details about the error that has occurred.

components/schemas/jobs/JobTask.yml

@@ -0,0 +1,68 @@
+title: JobTask
+type: object
+description: Information about a job task.
+required:
+  - id
+  - caption
+  - header
+  - events
+  - error
+  - steps
+  - state
+  - input
+  - output
+properties:
+  id:
+    $ref: ../ID.yml
+  caption:
+    type: string
+    description: A short description of the task.
+  header:
+    type: string
+    description: The API function called.
+  events:
+    title: TaskEvents
+    type: object
+    description: A collection of timestamps for each event in the job's lifetime.
+    required:
+      - queued
+      - completed
+      - started
+    properties:
+      queued:
+        description: The timestamp of when the task was queued.
+        $ref: "../DateTime.yml"
+      completed:
+        description: The timestamp of when the task was completed.
+        $ref: "../DateTime.yml"
+      started:
+        description: The timestamp of when the task was started.
+        $ref: "../DateTime.yml"
+  steps:
+    description: An array of job task steps.
+    type: array
+    items:
+      $ref: ./TaskStep.yml
+  state:
+    $ref: ./TaskState.yml
+  input:
+    type: object
+    description: Input information used for the job tasks.
+    additionalProperties:
+      type: string
+  output:
+    type: object
+    nullable: true
+    description: Output informaiton used for the job tasks.
+    additionalProperties:
+      type: string
+  error:
+    type: object
+    nullable: true
+    description: An error object describing issues with the job.
+    required:
+      - message
+    properties:
+      message:
+        type: string
+        description: An error message

components/schemas/jobs/JobTasks.yml

@@ -1,14 +1,13 @@
 title: TaskState
-allOf:
-  - required:
-      - current
-    properties:
-      current:
-        description: The current state of the task.
-        type: string
-        enum:
-          - pending
-          - error
-          - running
-          - completed
-  - "$ref": "../State.yml"
+type: object
+properties:
+  changed:
+    $ref: ../DateTime.yml
+  current:
+    description: The current state of the task.
+    type: string
+    enum:
+      - pending
+      - error
+      - running
+      - completed

components/schemas/jobs/TaskState.yml

@@ -408,7 +408,7 @@ paths:
   "/v1/security/report":
     $ref: paths/security/report.yml
   # Utils
-  "/v1/utils/lookup":
+  "/v1/utils/resource/lookup":
     $ref: paths/utils/resource/lookup.yml
 components:
   securitySchemes: