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
40
specs/api/components/schemas/query/ObjectsQueryRequest.yaml
Normal file
40
specs/api/components/schemas/query/ObjectsQueryRequest.yaml
Normal file
|
|
@ -0,0 +1,40 @@
|
|||
type: object
|
||||
description: |
|
||||
Objects query request - GraphQL query over knowledge graph.
|
||||
required:
|
||||
- query
|
||||
properties:
|
||||
query:
|
||||
type: string
|
||||
description: GraphQL query string
|
||||
example: |
|
||||
query GetPerson($id: ID!) {
|
||||
person(id: $id) {
|
||||
name
|
||||
email
|
||||
knows {
|
||||
name
|
||||
}
|
||||
}
|
||||
}
|
||||
variables:
|
||||
type: object
|
||||
description: GraphQL query variables
|
||||
additionalProperties:
|
||||
type: string
|
||||
example:
|
||||
id: "https://example.com/person/alice"
|
||||
operation-name:
|
||||
type: string
|
||||
description: Operation name (for multi-operation documents)
|
||||
example: GetPerson
|
||||
user:
|
||||
type: string
|
||||
description: User identifier
|
||||
default: trustgraph
|
||||
example: alice
|
||||
collection:
|
||||
type: string
|
||||
description: Collection to query
|
||||
default: default
|
||||
example: research
|
||||
Loading…
Add table
Add a link
Reference in a new issue