SuiteReviewResponse

Fields

11 fields

created_at · required

string (date-time)

id · required

string (uuid)

note

string or null

project_id · required

string (uuid)

reviewed_at

string (date-time) or null

reviewer_email

string or null

reviewer_user_id

string (uuid) or null

state · required

string

suite_name · required

string

test_run_id · required

string (uuid)

updated_at · required

string (date-time)

Raw schema (JSON)

{
  "properties": {
    "created_at": {
      "format": "date-time",
      "title": "Created At",
      "type": "string"
    },
    "id": {
      "format": "uuid",
      "title": "Id",
      "type": "string"
    },
    "note": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Note"
    },
    "project_id": {
      "format": "uuid",
      "title": "Project Id",
      "type": "string"
    },
    "reviewed_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Reviewed At"
    },
    "reviewer_email": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Reviewer Email"
    },
    "reviewer_user_id": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Reviewer User Id"
    },
    "state": {
      "title": "State",
      "type": "string"
    },
    "suite_name": {
      "title": "Suite Name",
      "type": "string"
    },
    "test_run_id": {
      "format": "uuid",
      "title": "Test Run Id",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "title": "Updated At",
      "type": "string"
    }
  },
  "required": [
    "id",
    "project_id",
    "suite_name",
    "test_run_id",
    "state",
    "created_at",
    "updated_at"
  ],
  "title": "SuiteReviewResponse",
  "type": "object"
}

Used by endpoints

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

• GET /api/v1/test-management/suite-reviews — List Suite Reviews
• GET /api/v1/test-management/suite-reviews/by-run/{test_run_id} — List Reviews For Run
• PUT /api/v1/test-management/suite-reviews/by-run/{test_run_id}/{suite_name} — Upsert Review For Run Suite

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON