mirror of
https://github.com/trustgraph-ai/trustgraph.git
synced 2026-04-25 08:26:21 +02:00
Update API specs for 2.1 (#699)
* Updating API specs for 2.1 * Updated API and SDK docs
This commit is contained in:
parent
c387670944
commit
664d1d0384
19 changed files with 4280 additions and 1949 deletions
53
specs/api/paths/document-stream.yaml
Normal file
53
specs/api/paths/document-stream.yaml
Normal file
|
|
@ -0,0 +1,53 @@
|
|||
get:
|
||||
tags:
|
||||
- Import/Export
|
||||
summary: Stream document content from library
|
||||
description: |
|
||||
Streams the raw content of a document stored in the library.
|
||||
Returns the document content in chunked transfer encoding.
|
||||
|
||||
## Parameters
|
||||
|
||||
- `user`: User identifier (required)
|
||||
- `document-id`: Document IRI to retrieve (required)
|
||||
- `chunk-size`: Size of each response chunk in bytes (optional, default: 1MB)
|
||||
|
||||
operationId: documentStream
|
||||
security:
|
||||
- bearerAuth: []
|
||||
parameters:
|
||||
- name: user
|
||||
in: query
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: User identifier
|
||||
example: trustgraph
|
||||
- name: document-id
|
||||
in: query
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Document IRI to retrieve
|
||||
example: "urn:trustgraph:doc:abc123"
|
||||
- name: chunk-size
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
type: integer
|
||||
default: 1048576
|
||||
description: Chunk size in bytes (default 1MB)
|
||||
responses:
|
||||
'200':
|
||||
description: Document content streamed as raw bytes
|
||||
content:
|
||||
application/octet-stream:
|
||||
schema:
|
||||
type: string
|
||||
format: binary
|
||||
'400':
|
||||
description: Missing required parameters
|
||||
'401':
|
||||
$ref: '../components/responses/Unauthorized.yaml'
|
||||
'500':
|
||||
$ref: '../components/responses/Error.yaml'
|
||||
Loading…
Add table
Add a link
Reference in a new issue