Skip to content

Fix FileOperation response schema #28

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
May 30, 2026
+86 −24
Merged

Fix FileOperation response schema #28

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
57 changes: 42 additions & 15 deletions spec3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9175,6 +9175,17 @@
"export"
]
},
"format": {
"type": "string",
"description": "The file format of the resulting file.",
"example": "outline-markdown",
"readOnly": true
},
"name": {
"type": "string",
"description": "The name of the file operation, derived from the collection name, document title, or file name.",
"readOnly": true
},
"state": {
"type": "string",
"description": "The state of the file operation.",
Expand All @@ -9188,30 +9199,46 @@
"expired"
]
},
"collection": {
"allOf": [
{
"nullable": true
},
{
"$ref": "#/components/schemas/Collection"
}
]
},
"user": {
"$ref": "#/components/schemas/User"
"error": {
"type": "string",
"nullable": true,
"description": "An error message if the file operation failed.",
"readOnly": true
},
"size": {
"type": "number",
"description": "The size of the resulting file in bytes",
"type": "string",
"description": "The size of the resulting file in bytes. Returned as a string as the value may exceed the safe integer range.",
"readOnly": true,
"example": 2048
"example": "2048"
},
"collectionId": {
"type": "string",
"nullable": true,
"description": "Identifier for the associated collection, if the file operation is scoped to a single collection.",
"readOnly": true,
"format": "uuid"
},
"documentId": {
"type": "string",
"nullable": true,
"description": "Identifier for the associated document, if the file operation is scoped to a single document.",
"readOnly": true,
"format": "uuid"
},
"user": {
"$ref": "#/components/schemas/User"
},
"createdAt": {
"type": "string",
"description": "The date and time that this object was created",
"readOnly": true,
"format": "date-time"
},
"updatedAt": {
"type": "string",
"description": "The date and time that this object was last changed",
"readOnly": true,
"format": "date-time"
}
}
},
Expand Down
53 changes: 44 additions & 9 deletions spec3.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6380,6 +6380,17 @@ components:
enum:
- import
- export
format:
type: string
description: The file format of the resulting file.
example: outline-markdown
readOnly: true
name:
type: string
description: >-
The name of the file operation, derived from the collection name,
document title, or file name.
readOnly: true
state:
type: string
description: The state of the file operation.
Expand All @@ -6391,22 +6402,46 @@ components:
- complete
- error
- expired
collection:
allOf:
- nullable: true
- "$ref": "#/components/schemas/Collection"
user:
"$ref": "#/components/schemas/User"
error:
type: string
nullable: true
description: An error message if the file operation failed.
readOnly: true
size:
type: number
description: The size of the resulting file in bytes
type: string
description: >-
The size of the resulting file in bytes. Returned as a string as the
value may exceed the safe integer range.
readOnly: true
example: "2048"
collectionId:
type: string
nullable: true
description: >-
Identifier for the associated collection, if the file operation is
scoped to a single collection.
readOnly: true
format: uuid
documentId:
type: string
nullable: true
description: >-
Identifier for the associated document, if the file operation is
scoped to a single document.
readOnly: true
example: 2048
format: uuid
user:
"$ref": "#/components/schemas/User"
createdAt:
type: string
description: The date and time that this object was created
readOnly: true
format: date-time
updatedAt:
type: string
description: The date and time that this object was last changed
readOnly: true
format: date-time
Group:
type: object
properties:
Expand Down
Loading