CanonicalTestCaseResponse

Fields

24 fields

class_name: string or null
created_at · required: string (date-time)
deleted_at_run_id: string (uuid) or null
deleted_observed_at: string (date-time) or null
first_seen_run_id: string (uuid) or null
id · required: string (uuid)
last_seen_at: string (date-time) or null
last_seen_run_id: string (uuid) or null
last_seen_test_case_id: string (uuid) or null
managed_test_case_id: string (uuid) or null
project_id · required: string (uuid)
retirement_confirmed_at: string (date-time) or null
retirement_confirmed_by_id: string (uuid) or null
retirement_reason: string or null
review_tag: string or null
run_count: integer or null
source · required: string
status · required: string
tags: array of string or null
test_fingerprint · required: string
test_name · required: string
test_suite_id · required: string (uuid)
test_suite_name: string or null
updated_at: string (date-time) or null

Raw schema (JSON)

{
  "properties": {
    "class_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Class Name"
    },
    "created_at": {
      "format": "date-time",
      "title": "Created At",
      "type": "string"
    },
    "deleted_at_run_id": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Deleted At Run Id"
    },
    "deleted_observed_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Deleted Observed At"
    },
    "first_seen_run_id": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "First Seen Run Id"
    },
    "id": {
      "format": "uuid",
      "title": "Id",
      "type": "string"
    },
    "last_seen_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Last Seen At"
    },
    "last_seen_run_id": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Last Seen Run Id"
    },
    "last_seen_test_case_id": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Last Seen Test Case Id"
    },
    "managed_test_case_id": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Managed Test Case Id"
    },
    "project_id": {
      "format": "uuid",
      "title": "Project Id",
      "type": "string"
    },
    "retirement_confirmed_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Retirement Confirmed At"
    },
    "retirement_confirmed_by_id": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Retirement Confirmed By Id"
    },
    "retirement_reason": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Retirement Reason"
    },
    "review_tag": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Review Tag"
    },
    "run_count": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Run Count"
    },
    "source": {
      "title": "Source",
      "type": "string"
    },
    "status": {
      "title": "Status",
      "type": "string"
    },
    "tags": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Tags"
    },
    "test_fingerprint": {
      "title": "Test Fingerprint",
      "type": "string"
    },
    "test_name": {
      "title": "Test Name",
      "type": "string"
    },
    "test_suite_id": {
      "format": "uuid",
      "title": "Test Suite Id",
      "type": "string"
    },
    "test_suite_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Test Suite Name"
    },
    "updated_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Updated At"
    }
  },
  "required": [
    "created_at",
    "id",
    "project_id",
    "test_suite_id",
    "test_fingerprint",
    "test_name",
    "status",
    "source"
  ],
  "title": "CanonicalTestCaseResponse",
  "type": "object"
}

Used by endpoints

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

GET /api/v1/canonical-test-cases/{canonical_id} — Get Canonical Case
POST /api/v1/canonical-test-cases/{canonical_id}/confirm-retirement — Confirm Canonical Retirement
POST /api/v1/canonical-test-cases/{canonical_id}/link — Link Canonical To Suite
DELETE /api/v1/canonical-test-cases/{canonical_id}/managed-link — Unlink Canonical Managed Case
GET /api/v1/canonical-test-cases — List Canonical Cases
POST /api/v1/canonical-test-cases/{canonical_id}/promote — Promote Canonical Case
GET /api/v1/canonical-test-cases/orphaned — List Orphaned Canonical Cases
GET /api/v1/suites/{suite_id}/test-cases — List Suite Test Cases

Used by schemas

More details

Specification: OpenAPI JSON