PinnedCollectionsUpdateDto

Endpoints · All schemas

Field	Required	Description
expectedRevision	Yes	Revision returned by GET; null only when no pin list exists. A stale save returns 409
pins	Yes	Replace the complete ordered list to add, remove or reorder pins; an empty list clears it

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

Field definitions: PinnedCollectionRef

{
  "additionalProperties": false,
  "properties": {
    "expectedRevision": {
      "description": "Revision returned by GET; null only when no pin list exists. A stale save returns 409",
      "format": "uuid",
      "nullable": true,
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "type": "string"
    },
    "pins": {
      "description": "Replace the complete ordered list to add, remove or reorder pins; an empty list clears it",
      "items": {
        "$ref": "#/components/schemas/PinnedCollectionRef"
      },
      "maxItems": 50,
      "type": "array"
    }
  },
  "required": [
    "expectedRevision",
    "pins"
  ],
  "type": "object"
}