Merge pull request #159 from qase-tms/update-v2-specs

testops-api/v2/schemas/ResultCreate.yaml

@@ -15,6 +15,29 @@ properties:
     $ref: './ResultExecution.yaml'
   fields:
     type: object
+    properties:
+      author:
+        type: string
+      description:
+        type: string
+      preconditions:
+        type: string
+      postconditions:
+        type: string
+      layer:
+        type: string
+      severity:
+        type: string
+      priority:
+        type: string
+      behavior:
+        type: string
+      type:
+        type: string
+      muted:
+        type: string
+      is_flaky:
+        type: string
     additionalProperties:
       type: string
   attachments:
@@ -31,19 +54,24 @@ properties:
     type: object
     additionalProperties:
       type: string
-  author:
-    type: string
+  param_groups:
+    type: array
+    description: List parameter groups by name only. Add their values in the 'params' field
+    nullable: true
+    items:
+      type: array
+      description: A list of parameters in group
+      items:
+        type: string
+        description: A name of the parameter
   relations:
     $ref: './ResultRelations.yaml'
-  muted:
-    type: boolean
   message:
     type: string
     nullable: true
-  created_at:
-    type: number
-    format: double
-    nullable: true
+  defect:
+    type: boolean
+    description: If true and the result is failed, the defect associated with the result will be created
 required:
   - title
   - execution

testops-api/v2/schemas/ResultExecution.yaml

@@ -2,17 +2,20 @@ type: object
 properties:
   start_time:
     type: number
+    description: Unix epoch time in seconds (whole part) and milliseconds (fractional part).
     format: double
     nullable: true
   end_time:
     type: number
+    description: Unix epoch time in seconds (whole part) and milliseconds (fractional part).
     format: double
     nullable: true
   status:
     type: string
     description: Can have the following values passed, failed, blocked, skipped, invalid + custom statuses
   duration:
     type: integer
+    description: Duration of the test execution in milliseconds.
     format: int64
     nullable: true
   stacktrace:

testops-api/v2/schemas/ResultStepExecution.yaml

@@ -2,16 +2,19 @@ type: object
 properties:
   start_time:
     type: number
+    description: Unix epoch time in seconds (whole part) and milliseconds (fractional part).
     format: double
     nullable: true
   end_time:
     type: number
+    description: Unix epoch time in seconds (whole part) and milliseconds (fractional part).
     format: double
     nullable: true
   status:
     $ref: './ResultStepStatus.yaml'
   duration:
     type: integer
+    description: Duration of the test step execution in milliseconds.
     format: int64
     nullable: true
   comment: