TestSuiteResponse

Fields

9 fields

created_at · required

string (date-time)

description

string or null

id · required

string (uuid)

is_default · required

boolean

name · required

string

project_id · required

string (uuid)

tags

array of string or null

test_case_count

integer or null

updated_at

string (date-time) or null

Raw schema (JSON)

{
  "properties": {
    "created_at": {
      "format": "date-time",
      "title": "Created At",
      "type": "string"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Description"
    },
    "id": {
      "format": "uuid",
      "title": "Id",
      "type": "string"
    },
    "is_default": {
      "title": "Is Default",
      "type": "boolean"
    },
    "name": {
      "title": "Name",
      "type": "string"
    },
    "project_id": {
      "format": "uuid",
      "title": "Project Id",
      "type": "string"
    },
    "tags": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Tags"
    },
    "test_case_count": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Test Case Count"
    },
    "updated_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Updated At"
    }
  },
  "required": [
    "created_at",
    "id",
    "project_id",
    "name",
    "is_default"
  ],
  "title": "TestSuiteResponse",
  "type": "object"
}

Used by endpoints

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

• POST /api/v1/suites — Create Suite
• GET /api/v1/suites/{suite_id} — Get Suite
• PATCH /api/v1/suites/{suite_id} — Update Suite
• POST /api/v1/suites/{suite_id}/set-default — Set Default
• GET /api/v1/suites — List Suites

Used by schemas

• TestSuiteListResponse

More details

• Specification: OpenAPI JSON