Outline · Example Payload

Commentscreate

Comments

Commentscreate 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": "commentsCreate",
  "path": "/comments.create",
  "method": "POST",
  "summary": "Create a comment",
  "tags": [
    "Comments"
  ],
  "requestSchema": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "format": "uuid"
      },
      "documentId": {
        "type": "string",
        "format": "uuid"
      },
      "parentCommentId": {
        "type": "string",
        "format": "uuid"
      },
      "data": {
        "type": "object",
        "description": "The body of the comment."
      },
      "text": {
        "type": "string",
        "description": "The body of the comment in markdown.",
        "example": "Sounds great"
      },
      "anchorText": {
        "type": "string",
        "description": "Plain text substring to anchor the comment to as an inline comment. The first occurrence in the document's plain text is used unless disambiguated by `anchorPrefix` and/or `anchorSuffix`."
      },
      "anchorPrefix": {
        "type": "string",
        "description": "Text immediately preceding `anchorText`, used to disambiguate between multiple occurrences. Requires `anchorText`."
      },
      "anchorSuffix": {
        "type": "string",
        "description": "Text immediately following `anchorText`, used to disambiguate between multiple occurrences. Requires `anchorText`."
      }
    },
    "required": [
      "documentId"
    ]
  }
}