trustgraph/specs/api/components/schemas/query/RowsQueryRequest.yaml

41 lines
862 B
YAML
Raw Normal View History

type: object
description: |
Rows query request - GraphQL query over structured data.
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