trustgraph/specs/api/paths/export-core.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

98 lines
2.3 KiB
YAML

get:
tags:
- Import/Export
summary: Export Core - bulk export triples and embeddings
description: |
Export knowledge cores in bulk using streaming MessagePack format.
## Export Core Overview
Bulk data export for knowledge graph:
- **Format**: MessagePack streaming
- **Content**: Triples and graph embeddings
- **Source**: Global knowledge storage
- **Use**: Backups, data migration, archival
## MessagePack Protocol
Response body is MessagePack stream with message tuples:
### Triple Message
```
("t", {
"m": { // Metadata
"i": "core-id", // Knowledge core ID
"m": [...], // Metadata triples array
"c": "collection" // Collection
},
"t": [...] // Triples array
})
```
### Graph Embeddings Message
```
("ge", {
"m": { // Metadata
"i": "core-id",
"m": [...],
"c": "collection"
},
"e": [ // Entities array
{
"e": {"v": "uri", "e": true}, // Entity RdfValue
"v": [0.1, 0.2, ...] // Vectors
}
]
})
```
### End of Stream Message
```
("eos", {})
```
## Query Parameters
- **id**: Knowledge core ID to export
## Streaming
Data streamed incrementally:
- Triples sent first
- Graph embeddings sent next
- EOS marker signals completion
Client should process messages as received.
## Use Cases
- **Backups**: Export for disaster recovery
- **Data migration**: Move to another system
- **Archival**: Long-term storage
- **Replication**: Copy knowledge cores
- **Analysis**: External processing
operationId: exportCore
security:
- bearerAuth: []
parameters:
- name: id
in: query
required: true
schema:
type: string
description: Knowledge core ID to export
example: core-123
responses:
'200':
description: Export stream
content:
application/msgpack:
schema:
type: string
format: binary
description: MessagePack stream of knowledge data
'401':
$ref: '../components/responses/Unauthorized.yaml'
'500':
$ref: '../components/responses/Error.yaml'