Comment Response Object

APIs.ioEngineeringPlatform

Properties

Name Type Description
data array
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-commentresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/commentResponse",
  "title": "Comment Response Object",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "required": [
        "id",
        "threadId",
        "createdBy",
        "createdAt",
        "updatedAt",
        "body"
      ],
      "items": {
        "type": "object",
        "description": "Information about the comment.",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The comment's ID.",
            "example": 46814
          },
          "threadId": {
            "type": "integer",
            "description": "The comment's thread ID.",
            "example": 12345
          },
          "createdBy": {
            "type": "integer",
            "description": "The user ID of the user who created the comment.",
            "example": 12345678
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time at which the comment was created.",
            "example": "2024-01-18T11:30:40.000Z"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time when the comment was last updated.",
            "example": "2024-01-18T11:30:40.000Z"
          },
          "body": {
            "type": "string",
            "description": "The contents of the comment.",
            "example": "This is an example."
          }
        }
      }
    }
  }
}