RequirementLinkRead

Fields

8 fields

created_at · required

string (date-time)

created_by_name

string or null

id · required

string (uuid)

link_type · required

string

normalized_key · required

string

requirement_key · required

string

requirement_title

string or null

test_case_id · required

string (uuid)

Raw schema (JSON)

{
  "properties": {
    "created_at": {
      "format": "date-time",
      "title": "Created At",
      "type": "string"
    },
    "created_by_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Created By Name"
    },
    "id": {
      "format": "uuid",
      "title": "Id",
      "type": "string"
    },
    "link_type": {
      "title": "Link Type",
      "type": "string"
    },
    "normalized_key": {
      "title": "Normalized Key",
      "type": "string"
    },
    "requirement_key": {
      "title": "Requirement Key",
      "type": "string"
    },
    "requirement_title": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Requirement Title"
    },
    "test_case_id": {
      "format": "uuid",
      "title": "Test Case Id",
      "type": "string"
    }
  },
  "required": [
    "id",
    "test_case_id",
    "requirement_key",
    "normalized_key",
    "link_type",
    "created_at"
  ],
  "title": "RequirementLinkRead",
  "type": "object"
}

Used by endpoints

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

• POST /api/v1/test-management/cases/{case_id}/requirements — Add Case Requirement
• GET /api/v1/test-management/cases/{case_id}/requirements — List Case Requirements

Used by schemas

• RequirementLinkListResponse

More details

• Specification: OpenAPI JSON