TestCaseCommentResponse

Fields

11 fields

author_id

string (uuid) or null

comment_type · required

string

content · required

string

created_at · required

string (date-time)

id · required

string (uuid)

is_resolved · required

boolean

mentions

array of CommentMention

parent_id

string (uuid) or null

step_number

integer or null

test_case_id · required

string (uuid)

updated_at · required

string (date-time)

Raw schema (JSON)

{
  "properties": {
    "author_id": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Author Id"
    },
    "comment_type": {
      "title": "Comment Type",
      "type": "string"
    },
    "content": {
      "title": "Content",
      "type": "string"
    },
    "created_at": {
      "format": "date-time",
      "title": "Created At",
      "type": "string"
    },
    "id": {
      "format": "uuid",
      "title": "Id",
      "type": "string"
    },
    "is_resolved": {
      "title": "Is Resolved",
      "type": "boolean"
    },
    "mentions": {
      "default": [],
      "items": {
        "$ref": "#/components/schemas/CommentMention"
      },
      "title": "Mentions",
      "type": "array"
    },
    "parent_id": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Parent Id"
    },
    "step_number": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Step Number"
    },
    "test_case_id": {
      "format": "uuid",
      "title": "Test Case Id",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "title": "Updated At",
      "type": "string"
    }
  },
  "required": [
    "id",
    "test_case_id",
    "content",
    "comment_type",
    "is_resolved",
    "created_at",
    "updated_at"
  ],
  "title": "TestCaseCommentResponse",
  "type": "object"
}

Used by endpoints

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

• GET /api/v1/test-management/cases/{case_id}/comments — List Comments
• POST /api/v1/test-management/cases/{case_id}/comments — Add Comment

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON