LiveSessionCreate

Fields

Request body to register a new live execution session.

19 fields

branch

string or null

build_number

string or null

ci_actor

string or null

ci_provider

string or null

ci_repo

string or null

ci_run_url

string or null

client_name · required

string

commit_hash

string or null

commit_range

array of SuppliedCommit or SuppliedCommitRange or null

framework

string or null

launch_name

string or null

machine_id

string or null

metadata

object or null

pr_number

integer or null

project_id · required

string

release_name

string or null

run_context

RunContext or null

suite_name

string or null

total_tests

integer or null

Raw schema (JSON)

{
  "description": "Request body to register a new live execution session.\n\n``project_id`` accepts either a project UUID *or* a human-readable project\nname (case-insensitive exact match). The server resolves it to a real UUID\nin ``stream_service.create_session``. Keeping the field name ``project_id``\npreserves wire compatibility with SDK callers that already map their\n``testlookup.project`` config (conventionally a name, à la\n``rp.project``) onto this field.",
  "properties": {
    "branch": {
      "anyOf": [
        {
          "maxLength": 255,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Branch"
    },
    "build_number": {
      "anyOf": [
        {
          "maxLength": 100,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Build Number"
    },
    "ci_actor": {
      "anyOf": [
        {
          "maxLength": 120,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Ci Actor"
    },
    "ci_provider": {
      "anyOf": [
        {
          "maxLength": 30,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Ci Provider"
    },
    "ci_repo": {
      "anyOf": [
        {
          "maxLength": 300,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Ci Repo"
    },
    "ci_run_url": {
      "anyOf": [
        {
          "maxLength": 1000,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Ci Run Url"
    },
    "client_name": {
      "maxLength": 255,
      "minLength": 1,
      "title": "Client Name",
      "type": "string"
    },
    "commit_hash": {
      "anyOf": [
        {
          "maxLength": 64,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Commit Hash"
    },
    "commit_range": {
      "anyOf": [
        {
          "items": {
            "$ref": "#/components/schemas/SuppliedCommit"
          },
          "type": "array"
        },
        {
          "$ref": "#/components/schemas/SuppliedCommitRange"
        },
        {
          "type": "null"
        }
      ],
      "title": "Commit Range"
    },
    "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"
    },
    "pr_number": {
      "anyOf": [
        {
          "minimum": 1,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Pr Number"
    },
    "project_id": {
      "maxLength": 255,
      "minLength": 1,
      "title": "Project Id",
      "type": "string"
    },
    "release_name": {
      "anyOf": [
        {
          "maxLength": 255,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Release Name"
    },
    "run_context": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/RunContext"
        },
        {
          "type": "null"
        }
      ]
    },
    "suite_name": {
      "anyOf": [
        {
          "maxLength": 500,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Suite Name"
    },
    "total_tests": {
      "anyOf": [
        {
          "minimum": 0,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Total Tests"
    }
  },
  "required": [
    "project_id",
    "client_name"
  ],
  "title": "LiveSessionCreate",
  "type": "object"
}

Used by endpoints

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

• POST /api/v1/stream/sessions — Create Session

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON