From 7be110c14fcbf0c21dee8b16aa770ace9230cb9d Mon Sep 17 00:00:00 2001 From: Claude Date: Fri, 12 Jun 2026 11:04:04 +0000 Subject: [PATCH 1/2] Document data parameter on collections.create and collections.update Adds the rich-text ProseMirror `data` parameter to both collection endpoints and notes the new mutual exclusivity with the markdown `description` parameter (outline/outline#12648). --- spec3.yml | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/spec3.yml b/spec3.yml index 82e5c1b..2d35461 100644 --- a/spec3.yml +++ b/spec3.yml @@ -808,8 +808,11 @@ paths: example: Human Resources description: type: string - description: A brief description of the collection, markdown supported. + description: A brief description of the collection, markdown supported. Only one of `description` or `data` may be provided. example: HR documentation is confidential and should be handled with care. + data: + type: object + description: The collection description as a rich-text ProseMirror JSON document. Only one of `description` or `data` may be provided. permission: "$ref": "#/components/schemas/Permission" icon: @@ -868,8 +871,11 @@ paths: example: Human Resources description: type: string - description: A brief description of the collection, markdown supported. + description: A brief description of the collection, markdown supported. Only one of `description` or `data` may be provided. example: HR documentation is confidential and should be handled with care. + data: + type: object + description: The collection description as a rich-text ProseMirror JSON document. Only one of `description` or `data` may be provided. permission: "$ref": "#/components/schemas/Permission" icon: From fba9f0e6e20e1cad200aa91bc658ee7e5ad5d8e7 Mon Sep 17 00:00:00 2001 From: Claude Date: Fri, 12 Jun 2026 11:05:05 +0000 Subject: [PATCH 2/2] Regenerate spec3.json --- spec3.json | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/spec3.json b/spec3.json index 93562d7..f4579bc 100644 --- a/spec3.json +++ b/spec3.json @@ -910,9 +910,13 @@ }, "description": { "type": "string", - "description": "A brief description of the collection, markdown supported.", + "description": "A brief description of the collection, markdown supported. Only one of `description` or `data` may be provided.", "example": "HR documentation is confidential and should be handled with care." }, + "data": { + "type": "object", + "description": "The collection description as a rich-text ProseMirror JSON document. Only one of `description` or `data` may be provided." + }, "permission": { "$ref": "#/components/schemas/Permission" }, @@ -999,9 +1003,13 @@ }, "description": { "type": "string", - "description": "A brief description of the collection, markdown supported.", + "description": "A brief description of the collection, markdown supported. Only one of `description` or `data` may be provided.", "example": "HR documentation is confidential and should be handled with care." }, + "data": { + "type": "object", + "description": "The collection description as a rich-text ProseMirror JSON document. Only one of `description` or `data` may be provided." + }, "permission": { "$ref": "#/components/schemas/Permission" },