Atlassian · Schema

PageOfComments

A page of comments.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
comments array The list of comments.
maxResults integer The maximum number of items that could be returned.
startAt integer The index of the first item returned.
total integer The number of items returned.
View JSON Schema on GitHub

JSON Schema

atlassian-pageofcomments-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PageOfComments",
  "title": "PageOfComments",
  "additionalProperties": true,
  "description": "A page of comments.",
  "properties": {
    "comments": {
      "description": "The list of comments.",
      "items": {
        "$ref": "#/components/schemas/Comment"
      },
      "readOnly": true,
      "type": "array"
    },
    "maxResults": {
      "description": "The maximum number of items that could be returned.",
      "format": "int32",
      "readOnly": true,
      "type": "integer"
    },
    "startAt": {
      "description": "The index of the first item returned.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "total": {
      "description": "The number of items returned.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    }
  },
  "type": "object"
}