Skip to content

Document patch editMode and Share allowSubscriptions #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tommoor merged 1 commit into from
Apr 17, 2026
Merged

Document patch editMode and Share allowSubscriptions #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions spec3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3301,6 +3301,10 @@
"editMode": {
"$ref": "#/components/schemas/TextEditMode"
},
"findText": {
"type": "string",
"description": "The text to find within the document when using `patch` editMode. This text will be replaced with the value of `text`. Required when `editMode` is `patch`."
},
"publish": {
"type": "boolean",
"description": "Whether this document should be published and made visible to other workspace members, if a draft"
Expand Down Expand Up @@ -8095,11 +8099,12 @@
},
"TextEditMode": {
"type": "string",
"description": "The editing mode for text updates to a document.",
"description": "The editing mode for text updates to a document. When set to `patch`, the `findText` parameter is required and the existing occurrence of `findText` will be replaced with the value of `text`.",
"enum": [
"append",
"prepend",
"replace"
"replace",
"patch"
]
},
"Attachment": {
Expand Down Expand Up @@ -8919,6 +8924,11 @@
"example": true,
"description": "If to also give permission to view documents nested beneath this one."
},
"allowSubscriptions": {
"type": "boolean",
"example": true,
"description": "Whether visitors to the public share can subscribe to receive email notifications when the document is updated. Requires SMTP to be configured on the workspace."
},
"createdAt": {
"type": "string",
"format": "date-time",
Expand Down
16 changes: 15 additions & 1 deletion spec3.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2404,6 +2404,11 @@ paths:
description: Whether insights should be visible on the document
editMode:
"$ref": "#/components/schemas/TextEditMode"
findText:
type: string
description: The text to find within the document when using
`patch` editMode. This text will be replaced with the value
of `text`. Required when `editMode` is `patch`.
publish:
type: boolean
description: Whether this document should be published and made
Expand Down Expand Up @@ -5550,11 +5555,14 @@ components:
- read_write
TextEditMode:
type: string
description: The editing mode for text updates to a document.
description: The editing mode for text updates to a document. When set to
`patch`, the `findText` parameter is required and the existing occurrence
of `findText` will be replaced with the value of `text`.
enum:
- append
- prepend
- replace
- patch
Attachment:
type: object
properties:
Expand Down Expand Up @@ -6187,6 +6195,12 @@ components:
example: true
description: If to also give permission to view documents nested beneath
this one.
allowSubscriptions:
type: boolean
example: true
description: Whether visitors to the public share can subscribe to
receive email notifications when the document is updated. Requires
SMTP to be configured on the workspace.
createdAt:
type: string
format: date-time
Expand Down
Loading