Skip to content

Commit 4c48050

Browse files
committed
chore(spec): regenerate reference docs and liveness counts
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
1 parent f521dd7 commit 4c48050

2 files changed

Lines changed: 9 additions & 8 deletions

File tree

content/docs/references/api/rest-server.mdx

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -175,16 +175,17 @@ const result = BatchEndpointsConfigSchema.parse(data);
175175
| **enableCache** | `boolean` | optional (default: `true`) | Enable HTTP cache headers (ETag, Last-Modified) |
176176
| **cacheTtl** | `never` | optional | [REMOVED] `metadata.cacheTtl` was removed in @objectstack/spec 17 (ADR-0049 enforce-or-remove) — nothing ever read it: `metadata.enableCache` selects the protocol's `getMetaItemCached` read path, which takes no TTL, and no Cache-Control / ETag header was ever built from this value. Delete the key; `metadata.enableCache` is the live switch, and a declarative `api` endpoint's `cacheTtl` is the key that does reach the wire. |
177177
| **maskObjectFields** | `boolean` | optional (default: `true`) | [ADR-0106 D8] Mask served object schemas to the caller's readable fields |
178-
| **endpoints** | `{ types: boolean; items: boolean; item: boolean }` | optional | Enable/disable specific endpoints |
178+
| **endpoints** | `{ types: boolean; items: boolean; item: boolean; maintenance: boolean }` | optional | Enable/disable specific endpoints |
179179

180180
### Nested Shape: `MetadataEndpointsConfig.endpoints`
181181

182182
| Property | Type | Required | Description |
183183
| :--- | :--- | :--- | :--- |
184-
| **types** | `boolean` | optional (default: `true`) | GET /meta - List all metadata types |
185-
| **items** | `boolean` | optional (default: `true`) | GET /meta/:type - List items of type |
186-
| **item** | `boolean` | optional (default: `true`) | GET /meta/:type/:name - Get specific item |
187-
| **schema** | `never` | optional | [REMOVED] `metadata.endpoints.schema` was removed in @objectstack/spec 17 (ADR-0049 enforce-or-remove) — it gated a route that does not exist: the REST server mounts no `GET /meta/:type/:name/schema`, so `false` removed nothing and `true` added nothing. Delete the key; `endpoints.types` / `items` / `item` are the switches that gate real mounts. |
184+
| **types** | `boolean` | optional (default: `true`) | Mount the metadata type list — `GET /meta` and `GET /meta/types` (one handler, two paths) |
185+
| **items** | `boolean` | optional (default: `true`) | Mount the per-type item list — `GET /meta/:type`, and nothing else |
186+
| **item** | `boolean` | optional (default: `true`) | Mount the whole per-item face — `GET`, `PUT` and `DELETE /meta/:type/:name`, its `/references` and `/layers` reads, the history family (`/history`, `/audit`, `/diff`, `/published`, `/publish`, `/rollback`) and `GET /meta/book/:name/tree` |
187+
| **maintenance** | `boolean` | optional (default: `true`) | Mount the whole-store maintenance operations — `GET /meta/diagnostics`, `GET /meta/_drafts` and the `POST /meta/_migrate-stored` write door |
188+
| **schema** | `never` | optional | [REMOVED] `metadata.endpoints.schema` was removed in @objectstack/spec 17 (ADR-0049 enforce-or-remove) — it gated a route that does not exist: the REST server mounts no `GET /meta/:type/:name/schema`, so `false` removed nothing and `true` added nothing. Delete the key; `endpoints.types` / `items` / `item` / `maintenance` are the switches that gate real mounts. |
188189

189190

190191
---
@@ -284,7 +285,7 @@ const result = BatchEndpointsConfigSchema.parse(data);
284285
| **enableCache** | `boolean` | optional (default: `true`) | Enable HTTP cache headers (ETag, Last-Modified) |
285286
| **cacheTtl** | `never` | optional | [REMOVED] `metadata.cacheTtl` was removed in @objectstack/spec 17 (ADR-0049 enforce-or-remove) — nothing ever read it: `metadata.enableCache` selects the protocol's `getMetaItemCached` read path, which takes no TTL, and no Cache-Control / ETag header was ever built from this value. Delete the key; `metadata.enableCache` is the live switch, and a declarative `api` endpoint's `cacheTtl` is the key that does reach the wire. |
286287
| **maskObjectFields** | `boolean` | optional (default: `true`) | [ADR-0106 D8] Mask served object schemas to the caller's readable fields |
287-
| **endpoints** | `{ types: boolean; items: boolean; item: boolean }` | optional | Enable/disable specific endpoints |
288+
| **endpoints** | `{ types: boolean; items: boolean; item: boolean; maintenance: boolean }` | optional | Enable/disable specific endpoints |
288289

289290
### Nested Shape: `RestServerConfig.batch`
290291

packages/spec/liveness/state-counts.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,8 @@ for both corollaries.
5959
| `qa` | 4 | 0 | 0 | 5 | 0 | 9 |
6060
| `manifest` | 23 | 0 | 1 | 15 | 0 | 39 |
6161
| `crud_endpoints` | 6 | 0 | 0 | 2 | 0 | 8 |
62-
| `metadata_endpoints` | 6 | 0 | 0 | 2 | 0 | 8 |
62+
| `metadata_endpoints` | 7 | 0 | 0 | 2 | 0 | 9 |
6363
| `batch_endpoints` | 5 | 0 | 0 | 2 | 0 | 7 |
6464
| `route_generation` | 0 | 0 | 0 | 4 | 0 | 4 |
6565
| `realtime_subscription` | 0 | 0 | 0 | 6 | 0 | 6 |
66-
| **total** | **845** | **5** | **1** | **94** | **12** | **957** |
66+
| **total** | **846** | **5** | **1** | **94** | **12** | **958** |

0 commit comments

Comments
 (0)