Outline · Example Payload

Sharescreate

Shares

Sharescreate 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": "sharesCreate",
  "path": "/shares.create",
  "method": "POST",
  "summary": "Create a share",
  "tags": [
    "Shares"
  ],
  "requestSchema": {
    "type": "object",
    "properties": {
      "documentId": {
        "type": "string",
        "format": "uuid",
        "description": "Identifier for the document to share. Mutually exclusive with `collectionId`."
      },
      "collectionId": {
        "type": "string",
        "format": "uuid",
        "description": "Identifier for the collection to share. Mutually exclusive with `documentId`."
      }
    },
    "oneOf": [
      {
        "required": [
          "documentId"
        ]
      },
      {
        "required": [
          "collectionId"
        ]
      }
    ]
  }
}