test-runs.yaml

openapi: 3.0.0
info:
  title: Test runs
  version: v1
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://{hostname}/test-management/v1
x-akamai:
  auth-type: EDGE_GRID
  file-path: test-runs.yaml
paths:
  /test-runs:
    post:
      operationId: post-test-runs
      summary: Submit a test run
      tags:
      - Test runs
      description: |
        Start a test run containing one or more test definitions and their corresponding test cases.
      requestBody:
        required: true
        content:
          application/json:
            example:
              $ref: examples/create-test-run-request.json
            schema:
              $ref: schemas/createTestRunRequest.yaml
      responses:
        202:
          description: |
            Successfully submitted.
          content:
            application/json:
              example:
                $ref: examples/get-test-run-response.json
              schema:
                $ref: schemas/getTestRunResponse.yaml
  /test-runs/{testRunId}:
    parameters:
    - $ref: parameters/testRunId-path.yaml
    get:
      operationId: get-test-run
      summary: Get test run
      tags:
      - Test runs
      description: |
        Get the Test Run identified by `testRunId`.
      responses:
        200:
          description: |
            Successful response.
          content:
            application/json:
              example:
                $ref: examples/get-test-run-response.json
              schema:
                $ref: schemas/getTestRunResponse.yaml