mirror of
https://github.com/trustgraph-ai/trustgraph.git
synced 2026-04-25 08:26:21 +02:00
REST API OpenAPI spec (#612)
* OpenAPI spec in specs/api. Checked lint with redoc.
This commit is contained in:
parent
62b754d788
commit
fce43ae035
84 changed files with 5638 additions and 0 deletions
37
specs/api/components/schemas/loading/TextLoadRequest.yaml
Normal file
37
specs/api/components/schemas/loading/TextLoadRequest.yaml
Normal file
|
|
@ -0,0 +1,37 @@
|
|||
type: object
|
||||
description: |
|
||||
Text load request - load text document into processing pipeline.
|
||||
|
||||
Fire-and-forget operation (no response).
|
||||
required:
|
||||
- text
|
||||
properties:
|
||||
text:
|
||||
type: string
|
||||
description: Text content (base64 encoded)
|
||||
format: byte
|
||||
example: VGhpcyBpcyB0aGUgZG9jdW1lbnQgdGV4dC4uLg==
|
||||
id:
|
||||
type: string
|
||||
description: Document identifier
|
||||
example: doc-123
|
||||
user:
|
||||
type: string
|
||||
description: User identifier
|
||||
default: trustgraph
|
||||
example: alice
|
||||
collection:
|
||||
type: string
|
||||
description: Collection for document
|
||||
default: default
|
||||
example: research
|
||||
charset:
|
||||
type: string
|
||||
description: Text character encoding
|
||||
default: utf-8
|
||||
example: utf-8
|
||||
metadata:
|
||||
type: array
|
||||
description: Document metadata as RDF triples
|
||||
items:
|
||||
$ref: '../../common/Triple.yaml'
|
||||
Loading…
Add table
Add a link
Reference in a new issue