# opensharing-io/opensharing architecture

> Architecture diagram of the GitHub repository opensharing-io/opensharing, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-05). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/opensharing-io/opensharing
- Repository: https://github.com/opensharing-io/opensharing

## Overview

OpenSharing is a documented, vendor-neutral protocol for discovering and sharing data and AI assets without copying them. Providers define shares and assets; recipients discover them through a sharing server, obtain scoped credentials, then read directly from provider storage. The repository contains protocol specifications rather than runtime code, so this map describes documented protocol roles and capabilities, not implementation calls.

Main entry points: [`spec/protocols/SCHEMAS.md`](https://github.com/opensharing-io/opensharing/blob/main/spec/protocols/SCHEMAS.md) (Schemas), [`spec/protocols/CREDENTIALS.md`](https://github.com/opensharing-io/opensharing/blob/main/spec/protocols/CREDENTIALS.md) (Credential model), [`spec/protocols/OVERVIEW.md`](https://github.com/opensharing-io/opensharing/blob/main/spec/protocols/OVERVIEW.md) (Sharing server), [`spec/protocols/SHARES.md`](https://github.com/opensharing-io/opensharing/blob/main/spec/protocols/SHARES.md) (Shares)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_core["Protocol hierarchy"]
  node_shares["Shares<br/>[SHARES.md]"]
  node_schemas["Schemas<br/>[SCHEMAS.md]"]
end

subgraph group_assets["Asset specifications"]
  node_tables["Tables<br/>[TABLES.md]"]
  node_volumes["Volumes<br/>[VOLUMES.md]"]
  node_skills["Agent skills<br/>[AGENT_SKILLS.md]"]
  node_models["ML models<br/>[ML_MODELS.md]"]
  node_agents["Agent proposal<br/>[AGENTS.md]"]
  node_pages["Page proposal<br/>[GLOSSARY.md]"]
end

subgraph group_access["Access and credentials"]
  node_server["Sharing server<br/>[OVERVIEW.md]"]
  node_credentials["Credential model<br/>[CREDENTIALS.md]"]
end

subgraph group_ecosystem["Participants and storage"]
  node_provider(("Provider"))
  node_recipient(("Recipient"))
  node_storage[("Provider storage")]
  node_clients["Compliant clients"]
end

node_provider -->|"creates shares"| node_server
node_provider -->|"defines access"| node_shares
node_shares -->|"groups assets"| node_schemas
node_schemas -->|"contains"| node_tables
node_schemas -->|"contains"| node_volumes
node_schemas -->|"contains"| node_skills
node_schemas -->|"contains"| node_models
node_schemas -->|"proposes"| node_agents
node_schemas -->|"proposes"| node_pages
node_recipient -->|"discovers assets"| node_server
node_server -->|"vends credentials"| node_credentials
node_server -->|"issues credentials"| node_recipient
node_recipient -->|"reads directly"| node_storage
node_clients -->|"uses protocol"| node_server
node_tables -->|"defines credential endpoint"| node_credentials
node_volumes -->|"defines credential endpoint"| node_credentials
node_skills -->|"defines credential endpoint"| node_credentials
node_models -->|"defines credential endpoint"| node_credentials
node_credentials -->|"grants scoped access"| node_storage

click node_server "https://github.com/opensharing-io/opensharing/blob/main/spec/protocols/OVERVIEW.md"
click node_shares "https://github.com/opensharing-io/opensharing/blob/main/spec/protocols/SHARES.md"
click node_schemas "https://github.com/opensharing-io/opensharing/blob/main/spec/protocols/SCHEMAS.md"
click node_tables "https://github.com/opensharing-io/opensharing/blob/main/spec/protocols/TABLES.md"
click node_volumes "https://github.com/opensharing-io/opensharing/blob/main/spec/protocols/VOLUMES.md"
click node_skills "https://github.com/opensharing-io/opensharing/blob/main/spec/protocols/AGENT_SKILLS.md"
click node_models "https://github.com/opensharing-io/opensharing/blob/main/spec/protocols/ML_MODELS.md"
click node_agents "https://github.com/opensharing-io/opensharing/blob/main/spec/protocols/AGENTS.md"
click node_pages "https://github.com/opensharing-io/opensharing/blob/main/spec/protocols/GLOSSARY.md"
click node_credentials "https://github.com/opensharing-io/opensharing/blob/main/spec/protocols/CREDENTIALS.md"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_shares,node_schemas toneBlue
class node_tables,node_volumes,node_skills,node_models,node_agents,node_pages toneAmber
class node_server,node_credentials toneMint
class node_provider,node_recipient,node_storage,node_clients toneRose
```

## Components

### Protocol hierarchy

- [Shares](https://github.com/opensharing-io/opensharing/blob/main/spec/protocols/SHARES.md): `spec/protocols/SHARES.md`
- [Schemas](https://github.com/opensharing-io/opensharing/blob/main/spec/protocols/SCHEMAS.md): `spec/protocols/SCHEMAS.md`

### Asset specifications

- [Tables](https://github.com/opensharing-io/opensharing/blob/main/spec/protocols/TABLES.md): `spec/protocols/TABLES.md`
- [Volumes](https://github.com/opensharing-io/opensharing/blob/main/spec/protocols/VOLUMES.md): `spec/protocols/VOLUMES.md`
- [Agent skills](https://github.com/opensharing-io/opensharing/blob/main/spec/protocols/AGENT_SKILLS.md): `spec/protocols/AGENT_SKILLS.md`
- [ML models](https://github.com/opensharing-io/opensharing/blob/main/spec/protocols/ML_MODELS.md): `spec/protocols/ML_MODELS.md`
- [Agent proposal](https://github.com/opensharing-io/opensharing/blob/main/spec/protocols/AGENTS.md): `spec/protocols/AGENTS.md`
- [Page proposal](https://github.com/opensharing-io/opensharing/blob/main/spec/protocols/GLOSSARY.md): `spec/protocols/GLOSSARY.md`

### Access and credentials

- [Sharing server](https://github.com/opensharing-io/opensharing/blob/main/spec/protocols/OVERVIEW.md): `spec/protocols/OVERVIEW.md`
- [Credential model](https://github.com/opensharing-io/opensharing/blob/main/spec/protocols/CREDENTIALS.md): `spec/protocols/CREDENTIALS.md`

### Participants and storage

- **Provider**
- **Recipient**
- **Provider storage**
- **Compliant clients**

## Connections

- Provider → Sharing server: creates shares (evidence: `README.md`)
- Provider → Shares: defines access (evidence: `README.md`)
- Shares → Schemas: groups assets (evidence: `README.md`)
- Schemas → Tables: contains (evidence: `README.md`)
- Schemas → Volumes: contains (evidence: `README.md`)
- Schemas → Agent skills: contains (evidence: `README.md`)
- Schemas → ML models: contains (evidence: `README.md`)
- Schemas → Agent proposal: proposes (evidence: `README.md`)
- Schemas → Page proposal: proposes (evidence: `README.md`)
- Recipient → Sharing server: discovers assets (evidence: `README.md`)
- Sharing server → Credential model: vends credentials (evidence: `README.md`)
- Sharing server → Recipient: issues credentials (evidence: `README.md`)
- Recipient → Provider storage: reads directly (evidence: `README.md`)
- Compliant clients → Sharing server: uses protocol (evidence: `README.md`)
- Tables → Credential model: defines credential endpoint (evidence: `README.md`)
- Volumes → Credential model: defines credential endpoint (evidence: `README.md`)
- Agent skills → Credential model: defines credential endpoint (evidence: `README.md`)
- ML models → Credential model: defines credential endpoint (evidence: `README.md`)
- Credential model → Provider storage: grants scoped access (evidence: `README.md`)
