Outline · Example Payload

Commentslist

Comments

Commentslist is an example object payload from Outline, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdpathmethodsummarytagsrequestSchema

Example Payload

Raw ↑ 
{
  "operationId": "commentsList",
  "path": "/comments.list",
  "method": "POST",
  "summary": "List all comments",
  "tags": [
    "Comments"
  ],
  "requestSchema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Pagination"
      },
      {
        "$ref": "#/components/schemas/Sorting"
      },
      {
        "type": "object",
        "properties": {
          "documentId": {
            "type": "string",
            "format": "uuid",
            "description": "Filter to a specific document"
          },
          "collectionId": {
            "type": "string",
            "format": "uuid",
            "description": "Filter to a specific collection"
          },
          "includeAnchorText": {
            "type": "boolean",
            "description": "Include the document text that the comment is anchored to, if any, in the response."
          }
        }
      }
    ]
  }
}