LiveStreamMeta

Fields

Optional CI/run metadata that enriches the auto-created session.

10 fields

branch

string or null

build_number

string or null

commit_hash

string or null

framework

string or null

launch_name

string or null

machine_id

string or null

metadata

object or null

release_name

string or null

run_context

RunContext or null

total_tests

integer or null

Raw schema (JSON)

{
  "description": "Optional CI/run metadata that enriches the auto-created session.\n\nAll fields are optional — when omitted the server falls back to the API\nkey's name (for client_name) and the run_id (for build_number).",
  "properties": {
    "branch": {
      "anyOf": [
        {
          "maxLength": 255,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Branch"
    },
    "build_number": {
      "anyOf": [
        {
          "maxLength": 100,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Build Number"
    },
    "commit_hash": {
      "anyOf": [
        {
          "maxLength": 64,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Commit Hash"
    },
    "framework": {
      "anyOf": [
        {
          "maxLength": 50,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Framework"
    },
    "launch_name": {
      "anyOf": [
        {
          "maxLength": 255,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Launch Name"
    },
    "machine_id": {
      "anyOf": [
        {
          "maxLength": 255,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Machine Id"
    },
    "metadata": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Metadata"
    },
    "release_name": {
      "anyOf": [
        {
          "maxLength": 255,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Release Name"
    },
    "run_context": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/RunContext"
        },
        {
          "type": "null"
        }
      ]
    },
    "total_tests": {
      "anyOf": [
        {
          "minimum": 0,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Total Tests"
    }
  },
  "title": "LiveStreamMeta",
  "type": "object"
}

Used by endpoints

One endpoint sends or returns this schema, on its own or inside another schema.

• POST /api/v1/stream/ingest — Ingest Via Api Key

Used by schemas

• LiveStreamIngestRequest

More details

• Specification: OpenAPI JSON