REST API OpenAPI spec (#612)

* OpenAPI spec in specs/api.  Checked lint with redoc.
This commit is contained in:
cybermaggedon 2026-01-15 11:04:37 +00:00 committed by GitHub
parent 62b754d788
commit fce43ae035
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
84 changed files with 5638 additions and 0 deletions

View file

@ -0,0 +1,32 @@
type: object
description: |
Document load request - load binary document (PDF, etc.) into processing pipeline.
Fire-and-forget operation (no response).
required:
- data
properties:
data:
type: string
description: Document data (base64 encoded)
format: byte
example: JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PC9UeXBlL...
id:
type: string
description: Document identifier
example: doc-456
user:
type: string
description: User identifier
default: trustgraph
example: alice
collection:
type: string
description: Collection for document
default: default
example: research
metadata:
type: array
description: Document metadata as RDF triples
items:
$ref: '../../common/Triple.yaml'

View 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'