Skip to content

Omit data and text from revisions.list response #32

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

Open
tommoor wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Omit data and text from revisions.list response #32

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
36 changes: 24 additions & 12 deletions spec3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6590,7 +6590,7 @@
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Revision"
"$ref": "#/components/schemas/RevisionDetail"
}
}
}
Expand Down Expand Up @@ -6619,7 +6619,7 @@
"Revisions"
],
"summary": "List all revisions",
"description": "List all revisions for a specific document. Revisions represent historical snapshots of a document's content and can be used to track changes over time.",
"description": "List all revisions for a specific document. Revisions represent historical snapshots of a document's content and can be used to track changes over time. The `data` and `text` fields are omitted from listed revisions for performance; use `revisions.info` to retrieve the full content of a specific revision.",
"requestBody": {
"content": {
"application/json": {
Expand Down Expand Up @@ -9636,16 +9636,6 @@
"description": "The name of the revision, if any.",
"readOnly": true
},
"data": {
"type": "object",
"description": "The body of the revision as a Prosemirror document.",
"readOnly": true
},
"text": {
"type": "string",
"description": "Body of the document, may contain markdown formatting",
"readOnly": true
},
"icon": {
"type": "string",
"nullable": true,
Expand Down Expand Up @@ -9688,6 +9678,28 @@
}
}
},
"RevisionDetail": {
"allOf": [
{
"$ref": "#/components/schemas/Revision"
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"description": "The body of the revision as a Prosemirror document.",
"readOnly": true
},
"text": {
"type": "string",
"description": "Body of the document, may contain markdown formatting",
"readOnly": true
}
}
}
]
},
"Share": {
"type": "object",
"properties": {
Expand Down
25 changes: 15 additions & 10 deletions spec3.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4623,7 +4623,7 @@ paths:
type: object
properties:
data:
"$ref": "#/components/schemas/Revision"
"$ref": "#/components/schemas/RevisionDetail"
"401":
"$ref": "#/components/responses/Unauthenticated"
"403":
Expand All @@ -4638,7 +4638,7 @@ paths:
tags:
- Revisions
summary: List all revisions
description: List all revisions for a specific document. Revisions represent historical snapshots of a document's content and can be used to track changes over time.
description: List all revisions for a specific document. Revisions represent historical snapshots of a document's content and can be used to track changes over time. The `data` and `text` fields are omitted from listed revisions for performance; use `revisions.info` to retrieve the full content of a specific revision.
requestBody:
content:
application/json:
Expand Down Expand Up @@ -6764,14 +6764,6 @@ components:
nullable: true
description: The name of the revision, if any.
readOnly: true
data:
type: object
description: The body of the revision as a Prosemirror document.
readOnly: true
text:
type: string
description: Body of the document, may contain markdown formatting
readOnly: true
icon:
type: string
nullable: true
Expand Down Expand Up @@ -6804,6 +6796,19 @@ components:
nullable: true
description: Date and time when this revision was deleted, if applicable.
readOnly: true
RevisionDetail:
allOf:
- "$ref": "#/components/schemas/Revision"
- type: object
properties:
data:
type: object
description: The body of the revision as a Prosemirror document.
readOnly: true
text:
type: string
description: Body of the document, may contain markdown formatting
readOnly: true
Share:
type: object
properties:
Expand Down
Loading