trustgraph/specs/api/paths/flow/sparql-query.yaml
cybermaggedon d35473f7f7
feat: workspace-based multi-tenancy, replacing user as tenancy axis (#840)
Introduces `workspace` as the isolation boundary for config, flows,
library, and knowledge data. Removes `user` as a schema-level field
throughout the code, API specs, and tests; workspace provides the
same separation more cleanly at the trusted flow.workspace layer
rather than through client-supplied message fields.

Design
------
- IAM tech spec (docs/tech-specs/iam.md) documents current state,
  proposed auth/access model, and migration direction.
- Data ownership model (docs/tech-specs/data-ownership-model.md)
  captures the workspace/collection/flow hierarchy.

Schema + messaging
------------------
- Drop `user` field from AgentRequest/Step, GraphRagQuery,
  DocumentRagQuery, Triples/Graph/Document/Row EmbeddingsRequest,
  Sparql/Rows/Structured QueryRequest, ToolServiceRequest.
- Keep collection/workspace routing via flow.workspace at the
  service layer.
- Translators updated to not serialise/deserialise user.

API specs
---------
- OpenAPI schemas and path examples cleaned of user fields.
- Websocket async-api messages updated.
- Removed the unused parameters/User.yaml.

Services + base
---------------
- Librarian, collection manager, knowledge, config: all operations
  scoped by workspace. Config client API takes workspace as first
  positional arg.
- `flow.workspace` set at flow start time by the infrastructure;
  no longer pass-through from clients.
- Tool service drops user-personalisation passthrough.

CLI + SDK
---------
- tg-init-workspace and workspace-aware import/export.
- All tg-* commands drop user args; accept --workspace.
- Python API/SDK (flow, socket_client, async_*, explainability,
  library) drop user kwargs from every method signature.

MCP server
----------
- All tool endpoints drop user parameters; socket_manager no longer
  keyed per user.

Flow service
------------
- Closure-based topic cleanup on flow stop: only delete topics
  whose blueprint template was parameterised AND no remaining
  live flow (across all workspaces) still resolves to that topic.
  Three scopes fall out naturally from template analysis:
    * {id} -> per-flow, deleted on stop
    * {blueprint} -> per-blueprint, kept while any flow of the
      same blueprint exists
    * {workspace} -> per-workspace, kept while any flow in the
      workspace exists
    * literal -> global, never deleted (e.g. tg.request.librarian)
  Fixes a bug where stopping a flow silently destroyed the global
  librarian exchange, wedging all library operations until manual
  restart.

RabbitMQ backend
----------------
- heartbeat=60, blocked_connection_timeout=300. Catches silently
  dead connections (broker restart, orphaned channels, network
  partitions) within ~2 heartbeat windows, so the consumer
  reconnects and re-binds its queue rather than sitting forever
  on a zombie connection.

Tests
-----
- Full test refresh: unit, integration, contract, provenance.
- Dropped user-field assertions and constructor kwargs across
  ~100 test files.
- Renamed user-collection isolation tests to workspace-collection.
2026-04-21 23:23:01 +01:00

140 lines
4.2 KiB
YAML

post:
tags:
- Flow Services
summary: SPARQL query - execute SPARQL 1.1 queries against the knowledge graph
description: |
Execute a SPARQL 1.1 query against the knowledge graph.
## Supported Query Types
- **SELECT**: Returns variable bindings as a table of results
- **ASK**: Returns true/false for existence checks
- **CONSTRUCT**: Returns a set of triples built from a template
- **DESCRIBE**: Returns triples describing matched resources
## SPARQL Features
Supports standard SPARQL 1.1 features including:
- Basic Graph Patterns (BGPs) with triple pattern matching
- OPTIONAL, UNION, FILTER
- BIND, VALUES
- ORDER BY, LIMIT, OFFSET, DISTINCT
- GROUP BY with aggregates (COUNT, SUM, AVG, MIN, MAX, GROUP_CONCAT)
- Built-in functions (isIRI, STR, REGEX, CONTAINS, etc.)
## Query Examples
Find all entities of a type:
```sparql
SELECT ?s ?label WHERE {
?s <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <http://example.com/Person> .
?s <http://www.w3.org/2000/01/rdf-schema#label> ?label .
}
LIMIT 10
```
Check if an entity exists:
```sparql
ASK { <http://example.com/alice> ?p ?o }
```
operationId: sparqlQueryService
security:
- bearerAuth: []
parameters:
- name: flow
in: path
required: true
schema:
type: string
description: Flow instance ID
example: my-flow
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- query
properties:
query:
type: string
description: SPARQL 1.1 query string
collection:
type: string
default: default
description: Collection identifier
limit:
type: integer
default: 10000
description: Safety limit on number of results
examples:
selectQuery:
summary: SELECT query
value:
query: "SELECT ?s ?p ?o WHERE { ?s ?p ?o } LIMIT 10"
collection: default
askQuery:
summary: ASK query
value:
query: "ASK { <http://example.com/alice> ?p ?o }"
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
query-type:
type: string
enum: [select, ask, construct, describe]
variables:
type: array
items:
type: string
description: Variable names (SELECT only)
bindings:
type: array
items:
type: object
properties:
values:
type: array
items:
$ref: '../../components/schemas/common/RdfValue.yaml'
description: Result rows (SELECT only)
ask-result:
type: boolean
description: Boolean result (ASK only)
triples:
type: array
description: Result triples (CONSTRUCT/DESCRIBE only)
error:
type: object
properties:
type:
type: string
message:
type: string
examples:
selectResult:
summary: SELECT result
value:
query-type: select
variables: [s, p, o]
bindings:
- values:
- {t: i, i: "http://example.com/alice"}
- {t: i, i: "http://www.w3.org/1999/02/22-rdf-syntax-ns#type"}
- {t: i, i: "http://example.com/Person"}
askResult:
summary: ASK result
value:
query-type: ask
ask-result: true
'401':
$ref: '../../components/responses/Unauthorized.yaml'
'500':
$ref: '../../components/responses/Error.yaml'