Outline · Example Payload

Collectionsadduser

Collections

Collectionsadduser 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": "collectionsAddUser",
  "path": "/collections.add_user",
  "method": "POST",
  "summary": "Add a collection user",
  "tags": [
    "Collections"
  ],
  "requestSchema": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "description": "Identifier for the collection",
        "format": "uuid"
      },
      "userId": {
        "type": "string",
        "description": "Identifier for the user to add to the collection",
        "format": "uuid"
      },
      "permission": {
        "$ref": "#/components/schemas/Permission"
      }
    },
    "required": [
      "id",
      "userId"
    ]
  }
}