Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,8 @@

**[Documentation](https://docs.w3ds.metastate.foundation)** — Getting started with W3DS and the MetaState prototype.

**Building with an AI coding agent?** Load the [W3DS agent skill](https://docs.w3ds.metastate.foundation/docs/Post%20Platform%20Guide/ai-agent-skill) — `npx skills add MetaState-Prototype-Project/prototype@w3ds`, or point a fetch-capable agent at [`/skill/SKILL.md`](https://docs.w3ds.metastate.foundation/skill/SKILL.md) and [`/llms.txt`](https://docs.w3ds.metastate.foundation/llms.txt).

**Quick start (registry + evault-core + dev-sandbox):** see **[QUICKSTART.md](QUICKSTART.md)** — one script to run Postgres + Neo4j in Docker and the core services locally. Dev sandbox runs at **http://localhost:8080**.

## Docker Development Environment
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/Getting Started/getting-started.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -203,4 +203,6 @@ The [Provisioner](/docs/W3DS%20Basics/Links) hosts `/provision`; the [Registry](
- Understand [Authentication](/docs/W3DS%20Protocol/Authentication) - How users authenticate with platforms
- Learn about [Signing](/docs/W3DS%20Protocol/Signing) - Signature creation and verification
- Explore [Signature Formats](/docs/W3DS%20Protocol/Signature-Formats) - Technical details on cryptographic signatures
- Read the [Data Ownership Rules](/docs/W3DS%20Basics/Data-Ownership-Rules) - Where data lives, and why the eVault is the source of truth
- Build a platform with the [Post Platform Guide](/docs/Post%20Platform%20Guide/getting-started) - Step-by-step guide to creating a W3DS-compatible platform
- Building with an AI coding agent? Load the [W3DS agent skill](/docs/Post%20Platform%20Guide/ai-agent-skill) first - it keeps the agent grounded in these docs instead of guessing
94 changes: 92 additions & 2 deletions docs/docs/Infrastructure/Ontology.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,13 +24,16 @@ Returns a list of all available schemas.

```json
[
{ "id": "550e8400-e29b-41d4-a716-446655440000", "title": "User" },
{ "id": "550e8400-e29b-41d4-a716-446655440001", "title": "SocialMediaPost" }
{ "id": "550e8400-e29b-41d4-a716-446655440000", "title": "User", "domain": "identity" },
{ "id": "550e8400-e29b-41d4-a716-446655440001", "title": "SocialMediaPost", "domain": "social" }
]
```

- `id`: Schema W3ID (`schemaId`).
- `title`: Human-readable schema title.
- `domain`: The domain the schema belongs to, or `null` if untagged. See [GET /domains](#get-domains).

This endpoint is the only correct way to obtain a `schemaId`. Match on `title`, then confirm the field names with `GET /schemas/:id` before writing a mapping. Schema IDs are not derivable, not sequential, and not stable enough to recall from memory — a wrong `schemaId` means every awareness packet for that type is silently dropped by receiving platforms.

### GET /schemas/:id

Expand All@@ -44,6 +47,30 @@ Returns the full JSON Schema for the given W3ID. Use this when you need the comp

- **404**: Schema not found for the given W3ID.

### GET /domains

Returns the domain list every schema is tagged with — the same list a platform is granted access to, one domain at a time.

**Response** (200):

```json
{
"schemaId": "<the Domain schema's own W3ID>",
"domains": [
{ "id": "identity", "label": "Identity", "description": "..." },
{ "id": "social", "label": "Social", "description": "..." }
]
}
```

The list is not a separate config file: it is read from the `Domain` schema's own enum, so it is versioned, browsable and fetchable like any other type.

### GET /domains/:id/schemas

Returns every schema under one domain: `{ "domain": { ... }, "schemas": [ { "id", "title" } ] }`. **404** if the domain does not exist.

Use this when you know the subject area but not the type name — "what does W3DS already have for finance?" — before concluding that nothing fits and [proposing a new ontology](#proposing-a-new-ontology).

### Human-facing viewer

- **GET /** — Renders a viewer page that lists schemas and supports search. Optional query `?q=...` filters by title or ID; `?schema=<id>` shows one schema.
Expand DownExpand Up@@ -83,6 +110,68 @@ Example (conceptually):

In eVault, a MetaEnvelope for a post would have `ontology: "550e8400-e29b-41d4-a716-446655440001"`, and its Envelopes would have `ontology` values such as `content`, `authorId`, `createdAt`.

## Proposing a new ontology

Nothing in W3DS obliges you to squeeze your data into an existing type. If no schema fits what you are modelling, the correct move is to **propose a new one** — never to invent a `schemaId` and ship it.

An invented `schemaId` does not fail loudly. The MetaEnvelope is written, the awareness packet fans out, and every receiving platform finds no mapping for that schema and drops it. The data becomes unreachable to the ecosystem while looking perfectly healthy on the platform that wrote it.

### Before proposing

1. `GET /schemas` and search the titles.
2. `GET /domains/:id/schemas` for the domain your data belongs to.
3. Read the near misses in full with `GET /schemas/:id`.

Reuse beats addition, and **extending a near match by PR beats creating a parallel type**. Two schemas that mean the same thing split the ecosystem in half: platforms mapping one will not see data from platforms mapping the other.

### Write the schema

Schemas are ordinary files in the [prototype repository](https://github.com/MetaState-Prototype-Project/prototype), under `services/ontology/schemas/<name>.json`. The service loads the directory into an in-memory index at boot; there is no database and no registration call.

```json
{
"$schema": "http://json-schema.org/draft-07/schema#",
"schemaId": "<a freshly generated random UUIDv4>",
"title": "Bookmark",
"domain": "productivity",
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier for the bookmark"
},
"userId": {
"type": "string",
"format": "uuid",
"description": "The ID of the user who created the bookmark"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "When the bookmark was created"
}
},
"required": ["id", "userId", "createdAt"],
"additionalProperties": false
}
```

Requirements:

- **`schemaId`** — a freshly generated random UUIDv4 (`uuidgen`, `crypto.randomUUID()`). Never derive one from an existing ID, never continue a numeric sequence you notice in the directory, and never reuse an ID from another schema.
- **`title`** — the type name as other platforms will search for it. Singular, PascalCase.
- **`domain`** — one value from the `Domain` schema's enum, fetchable at `GET /domains`. Platforms are granted access domain by domain, so this decides who can consume the type.
- **`properties`** — every field with a `description`. Each property name becomes an Envelope's `ontology` value in the eVault, so **name fields for their cross-platform meaning, not after your local columns**. `authorId` is a W3DS field name; `fk_user_id_2` is not.
- **`required`** — the fields a consumer can rely on being present.
- **`additionalProperties`** — `false`, unless you have a specific reason.

### Open the PR

Add the file, open a pull request against the prototype repository, and say in the description what the type is for and which platform will write it. Reviewers will ask whether an existing schema could have carried the data — answer that question in the PR body and you will save a round trip.

Until the PR merges and the service redeploys, **the type does not exist**. Do not ship a `mapping.json` referencing an unmerged `schemaId`; the sync will look fine locally and silently drop everywhere else.

## Available schemas

To see all available schemas, call `GET /schemas` on the [Ontology production service](/docs/W3DS%20Basics/Links) or browse the [viewer](https://ontology.w3ds.metastate.foundation/) at the production base URL.
Expand All@@ -97,3 +186,4 @@ To see all available schemas, call `GET /schemas` on the [Ontology production se
- [eVault](/docs/Infrastructure/eVault) — MetaEnvelopes, Envelopes, and the `ontology` field
- [W3DS Basics](/docs/W3DS%20Basics/getting-started) — Ontology and schema concepts
- [Links](/docs/W3DS%20Basics/Links) — Production Ontology base URL
- [Data Ownership Rules](/docs/W3DS%20Basics/Data-Ownership-Rules) — why every persisted entity needs an ontology
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,8 @@

**[Documentation](https://docs.w3ds.metastate.foundation)** — Getting started with W3DS and the MetaState prototype.

**Building with an AI coding agent?** Load the [W3DS agent skill](https://docs.w3ds.metastate.foundation/docs/Post%20Platform%20Guide/ai-agent-skill) — `npx skills add MetaState-Prototype-Project/prototype@w3ds`, or point a fetch-capable agent at [`/skill/SKILL.md`](https://docs.w3ds.metastate.foundation/skill/SKILL.md) and [`/llms.txt`](https://docs.w3ds.metastate.foundation/llms.txt).

**Quick start (registry + evault-core + dev-sandbox):** see **[QUICKSTART.md](QUICKSTART.md)** — one script to run Postgres + Neo4j in Docker and the core services locally. Dev sandbox runs at **http://localhost:8080**.

## Docker Development Environment
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/Getting Started/getting-started.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -203,4 +203,6 @@ The [Provisioner](/docs/W3DS%20Basics/Links) hosts `/provision`; the [Registry](
- Understand [Authentication](/docs/W3DS%20Protocol/Authentication) - How users authenticate with platforms
- Learn about [Signing](/docs/W3DS%20Protocol/Signing) - Signature creation and verification
- Explore [Signature Formats](/docs/W3DS%20Protocol/Signature-Formats) - Technical details on cryptographic signatures
- Read the [Data Ownership Rules](/docs/W3DS%20Basics/Data-Ownership-Rules) - Where data lives, and why the eVault is the source of truth
- Build a platform with the [Post Platform Guide](/docs/Post%20Platform%20Guide/getting-started) - Step-by-step guide to creating a W3DS-compatible platform
- Building with an AI coding agent? Load the [W3DS agent skill](/docs/Post%20Platform%20Guide/ai-agent-skill) first - it keeps the agent grounded in these docs instead of guessing
94 changes: 92 additions & 2 deletions docs/docs/Infrastructure/Ontology.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,13 +24,16 @@ Returns a list of all available schemas.

```json
[
{ "id": "550e8400-e29b-41d4-a716-446655440000", "title": "User" },
{ "id": "550e8400-e29b-41d4-a716-446655440001", "title": "SocialMediaPost" }
{ "id": "550e8400-e29b-41d4-a716-446655440000", "title": "User", "domain": "identity" },
{ "id": "550e8400-e29b-41d4-a716-446655440001", "title": "SocialMediaPost", "domain": "social" }
]
```

- `id`: Schema W3ID (`schemaId`).
- `title`: Human-readable schema title.
- `domain`: The domain the schema belongs to, or `null` if untagged. See [GET /domains](#get-domains).

This endpoint is the only correct way to obtain a `schemaId`. Match on `title`, then confirm the field names with `GET /schemas/:id` before writing a mapping. Schema IDs are not derivable, not sequential, and not stable enough to recall from memory — a wrong `schemaId` means every awareness packet for that type is silently dropped by receiving platforms.

### GET /schemas/:id

Expand All@@ -44,6 +47,30 @@ Returns the full JSON Schema for the given W3ID. Use this when you need the comp

- **404**: Schema not found for the given W3ID.

### GET /domains

Returns the domain list every schema is tagged with — the same list a platform is granted access to, one domain at a time.

**Response** (200):

```json
{
"schemaId": "<the Domain schema's own W3ID>",
"domains": [
{ "id": "identity", "label": "Identity", "description": "..." },
{ "id": "social", "label": "Social", "description": "..." }
]
}
```

The list is not a separate config file: it is read from the `Domain` schema's own enum, so it is versioned, browsable and fetchable like any other type.

### GET /domains/:id/schemas

Returns every schema under one domain: `{ "domain": { ... }, "schemas": [ { "id", "title" } ] }`. **404** if the domain does not exist.

Use this when you know the subject area but not the type name — "what does W3DS already have for finance?" — before concluding that nothing fits and [proposing a new ontology](#proposing-a-new-ontology).

### Human-facing viewer

- **GET /** — Renders a viewer page that lists schemas and supports search. Optional query `?q=...` filters by title or ID; `?schema=<id>` shows one schema.
Expand DownExpand Up@@ -83,6 +110,68 @@ Example (conceptually):

In eVault, a MetaEnvelope for a post would have `ontology: "550e8400-e29b-41d4-a716-446655440001"`, and its Envelopes would have `ontology` values such as `content`, `authorId`, `createdAt`.

## Proposing a new ontology

Nothing in W3DS obliges you to squeeze your data into an existing type. If no schema fits what you are modelling, the correct move is to **propose a new one** — never to invent a `schemaId` and ship it.

An invented `schemaId` does not fail loudly. The MetaEnvelope is written, the awareness packet fans out, and every receiving platform finds no mapping for that schema and drops it. The data becomes unreachable to the ecosystem while looking perfectly healthy on the platform that wrote it.

### Before proposing

1. `GET /schemas` and search the titles.
2. `GET /domains/:id/schemas` for the domain your data belongs to.
3. Read the near misses in full with `GET /schemas/:id`.

Reuse beats addition, and **extending a near match by PR beats creating a parallel type**. Two schemas that mean the same thing split the ecosystem in half: platforms mapping one will not see data from platforms mapping the other.

### Write the schema

Schemas are ordinary files in the [prototype repository](https://github.com/MetaState-Prototype-Project/prototype), under `services/ontology/schemas/<name>.json`. The service loads the directory into an in-memory index at boot; there is no database and no registration call.

```json
{
"$schema": "http://json-schema.org/draft-07/schema#",
"schemaId": "<a freshly generated random UUIDv4>",
"title": "Bookmark",
"domain": "productivity",
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier for the bookmark"
},
"userId": {
"type": "string",
"format": "uuid",
"description": "The ID of the user who created the bookmark"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "When the bookmark was created"
}
},
"required": ["id", "userId", "createdAt"],
"additionalProperties": false
}
```

Requirements:

- **`schemaId`** — a freshly generated random UUIDv4 (`uuidgen`, `crypto.randomUUID()`). Never derive one from an existing ID, never continue a numeric sequence you notice in the directory, and never reuse an ID from another schema.
- **`title`** — the type name as other platforms will search for it. Singular, PascalCase.
- **`domain`** — one value from the `Domain` schema's enum, fetchable at `GET /domains`. Platforms are granted access domain by domain, so this decides who can consume the type.
- **`properties`** — every field with a `description`. Each property name becomes an Envelope's `ontology` value in the eVault, so **name fields for their cross-platform meaning, not after your local columns**. `authorId` is a W3DS field name; `fk_user_id_2` is not.
- **`required`** — the fields a consumer can rely on being present.
- **`additionalProperties`** — `false`, unless you have a specific reason.

### Open the PR

Add the file, open a pull request against the prototype repository, and say in the description what the type is for and which platform will write it. Reviewers will ask whether an existing schema could have carried the data — answer that question in the PR body and you will save a round trip.

Until the PR merges and the service redeploys, **the type does not exist**. Do not ship a `mapping.json` referencing an unmerged `schemaId`; the sync will look fine locally and silently drop everywhere else.

## Available schemas

To see all available schemas, call `GET /schemas` on the [Ontology production service](/docs/W3DS%20Basics/Links) or browse the [viewer](https://ontology.w3ds.metastate.foundation/) at the production base URL.
Expand All@@ -97,3 +186,4 @@ To see all available schemas, call `GET /schemas` on the [Ontology production se
- [eVault](/docs/Infrastructure/eVault) — MetaEnvelopes, Envelopes, and the `ontology` field
- [W3DS Basics](/docs/W3DS%20Basics/getting-started) — Ontology and schema concepts
- [Links](/docs/W3DS%20Basics/Links) — Production Ontology base URL
- [Data Ownership Rules](/docs/W3DS%20Basics/Data-Ownership-Rules) — why every persisted entity needs an ontology
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,8 @@

**[Documentation](https://docs.w3ds.metastate.foundation)** — Getting started with W3DS and the MetaState prototype.

**Building with an AI coding agent?** Load the [W3DS agent skill](https://docs.w3ds.metastate.foundation/docs/Post%20Platform%20Guide/ai-agent-skill) — `npx skills add MetaState-Prototype-Project/prototype@w3ds`, or point a fetch-capable agent at [`/skill/SKILL.md`](https://docs.w3ds.metastate.foundation/skill/SKILL.md) and [`/llms.txt`](https://docs.w3ds.metastate.foundation/llms.txt).

**Quick start (registry + evault-core + dev-sandbox):** see **[QUICKSTART.md](QUICKSTART.md)** — one script to run Postgres + Neo4j in Docker and the core services locally. Dev sandbox runs at **http://localhost:8080**.

## Docker Development Environment
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/Getting Started/getting-started.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -203,4 +203,6 @@ The [Provisioner](/docs/W3DS%20Basics/Links) hosts `/provision`; the [Registry](
- Understand [Authentication](/docs/W3DS%20Protocol/Authentication) - How users authenticate with platforms
- Learn about [Signing](/docs/W3DS%20Protocol/Signing) - Signature creation and verification
- Explore [Signature Formats](/docs/W3DS%20Protocol/Signature-Formats) - Technical details on cryptographic signatures
- Read the [Data Ownership Rules](/docs/W3DS%20Basics/Data-Ownership-Rules) - Where data lives, and why the eVault is the source of truth
- Build a platform with the [Post Platform Guide](/docs/Post%20Platform%20Guide/getting-started) - Step-by-step guide to creating a W3DS-compatible platform
- Building with an AI coding agent? Load the [W3DS agent skill](/docs/Post%20Platform%20Guide/ai-agent-skill) first - it keeps the agent grounded in these docs instead of guessing
94 changes: 92 additions & 2 deletions docs/docs/Infrastructure/Ontology.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,13 +24,16 @@ Returns a list of all available schemas.

```json
[
{ "id": "550e8400-e29b-41d4-a716-446655440000", "title": "User" },
{ "id": "550e8400-e29b-41d4-a716-446655440001", "title": "SocialMediaPost" }
{ "id": "550e8400-e29b-41d4-a716-446655440000", "title": "User", "domain": "identity" },
{ "id": "550e8400-e29b-41d4-a716-446655440001", "title": "SocialMediaPost", "domain": "social" }
]
```

- `id`: Schema W3ID (`schemaId`).
- `title`: Human-readable schema title.
- `domain`: The domain the schema belongs to, or `null` if untagged. See [GET /domains](#get-domains).

This endpoint is the only correct way to obtain a `schemaId`. Match on `title`, then confirm the field names with `GET /schemas/:id` before writing a mapping. Schema IDs are not derivable, not sequential, and not stable enough to recall from memory — a wrong `schemaId` means every awareness packet for that type is silently dropped by receiving platforms.

### GET /schemas/:id

Expand All@@ -44,6 +47,30 @@ Returns the full JSON Schema for the given W3ID. Use this when you need the comp

- **404**: Schema not found for the given W3ID.

### GET /domains

Returns the domain list every schema is tagged with — the same list a platform is granted access to, one domain at a time.

**Response** (200):

```json
{
"schemaId": "<the Domain schema's own W3ID>",
"domains": [
{ "id": "identity", "label": "Identity", "description": "..." },
{ "id": "social", "label": "Social", "description": "..." }
]
}
```

The list is not a separate config file: it is read from the `Domain` schema's own enum, so it is versioned, browsable and fetchable like any other type.

### GET /domains/:id/schemas

Returns every schema under one domain: `{ "domain": { ... }, "schemas": [ { "id", "title" } ] }`. **404** if the domain does not exist.

Use this when you know the subject area but not the type name — "what does W3DS already have for finance?" — before concluding that nothing fits and [proposing a new ontology](#proposing-a-new-ontology).

### Human-facing viewer

- **GET /** — Renders a viewer page that lists schemas and supports search. Optional query `?q=...` filters by title or ID; `?schema=<id>` shows one schema.
Expand DownExpand Up@@ -83,6 +110,68 @@ Example (conceptually):

In eVault, a MetaEnvelope for a post would have `ontology: "550e8400-e29b-41d4-a716-446655440001"`, and its Envelopes would have `ontology` values such as `content`, `authorId`, `createdAt`.

## Proposing a new ontology

Nothing in W3DS obliges you to squeeze your data into an existing type. If no schema fits what you are modelling, the correct move is to **propose a new one** — never to invent a `schemaId` and ship it.

An invented `schemaId` does not fail loudly. The MetaEnvelope is written, the awareness packet fans out, and every receiving platform finds no mapping for that schema and drops it. The data becomes unreachable to the ecosystem while looking perfectly healthy on the platform that wrote it.

### Before proposing

1. `GET /schemas` and search the titles.
2. `GET /domains/:id/schemas` for the domain your data belongs to.
3. Read the near misses in full with `GET /schemas/:id`.

Reuse beats addition, and **extending a near match by PR beats creating a parallel type**. Two schemas that mean the same thing split the ecosystem in half: platforms mapping one will not see data from platforms mapping the other.

### Write the schema

Schemas are ordinary files in the [prototype repository](https://github.com/MetaState-Prototype-Project/prototype), under `services/ontology/schemas/<name>.json`. The service loads the directory into an in-memory index at boot; there is no database and no registration call.

```json
{
"$schema": "http://json-schema.org/draft-07/schema#",
"schemaId": "<a freshly generated random UUIDv4>",
"title": "Bookmark",
"domain": "productivity",
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier for the bookmark"
},
"userId": {
"type": "string",
"format": "uuid",
"description": "The ID of the user who created the bookmark"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "When the bookmark was created"
}
},
"required": ["id", "userId", "createdAt"],
"additionalProperties": false
}
```

Requirements:

- **`schemaId`** — a freshly generated random UUIDv4 (`uuidgen`, `crypto.randomUUID()`). Never derive one from an existing ID, never continue a numeric sequence you notice in the directory, and never reuse an ID from another schema.
- **`title`** — the type name as other platforms will search for it. Singular, PascalCase.
- **`domain`** — one value from the `Domain` schema's enum, fetchable at `GET /domains`. Platforms are granted access domain by domain, so this decides who can consume the type.
- **`properties`** — every field with a `description`. Each property name becomes an Envelope's `ontology` value in the eVault, so **name fields for their cross-platform meaning, not after your local columns**. `authorId` is a W3DS field name; `fk_user_id_2` is not.
- **`required`** — the fields a consumer can rely on being present.
- **`additionalProperties`** — `false`, unless you have a specific reason.

### Open the PR

Add the file, open a pull request against the prototype repository, and say in the description what the type is for and which platform will write it. Reviewers will ask whether an existing schema could have carried the data — answer that question in the PR body and you will save a round trip.

Until the PR merges and the service redeploys, **the type does not exist**. Do not ship a `mapping.json` referencing an unmerged `schemaId`; the sync will look fine locally and silently drop everywhere else.

## Available schemas

To see all available schemas, call `GET /schemas` on the [Ontology production service](/docs/W3DS%20Basics/Links) or browse the [viewer](https://ontology.w3ds.metastate.foundation/) at the production base URL.
Expand All@@ -97,3 +186,4 @@ To see all available schemas, call `GET /schemas` on the [Ontology production se
- [eVault](/docs/Infrastructure/eVault) — MetaEnvelopes, Envelopes, and the `ontology` field
- [W3DS Basics](/docs/W3DS%20Basics/getting-started) — Ontology and schema concepts
- [Links](/docs/W3DS%20Basics/Links) — Production Ontology base URL
- [Data Ownership Rules](/docs/W3DS%20Basics/Data-Ownership-Rules) — why every persisted entity needs an ontology
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,8 @@

**[Documentation](https://docs.w3ds.metastate.foundation)** — Getting started with W3DS and the MetaState prototype.

**Building with an AI coding agent?** Load the [W3DS agent skill](https://docs.w3ds.metastate.foundation/docs/Post%20Platform%20Guide/ai-agent-skill) — `npx skills add MetaState-Prototype-Project/prototype@w3ds`, or point a fetch-capable agent at [`/skill/SKILL.md`](https://docs.w3ds.metastate.foundation/skill/SKILL.md) and [`/llms.txt`](https://docs.w3ds.metastate.foundation/llms.txt).

**Quick start (registry + evault-core + dev-sandbox):** see **[QUICKSTART.md](QUICKSTART.md)** — one script to run Postgres + Neo4j in Docker and the core services locally. Dev sandbox runs at **http://localhost:8080**.

## Docker Development Environment
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/Getting Started/getting-started.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -203,4 +203,6 @@ The [Provisioner](/docs/W3DS%20Basics/Links) hosts `/provision`; the [Registry](
- Understand [Authentication](/docs/W3DS%20Protocol/Authentication) - How users authenticate with platforms
- Learn about [Signing](/docs/W3DS%20Protocol/Signing) - Signature creation and verification
- Explore [Signature Formats](/docs/W3DS%20Protocol/Signature-Formats) - Technical details on cryptographic signatures
- Read the [Data Ownership Rules](/docs/W3DS%20Basics/Data-Ownership-Rules) - Where data lives, and why the eVault is the source of truth
- Build a platform with the [Post Platform Guide](/docs/Post%20Platform%20Guide/getting-started) - Step-by-step guide to creating a W3DS-compatible platform
- Building with an AI coding agent? Load the [W3DS agent skill](/docs/Post%20Platform%20Guide/ai-agent-skill) first - it keeps the agent grounded in these docs instead of guessing
94 changes: 92 additions & 2 deletions docs/docs/Infrastructure/Ontology.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,13 +24,16 @@ Returns a list of all available schemas.

```json
[
{ "id": "550e8400-e29b-41d4-a716-446655440000", "title": "User" },
{ "id": "550e8400-e29b-41d4-a716-446655440001", "title": "SocialMediaPost" }
{ "id": "550e8400-e29b-41d4-a716-446655440000", "title": "User", "domain": "identity" },
{ "id": "550e8400-e29b-41d4-a716-446655440001", "title": "SocialMediaPost", "domain": "social" }
]
```

- `id`: Schema W3ID (`schemaId`).
- `title`: Human-readable schema title.
- `domain`: The domain the schema belongs to, or `null` if untagged. See [GET /domains](#get-domains).

This endpoint is the only correct way to obtain a `schemaId`. Match on `title`, then confirm the field names with `GET /schemas/:id` before writing a mapping. Schema IDs are not derivable, not sequential, and not stable enough to recall from memory — a wrong `schemaId` means every awareness packet for that type is silently dropped by receiving platforms.

### GET /schemas/:id

Expand All@@ -44,6 +47,30 @@ Returns the full JSON Schema for the given W3ID. Use this when you need the comp

- **404**: Schema not found for the given W3ID.

### GET /domains

Returns the domain list every schema is tagged with — the same list a platform is granted access to, one domain at a time.

**Response** (200):

```json
{
"schemaId": "<the Domain schema's own W3ID>",
"domains": [
{ "id": "identity", "label": "Identity", "description": "..." },
{ "id": "social", "label": "Social", "description": "..." }
]
}
```

The list is not a separate config file: it is read from the `Domain` schema's own enum, so it is versioned, browsable and fetchable like any other type.

### GET /domains/:id/schemas

Returns every schema under one domain: `{ "domain": { ... }, "schemas": [ { "id", "title" } ] }`. **404** if the domain does not exist.

Use this when you know the subject area but not the type name — "what does W3DS already have for finance?" — before concluding that nothing fits and [proposing a new ontology](#proposing-a-new-ontology).

### Human-facing viewer

- **GET /** — Renders a viewer page that lists schemas and supports search. Optional query `?q=...` filters by title or ID; `?schema=<id>` shows one schema.
Expand DownExpand Up@@ -83,6 +110,68 @@ Example (conceptually):

In eVault, a MetaEnvelope for a post would have `ontology: "550e8400-e29b-41d4-a716-446655440001"`, and its Envelopes would have `ontology` values such as `content`, `authorId`, `createdAt`.

## Proposing a new ontology

Nothing in W3DS obliges you to squeeze your data into an existing type. If no schema fits what you are modelling, the correct move is to **propose a new one** — never to invent a `schemaId` and ship it.

An invented `schemaId` does not fail loudly. The MetaEnvelope is written, the awareness packet fans out, and every receiving platform finds no mapping for that schema and drops it. The data becomes unreachable to the ecosystem while looking perfectly healthy on the platform that wrote it.

### Before proposing

1. `GET /schemas` and search the titles.
2. `GET /domains/:id/schemas` for the domain your data belongs to.
3. Read the near misses in full with `GET /schemas/:id`.

Reuse beats addition, and **extending a near match by PR beats creating a parallel type**. Two schemas that mean the same thing split the ecosystem in half: platforms mapping one will not see data from platforms mapping the other.

### Write the schema

Schemas are ordinary files in the [prototype repository](https://github.com/MetaState-Prototype-Project/prototype), under `services/ontology/schemas/<name>.json`. The service loads the directory into an in-memory index at boot; there is no database and no registration call.

```json
{
"$schema": "http://json-schema.org/draft-07/schema#",
"schemaId": "<a freshly generated random UUIDv4>",
"title": "Bookmark",
"domain": "productivity",
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier for the bookmark"
},
"userId": {
"type": "string",
"format": "uuid",
"description": "The ID of the user who created the bookmark"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "When the bookmark was created"
}
},
"required": ["id", "userId", "createdAt"],
"additionalProperties": false
}
```

Requirements:

- **`schemaId`** — a freshly generated random UUIDv4 (`uuidgen`, `crypto.randomUUID()`). Never derive one from an existing ID, never continue a numeric sequence you notice in the directory, and never reuse an ID from another schema.
- **`title`** — the type name as other platforms will search for it. Singular, PascalCase.
- **`domain`** — one value from the `Domain` schema's enum, fetchable at `GET /domains`. Platforms are granted access domain by domain, so this decides who can consume the type.
- **`properties`** — every field with a `description`. Each property name becomes an Envelope's `ontology` value in the eVault, so **name fields for their cross-platform meaning, not after your local columns**. `authorId` is a W3DS field name; `fk_user_id_2` is not.
- **`required`** — the fields a consumer can rely on being present.
- **`additionalProperties`** — `false`, unless you have a specific reason.

### Open the PR

Add the file, open a pull request against the prototype repository, and say in the description what the type is for and which platform will write it. Reviewers will ask whether an existing schema could have carried the data — answer that question in the PR body and you will save a round trip.

Until the PR merges and the service redeploys, **the type does not exist**. Do not ship a `mapping.json` referencing an unmerged `schemaId`; the sync will look fine locally and silently drop everywhere else.

## Available schemas

To see all available schemas, call `GET /schemas` on the [Ontology production service](/docs/W3DS%20Basics/Links) or browse the [viewer](https://ontology.w3ds.metastate.foundation/) at the production base URL.
Expand All@@ -97,3 +186,4 @@ To see all available schemas, call `GET /schemas` on the [Ontology production se
- [eVault](/docs/Infrastructure/eVault) — MetaEnvelopes, Envelopes, and the `ontology` field
- [W3DS Basics](/docs/W3DS%20Basics/getting-started) — Ontology and schema concepts
- [Links](/docs/W3DS%20Basics/Links) — Production Ontology base URL
- [Data Ownership Rules](/docs/W3DS%20Basics/Data-Ownership-Rules) — why every persisted entity needs an ontology
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,8 @@

**[Documentation](https://docs.w3ds.metastate.foundation)** — Getting started with W3DS and the MetaState prototype.

**Building with an AI coding agent?** Load the [W3DS agent skill](https://docs.w3ds.metastate.foundation/docs/Post%20Platform%20Guide/ai-agent-skill) — `npx skills add MetaState-Prototype-Project/prototype@w3ds`, or point a fetch-capable agent at [`/skill/SKILL.md`](https://docs.w3ds.metastate.foundation/skill/SKILL.md) and [`/llms.txt`](https://docs.w3ds.metastate.foundation/llms.txt).

**Quick start (registry + evault-core + dev-sandbox):** see **[QUICKSTART.md](QUICKSTART.md)** — one script to run Postgres + Neo4j in Docker and the core services locally. Dev sandbox runs at **http://localhost:8080**.

## Docker Development Environment
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/Getting Started/getting-started.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -203,4 +203,6 @@ The [Provisioner](/docs/W3DS%20Basics/Links) hosts `/provision`; the [Registry](
- Understand [Authentication](/docs/W3DS%20Protocol/Authentication) - How users authenticate with platforms
- Learn about [Signing](/docs/W3DS%20Protocol/Signing) - Signature creation and verification
- Explore [Signature Formats](/docs/W3DS%20Protocol/Signature-Formats) - Technical details on cryptographic signatures
- Read the [Data Ownership Rules](/docs/W3DS%20Basics/Data-Ownership-Rules) - Where data lives, and why the eVault is the source of truth
- Build a platform with the [Post Platform Guide](/docs/Post%20Platform%20Guide/getting-started) - Step-by-step guide to creating a W3DS-compatible platform
- Building with an AI coding agent? Load the [W3DS agent skill](/docs/Post%20Platform%20Guide/ai-agent-skill) first - it keeps the agent grounded in these docs instead of guessing
94 changes: 92 additions & 2 deletions docs/docs/Infrastructure/Ontology.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,13 +24,16 @@ Returns a list of all available schemas.

```json
[
{ "id": "550e8400-e29b-41d4-a716-446655440000", "title": "User" },
{ "id": "550e8400-e29b-41d4-a716-446655440001", "title": "SocialMediaPost" }
{ "id": "550e8400-e29b-41d4-a716-446655440000", "title": "User", "domain": "identity" },
{ "id": "550e8400-e29b-41d4-a716-446655440001", "title": "SocialMediaPost", "domain": "social" }
]
```

- `id`: Schema W3ID (`schemaId`).
- `title`: Human-readable schema title.
- `domain`: The domain the schema belongs to, or `null` if untagged. See [GET /domains](#get-domains).

This endpoint is the only correct way to obtain a `schemaId`. Match on `title`, then confirm the field names with `GET /schemas/:id` before writing a mapping. Schema IDs are not derivable, not sequential, and not stable enough to recall from memory — a wrong `schemaId` means every awareness packet for that type is silently dropped by receiving platforms.

### GET /schemas/:id

Expand All@@ -44,6 +47,30 @@ Returns the full JSON Schema for the given W3ID. Use this when you need the comp

- **404**: Schema not found for the given W3ID.

### GET /domains

Returns the domain list every schema is tagged with — the same list a platform is granted access to, one domain at a time.

**Response** (200):

```json
{
"schemaId": "<the Domain schema's own W3ID>",
"domains": [
{ "id": "identity", "label": "Identity", "description": "..." },
{ "id": "social", "label": "Social", "description": "..." }
]
}
```

The list is not a separate config file: it is read from the `Domain` schema's own enum, so it is versioned, browsable and fetchable like any other type.

### GET /domains/:id/schemas

Returns every schema under one domain: `{ "domain": { ... }, "schemas": [ { "id", "title" } ] }`. **404** if the domain does not exist.

Use this when you know the subject area but not the type name — "what does W3DS already have for finance?" — before concluding that nothing fits and [proposing a new ontology](#proposing-a-new-ontology).

### Human-facing viewer

- **GET /** — Renders a viewer page that lists schemas and supports search. Optional query `?q=...` filters by title or ID; `?schema=<id>` shows one schema.
Expand DownExpand Up@@ -83,6 +110,68 @@ Example (conceptually):

In eVault, a MetaEnvelope for a post would have `ontology: "550e8400-e29b-41d4-a716-446655440001"`, and its Envelopes would have `ontology` values such as `content`, `authorId`, `createdAt`.

## Proposing a new ontology

Nothing in W3DS obliges you to squeeze your data into an existing type. If no schema fits what you are modelling, the correct move is to **propose a new one** — never to invent a `schemaId` and ship it.

An invented `schemaId` does not fail loudly. The MetaEnvelope is written, the awareness packet fans out, and every receiving platform finds no mapping for that schema and drops it. The data becomes unreachable to the ecosystem while looking perfectly healthy on the platform that wrote it.

### Before proposing

1. `GET /schemas` and search the titles.
2. `GET /domains/:id/schemas` for the domain your data belongs to.
3. Read the near misses in full with `GET /schemas/:id`.

Reuse beats addition, and **extending a near match by PR beats creating a parallel type**. Two schemas that mean the same thing split the ecosystem in half: platforms mapping one will not see data from platforms mapping the other.

### Write the schema

Schemas are ordinary files in the [prototype repository](https://github.com/MetaState-Prototype-Project/prototype), under `services/ontology/schemas/<name>.json`. The service loads the directory into an in-memory index at boot; there is no database and no registration call.

```json
{
"$schema": "http://json-schema.org/draft-07/schema#",
"schemaId": "<a freshly generated random UUIDv4>",
"title": "Bookmark",
"domain": "productivity",
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier for the bookmark"
},
"userId": {
"type": "string",
"format": "uuid",
"description": "The ID of the user who created the bookmark"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "When the bookmark was created"
}
},
"required": ["id", "userId", "createdAt"],
"additionalProperties": false
}
```

Requirements:

- **`schemaId`** — a freshly generated random UUIDv4 (`uuidgen`, `crypto.randomUUID()`). Never derive one from an existing ID, never continue a numeric sequence you notice in the directory, and never reuse an ID from another schema.
- **`title`** — the type name as other platforms will search for it. Singular, PascalCase.
- **`domain`** — one value from the `Domain` schema's enum, fetchable at `GET /domains`. Platforms are granted access domain by domain, so this decides who can consume the type.
- **`properties`** — every field with a `description`. Each property name becomes an Envelope's `ontology` value in the eVault, so **name fields for their cross-platform meaning, not after your local columns**. `authorId` is a W3DS field name; `fk_user_id_2` is not.
- **`required`** — the fields a consumer can rely on being present.
- **`additionalProperties`** — `false`, unless you have a specific reason.

### Open the PR

Add the file, open a pull request against the prototype repository, and say in the description what the type is for and which platform will write it. Reviewers will ask whether an existing schema could have carried the data — answer that question in the PR body and you will save a round trip.

Until the PR merges and the service redeploys, **the type does not exist**. Do not ship a `mapping.json` referencing an unmerged `schemaId`; the sync will look fine locally and silently drop everywhere else.

## Available schemas

To see all available schemas, call `GET /schemas` on the [Ontology production service](/docs/W3DS%20Basics/Links) or browse the [viewer](https://ontology.w3ds.metastate.foundation/) at the production base URL.
Expand All@@ -97,3 +186,4 @@ To see all available schemas, call `GET /schemas` on the [Ontology production se
- [eVault](/docs/Infrastructure/eVault) — MetaEnvelopes, Envelopes, and the `ontology` field
- [W3DS Basics](/docs/W3DS%20Basics/getting-started) — Ontology and schema concepts
- [Links](/docs/W3DS%20Basics/Links) — Production Ontology base URL
- [Data Ownership Rules](/docs/W3DS%20Basics/Data-Ownership-Rules) — why every persisted entity needs an ontology
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,8 @@

**[Documentation](https://docs.w3ds.metastate.foundation)** — Getting started with W3DS and the MetaState prototype.

**Building with an AI coding agent?** Load the [W3DS agent skill](https://docs.w3ds.metastate.foundation/docs/Post%20Platform%20Guide/ai-agent-skill) — `npx skills add MetaState-Prototype-Project/prototype@w3ds`, or point a fetch-capable agent at [`/skill/SKILL.md`](https://docs.w3ds.metastate.foundation/skill/SKILL.md) and [`/llms.txt`](https://docs.w3ds.metastate.foundation/llms.txt).

**Quick start (registry + evault-core + dev-sandbox):** see **[QUICKSTART.md](QUICKSTART.md)** — one script to run Postgres + Neo4j in Docker and the core services locally. Dev sandbox runs at **http://localhost:8080**.

## Docker Development Environment
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/Getting Started/getting-started.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -203,4 +203,6 @@ The [Provisioner](/docs/W3DS%20Basics/Links) hosts `/provision`; the [Registry](
- Understand [Authentication](/docs/W3DS%20Protocol/Authentication) - How users authenticate with platforms
- Learn about [Signing](/docs/W3DS%20Protocol/Signing) - Signature creation and verification
- Explore [Signature Formats](/docs/W3DS%20Protocol/Signature-Formats) - Technical details on cryptographic signatures
- Read the [Data Ownership Rules](/docs/W3DS%20Basics/Data-Ownership-Rules) - Where data lives, and why the eVault is the source of truth
- Build a platform with the [Post Platform Guide](/docs/Post%20Platform%20Guide/getting-started) - Step-by-step guide to creating a W3DS-compatible platform
- Building with an AI coding agent? Load the [W3DS agent skill](/docs/Post%20Platform%20Guide/ai-agent-skill) first - it keeps the agent grounded in these docs instead of guessing
94 changes: 92 additions & 2 deletions docs/docs/Infrastructure/Ontology.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,13 +24,16 @@ Returns a list of all available schemas.

```json
[
{ "id": "550e8400-e29b-41d4-a716-446655440000", "title": "User" },
{ "id": "550e8400-e29b-41d4-a716-446655440001", "title": "SocialMediaPost" }
{ "id": "550e8400-e29b-41d4-a716-446655440000", "title": "User", "domain": "identity" },
{ "id": "550e8400-e29b-41d4-a716-446655440001", "title": "SocialMediaPost", "domain": "social" }
]
```

- `id`: Schema W3ID (`schemaId`).
- `title`: Human-readable schema title.
- `domain`: The domain the schema belongs to, or `null` if untagged. See [GET /domains](#get-domains).

This endpoint is the only correct way to obtain a `schemaId`. Match on `title`, then confirm the field names with `GET /schemas/:id` before writing a mapping. Schema IDs are not derivable, not sequential, and not stable enough to recall from memory — a wrong `schemaId` means every awareness packet for that type is silently dropped by receiving platforms.

### GET /schemas/:id

Expand All@@ -44,6 +47,30 @@ Returns the full JSON Schema for the given W3ID. Use this when you need the comp

- **404**: Schema not found for the given W3ID.

### GET /domains

Returns the domain list every schema is tagged with — the same list a platform is granted access to, one domain at a time.

**Response** (200):

```json
{
"schemaId": "<the Domain schema's own W3ID>",
"domains": [
{ "id": "identity", "label": "Identity", "description": "..." },
{ "id": "social", "label": "Social", "description": "..." }
]
}
```

The list is not a separate config file: it is read from the `Domain` schema's own enum, so it is versioned, browsable and fetchable like any other type.

### GET /domains/:id/schemas

Returns every schema under one domain: `{ "domain": { ... }, "schemas": [ { "id", "title" } ] }`. **404** if the domain does not exist.

Use this when you know the subject area but not the type name — "what does W3DS already have for finance?" — before concluding that nothing fits and [proposing a new ontology](#proposing-a-new-ontology).

### Human-facing viewer

- **GET /** — Renders a viewer page that lists schemas and supports search. Optional query `?q=...` filters by title or ID; `?schema=<id>` shows one schema.
Expand DownExpand Up@@ -83,6 +110,68 @@ Example (conceptually):

In eVault, a MetaEnvelope for a post would have `ontology: "550e8400-e29b-41d4-a716-446655440001"`, and its Envelopes would have `ontology` values such as `content`, `authorId`, `createdAt`.

## Proposing a new ontology

Nothing in W3DS obliges you to squeeze your data into an existing type. If no schema fits what you are modelling, the correct move is to **propose a new one** — never to invent a `schemaId` and ship it.

An invented `schemaId` does not fail loudly. The MetaEnvelope is written, the awareness packet fans out, and every receiving platform finds no mapping for that schema and drops it. The data becomes unreachable to the ecosystem while looking perfectly healthy on the platform that wrote it.

### Before proposing

1. `GET /schemas` and search the titles.
2. `GET /domains/:id/schemas` for the domain your data belongs to.
3. Read the near misses in full with `GET /schemas/:id`.

Reuse beats addition, and **extending a near match by PR beats creating a parallel type**. Two schemas that mean the same thing split the ecosystem in half: platforms mapping one will not see data from platforms mapping the other.

### Write the schema

Schemas are ordinary files in the [prototype repository](https://github.com/MetaState-Prototype-Project/prototype), under `services/ontology/schemas/<name>.json`. The service loads the directory into an in-memory index at boot; there is no database and no registration call.

```json
{
"$schema": "http://json-schema.org/draft-07/schema#",
"schemaId": "<a freshly generated random UUIDv4>",
"title": "Bookmark",
"domain": "productivity",
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier for the bookmark"
},
"userId": {
"type": "string",
"format": "uuid",
"description": "The ID of the user who created the bookmark"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "When the bookmark was created"
}
},
"required": ["id", "userId", "createdAt"],
"additionalProperties": false
}
```

Requirements:

- **`schemaId`** — a freshly generated random UUIDv4 (`uuidgen`, `crypto.randomUUID()`). Never derive one from an existing ID, never continue a numeric sequence you notice in the directory, and never reuse an ID from another schema.
- **`title`** — the type name as other platforms will search for it. Singular, PascalCase.
- **`domain`** — one value from the `Domain` schema's enum, fetchable at `GET /domains`. Platforms are granted access domain by domain, so this decides who can consume the type.
- **`properties`** — every field with a `description`. Each property name becomes an Envelope's `ontology` value in the eVault, so **name fields for their cross-platform meaning, not after your local columns**. `authorId` is a W3DS field name; `fk_user_id_2` is not.
- **`required`** — the fields a consumer can rely on being present.
- **`additionalProperties`** — `false`, unless you have a specific reason.

### Open the PR

Add the file, open a pull request against the prototype repository, and say in the description what the type is for and which platform will write it. Reviewers will ask whether an existing schema could have carried the data — answer that question in the PR body and you will save a round trip.

Until the PR merges and the service redeploys, **the type does not exist**. Do not ship a `mapping.json` referencing an unmerged `schemaId`; the sync will look fine locally and silently drop everywhere else.

## Available schemas

To see all available schemas, call `GET /schemas` on the [Ontology production service](/docs/W3DS%20Basics/Links) or browse the [viewer](https://ontology.w3ds.metastate.foundation/) at the production base URL.
Expand All@@ -97,3 +186,4 @@ To see all available schemas, call `GET /schemas` on the [Ontology production se
- [eVault](/docs/Infrastructure/eVault) — MetaEnvelopes, Envelopes, and the `ontology` field
- [W3DS Basics](/docs/W3DS%20Basics/getting-started) — Ontology and schema concepts
- [Links](/docs/W3DS%20Basics/Links) — Production Ontology base URL
- [Data Ownership Rules](/docs/W3DS%20Basics/Data-Ownership-Rules) — why every persisted entity needs an ontology
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,8 @@

**[Documentation](https://docs.w3ds.metastate.foundation)** — Getting started with W3DS and the MetaState prototype.

**Building with an AI coding agent?** Load the [W3DS agent skill](https://docs.w3ds.metastate.foundation/docs/Post%20Platform%20Guide/ai-agent-skill) — `npx skills add MetaState-Prototype-Project/prototype@w3ds`, or point a fetch-capable agent at [`/skill/SKILL.md`](https://docs.w3ds.metastate.foundation/skill/SKILL.md) and [`/llms.txt`](https://docs.w3ds.metastate.foundation/llms.txt).

**Quick start (registry + evault-core + dev-sandbox):** see **[QUICKSTART.md](QUICKSTART.md)** — one script to run Postgres + Neo4j in Docker and the core services locally. Dev sandbox runs at **http://localhost:8080**.

## Docker Development Environment
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/Getting Started/getting-started.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -203,4 +203,6 @@ The [Provisioner](/docs/W3DS%20Basics/Links) hosts `/provision`; the [Registry](
- Understand [Authentication](/docs/W3DS%20Protocol/Authentication) - How users authenticate with platforms
- Learn about [Signing](/docs/W3DS%20Protocol/Signing) - Signature creation and verification
- Explore [Signature Formats](/docs/W3DS%20Protocol/Signature-Formats) - Technical details on cryptographic signatures
- Read the [Data Ownership Rules](/docs/W3DS%20Basics/Data-Ownership-Rules) - Where data lives, and why the eVault is the source of truth
- Build a platform with the [Post Platform Guide](/docs/Post%20Platform%20Guide/getting-started) - Step-by-step guide to creating a W3DS-compatible platform
- Building with an AI coding agent? Load the [W3DS agent skill](/docs/Post%20Platform%20Guide/ai-agent-skill) first - it keeps the agent grounded in these docs instead of guessing
94 changes: 92 additions & 2 deletions docs/docs/Infrastructure/Ontology.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,13 +24,16 @@ Returns a list of all available schemas.

```json
[
{ "id": "550e8400-e29b-41d4-a716-446655440000", "title": "User" },
{ "id": "550e8400-e29b-41d4-a716-446655440001", "title": "SocialMediaPost" }
{ "id": "550e8400-e29b-41d4-a716-446655440000", "title": "User", "domain": "identity" },
{ "id": "550e8400-e29b-41d4-a716-446655440001", "title": "SocialMediaPost", "domain": "social" }
]
```

- `id`: Schema W3ID (`schemaId`).
- `title`: Human-readable schema title.
- `domain`: The domain the schema belongs to, or `null` if untagged. See [GET /domains](#get-domains).

This endpoint is the only correct way to obtain a `schemaId`. Match on `title`, then confirm the field names with `GET /schemas/:id` before writing a mapping. Schema IDs are not derivable, not sequential, and not stable enough to recall from memory — a wrong `schemaId` means every awareness packet for that type is silently dropped by receiving platforms.

### GET /schemas/:id

Expand All@@ -44,6 +47,30 @@ Returns the full JSON Schema for the given W3ID. Use this when you need the comp

- **404**: Schema not found for the given W3ID.

### GET /domains

Returns the domain list every schema is tagged with — the same list a platform is granted access to, one domain at a time.

**Response** (200):

```json
{
"schemaId": "<the Domain schema's own W3ID>",
"domains": [
{ "id": "identity", "label": "Identity", "description": "..." },
{ "id": "social", "label": "Social", "description": "..." }
]
}
```

The list is not a separate config file: it is read from the `Domain` schema's own enum, so it is versioned, browsable and fetchable like any other type.

### GET /domains/:id/schemas

Returns every schema under one domain: `{ "domain": { ... }, "schemas": [ { "id", "title" } ] }`. **404** if the domain does not exist.

Use this when you know the subject area but not the type name — "what does W3DS already have for finance?" — before concluding that nothing fits and [proposing a new ontology](#proposing-a-new-ontology).

### Human-facing viewer

- **GET /** — Renders a viewer page that lists schemas and supports search. Optional query `?q=...` filters by title or ID; `?schema=<id>` shows one schema.
Expand DownExpand Up@@ -83,6 +110,68 @@ Example (conceptually):

In eVault, a MetaEnvelope for a post would have `ontology: "550e8400-e29b-41d4-a716-446655440001"`, and its Envelopes would have `ontology` values such as `content`, `authorId`, `createdAt`.

## Proposing a new ontology

Nothing in W3DS obliges you to squeeze your data into an existing type. If no schema fits what you are modelling, the correct move is to **propose a new one** — never to invent a `schemaId` and ship it.

An invented `schemaId` does not fail loudly. The MetaEnvelope is written, the awareness packet fans out, and every receiving platform finds no mapping for that schema and drops it. The data becomes unreachable to the ecosystem while looking perfectly healthy on the platform that wrote it.

### Before proposing

1. `GET /schemas` and search the titles.
2. `GET /domains/:id/schemas` for the domain your data belongs to.
3. Read the near misses in full with `GET /schemas/:id`.

Reuse beats addition, and **extending a near match by PR beats creating a parallel type**. Two schemas that mean the same thing split the ecosystem in half: platforms mapping one will not see data from platforms mapping the other.

### Write the schema

Schemas are ordinary files in the [prototype repository](https://github.com/MetaState-Prototype-Project/prototype), under `services/ontology/schemas/<name>.json`. The service loads the directory into an in-memory index at boot; there is no database and no registration call.

```json
{
"$schema": "http://json-schema.org/draft-07/schema#",
"schemaId": "<a freshly generated random UUIDv4>",
"title": "Bookmark",
"domain": "productivity",
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier for the bookmark"
},
"userId": {
"type": "string",
"format": "uuid",
"description": "The ID of the user who created the bookmark"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "When the bookmark was created"
}
},
"required": ["id", "userId", "createdAt"],
"additionalProperties": false
}
```

Requirements:

- **`schemaId`** — a freshly generated random UUIDv4 (`uuidgen`, `crypto.randomUUID()`). Never derive one from an existing ID, never continue a numeric sequence you notice in the directory, and never reuse an ID from another schema.
- **`title`** — the type name as other platforms will search for it. Singular, PascalCase.
- **`domain`** — one value from the `Domain` schema's enum, fetchable at `GET /domains`. Platforms are granted access domain by domain, so this decides who can consume the type.
- **`properties`** — every field with a `description`. Each property name becomes an Envelope's `ontology` value in the eVault, so **name fields for their cross-platform meaning, not after your local columns**. `authorId` is a W3DS field name; `fk_user_id_2` is not.
- **`required`** — the fields a consumer can rely on being present.
- **`additionalProperties`** — `false`, unless you have a specific reason.

### Open the PR

Add the file, open a pull request against the prototype repository, and say in the description what the type is for and which platform will write it. Reviewers will ask whether an existing schema could have carried the data — answer that question in the PR body and you will save a round trip.

Until the PR merges and the service redeploys, **the type does not exist**. Do not ship a `mapping.json` referencing an unmerged `schemaId`; the sync will look fine locally and silently drop everywhere else.

## Available schemas

To see all available schemas, call `GET /schemas` on the [Ontology production service](/docs/W3DS%20Basics/Links) or browse the [viewer](https://ontology.w3ds.metastate.foundation/) at the production base URL.
Expand All@@ -97,3 +186,4 @@ To see all available schemas, call `GET /schemas` on the [Ontology production se
- [eVault](/docs/Infrastructure/eVault) — MetaEnvelopes, Envelopes, and the `ontology` field
- [W3DS Basics](/docs/W3DS%20Basics/getting-started) — Ontology and schema concepts
- [Links](/docs/W3DS%20Basics/Links) — Production Ontology base URL
- [Data Ownership Rules](/docs/W3DS%20Basics/Data-Ownership-Rules) — why every persisted entity needs an ontology
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,8 @@

**[Documentation](https://docs.w3ds.metastate.foundation)** — Getting started with W3DS and the MetaState prototype.

**Building with an AI coding agent?** Load the [W3DS agent skill](https://docs.w3ds.metastate.foundation/docs/Post%20Platform%20Guide/ai-agent-skill) — `npx skills add MetaState-Prototype-Project/prototype@w3ds`, or point a fetch-capable agent at [`/skill/SKILL.md`](https://docs.w3ds.metastate.foundation/skill/SKILL.md) and [`/llms.txt`](https://docs.w3ds.metastate.foundation/llms.txt).

**Quick start (registry + evault-core + dev-sandbox):** see **[QUICKSTART.md](QUICKSTART.md)** — one script to run Postgres + Neo4j in Docker and the core services locally. Dev sandbox runs at **http://localhost:8080**.

## Docker Development Environment
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/Getting Started/getting-started.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -203,4 +203,6 @@ The [Provisioner](/docs/W3DS%20Basics/Links) hosts `/provision`; the [Registry](
- Understand [Authentication](/docs/W3DS%20Protocol/Authentication) - How users authenticate with platforms
- Learn about [Signing](/docs/W3DS%20Protocol/Signing) - Signature creation and verification
- Explore [Signature Formats](/docs/W3DS%20Protocol/Signature-Formats) - Technical details on cryptographic signatures
- Read the [Data Ownership Rules](/docs/W3DS%20Basics/Data-Ownership-Rules) - Where data lives, and why the eVault is the source of truth
- Build a platform with the [Post Platform Guide](/docs/Post%20Platform%20Guide/getting-started) - Step-by-step guide to creating a W3DS-compatible platform
- Building with an AI coding agent? Load the [W3DS agent skill](/docs/Post%20Platform%20Guide/ai-agent-skill) first - it keeps the agent grounded in these docs instead of guessing
94 changes: 92 additions & 2 deletions docs/docs/Infrastructure/Ontology.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,13 +24,16 @@ Returns a list of all available schemas.

```json
[
{ "id": "550e8400-e29b-41d4-a716-446655440000", "title": "User" },
{ "id": "550e8400-e29b-41d4-a716-446655440001", "title": "SocialMediaPost" }
{ "id": "550e8400-e29b-41d4-a716-446655440000", "title": "User", "domain": "identity" },
{ "id": "550e8400-e29b-41d4-a716-446655440001", "title": "SocialMediaPost", "domain": "social" }
]
```

- `id`: Schema W3ID (`schemaId`).
- `title`: Human-readable schema title.
- `domain`: The domain the schema belongs to, or `null` if untagged. See [GET /domains](#get-domains).

This endpoint is the only correct way to obtain a `schemaId`. Match on `title`, then confirm the field names with `GET /schemas/:id` before writing a mapping. Schema IDs are not derivable, not sequential, and not stable enough to recall from memory — a wrong `schemaId` means every awareness packet for that type is silently dropped by receiving platforms.

### GET /schemas/:id

Expand All@@ -44,6 +47,30 @@ Returns the full JSON Schema for the given W3ID. Use this when you need the comp

- **404**: Schema not found for the given W3ID.

### GET /domains

Returns the domain list every schema is tagged with — the same list a platform is granted access to, one domain at a time.

**Response** (200):

```json
{
"schemaId": "<the Domain schema's own W3ID>",
"domains": [
{ "id": "identity", "label": "Identity", "description": "..." },
{ "id": "social", "label": "Social", "description": "..." }
]
}
```

The list is not a separate config file: it is read from the `Domain` schema's own enum, so it is versioned, browsable and fetchable like any other type.

### GET /domains/:id/schemas

Returns every schema under one domain: `{ "domain": { ... }, "schemas": [ { "id", "title" } ] }`. **404** if the domain does not exist.

Use this when you know the subject area but not the type name — "what does W3DS already have for finance?" — before concluding that nothing fits and [proposing a new ontology](#proposing-a-new-ontology).

### Human-facing viewer

- **GET /** — Renders a viewer page that lists schemas and supports search. Optional query `?q=...` filters by title or ID; `?schema=<id>` shows one schema.
Expand DownExpand Up@@ -83,6 +110,68 @@ Example (conceptually):

In eVault, a MetaEnvelope for a post would have `ontology: "550e8400-e29b-41d4-a716-446655440001"`, and its Envelopes would have `ontology` values such as `content`, `authorId`, `createdAt`.

## Proposing a new ontology

Nothing in W3DS obliges you to squeeze your data into an existing type. If no schema fits what you are modelling, the correct move is to **propose a new one** — never to invent a `schemaId` and ship it.

An invented `schemaId` does not fail loudly. The MetaEnvelope is written, the awareness packet fans out, and every receiving platform finds no mapping for that schema and drops it. The data becomes unreachable to the ecosystem while looking perfectly healthy on the platform that wrote it.

### Before proposing

1. `GET /schemas` and search the titles.
2. `GET /domains/:id/schemas` for the domain your data belongs to.
3. Read the near misses in full with `GET /schemas/:id`.

Reuse beats addition, and **extending a near match by PR beats creating a parallel type**. Two schemas that mean the same thing split the ecosystem in half: platforms mapping one will not see data from platforms mapping the other.

### Write the schema

Schemas are ordinary files in the [prototype repository](https://github.com/MetaState-Prototype-Project/prototype), under `services/ontology/schemas/<name>.json`. The service loads the directory into an in-memory index at boot; there is no database and no registration call.

```json
{
"$schema": "http://json-schema.org/draft-07/schema#",
"schemaId": "<a freshly generated random UUIDv4>",
"title": "Bookmark",
"domain": "productivity",
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier for the bookmark"
},
"userId": {
"type": "string",
"format": "uuid",
"description": "The ID of the user who created the bookmark"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "When the bookmark was created"
}
},
"required": ["id", "userId", "createdAt"],
"additionalProperties": false
}
```

Requirements:

- **`schemaId`** — a freshly generated random UUIDv4 (`uuidgen`, `crypto.randomUUID()`). Never derive one from an existing ID, never continue a numeric sequence you notice in the directory, and never reuse an ID from another schema.
- **`title`** — the type name as other platforms will search for it. Singular, PascalCase.
- **`domain`** — one value from the `Domain` schema's enum, fetchable at `GET /domains`. Platforms are granted access domain by domain, so this decides who can consume the type.
- **`properties`** — every field with a `description`. Each property name becomes an Envelope's `ontology` value in the eVault, so **name fields for their cross-platform meaning, not after your local columns**. `authorId` is a W3DS field name; `fk_user_id_2` is not.
- **`required`** — the fields a consumer can rely on being present.
- **`additionalProperties`** — `false`, unless you have a specific reason.

### Open the PR

Add the file, open a pull request against the prototype repository, and say in the description what the type is for and which platform will write it. Reviewers will ask whether an existing schema could have carried the data — answer that question in the PR body and you will save a round trip.

Until the PR merges and the service redeploys, **the type does not exist**. Do not ship a `mapping.json` referencing an unmerged `schemaId`; the sync will look fine locally and silently drop everywhere else.

## Available schemas

To see all available schemas, call `GET /schemas` on the [Ontology production service](/docs/W3DS%20Basics/Links) or browse the [viewer](https://ontology.w3ds.metastate.foundation/) at the production base URL.
Expand All@@ -97,3 +186,4 @@ To see all available schemas, call `GET /schemas` on the [Ontology production se
- [eVault](/docs/Infrastructure/eVault) — MetaEnvelopes, Envelopes, and the `ontology` field
- [W3DS Basics](/docs/W3DS%20Basics/getting-started) — Ontology and schema concepts
- [Links](/docs/W3DS%20Basics/Links) — Production Ontology base URL
- [Data Ownership Rules](/docs/W3DS%20Basics/Data-Ownership-Rules) — why every persisted entity needs an ontology
Loading
Loading