seb/dashlibstorage
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: expand input and output object types in API signatures

Browse Source
This commit is contained in:
seb
2026-09-16 17:45:46 +02:00
parent 9b1b7615e2
commit 5a7773df79
22 changed files with 128 additions and 89 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
API.manifestattachment.md
View File

@@ -21,7 +21,7 @@ Attaches a file to an existing manifest.
**Returns**
`Promise<object>` — The created attachment record.
`Promise<{id: number, manifestId: number, fileId: number, mimetype: string, name: string}>` — The created attachment record.
**Throws**
@@ -54,7 +54,7 @@ Gets an attachment for a manifest by its attachment ID or file ID, including ful
**Returns**
`Promise<object>` — The attachment record with binary content.
`Promise<{id: number, manifestId: number, fileId: number, mimetype: string, name: string, content: Buffer}>` — The attachment record with binary content.
**Throws**
@@ -82,7 +82,7 @@ Lists all attachments for a given manifest, without loading their full binary co
**Returns**
`Promise<Array<object>>` — A list of attachment metadata objects.
`Promise<Array<{id: number, manifestId: number, fileId: number, mimetype: string, name: string, size: number}>>` — A list of attachment metadata objects.
**Throws**