Outline · Example Payload

Collectionsmemberships

Collections

Collectionsmemberships 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": "collectionsMemberships",
  "path": "/collections.memberships",
  "method": "POST",
  "summary": "List all collection memberships",
  "tags": [
    "Collections"
  ],
  "requestSchema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Pagination"
      },
      {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Identifier for the collection",
            "format": "uuid"
          },
          "query": {
            "type": "string",
            "description": "Filter memberships by user names",
            "example": "jenny"
          },
          "permission": {
            "$ref": "#/components/schemas/Permission"
          }
        },
        "required": [
          "id"
        ]
      }
    ]
  }
}