Outline · Example Payload

Documentsinfo

Documents

Documentsinfo 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": "documentsInfo",
  "path": "/documents.info",
  "method": "POST",
  "summary": "Retrieve a document",
  "tags": [
    "Documents"
  ],
  "requestSchema": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "description": "Unique identifier for the document. Either the UUID or the urlId is acceptable."
      },
      "shareId": {
        "type": "string",
        "format": "uuid",
        "description": "Unique identifier for a document share, a shareId may be used in place of a document UUID"
      }
    }
  }
}