trustgraph/specs/api/paths/flow/triples.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

127 lines
3.9 KiB
YAML

post:
tags:
- Flow Services
summary: Triples query - pattern-based graph queries
description: |
Query knowledge graph using subject-predicate-object patterns.
## Triples Query Overview
Query RDF triples with flexible pattern matching:
- Specify subject, predicate, and/or object
- Any combination of filters (all optional)
- Returns matching triples up to limit
## Pattern Matching
Pattern syntax supports:
- **All triples**: Omit all filters (returns everything up to limit)
- **Subject match**: Specify `s` only (all triples about that subject)
- **Predicate match**: Specify `p` only (all uses of that property)
- **Object match**: Specify `o` only (all triples with that value)
- **Combinations**: Any combination of s/p/o
## RDF Value Format
Each component (s/p/o) uses RdfValue format:
- **Entity/URI**: `{"v": "https://example.com/entity", "e": true}`
- **Literal**: `{"v": "Some text", "e": false}`
## Query Examples
Find all properties of an entity:
```json
{"s": {"v": "https://example.com/person/alice", "e": true}}
```
Find all instances of a type:
```json
{
"p": {"v": "http://www.w3.org/1999/02/22-rdf-syntax-ns#type", "e": true},
"o": {"v": "https://example.com/type/Person", "e": true}
}
```
Find specific relationship:
```json
{
"s": {"v": "https://example.com/person/alice", "e": true},
"p": {"v": "https://example.com/knows", "e": true}
}
```
## Performance
- Default limit: 10,000 triples
- Max limit: 100,000 triples
- More specific patterns = faster queries
- Consider limit for large result sets
operationId: triplesQueryService
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:
$ref: '../../components/schemas/query/TriplesQueryRequest.yaml'
examples:
allTriplesAboutEntity:
summary: All triples about an entity
value:
s:
v: https://example.com/person/alice
e: true
collection: research
limit: 100
allInstancesOfType:
summary: Find all instances of a type
value:
p:
v: http://www.w3.org/1999/02/22-rdf-syntax-ns#type
e: true
o:
v: https://example.com/type/Person
e: true
limit: 50
specificRelationship:
summary: Find specific relationships
value:
p:
v: https://example.com/knows
e: true
limit: 200
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '../../components/schemas/query/TriplesQueryResponse.yaml'
examples:
matchingTriples:
summary: Matching triples
value:
response:
- s: {v: "https://example.com/person/alice", e: true}
p: {v: "https://www.w3.org/1999/02/22-rdf-syntax-ns#type", e: true}
o: {v: "https://example.com/type/Person", e: true}
- s: {v: "https://example.com/person/alice", e: true}
p: {v: "https://www.w3.org/2000/01/rdf-schema#label", e: true}
o: {v: "Alice", e: false}
- s: {v: "https://example.com/person/alice", e: true}
p: {v: "https://example.com/knows", e: true}
o: {v: "https://example.com/person/bob", e: true}
'401':
$ref: '../../components/responses/Unauthorized.yaml'
'500':
$ref: '../../components/responses/Error.yaml'