BugBug Test runs API

openapi: 3.2.0
info:
  title: BugBug.io Public Test runs API
  version: v2
  x-logo:
    url: /static/images/logo.svg
    altText: BugBug.io
  description: 'BugBug.io is a modern browser-based app for software testers, developers, or product managers in need of quick & reliable test automation. You can run tests from your CI/CD pipeline or build system. You can run tests and suites in the cloud via BugBug Command Line Interface.


    Please use Authorize button to Try it out.'
  contact:
    email: support@bugbug.io
tags:
- name: Test Runs
  description: Executing tests and getting result
paths:
  /v2/testruns/:
    get:
      operationId: v2_testruns_list
      summary: Returns list of historical TestRuns
      parameters:
      - in: query
        name: ordering
        schema:
          type: string
          enum:
          - -created
          - -started
          - created
          - started
        description: Sort list by param
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: started_after
        schema:
          type: string
          format: date-time
      - in: query
        name: started_before
        schema:
          type: string
          format: date-time
      - in: query
        name: status
        schema:
          type: string
          x-spec-enum-id: d6540c730bc09488
          enum:
          - auto_retrying
          - error
          - failed
          - initialized
          - passed
          - paused
          - queued
          - recording
          - running
          - skipped
          - stopped
        description: '* `error` - Error

          * `passed` - Passed

          * `failed` - Failed

          * `running` - Running

          * `auto_retrying` - Auto Retrying

          * `stopped` - Stopped

          * `queued` - Queued

          * `paused` - Paused

          * `skipped` - Skipped

          * `recording` - Recording

          * `initialized` - Initialized'
      - in: query
        name: tags
        schema:
          type: string
        description: Comma-separated tag names. Names cannot contain commas. Matching is case-insensitive and uses AND semantics.
      - in: query
        name: testId
        schema:
          type: string
          format: uuid
        description: Filter by test id.
      tags:
      - Test Runs
      security:
      - tokenAuth: []
      - Bearer: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedV2TestRunList'
          description: ''
        '401':
          description: Authentication credentials were missing or invalid.
    post:
      operationId: v2_testruns_create
      description: Execute desired test.
      summary: Execute desired test
      tags:
      - Test Runs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V2RunTestDocs'
        required: true
      security:
      - tokenAuth: []
      - Bearer: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2TestRunState'
          description: ''
        '401':
          description: Authentication credentials were missing or invalid.
        '400':
          description: Request body failed validation.
  /v2/testruns/{id}/:
    get:
      operationId: v2_testruns_retrieve
      description: Returns single object.
      summary: Retrieve test run result
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this test run.
        required: true
      tags:
      - Test Runs
      security:
      - tokenAuth: []
      - Bearer: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2TestRun'
          description: ''
        '401':
          description: Authentication credentials were missing or invalid.
        '404':
          description: Resource not found.
    patch:
      operationId: v2_testruns_partial_update
      description: Partially updates the test run. Only `notes` can be changed.
      summary: Update test run
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this test run.
        required: true
      tags:
      - Test Runs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedV2RunUpdate'
      security:
      - tokenAuth: []
      - Bearer: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2TestRun'
          description: ''
        '401':
          description: Authentication credentials were missing or invalid.
        '400':
          description: Request body failed validation.
        '404':
          description: Resource not found.
  /v2/testruns/{id}/debug-artifacts/:
    get:
      operationId: v2_testruns_debug_artifacts_list
      description: Returns list of debug artifacts attached to the test run.
      summary: List test run debug artifacts
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this test run.
        required: true
      tags:
      - Test Runs
      security:
      - tokenAuth: []
      - Bearer: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DebugArtifact'
          description: ''
        '401':
          description: Authentication credentials were missing or invalid.
        '404':
          description: Resource not found.
  /v2/testruns/{id}/debug-artifacts/{artifact_type}/:
    get:
      operationId: v2_testruns_debug_artifacts_retrieve
      description: Returns a single debug artifact of the given kind attached to the test run.
      summary: Retrieve test run debug artifact by kind
      parameters:
      - in: path
        name: artifact_type
        schema:
          type: string
          enum:
          - chrome_debug_logs
          - cloud_logs
          - container_stats
          - dom_snapshot
          - logs
          - logs_partial
          - network_logs
        description: Debug artifact type.
        required: true
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this test run.
        required: true
      tags:
      - Test Runs
      security:
      - tokenAuth: []
      - Bearer: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DebugArtifact'
          description: ''
        '404':
          description: Artifact not found
        '401':
          description: Authentication credentials were missing or invalid.
  /v2/testruns/{id}/logs/:
    get:
      operationId: v2_testruns_logs_retrieve
      description: Download the logs for the selected test run.
      summary: Download test run logs
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this test run.
        required: true
      tags:
      - Test Runs
      security:
      - tokenAuth: []
      - Bearer: []
      responses:
        '302':
          description: Redirect to logs file
        '404':
          description: Logs not found or expired
        '401':
          description: Authentication credentials were missing or invalid.
  /v2/testruns/{id}/report/junit/:
    get:
      operationId: v2_testruns_report_junit_retrieve
      description: Download the JUnit XML report for the selected test run.
      summary: Download JUnit XML report
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this test run.
        required: true
      tags:
      - Test Runs
      security:
      - tokenAuth: []
      - Bearer: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
                format: binary
          description: JUnit XML report file
        '401':
          description: Authentication credentials were missing or invalid.
        '404':
          description: Resource not found.
  /v2/testruns/{id}/screenshots/:
    get:
      operationId: v2_testruns_screenshots_retrieve
      description: Returns all screenshots.
      summary: Get test run steps screenshots
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this test run.
        required: true
      tags:
      - Test Runs
      security:
      - tokenAuth: []
      - Bearer: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2TestRunScreenshots'
          description: ''
        '401':
          description: Authentication credentials were missing or invalid.
        '404':
          description: Resource not found.
  /v2/testruns/{id}/status/:
    get:
      operationId: v2_testruns_status_retrieve
      description: Returns single object.
      summary: Get test run status
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this test run.
        required: true
      tags:
      - Test Runs
      security:
      - tokenAuth: []
      - Bearer: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2TestRunState'
          description: ''
        '401':
          description: Authentication credentials were missing or invalid.
        '404':
          description: Resource not found.
  /v2/testruns/{id}/stop/:
    post:
      operationId: v2_testruns_stop_create
      description: Stop test run
      summary: Stop running test run
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this test run.
        required: true
      tags:
      - Test Runs
      security:
      - tokenAuth: []
      - Bearer: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2TestRunState'
          description: ''
        '401':
          description: Authentication credentials were missing or invalid.
        '400':
          description: Request body failed validation.
        '404':
          description: Resource not found.
  /v2/testruns/{id}/tags/:
    put:
      operationId: v2_testruns_tags_update
      description: Replaces directly assigned tags. Inherited tags are preserved. Tag names that do not exist yet are created in the project with a default color.
      summary: Replace test run tags
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this test run.
        required: true
      tags:
      - Test Runs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V2RunTagsUpdate'
      security:
      - tokenAuth: []
      - Bearer: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/V2RunTag'
          description: ''
        '401':
          description: Authentication credentials were missing or invalid.
        '400':
          description: Request body failed validation.
        '404':
          description: Resource not found.
components:
  schemas:
    V2TestRun:
      type: object
      properties:
        browserName:
          type:
          - string
          - 'null'
          readOnly: true
        browserHeight:
          type:
          - integer
          - 'null'
          readOnly: true
        browserVersion:
          type:
          - string
          - 'null'
          readOnly: true
        browserWidth:
          type:
          - integer
          - 'null'
          readOnly: true
        duration:
          type:
          - string
          - 'null'
          readOnly: true
        ended:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
        errorCode:
          type:
          - string
          - 'null'
          readOnly: true
        extensionVersion:
          type:
          - string
          - 'null'
          readOnly: true
        id:
          type: string
          format: uuid
          readOnly: true
        isAutoRetried:
          type: boolean
          readOnly: true
        name:
          type: string
          readOnly: true
        notes:
          type:
          - string
          - 'null'
          readOnly: true
        osName:
          type:
          - string
          - 'null'
          readOnly: true
        profileId:
          type: string
          format: uuid
          readOnly: true
        profileName:
          type: string
          readOnly: true
        queued:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
        runMode:
          enum:
          - server
          - local
          - recording
          type: string
          description: '* `server` - cloud

            * `local` - local

            * `recording` - recording'
          x-spec-enum-id: 396ab9b642f5073e
          readOnly: true
        runProfileId:
          type:
          - string
          - 'null'
          format: uuid
          readOnly: true
        screenSizeType:
          enum:
          - desktop
          - mobile
          - custom
          type: string
          description: '* `desktop` - Desktop

            * `mobile` - Mobile

            * `custom` - Custom'
          x-spec-enum-id: c0cdf94a62475084
          readOnly: true
        section:
          enum:
          - main
          - before_all
          - after_all
          type: string
          description: '* `main` - Main

            * `before_all` - Before all

            * `after_all` - After all'
          x-spec-enum-id: e59cc6e0718a4fdc
          readOnly: true
        sequence:
          type:
          - integer
          - 'null'
          readOnly: true
        started:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
        status:
          enum:
          - error
          - passed
          - failed
          - running
          - auto_retrying
          - stopped
          - queued
          - paused
          - skipped
          - recording
          - initialized
          type: string
          description: '* `error` - Error

            * `passed` - Passed

            * `failed` - Failed

            * `running` - Running

            * `auto_retrying` - Auto Retrying

            * `stopped` - Stopped

            * `queued` - Queued

            * `paused` - Paused

            * `skipped` - Skipped

            * `recording` - Recording

            * `initialized` - Initialized'
          x-spec-enum-id: d6540c730bc09488
          readOnly: true
        stepsRuns:
          type: string
          readOnly: true
        suiteRunId:
          type:
          - string
          - 'null'
          format: uuid
          readOnly: true
        tags:
          type: array
          items:
            $ref: '#/components/schemas/V2RunTag'
          readOnly: true
        testId:
          type:
          - string
          - 'null'
          format: uuid
          readOnly: true
        triggeredBy:
          enum:
          - user
          - api
          - webhook
          - scheduler
          - github
          - cli
          - agent
          - vercel
          type: string
          description: '* `user` - User

            * `api` - Api

            * `webhook` - Webhook

            * `scheduler` - Scheduler

            * `github` - Github

            * `cli` - Cli

            * `agent` - Agent

            * `vercel` - Vercel'
          x-spec-enum-id: 2ea33822d75ad557
          readOnly: true
        userId:
          type:
          - string
          - 'null'
          format: uuid
          readOnly: true
        webappUrl:
          type: string
          readOnly: true
      required:
      - browserHeight
      - browserName
      - browserVersion
      - browserWidth
      - duration
      - ended
      - errorCode
      - extensionVersion
      - id
      - isAutoRetried
      - name
      - notes
      - osName
      - profileId
      - profileName
      - queued
      - runMode
      - runProfileId
      - screenSizeType
      - section
      - sequence
      - started
      - status
      - stepsRuns
      - suiteRunId
      - tags
      - testId
      - triggeredBy
      - userId
      - webappUrl
    V2RunTag:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        name:
          type: string
          readOnly: true
        color:
          type: string
          readOnly: true
        inherited:
          type: boolean
          readOnly: true
      required:
      - color
      - id
      - inherited
      - name
    V2TestRunScreenshots:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        stepsRuns:
          type: array
          items:
            $ref: '#/components/schemas/V2StepRunScreenshot'
          readOnly: true
      required:
      - id
      - stepsRuns
    DebugArtifact:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        kind:
          enum:
          - logs_partial
          - logs
          - cloud_logs
          - container_stats
          - chrome_debug_logs
          - dom_snapshot
          - network_logs
          type: string
          description: '* `logs_partial` - Logs Partial

            * `logs` - Logs

            * `cloud_logs` - Cloud Logs

            * `container_stats` - Container Stats

            * `chrome_debug_logs` - Chrome Debug Logs

            * `dom_snapshot` - Dom Snapshot

            * `network_logs` - Network Logs'
          x-spec-enum-id: b3c3cb8d0ce4e863
          readOnly: true
        file:
          type: string
        fileExtension:
          type:
          - string
          - 'null'
          readOnly: true
        contentType:
          type:
          - string
          - 'null'
          readOnly: true
        expirationTime:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
          description: None for eternal
      required:
      - contentType
      - expirationTime
      - file
      - fileExtension
      - id
      - kind
    V2RunTestDocs:
      type: object
      properties:
        testId:
          type: string
          format: uuid
        runProfileId:
          type:
          - string
          - 'null'
          format: uuid
        variables:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/V2OverrideVariable'
          default: []
        tags:
          type: array
          items:
            type: string
            maxLength: 64
          maxItems: 64
      required:
      - testId
    V2RunTagsUpdate:
      type: object
      properties:
        tags:
          type: array
          items:
            type: string
            maxLength: 64
          maxItems: 64
        tagIds:
          type: array
          items:
            type: string
            format: uuid
          maxItems: 64
    V2TestRunState:
      type: object
      properties:
        duration:
          type:
          - string
          - 'null'
          readOnly: true
        finishedSteps:
          type: integer
          readOnly: true
        id:
          type: string
          format: uuid
          readOnly: true
        modified:
          type: string
          format: date-time
          readOnly: true
        status:
          enum:
          - error
          - passed
          - failed
          - running
          - auto_retrying
          - stopped
          - queued
          - paused
          - skipped
          - recording
          - initialized
          type: string
          description: '* `error` - Error

            * `passed` - Passed

            * `failed` - Failed

            * `running` - Running

            * `auto_retrying` - Auto Retrying

            * `stopped` - Stopped

            * `queued` - Queued

            * `paused` - Paused

            * `skipped` - Skipped

            * `recording` - Recording

            * `initialized` - Initialized'
          x-spec-enum-id: d6540c730bc09488
          readOnly: true
        tags:
          type: array
          items:
            $ref: '#/components/schemas/V2RunTag'
          readOnly: true
        totalSteps:
          type: integer
          readOnly: true
        webappUrl:
          type: string
          readOnly: true
      required:
      - duration
      - finishedSteps
      - id
      - modified
      - status
      - tags
      - totalSteps
      - webappUrl
    V2OverrideVariable:
      type: object
      properties:
        key:
          type: string
          maxLength: 128
        value:
          type:
          - string
          - 'null'
      required:
      - key
    PatchedV2RunUpdate:
      type: object
      properties:
        notes:
          type:
          - string
          - 'null'
          maxLength: 1024
    PaginatedV2TestRunList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/V2TestRun'
    V2StepRunScreenshot:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        stepId:
          type:
          - string
          - 'null'
          format: uuid
          readOnly: true
        screenshotUrl:
          type: string
      required:
      - id
      - screenshotUrl
      - stepId
  securitySchemes:
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"