ReviewResponse

Fields

A review request as clients see it. No reviewer identity.

19 fields

ai_disclaimer · required: string
ai_disclaimer_version · required: string
created_at · required: string (date-time)
evidence_bundle_sha256: string or null
id · required: string (uuid)
kind · required: string
notes: string or null
pipeline_run_id: string (uuid) or null
project_id · required: string (uuid)
reason_code: string or null
requires_human_review: boolean
reviewed · required: boolean
reviewed_at: string (date-time) or null
state · required: string
subject_id · required: string
subject_type · required: string
superseded_by: string (uuid) or null
test_run_id: string (uuid) or null
workflow_type: string or null

Raw schema (JSON)

{
  "description": "A review request as clients see it. No reviewer identity (section 8.2).",
  "properties": {
    "ai_disclaimer": {
      "title": "Ai Disclaimer",
      "type": "string"
    },
    "ai_disclaimer_version": {
      "title": "Ai Disclaimer Version",
      "type": "string"
    },
    "created_at": {
      "format": "date-time",
      "title": "Created At",
      "type": "string"
    },
    "evidence_bundle_sha256": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Evidence Bundle Sha256"
    },
    "id": {
      "format": "uuid",
      "title": "Id",
      "type": "string"
    },
    "kind": {
      "title": "Kind",
      "type": "string"
    },
    "notes": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Notes"
    },
    "pipeline_run_id": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Pipeline Run Id"
    },
    "project_id": {
      "format": "uuid",
      "title": "Project Id",
      "type": "string"
    },
    "reason_code": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Reason Code"
    },
    "requires_human_review": {
      "default": true,
      "title": "Requires Human Review",
      "type": "boolean"
    },
    "reviewed": {
      "title": "Reviewed",
      "type": "boolean"
    },
    "reviewed_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Reviewed At"
    },
    "state": {
      "enum": [
        "pending_review",
        "accepted",
        "rejected",
        "superseded"
      ],
      "title": "State",
      "type": "string"
    },
    "subject_id": {
      "title": "Subject Id",
      "type": "string"
    },
    "subject_type": {
      "title": "Subject Type",
      "type": "string"
    },
    "superseded_by": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Superseded By"
    },
    "test_run_id": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Test Run Id"
    },
    "workflow_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Workflow Type"
    }
  },
  "required": [
    "id",
    "project_id",
    "kind",
    "subject_type",
    "subject_id",
    "state",
    "reviewed",
    "created_at",
    "ai_disclaimer",
    "ai_disclaimer_version"
  ],
  "title": "ReviewResponse",
  "type": "object"
}

Used by endpoints

4 endpoints send or return this schema, on its own or inside another schema.

GET /api/v1/projects/{project_id}/reviews — List Reviews
GET /api/v1/reviews/{review_id} — Get Review
POST /api/v1/reviews/{review_id}/accept — Accept Review
POST /api/v1/reviews/{review_id}/reject — Reject Review

Used by schemas

No other schema contains this one.

More details

Specification: OpenAPI JSON