IngestPayload

Fields

JSON batch ingest request body for POST /api/v1/ingest.

18 fields

branch

string or null

build_number · required

string

ci_actor

string or null

ci_provider

string or null

ci_repo

string or null

ci_run_url

string or null

commit_hash

string or null

commit_range

array of SuppliedCommit or SuppliedCommitRange or null

environment

string or null

framework

string or null

jenkins_job

string or null

pr_number

integer or null

project_id · required

string

Project UUID

release_name

string or null

results · required

array of IngestTestResult

run_ai

boolean

False skips the AI analysis and the suite comparison for this run.

run_context

RunContext or null

trigger_source

string or null

Raw schema (JSON)

{
  "description": "JSON batch ingest request body for POST /api/v1/ingest.",
  "properties": {
    "branch": {
      "anyOf": [
        {
          "maxLength": 255,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Branch"
    },
    "build_number": {
      "maxLength": 100,
      "minLength": 1,
      "title": "Build Number",
      "type": "string"
    },
    "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"
    },
    "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"
    },
    "environment": {
      "anyOf": [
        {
          "maxLength": 100,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Environment"
    },
    "framework": {
      "anyOf": [
        {
          "maxLength": 50,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Framework"
    },
    "jenkins_job": {
      "anyOf": [
        {
          "maxLength": 500,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Jenkins Job"
    },
    "pr_number": {
      "anyOf": [
        {
          "minimum": 1,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Pr Number"
    },
    "project_id": {
      "description": "Project UUID",
      "title": "Project Id",
      "type": "string"
    },
    "release_name": {
      "anyOf": [
        {
          "maxLength": 255,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Release Name"
    },
    "results": {
      "items": {
        "$ref": "#/components/schemas/IngestTestResult"
      },
      "maxItems": 50000,
      "minItems": 1,
      "title": "Results",
      "type": "array"
    },
    "run_ai": {
      "default": true,
      "description": "False skips the AI analysis and the suite comparison for this run.",
      "title": "Run Ai",
      "type": "boolean"
    },
    "run_context": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/RunContext"
        },
        {
          "type": "null"
        }
      ]
    },
    "trigger_source": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": "api",
      "title": "Trigger Source"
    }
  },
  "required": [
    "project_id",
    "build_number",
    "results"
  ],
  "title": "IngestPayload",
  "type": "object"
}

Used by endpoints

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

• POST /api/v1/ingest — Ingest test results (JSON batch)

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON