Merge pull request #183 from qase-tms/update-run-api

describe update run api

Author: abelharisov

testops-api/v1/paths/run.yaml

@@ -26,6 +26,39 @@ get:
     429:
       description: Too Many Requests.
 
+patch:
+  operationId: update-run
+  tags: [ runs ]
+  summary: Update a specific run
+  description: |
+    This method allows to update a specific run.
+  parameters:
+    - $ref: '../parameters/Code.yaml'
+    - $ref: '../parameters/Id.yaml'
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: '../schemas/Run.update.yaml'
+  responses:
+    200:
+      description: A result.
+      content:
+        application/json:
+          schema:
+            $ref: '../schemas/responses/BaseResponse.yaml'
+    400:
+      description: Bad Request.
+    401:
+      description: Unauthorized.
+    403:
+      description: Forbidden.
+    404:
+      description: Not Found.
+    429:
+      description: Too Many Requests.
+
 delete:
   operationId: delete-run
   tags: [ runs ]

testops-api/v1/schemas/Run.update.yaml

@@ -0,0 +1,40 @@
+type: object
+properties:
+  title:
+    type: string
+    maxLength: 255
+  description:
+    type: string
+    maxLength: 10000
+    nullable: true
+  environment_id:
+    type: integer
+    format: int64
+    minimum: 1
+    nullable: true
+  environment_slug:
+    type: string
+    maxLength: 255
+    nullable: true
+  milestone_id:
+    type: integer
+    format: int64
+    minimum: 1
+    nullable: true
+  tags:
+    type: array
+    items:
+      type: string
+    nullable: true
+  configurations:
+    type: array
+    items:
+      type: integer
+      format: int64
+    nullable: true
+  custom_field:
+    type: object
+    description: A map of custom fields values (id => value)
+    additionalProperties:
+      type: string
+    nullable: true

testops-api/v1/schemas/Run.yaml

@@ -105,3 +105,8 @@ properties:
     type: integer
     format: int64
     nullable: true
+  configurations:
+    type: array
+    items:
+      type: integer
+      format: int64