Outline · Example Payload

Commentsinfo

Comments

Commentsinfo 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": "commentsInfo",
  "path": "/comments.info",
  "method": "POST",
  "summary": "Retrieve a comment",
  "tags": [
    "Comments"
  ],
  "requestSchema": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "format": "uuid"
      },
      "includeAnchorText": {
        "type": "boolean",
        "description": "Include the document text that the comment is anchored to, if any, in the response."
      }
    },
    "required": [
      "id"
    ]
  }
}