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,29 @@
type: object
description: |
Document embeddings query request - find similar documents by vector similarity.
required:
- vectors
properties:
vectors:
type: array
description: Query embedding vector
items:
type: number
example: [0.023, -0.142, 0.089, 0.234, -0.067, 0.156]
limit:
type: integer
description: Maximum number of document chunks to return
default: 10
minimum: 1
maximum: 1000
example: 20
user:
type: string
description: User identifier
default: trustgraph
example: alice
collection:
type: string
description: Collection to search
default: default
example: research

View file

@ -0,0 +1,12 @@
type: object
description: Document embeddings query response
properties:
chunks:
type: array
description: Similar document chunks (text strings)
items:
type: string
example:
- "Quantum computing uses quantum mechanics principles for computation..."
- "Neural networks are computing systems inspired by biological neurons..."
- "Machine learning algorithms learn patterns from data..."

View file

@ -0,0 +1,29 @@
type: object
description: |
Graph embeddings query request - find similar entities by vector similarity.
required:
- vectors
properties:
vectors:
type: array
description: Query embedding vector
items:
type: number
example: [0.023, -0.142, 0.089, 0.234, -0.067, 0.156]
limit:
type: integer
description: Maximum number of entities to return
default: 10
minimum: 1
maximum: 1000
example: 20
user:
type: string
description: User identifier
default: trustgraph
example: alice
collection:
type: string
description: Collection to search
default: default
example: research

View file

@ -0,0 +1,12 @@
type: object
description: Graph embeddings query response
properties:
entities:
type: array
description: Similar entities (RDF values)
items:
$ref: '../../common/RdfValue.yaml'
example:
- {v: "https://example.com/person/alice", e: true}
- {v: "https://example.com/person/bob", e: true}
- {v: "https://example.com/concept/quantum", e: true}