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
83 changes: 83 additions & 0 deletions .changeset/rest-server-config-dead-keys-retired.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
---
"@objectstack/spec": minor
"@objectstack/rest": minor
---

feat(spec): retire the ten inert `RestServerConfig` keys the liveness ledger recorded as `dead` (#14691, ADR-0049 enforce-or-remove)

<!-- adr-0087: registered rest-server-config-dead-keys-retired -->

**BREAKING** accept-set narrowing, landing after the v17.0.0 cut (the lockstep
launch-window convention ships it as `minor`; the prescription is registered
under protocol major 18, where `os migrate meta` users will look).

#14369 enrolled the four `RestServerConfig` sub-objects (`crud`, `metadata`,
`batch`, `routes`) in the spec liveness ledger and found 15 of their 32 rows
`dead`: parsed, defaulted and normalized into the REST server's config by
`normalizeConfig` (#11984) and never read back. This change is the
enforce-or-remove call on every one of them, taken per family, and every
family resolved to REMOVE — each promised capability either already exists at
its proper seat or would contradict a fixed contract. The closed-set cloud
sweep (#14796, `objectstack-ai/cloud` @ `9b6abe0f2fd5`) returned zero hits,
structurally: cloud never authors a `RestServerConfig`.

**What is refused:** authoring any of the ten keys below. Each is a
`retiredKey()` tombstone (all four sub-schemas are non-strict `z.object()`s,
so a plain deletion would have silently stripped the key), so authoring it is
a `tsc` error and a parse error carrying the prescription — and, because
`RestServer` parses these sub-objects at construction (#11984),
`new RestServer(...)` / `createRestApiPlugin().start()` now refuse a config
that carries one, naming the sub-object, the key and the declaring schema.

**FROM → TO** (delete the key in every case; none ever had an effect to preserve):

- `crud.patterns` → the mounted CRUD paths are the contract the client SDK, the
discovery document and the served `/openapi.json` all describe; `crud.dataPrefix`
moves them deployment-wide. An endpoint on a custom path or method is a
declarative `api` endpoint (`type: 'object_operation'`). Its value schema
`CrudEndpointPatternSchema` / type `CrudEndpointPattern` are removed with it
(no other consumer; `CrudOperation` stays — `GeneratedEndpoint.operation` reads it).
- `crud.objectParamStyle` → the object name is always a path segment.
- `metadata.cacheTtl` → `metadata.enableCache` is the live switch (it selects the
protocol's `getMetaItemCached` path, which takes no TTL); a declarative `api`
endpoint's `cacheTtl` is the key that reaches the wire. The unbounded negative
TTL this key accepted goes with it.
- `metadata.endpoints.schema` → gated `GET /meta/:type/:name/schema`, which does
not exist; `endpoints.types` / `items` / `item` gate real mounts and stay.
- `batch.operations.upsertMany` → gated `POST /data/:object/upsertMany`, which
was never built; upsert is an operation type of the generic
`POST /data/:object/batch` endpoint (`BatchOperationType` `'upsert'`), gated
by `batch.enableBatchEndpoint`.
- `batch.defaultAtomic` → atomicity is the per-request `options.atomic`
(ADR-0119 D4, opt-in); a server-side default that flipped it silently would
change the failure semantics of callers who send nothing, which that ADR
refused. Callers that need all-or-nothing send `options: { atomic: true }`.
- `routes.includeObjects` / `routes.excludeObjects` / `routes.overrides`
(`enabled` / `basePath` / `operations`) → per-object API exposure is declared
ON the object and enforced by the REST data surface: `enable.apiEnabled: false`
hides it (404), `enable.apiMethods` whitelists its operations (405). The data
base path is deployment-wide (`crud.dataPrefix`).
- `routes.nameTransform` → the object `name` is the canonical id on every
surface, the REST path segment included; there is no URL transform to configure.

**What stays, byte-identical:** every live key of the four sub-objects —
`crud.operations.*`, `crud.dataPrefix`, `metadata.prefix` / `enableCache` /
`maskObjectFields` / `endpoints.types|items|item`, `batch.maxBatchSize` /
`enableBatchEndpoint` / `operations.createMany|updateMany|deleteMany` — with
its default and its mount. The mounted REST surface does not change: none of
the ten keys ever reached it. `@objectstack/rest`'s normalized config no longer
carries the retired keys (they were written and never read), and the #11984
pins of their accept/reject behaviour are reversed to refusal pins, by design.

The retirement kit: `retiredKey()` tombstones on the four sub-schemas;
`RestServerConfigSchema`'s `@example` no longer advertises
`routes: { excludeObjects: [...] }`; ledger rows kept `dead` with a REMOVED
note and `evidenceScope: cross-repo` (the two container rows collapse into one
each, since their child keys left the walked shape); `RETIRED_KEYS_BY_MAJOR[18]`
× 10 and `RETIRED_DEFS_BY_MAJOR[18]` `api/CrudEndpointPattern`; D3 semantic
entry `rest-server-config-dead-keys-retired`. No D2 conversion: a
`RestServerConfig` is plugin TS configuration (REST plugin constructor /
`plugin-hono-server` `restConfig`), never a stack collection member or a
`sys_metadata` row (the `openApi31` precedent, #4579), so there is no source
for the chain to rewrite and the prescription carries no `os migrate meta`
sentence.
6 changes: 3 additions & 3 deletions content/docs/permissions/system-context.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -64,7 +64,7 @@ not on any flag.
## How the flag is set

`isSystem` is **server-constructed and never client-supplied**. Inbound HTTP
cannot set it (`packages/rest/src/rest-server.ts:1522`, `:1551`), and neither
cannot set it (`packages/rest/src/rest-server.ts:1520`, `:1549`), and neither
can an action body (`packages/runtime/src/domains/actions.ts:404`). It is
written by internal callers only, as an option on the engine call:

Expand DownExpand Up@@ -103,7 +103,7 @@ that silently does not happen.
| 14 | MCP stdio bridge skips the object API-exposure gate | mcp | Get: the bridge reaches objects whose `apiEnabled` / `apiMethods` would refuse an external caller | `stdio-data-bridge.ts:246` |
| 15 | **Read-audit rows are not written** | plugin-audit | Lose: the "a person opened this record" trail. `sudo()` keeps the caller's `userId`, so this flag is the only thing separating a human read from a platform one | `read-audit.ts:556` |
| 16 | Approval snapshot payload redaction skipped | plugin-approvals | Get: the whole snapshot on `find` / `findOne` — the audit/replay channel. Lose: field-visibility redaction over approval payloads | `payload-redaction-middleware.ts:115` |
| 17 | REST anonymous-deny seam satisfied | rest | Get: `enforceAuth` passes with no `userId`. Not reachable from the wire — `isSystem` is never set on an inbound request | `rest-server.ts:1554` |
| 17 | REST anonymous-deny seam satisfied | rest | Get: `enforceAuth` passes with no `userId`. Not reachable from the wire — `isSystem` is never set on an inbound request | `rest-server.ts:1552` |

### 2. Write pipeline and data integrity

Expand DownExpand Up@@ -199,7 +199,7 @@ assuming `isSystem` covers it is a documented source of bugs.
| "It preserves a supplied `updated_at` / `updated_by`" | **No.** That is `preserveAudit`, a separate opt-in — and an UPDATE-path exemption only | `field.zod.ts:1516` (#3493 / #6640) |
| "It stamps `created_by`" | **No.** Audit stamping reads `userId` from the context. A user-less system write stamps nothing — that is today's behaviour, not an error | `runtime-identity.ts:280`–`281` |
| "It bypasses every guard" | **No.** The last-admin guard applies to **every** context, `isSystem` included — the deprovision path that actually locks an org out is the system one | `last-admin-guard.ts:299` |
| "A client can request it" | **No.** Never settable from inbound HTTP or from an action body | `rest-server.ts:1522`, `:1551`; `domains/actions.ts:404` |
| "A client can request it" | **No.** Never settable from inbound HTTP or from an action body | `rest-server.ts:1520`, `:1549`; `domains/actions.ts:404` |

---

Expand Down
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
83 changes: 83 additions & 0 deletions .changeset/rest-server-config-dead-keys-retired.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
---
"@objectstack/spec": minor
"@objectstack/rest": minor
---

feat(spec): retire the ten inert `RestServerConfig` keys the liveness ledger recorded as `dead` (#14691, ADR-0049 enforce-or-remove)

<!-- adr-0087: registered rest-server-config-dead-keys-retired -->

**BREAKING** accept-set narrowing, landing after the v17.0.0 cut (the lockstep
launch-window convention ships it as `minor`; the prescription is registered
under protocol major 18, where `os migrate meta` users will look).

#14369 enrolled the four `RestServerConfig` sub-objects (`crud`, `metadata`,
`batch`, `routes`) in the spec liveness ledger and found 15 of their 32 rows
`dead`: parsed, defaulted and normalized into the REST server's config by
`normalizeConfig` (#11984) and never read back. This change is the
enforce-or-remove call on every one of them, taken per family, and every
family resolved to REMOVE — each promised capability either already exists at
its proper seat or would contradict a fixed contract. The closed-set cloud
sweep (#14796, `objectstack-ai/cloud` @ `9b6abe0f2fd5`) returned zero hits,
structurally: cloud never authors a `RestServerConfig`.

**What is refused:** authoring any of the ten keys below. Each is a
`retiredKey()` tombstone (all four sub-schemas are non-strict `z.object()`s,
so a plain deletion would have silently stripped the key), so authoring it is
a `tsc` error and a parse error carrying the prescription — and, because
`RestServer` parses these sub-objects at construction (#11984),
`new RestServer(...)` / `createRestApiPlugin().start()` now refuse a config
that carries one, naming the sub-object, the key and the declaring schema.

**FROM → TO** (delete the key in every case; none ever had an effect to preserve):

- `crud.patterns` → the mounted CRUD paths are the contract the client SDK, the
discovery document and the served `/openapi.json` all describe; `crud.dataPrefix`
moves them deployment-wide. An endpoint on a custom path or method is a
declarative `api` endpoint (`type: 'object_operation'`). Its value schema
`CrudEndpointPatternSchema` / type `CrudEndpointPattern` are removed with it
(no other consumer; `CrudOperation` stays — `GeneratedEndpoint.operation` reads it).
- `crud.objectParamStyle` → the object name is always a path segment.
- `metadata.cacheTtl` → `metadata.enableCache` is the live switch (it selects the
protocol's `getMetaItemCached` path, which takes no TTL); a declarative `api`
endpoint's `cacheTtl` is the key that reaches the wire. The unbounded negative
TTL this key accepted goes with it.
- `metadata.endpoints.schema` → gated `GET /meta/:type/:name/schema`, which does
not exist; `endpoints.types` / `items` / `item` gate real mounts and stay.
- `batch.operations.upsertMany` → gated `POST /data/:object/upsertMany`, which
was never built; upsert is an operation type of the generic
`POST /data/:object/batch` endpoint (`BatchOperationType` `'upsert'`), gated
by `batch.enableBatchEndpoint`.
- `batch.defaultAtomic` → atomicity is the per-request `options.atomic`
(ADR-0119 D4, opt-in); a server-side default that flipped it silently would
change the failure semantics of callers who send nothing, which that ADR
refused. Callers that need all-or-nothing send `options: { atomic: true }`.
- `routes.includeObjects` / `routes.excludeObjects` / `routes.overrides`
(`enabled` / `basePath` / `operations`) → per-object API exposure is declared
ON the object and enforced by the REST data surface: `enable.apiEnabled: false`
hides it (404), `enable.apiMethods` whitelists its operations (405). The data
base path is deployment-wide (`crud.dataPrefix`).
- `routes.nameTransform` → the object `name` is the canonical id on every
surface, the REST path segment included; there is no URL transform to configure.

**What stays, byte-identical:** every live key of the four sub-objects —
`crud.operations.*`, `crud.dataPrefix`, `metadata.prefix` / `enableCache` /
`maskObjectFields` / `endpoints.types|items|item`, `batch.maxBatchSize` /
`enableBatchEndpoint` / `operations.createMany|updateMany|deleteMany` — with
its default and its mount. The mounted REST surface does not change: none of
the ten keys ever reached it. `@objectstack/rest`'s normalized config no longer
carries the retired keys (they were written and never read), and the #11984
pins of their accept/reject behaviour are reversed to refusal pins, by design.

The retirement kit: `retiredKey()` tombstones on the four sub-schemas;
`RestServerConfigSchema`'s `@example` no longer advertises
`routes: { excludeObjects: [...] }`; ledger rows kept `dead` with a REMOVED
note and `evidenceScope: cross-repo` (the two container rows collapse into one
each, since their child keys left the walked shape); `RETIRED_KEYS_BY_MAJOR[18]`
× 10 and `RETIRED_DEFS_BY_MAJOR[18]` `api/CrudEndpointPattern`; D3 semantic
entry `rest-server-config-dead-keys-retired`. No D2 conversion: a
`RestServerConfig` is plugin TS configuration (REST plugin constructor /
`plugin-hono-server` `restConfig`), never a stack collection member or a
`sys_metadata` row (the `openApi31` precedent, #4579), so there is no source
for the chain to rewrite and the prescription carries no `os migrate meta`
sentence.
6 changes: 3 additions & 3 deletions content/docs/permissions/system-context.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -64,7 +64,7 @@ not on any flag.
## How the flag is set

`isSystem` is **server-constructed and never client-supplied**. Inbound HTTP
cannot set it (`packages/rest/src/rest-server.ts:1522`, `:1551`), and neither
cannot set it (`packages/rest/src/rest-server.ts:1520`, `:1549`), and neither
can an action body (`packages/runtime/src/domains/actions.ts:404`). It is
written by internal callers only, as an option on the engine call:

Expand DownExpand Up@@ -103,7 +103,7 @@ that silently does not happen.
| 14 | MCP stdio bridge skips the object API-exposure gate | mcp | Get: the bridge reaches objects whose `apiEnabled` / `apiMethods` would refuse an external caller | `stdio-data-bridge.ts:246` |
| 15 | **Read-audit rows are not written** | plugin-audit | Lose: the "a person opened this record" trail. `sudo()` keeps the caller's `userId`, so this flag is the only thing separating a human read from a platform one | `read-audit.ts:556` |
| 16 | Approval snapshot payload redaction skipped | plugin-approvals | Get: the whole snapshot on `find` / `findOne` — the audit/replay channel. Lose: field-visibility redaction over approval payloads | `payload-redaction-middleware.ts:115` |
| 17 | REST anonymous-deny seam satisfied | rest | Get: `enforceAuth` passes with no `userId`. Not reachable from the wire — `isSystem` is never set on an inbound request | `rest-server.ts:1554` |
| 17 | REST anonymous-deny seam satisfied | rest | Get: `enforceAuth` passes with no `userId`. Not reachable from the wire — `isSystem` is never set on an inbound request | `rest-server.ts:1552` |

### 2. Write pipeline and data integrity

Expand DownExpand Up@@ -199,7 +199,7 @@ assuming `isSystem` covers it is a documented source of bugs.
| "It preserves a supplied `updated_at` / `updated_by`" | **No.** That is `preserveAudit`, a separate opt-in — and an UPDATE-path exemption only | `field.zod.ts:1516` (#3493 / #6640) |
| "It stamps `created_by`" | **No.** Audit stamping reads `userId` from the context. A user-less system write stamps nothing — that is today's behaviour, not an error | `runtime-identity.ts:280`–`281` |
| "It bypasses every guard" | **No.** The last-admin guard applies to **every** context, `isSystem` included — the deprovision path that actually locks an org out is the system one | `last-admin-guard.ts:299` |
| "A client can request it" | **No.** Never settable from inbound HTTP or from an action body | `rest-server.ts:1522`, `:1551`; `domains/actions.ts:404` |
| "A client can request it" | **No.** Never settable from inbound HTTP or from an action body | `rest-server.ts:1520`, `:1549`; `domains/actions.ts:404` |

---

Expand Down
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
83 changes: 83 additions & 0 deletions .changeset/rest-server-config-dead-keys-retired.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
---
"@objectstack/spec": minor
"@objectstack/rest": minor
---

feat(spec): retire the ten inert `RestServerConfig` keys the liveness ledger recorded as `dead` (#14691, ADR-0049 enforce-or-remove)

<!-- adr-0087: registered rest-server-config-dead-keys-retired -->

**BREAKING** accept-set narrowing, landing after the v17.0.0 cut (the lockstep
launch-window convention ships it as `minor`; the prescription is registered
under protocol major 18, where `os migrate meta` users will look).

#14369 enrolled the four `RestServerConfig` sub-objects (`crud`, `metadata`,
`batch`, `routes`) in the spec liveness ledger and found 15 of their 32 rows
`dead`: parsed, defaulted and normalized into the REST server's config by
`normalizeConfig` (#11984) and never read back. This change is the
enforce-or-remove call on every one of them, taken per family, and every
family resolved to REMOVE — each promised capability either already exists at
its proper seat or would contradict a fixed contract. The closed-set cloud
sweep (#14796, `objectstack-ai/cloud` @ `9b6abe0f2fd5`) returned zero hits,
structurally: cloud never authors a `RestServerConfig`.

**What is refused:** authoring any of the ten keys below. Each is a
`retiredKey()` tombstone (all four sub-schemas are non-strict `z.object()`s,
so a plain deletion would have silently stripped the key), so authoring it is
a `tsc` error and a parse error carrying the prescription — and, because
`RestServer` parses these sub-objects at construction (#11984),
`new RestServer(...)` / `createRestApiPlugin().start()` now refuse a config
that carries one, naming the sub-object, the key and the declaring schema.

**FROM → TO** (delete the key in every case; none ever had an effect to preserve):

- `crud.patterns` → the mounted CRUD paths are the contract the client SDK, the
discovery document and the served `/openapi.json` all describe; `crud.dataPrefix`
moves them deployment-wide. An endpoint on a custom path or method is a
declarative `api` endpoint (`type: 'object_operation'`). Its value schema
`CrudEndpointPatternSchema` / type `CrudEndpointPattern` are removed with it
(no other consumer; `CrudOperation` stays — `GeneratedEndpoint.operation` reads it).
- `crud.objectParamStyle` → the object name is always a path segment.
- `metadata.cacheTtl` → `metadata.enableCache` is the live switch (it selects the
protocol's `getMetaItemCached` path, which takes no TTL); a declarative `api`
endpoint's `cacheTtl` is the key that reaches the wire. The unbounded negative
TTL this key accepted goes with it.
- `metadata.endpoints.schema` → gated `GET /meta/:type/:name/schema`, which does
not exist; `endpoints.types` / `items` / `item` gate real mounts and stay.
- `batch.operations.upsertMany` → gated `POST /data/:object/upsertMany`, which
was never built; upsert is an operation type of the generic
`POST /data/:object/batch` endpoint (`BatchOperationType` `'upsert'`), gated
by `batch.enableBatchEndpoint`.
- `batch.defaultAtomic` → atomicity is the per-request `options.atomic`
(ADR-0119 D4, opt-in); a server-side default that flipped it silently would
change the failure semantics of callers who send nothing, which that ADR
refused. Callers that need all-or-nothing send `options: { atomic: true }`.
- `routes.includeObjects` / `routes.excludeObjects` / `routes.overrides`
(`enabled` / `basePath` / `operations`) → per-object API exposure is declared
ON the object and enforced by the REST data surface: `enable.apiEnabled: false`
hides it (404), `enable.apiMethods` whitelists its operations (405). The data
base path is deployment-wide (`crud.dataPrefix`).
- `routes.nameTransform` → the object `name` is the canonical id on every
surface, the REST path segment included; there is no URL transform to configure.

**What stays, byte-identical:** every live key of the four sub-objects —
`crud.operations.*`, `crud.dataPrefix`, `metadata.prefix` / `enableCache` /
`maskObjectFields` / `endpoints.types|items|item`, `batch.maxBatchSize` /
`enableBatchEndpoint` / `operations.createMany|updateMany|deleteMany` — with
its default and its mount. The mounted REST surface does not change: none of
the ten keys ever reached it. `@objectstack/rest`'s normalized config no longer
carries the retired keys (they were written and never read), and the #11984
pins of their accept/reject behaviour are reversed to refusal pins, by design.

The retirement kit: `retiredKey()` tombstones on the four sub-schemas;
`RestServerConfigSchema`'s `@example` no longer advertises
`routes: { excludeObjects: [...] }`; ledger rows kept `dead` with a REMOVED
note and `evidenceScope: cross-repo` (the two container rows collapse into one
each, since their child keys left the walked shape); `RETIRED_KEYS_BY_MAJOR[18]`
× 10 and `RETIRED_DEFS_BY_MAJOR[18]` `api/CrudEndpointPattern`; D3 semantic
entry `rest-server-config-dead-keys-retired`. No D2 conversion: a
`RestServerConfig` is plugin TS configuration (REST plugin constructor /
`plugin-hono-server` `restConfig`), never a stack collection member or a
`sys_metadata` row (the `openApi31` precedent, #4579), so there is no source
for the chain to rewrite and the prescription carries no `os migrate meta`
sentence.
6 changes: 3 additions & 3 deletions content/docs/permissions/system-context.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -64,7 +64,7 @@ not on any flag.
## How the flag is set

`isSystem` is **server-constructed and never client-supplied**. Inbound HTTP
cannot set it (`packages/rest/src/rest-server.ts:1522`, `:1551`), and neither
cannot set it (`packages/rest/src/rest-server.ts:1520`, `:1549`), and neither
can an action body (`packages/runtime/src/domains/actions.ts:404`). It is
written by internal callers only, as an option on the engine call:

Expand DownExpand Up@@ -103,7 +103,7 @@ that silently does not happen.
| 14 | MCP stdio bridge skips the object API-exposure gate | mcp | Get: the bridge reaches objects whose `apiEnabled` / `apiMethods` would refuse an external caller | `stdio-data-bridge.ts:246` |
| 15 | **Read-audit rows are not written** | plugin-audit | Lose: the "a person opened this record" trail. `sudo()` keeps the caller's `userId`, so this flag is the only thing separating a human read from a platform one | `read-audit.ts:556` |
| 16 | Approval snapshot payload redaction skipped | plugin-approvals | Get: the whole snapshot on `find` / `findOne` — the audit/replay channel. Lose: field-visibility redaction over approval payloads | `payload-redaction-middleware.ts:115` |
| 17 | REST anonymous-deny seam satisfied | rest | Get: `enforceAuth` passes with no `userId`. Not reachable from the wire — `isSystem` is never set on an inbound request | `rest-server.ts:1554` |
| 17 | REST anonymous-deny seam satisfied | rest | Get: `enforceAuth` passes with no `userId`. Not reachable from the wire — `isSystem` is never set on an inbound request | `rest-server.ts:1552` |

### 2. Write pipeline and data integrity

Expand DownExpand Up@@ -199,7 +199,7 @@ assuming `isSystem` covers it is a documented source of bugs.
| "It preserves a supplied `updated_at` / `updated_by`" | **No.** That is `preserveAudit`, a separate opt-in — and an UPDATE-path exemption only | `field.zod.ts:1516` (#3493 / #6640) |
| "It stamps `created_by`" | **No.** Audit stamping reads `userId` from the context. A user-less system write stamps nothing — that is today's behaviour, not an error | `runtime-identity.ts:280`–`281` |
| "It bypasses every guard" | **No.** The last-admin guard applies to **every** context, `isSystem` included — the deprovision path that actually locks an org out is the system one | `last-admin-guard.ts:299` |
| "A client can request it" | **No.** Never settable from inbound HTTP or from an action body | `rest-server.ts:1522`, `:1551`; `domains/actions.ts:404` |
| "A client can request it" | **No.** Never settable from inbound HTTP or from an action body | `rest-server.ts:1520`, `:1549`; `domains/actions.ts:404` |

---

Expand Down
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
83 changes: 83 additions & 0 deletions .changeset/rest-server-config-dead-keys-retired.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
---
"@objectstack/spec": minor
"@objectstack/rest": minor
---

feat(spec): retire the ten inert `RestServerConfig` keys the liveness ledger recorded as `dead` (#14691, ADR-0049 enforce-or-remove)

<!-- adr-0087: registered rest-server-config-dead-keys-retired -->

**BREAKING** accept-set narrowing, landing after the v17.0.0 cut (the lockstep
launch-window convention ships it as `minor`; the prescription is registered
under protocol major 18, where `os migrate meta` users will look).

#14369 enrolled the four `RestServerConfig` sub-objects (`crud`, `metadata`,
`batch`, `routes`) in the spec liveness ledger and found 15 of their 32 rows
`dead`: parsed, defaulted and normalized into the REST server's config by
`normalizeConfig` (#11984) and never read back. This change is the
enforce-or-remove call on every one of them, taken per family, and every
family resolved to REMOVE — each promised capability either already exists at
its proper seat or would contradict a fixed contract. The closed-set cloud
sweep (#14796, `objectstack-ai/cloud` @ `9b6abe0f2fd5`) returned zero hits,
structurally: cloud never authors a `RestServerConfig`.

**What is refused:** authoring any of the ten keys below. Each is a
`retiredKey()` tombstone (all four sub-schemas are non-strict `z.object()`s,
so a plain deletion would have silently stripped the key), so authoring it is
a `tsc` error and a parse error carrying the prescription — and, because
`RestServer` parses these sub-objects at construction (#11984),
`new RestServer(...)` / `createRestApiPlugin().start()` now refuse a config
that carries one, naming the sub-object, the key and the declaring schema.

**FROM → TO** (delete the key in every case; none ever had an effect to preserve):

- `crud.patterns` → the mounted CRUD paths are the contract the client SDK, the
discovery document and the served `/openapi.json` all describe; `crud.dataPrefix`
moves them deployment-wide. An endpoint on a custom path or method is a
declarative `api` endpoint (`type: 'object_operation'`). Its value schema
`CrudEndpointPatternSchema` / type `CrudEndpointPattern` are removed with it
(no other consumer; `CrudOperation` stays — `GeneratedEndpoint.operation` reads it).
- `crud.objectParamStyle` → the object name is always a path segment.
- `metadata.cacheTtl` → `metadata.enableCache` is the live switch (it selects the
protocol's `getMetaItemCached` path, which takes no TTL); a declarative `api`
endpoint's `cacheTtl` is the key that reaches the wire. The unbounded negative
TTL this key accepted goes with it.
- `metadata.endpoints.schema` → gated `GET /meta/:type/:name/schema`, which does
not exist; `endpoints.types` / `items` / `item` gate real mounts and stay.
- `batch.operations.upsertMany` → gated `POST /data/:object/upsertMany`, which
was never built; upsert is an operation type of the generic
`POST /data/:object/batch` endpoint (`BatchOperationType` `'upsert'`), gated
by `batch.enableBatchEndpoint`.
- `batch.defaultAtomic` → atomicity is the per-request `options.atomic`
(ADR-0119 D4, opt-in); a server-side default that flipped it silently would
change the failure semantics of callers who send nothing, which that ADR
refused. Callers that need all-or-nothing send `options: { atomic: true }`.
- `routes.includeObjects` / `routes.excludeObjects` / `routes.overrides`
(`enabled` / `basePath` / `operations`) → per-object API exposure is declared
ON the object and enforced by the REST data surface: `enable.apiEnabled: false`
hides it (404), `enable.apiMethods` whitelists its operations (405). The data
base path is deployment-wide (`crud.dataPrefix`).
- `routes.nameTransform` → the object `name` is the canonical id on every
surface, the REST path segment included; there is no URL transform to configure.

**What stays, byte-identical:** every live key of the four sub-objects —
`crud.operations.*`, `crud.dataPrefix`, `metadata.prefix` / `enableCache` /
`maskObjectFields` / `endpoints.types|items|item`, `batch.maxBatchSize` /
`enableBatchEndpoint` / `operations.createMany|updateMany|deleteMany` — with
its default and its mount. The mounted REST surface does not change: none of
the ten keys ever reached it. `@objectstack/rest`'s normalized config no longer
carries the retired keys (they were written and never read), and the #11984
pins of their accept/reject behaviour are reversed to refusal pins, by design.

The retirement kit: `retiredKey()` tombstones on the four sub-schemas;
`RestServerConfigSchema`'s `@example` no longer advertises
`routes: { excludeObjects: [...] }`; ledger rows kept `dead` with a REMOVED
note and `evidenceScope: cross-repo` (the two container rows collapse into one
each, since their child keys left the walked shape); `RETIRED_KEYS_BY_MAJOR[18]`
× 10 and `RETIRED_DEFS_BY_MAJOR[18]` `api/CrudEndpointPattern`; D3 semantic
entry `rest-server-config-dead-keys-retired`. No D2 conversion: a
`RestServerConfig` is plugin TS configuration (REST plugin constructor /
`plugin-hono-server` `restConfig`), never a stack collection member or a
`sys_metadata` row (the `openApi31` precedent, #4579), so there is no source
for the chain to rewrite and the prescription carries no `os migrate meta`
sentence.
6 changes: 3 additions & 3 deletions content/docs/permissions/system-context.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -64,7 +64,7 @@ not on any flag.
## How the flag is set

`isSystem` is **server-constructed and never client-supplied**. Inbound HTTP
cannot set it (`packages/rest/src/rest-server.ts:1522`, `:1551`), and neither
cannot set it (`packages/rest/src/rest-server.ts:1520`, `:1549`), and neither
can an action body (`packages/runtime/src/domains/actions.ts:404`). It is
written by internal callers only, as an option on the engine call:

Expand DownExpand Up@@ -103,7 +103,7 @@ that silently does not happen.
| 14 | MCP stdio bridge skips the object API-exposure gate | mcp | Get: the bridge reaches objects whose `apiEnabled` / `apiMethods` would refuse an external caller | `stdio-data-bridge.ts:246` |
| 15 | **Read-audit rows are not written** | plugin-audit | Lose: the "a person opened this record" trail. `sudo()` keeps the caller's `userId`, so this flag is the only thing separating a human read from a platform one | `read-audit.ts:556` |
| 16 | Approval snapshot payload redaction skipped | plugin-approvals | Get: the whole snapshot on `find` / `findOne` — the audit/replay channel. Lose: field-visibility redaction over approval payloads | `payload-redaction-middleware.ts:115` |
| 17 | REST anonymous-deny seam satisfied | rest | Get: `enforceAuth` passes with no `userId`. Not reachable from the wire — `isSystem` is never set on an inbound request | `rest-server.ts:1554` |
| 17 | REST anonymous-deny seam satisfied | rest | Get: `enforceAuth` passes with no `userId`. Not reachable from the wire — `isSystem` is never set on an inbound request | `rest-server.ts:1552` |

### 2. Write pipeline and data integrity

Expand DownExpand Up@@ -199,7 +199,7 @@ assuming `isSystem` covers it is a documented source of bugs.
| "It preserves a supplied `updated_at` / `updated_by`" | **No.** That is `preserveAudit`, a separate opt-in — and an UPDATE-path exemption only | `field.zod.ts:1516` (#3493 / #6640) |
| "It stamps `created_by`" | **No.** Audit stamping reads `userId` from the context. A user-less system write stamps nothing — that is today's behaviour, not an error | `runtime-identity.ts:280`–`281` |
| "It bypasses every guard" | **No.** The last-admin guard applies to **every** context, `isSystem` included — the deprovision path that actually locks an org out is the system one | `last-admin-guard.ts:299` |
| "A client can request it" | **No.** Never settable from inbound HTTP or from an action body | `rest-server.ts:1522`, `:1551`; `domains/actions.ts:404` |
| "A client can request it" | **No.** Never settable from inbound HTTP or from an action body | `rest-server.ts:1520`, `:1549`; `domains/actions.ts:404` |

---

Expand Down
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
83 changes: 83 additions & 0 deletions .changeset/rest-server-config-dead-keys-retired.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
---
"@objectstack/spec": minor
"@objectstack/rest": minor
---

feat(spec): retire the ten inert `RestServerConfig` keys the liveness ledger recorded as `dead` (#14691, ADR-0049 enforce-or-remove)

<!-- adr-0087: registered rest-server-config-dead-keys-retired -->

**BREAKING** accept-set narrowing, landing after the v17.0.0 cut (the lockstep
launch-window convention ships it as `minor`; the prescription is registered
under protocol major 18, where `os migrate meta` users will look).

#14369 enrolled the four `RestServerConfig` sub-objects (`crud`, `metadata`,
`batch`, `routes`) in the spec liveness ledger and found 15 of their 32 rows
`dead`: parsed, defaulted and normalized into the REST server's config by
`normalizeConfig` (#11984) and never read back. This change is the
enforce-or-remove call on every one of them, taken per family, and every
family resolved to REMOVE — each promised capability either already exists at
its proper seat or would contradict a fixed contract. The closed-set cloud
sweep (#14796, `objectstack-ai/cloud` @ `9b6abe0f2fd5`) returned zero hits,
structurally: cloud never authors a `RestServerConfig`.

**What is refused:** authoring any of the ten keys below. Each is a
`retiredKey()` tombstone (all four sub-schemas are non-strict `z.object()`s,
so a plain deletion would have silently stripped the key), so authoring it is
a `tsc` error and a parse error carrying the prescription — and, because
`RestServer` parses these sub-objects at construction (#11984),
`new RestServer(...)` / `createRestApiPlugin().start()` now refuse a config
that carries one, naming the sub-object, the key and the declaring schema.

**FROM → TO** (delete the key in every case; none ever had an effect to preserve):

- `crud.patterns` → the mounted CRUD paths are the contract the client SDK, the
discovery document and the served `/openapi.json` all describe; `crud.dataPrefix`
moves them deployment-wide. An endpoint on a custom path or method is a
declarative `api` endpoint (`type: 'object_operation'`). Its value schema
`CrudEndpointPatternSchema` / type `CrudEndpointPattern` are removed with it
(no other consumer; `CrudOperation` stays — `GeneratedEndpoint.operation` reads it).
- `crud.objectParamStyle` → the object name is always a path segment.
- `metadata.cacheTtl` → `metadata.enableCache` is the live switch (it selects the
protocol's `getMetaItemCached` path, which takes no TTL); a declarative `api`
endpoint's `cacheTtl` is the key that reaches the wire. The unbounded negative
TTL this key accepted goes with it.
- `metadata.endpoints.schema` → gated `GET /meta/:type/:name/schema`, which does
not exist; `endpoints.types` / `items` / `item` gate real mounts and stay.
- `batch.operations.upsertMany` → gated `POST /data/:object/upsertMany`, which
was never built; upsert is an operation type of the generic
`POST /data/:object/batch` endpoint (`BatchOperationType` `'upsert'`), gated
by `batch.enableBatchEndpoint`.
- `batch.defaultAtomic` → atomicity is the per-request `options.atomic`
(ADR-0119 D4, opt-in); a server-side default that flipped it silently would
change the failure semantics of callers who send nothing, which that ADR
refused. Callers that need all-or-nothing send `options: { atomic: true }`.
- `routes.includeObjects` / `routes.excludeObjects` / `routes.overrides`
(`enabled` / `basePath` / `operations`) → per-object API exposure is declared
ON the object and enforced by the REST data surface: `enable.apiEnabled: false`
hides it (404), `enable.apiMethods` whitelists its operations (405). The data
base path is deployment-wide (`crud.dataPrefix`).
- `routes.nameTransform` → the object `name` is the canonical id on every
surface, the REST path segment included; there is no URL transform to configure.

**What stays, byte-identical:** every live key of the four sub-objects —
`crud.operations.*`, `crud.dataPrefix`, `metadata.prefix` / `enableCache` /
`maskObjectFields` / `endpoints.types|items|item`, `batch.maxBatchSize` /
`enableBatchEndpoint` / `operations.createMany|updateMany|deleteMany` — with
its default and its mount. The mounted REST surface does not change: none of
the ten keys ever reached it. `@objectstack/rest`'s normalized config no longer
carries the retired keys (they were written and never read), and the #11984
pins of their accept/reject behaviour are reversed to refusal pins, by design.

The retirement kit: `retiredKey()` tombstones on the four sub-schemas;
`RestServerConfigSchema`'s `@example` no longer advertises
`routes: { excludeObjects: [...] }`; ledger rows kept `dead` with a REMOVED
note and `evidenceScope: cross-repo` (the two container rows collapse into one
each, since their child keys left the walked shape); `RETIRED_KEYS_BY_MAJOR[18]`
× 10 and `RETIRED_DEFS_BY_MAJOR[18]` `api/CrudEndpointPattern`; D3 semantic
entry `rest-server-config-dead-keys-retired`. No D2 conversion: a
`RestServerConfig` is plugin TS configuration (REST plugin constructor /
`plugin-hono-server` `restConfig`), never a stack collection member or a
`sys_metadata` row (the `openApi31` precedent, #4579), so there is no source
for the chain to rewrite and the prescription carries no `os migrate meta`
sentence.
6 changes: 3 additions & 3 deletions content/docs/permissions/system-context.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -64,7 +64,7 @@ not on any flag.
## How the flag is set

`isSystem` is **server-constructed and never client-supplied**. Inbound HTTP
cannot set it (`packages/rest/src/rest-server.ts:1522`, `:1551`), and neither
cannot set it (`packages/rest/src/rest-server.ts:1520`, `:1549`), and neither
can an action body (`packages/runtime/src/domains/actions.ts:404`). It is
written by internal callers only, as an option on the engine call:

Expand DownExpand Up@@ -103,7 +103,7 @@ that silently does not happen.
| 14 | MCP stdio bridge skips the object API-exposure gate | mcp | Get: the bridge reaches objects whose `apiEnabled` / `apiMethods` would refuse an external caller | `stdio-data-bridge.ts:246` |
| 15 | **Read-audit rows are not written** | plugin-audit | Lose: the "a person opened this record" trail. `sudo()` keeps the caller's `userId`, so this flag is the only thing separating a human read from a platform one | `read-audit.ts:556` |
| 16 | Approval snapshot payload redaction skipped | plugin-approvals | Get: the whole snapshot on `find` / `findOne` — the audit/replay channel. Lose: field-visibility redaction over approval payloads | `payload-redaction-middleware.ts:115` |
| 17 | REST anonymous-deny seam satisfied | rest | Get: `enforceAuth` passes with no `userId`. Not reachable from the wire — `isSystem` is never set on an inbound request | `rest-server.ts:1554` |
| 17 | REST anonymous-deny seam satisfied | rest | Get: `enforceAuth` passes with no `userId`. Not reachable from the wire — `isSystem` is never set on an inbound request | `rest-server.ts:1552` |

### 2. Write pipeline and data integrity

Expand DownExpand Up@@ -199,7 +199,7 @@ assuming `isSystem` covers it is a documented source of bugs.
| "It preserves a supplied `updated_at` / `updated_by`" | **No.** That is `preserveAudit`, a separate opt-in — and an UPDATE-path exemption only | `field.zod.ts:1516` (#3493 / #6640) |
| "It stamps `created_by`" | **No.** Audit stamping reads `userId` from the context. A user-less system write stamps nothing — that is today's behaviour, not an error | `runtime-identity.ts:280`–`281` |
| "It bypasses every guard" | **No.** The last-admin guard applies to **every** context, `isSystem` included — the deprovision path that actually locks an org out is the system one | `last-admin-guard.ts:299` |
| "A client can request it" | **No.** Never settable from inbound HTTP or from an action body | `rest-server.ts:1522`, `:1551`; `domains/actions.ts:404` |
| "A client can request it" | **No.** Never settable from inbound HTTP or from an action body | `rest-server.ts:1520`, `:1549`; `domains/actions.ts:404` |

---

Expand Down
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
83 changes: 83 additions & 0 deletions .changeset/rest-server-config-dead-keys-retired.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
---
"@objectstack/spec": minor
"@objectstack/rest": minor
---

feat(spec): retire the ten inert `RestServerConfig` keys the liveness ledger recorded as `dead` (#14691, ADR-0049 enforce-or-remove)

<!-- adr-0087: registered rest-server-config-dead-keys-retired -->

**BREAKING** accept-set narrowing, landing after the v17.0.0 cut (the lockstep
launch-window convention ships it as `minor`; the prescription is registered
under protocol major 18, where `os migrate meta` users will look).

#14369 enrolled the four `RestServerConfig` sub-objects (`crud`, `metadata`,
`batch`, `routes`) in the spec liveness ledger and found 15 of their 32 rows
`dead`: parsed, defaulted and normalized into the REST server's config by
`normalizeConfig` (#11984) and never read back. This change is the
enforce-or-remove call on every one of them, taken per family, and every
family resolved to REMOVE — each promised capability either already exists at
its proper seat or would contradict a fixed contract. The closed-set cloud
sweep (#14796, `objectstack-ai/cloud` @ `9b6abe0f2fd5`) returned zero hits,
structurally: cloud never authors a `RestServerConfig`.

**What is refused:** authoring any of the ten keys below. Each is a
`retiredKey()` tombstone (all four sub-schemas are non-strict `z.object()`s,
so a plain deletion would have silently stripped the key), so authoring it is
a `tsc` error and a parse error carrying the prescription — and, because
`RestServer` parses these sub-objects at construction (#11984),
`new RestServer(...)` / `createRestApiPlugin().start()` now refuse a config
that carries one, naming the sub-object, the key and the declaring schema.

**FROM → TO** (delete the key in every case; none ever had an effect to preserve):

- `crud.patterns` → the mounted CRUD paths are the contract the client SDK, the
discovery document and the served `/openapi.json` all describe; `crud.dataPrefix`
moves them deployment-wide. An endpoint on a custom path or method is a
declarative `api` endpoint (`type: 'object_operation'`). Its value schema
`CrudEndpointPatternSchema` / type `CrudEndpointPattern` are removed with it
(no other consumer; `CrudOperation` stays — `GeneratedEndpoint.operation` reads it).
- `crud.objectParamStyle` → the object name is always a path segment.
- `metadata.cacheTtl` → `metadata.enableCache` is the live switch (it selects the
protocol's `getMetaItemCached` path, which takes no TTL); a declarative `api`
endpoint's `cacheTtl` is the key that reaches the wire. The unbounded negative
TTL this key accepted goes with it.
- `metadata.endpoints.schema` → gated `GET /meta/:type/:name/schema`, which does
not exist; `endpoints.types` / `items` / `item` gate real mounts and stay.
- `batch.operations.upsertMany` → gated `POST /data/:object/upsertMany`, which
was never built; upsert is an operation type of the generic
`POST /data/:object/batch` endpoint (`BatchOperationType` `'upsert'`), gated
by `batch.enableBatchEndpoint`.
- `batch.defaultAtomic` → atomicity is the per-request `options.atomic`
(ADR-0119 D4, opt-in); a server-side default that flipped it silently would
change the failure semantics of callers who send nothing, which that ADR
refused. Callers that need all-or-nothing send `options: { atomic: true }`.
- `routes.includeObjects` / `routes.excludeObjects` / `routes.overrides`
(`enabled` / `basePath` / `operations`) → per-object API exposure is declared
ON the object and enforced by the REST data surface: `enable.apiEnabled: false`
hides it (404), `enable.apiMethods` whitelists its operations (405). The data
base path is deployment-wide (`crud.dataPrefix`).
- `routes.nameTransform` → the object `name` is the canonical id on every
surface, the REST path segment included; there is no URL transform to configure.

**What stays, byte-identical:** every live key of the four sub-objects —
`crud.operations.*`, `crud.dataPrefix`, `metadata.prefix` / `enableCache` /
`maskObjectFields` / `endpoints.types|items|item`, `batch.maxBatchSize` /
`enableBatchEndpoint` / `operations.createMany|updateMany|deleteMany` — with
its default and its mount. The mounted REST surface does not change: none of
the ten keys ever reached it. `@objectstack/rest`'s normalized config no longer
carries the retired keys (they were written and never read), and the #11984
pins of their accept/reject behaviour are reversed to refusal pins, by design.

The retirement kit: `retiredKey()` tombstones on the four sub-schemas;
`RestServerConfigSchema`'s `@example` no longer advertises
`routes: { excludeObjects: [...] }`; ledger rows kept `dead` with a REMOVED
note and `evidenceScope: cross-repo` (the two container rows collapse into one
each, since their child keys left the walked shape); `RETIRED_KEYS_BY_MAJOR[18]`
× 10 and `RETIRED_DEFS_BY_MAJOR[18]` `api/CrudEndpointPattern`; D3 semantic
entry `rest-server-config-dead-keys-retired`. No D2 conversion: a
`RestServerConfig` is plugin TS configuration (REST plugin constructor /
`plugin-hono-server` `restConfig`), never a stack collection member or a
`sys_metadata` row (the `openApi31` precedent, #4579), so there is no source
for the chain to rewrite and the prescription carries no `os migrate meta`
sentence.
6 changes: 3 additions & 3 deletions content/docs/permissions/system-context.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -64,7 +64,7 @@ not on any flag.
## How the flag is set

`isSystem` is **server-constructed and never client-supplied**. Inbound HTTP
cannot set it (`packages/rest/src/rest-server.ts:1522`, `:1551`), and neither
cannot set it (`packages/rest/src/rest-server.ts:1520`, `:1549`), and neither
can an action body (`packages/runtime/src/domains/actions.ts:404`). It is
written by internal callers only, as an option on the engine call:

Expand DownExpand Up@@ -103,7 +103,7 @@ that silently does not happen.
| 14 | MCP stdio bridge skips the object API-exposure gate | mcp | Get: the bridge reaches objects whose `apiEnabled` / `apiMethods` would refuse an external caller | `stdio-data-bridge.ts:246` |
| 15 | **Read-audit rows are not written** | plugin-audit | Lose: the "a person opened this record" trail. `sudo()` keeps the caller's `userId`, so this flag is the only thing separating a human read from a platform one | `read-audit.ts:556` |
| 16 | Approval snapshot payload redaction skipped | plugin-approvals | Get: the whole snapshot on `find` / `findOne` — the audit/replay channel. Lose: field-visibility redaction over approval payloads | `payload-redaction-middleware.ts:115` |
| 17 | REST anonymous-deny seam satisfied | rest | Get: `enforceAuth` passes with no `userId`. Not reachable from the wire — `isSystem` is never set on an inbound request | `rest-server.ts:1554` |
| 17 | REST anonymous-deny seam satisfied | rest | Get: `enforceAuth` passes with no `userId`. Not reachable from the wire — `isSystem` is never set on an inbound request | `rest-server.ts:1552` |

### 2. Write pipeline and data integrity

Expand DownExpand Up@@ -199,7 +199,7 @@ assuming `isSystem` covers it is a documented source of bugs.
| "It preserves a supplied `updated_at` / `updated_by`" | **No.** That is `preserveAudit`, a separate opt-in — and an UPDATE-path exemption only | `field.zod.ts:1516` (#3493 / #6640) |
| "It stamps `created_by`" | **No.** Audit stamping reads `userId` from the context. A user-less system write stamps nothing — that is today's behaviour, not an error | `runtime-identity.ts:280`–`281` |
| "It bypasses every guard" | **No.** The last-admin guard applies to **every** context, `isSystem` included — the deprovision path that actually locks an org out is the system one | `last-admin-guard.ts:299` |
| "A client can request it" | **No.** Never settable from inbound HTTP or from an action body | `rest-server.ts:1522`, `:1551`; `domains/actions.ts:404` |
| "A client can request it" | **No.** Never settable from inbound HTTP or from an action body | `rest-server.ts:1520`, `:1549`; `domains/actions.ts:404` |

---

Expand Down
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
83 changes: 83 additions & 0 deletions .changeset/rest-server-config-dead-keys-retired.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
---
"@objectstack/spec": minor
"@objectstack/rest": minor
---

feat(spec): retire the ten inert `RestServerConfig` keys the liveness ledger recorded as `dead` (#14691, ADR-0049 enforce-or-remove)

<!-- adr-0087: registered rest-server-config-dead-keys-retired -->

**BREAKING** accept-set narrowing, landing after the v17.0.0 cut (the lockstep
launch-window convention ships it as `minor`; the prescription is registered
under protocol major 18, where `os migrate meta` users will look).

#14369 enrolled the four `RestServerConfig` sub-objects (`crud`, `metadata`,
`batch`, `routes`) in the spec liveness ledger and found 15 of their 32 rows
`dead`: parsed, defaulted and normalized into the REST server's config by
`normalizeConfig` (#11984) and never read back. This change is the
enforce-or-remove call on every one of them, taken per family, and every
family resolved to REMOVE — each promised capability either already exists at
its proper seat or would contradict a fixed contract. The closed-set cloud
sweep (#14796, `objectstack-ai/cloud` @ `9b6abe0f2fd5`) returned zero hits,
structurally: cloud never authors a `RestServerConfig`.

**What is refused:** authoring any of the ten keys below. Each is a
`retiredKey()` tombstone (all four sub-schemas are non-strict `z.object()`s,
so a plain deletion would have silently stripped the key), so authoring it is
a `tsc` error and a parse error carrying the prescription — and, because
`RestServer` parses these sub-objects at construction (#11984),
`new RestServer(...)` / `createRestApiPlugin().start()` now refuse a config
that carries one, naming the sub-object, the key and the declaring schema.

**FROM → TO** (delete the key in every case; none ever had an effect to preserve):

- `crud.patterns` → the mounted CRUD paths are the contract the client SDK, the
discovery document and the served `/openapi.json` all describe; `crud.dataPrefix`
moves them deployment-wide. An endpoint on a custom path or method is a
declarative `api` endpoint (`type: 'object_operation'`). Its value schema
`CrudEndpointPatternSchema` / type `CrudEndpointPattern` are removed with it
(no other consumer; `CrudOperation` stays — `GeneratedEndpoint.operation` reads it).
- `crud.objectParamStyle` → the object name is always a path segment.
- `metadata.cacheTtl` → `metadata.enableCache` is the live switch (it selects the
protocol's `getMetaItemCached` path, which takes no TTL); a declarative `api`
endpoint's `cacheTtl` is the key that reaches the wire. The unbounded negative
TTL this key accepted goes with it.
- `metadata.endpoints.schema` → gated `GET /meta/:type/:name/schema`, which does
not exist; `endpoints.types` / `items` / `item` gate real mounts and stay.
- `batch.operations.upsertMany` → gated `POST /data/:object/upsertMany`, which
was never built; upsert is an operation type of the generic
`POST /data/:object/batch` endpoint (`BatchOperationType` `'upsert'`), gated
by `batch.enableBatchEndpoint`.
- `batch.defaultAtomic` → atomicity is the per-request `options.atomic`
(ADR-0119 D4, opt-in); a server-side default that flipped it silently would
change the failure semantics of callers who send nothing, which that ADR
refused. Callers that need all-or-nothing send `options: { atomic: true }`.
- `routes.includeObjects` / `routes.excludeObjects` / `routes.overrides`
(`enabled` / `basePath` / `operations`) → per-object API exposure is declared
ON the object and enforced by the REST data surface: `enable.apiEnabled: false`
hides it (404), `enable.apiMethods` whitelists its operations (405). The data
base path is deployment-wide (`crud.dataPrefix`).
- `routes.nameTransform` → the object `name` is the canonical id on every
surface, the REST path segment included; there is no URL transform to configure.

**What stays, byte-identical:** every live key of the four sub-objects —
`crud.operations.*`, `crud.dataPrefix`, `metadata.prefix` / `enableCache` /
`maskObjectFields` / `endpoints.types|items|item`, `batch.maxBatchSize` /
`enableBatchEndpoint` / `operations.createMany|updateMany|deleteMany` — with
its default and its mount. The mounted REST surface does not change: none of
the ten keys ever reached it. `@objectstack/rest`'s normalized config no longer
carries the retired keys (they were written and never read), and the #11984
pins of their accept/reject behaviour are reversed to refusal pins, by design.

The retirement kit: `retiredKey()` tombstones on the four sub-schemas;
`RestServerConfigSchema`'s `@example` no longer advertises
`routes: { excludeObjects: [...] }`; ledger rows kept `dead` with a REMOVED
note and `evidenceScope: cross-repo` (the two container rows collapse into one
each, since their child keys left the walked shape); `RETIRED_KEYS_BY_MAJOR[18]`
× 10 and `RETIRED_DEFS_BY_MAJOR[18]` `api/CrudEndpointPattern`; D3 semantic
entry `rest-server-config-dead-keys-retired`. No D2 conversion: a
`RestServerConfig` is plugin TS configuration (REST plugin constructor /
`plugin-hono-server` `restConfig`), never a stack collection member or a
`sys_metadata` row (the `openApi31` precedent, #4579), so there is no source
for the chain to rewrite and the prescription carries no `os migrate meta`
sentence.
6 changes: 3 additions & 3 deletions content/docs/permissions/system-context.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -64,7 +64,7 @@ not on any flag.
## How the flag is set

`isSystem` is **server-constructed and never client-supplied**. Inbound HTTP
cannot set it (`packages/rest/src/rest-server.ts:1522`, `:1551`), and neither
cannot set it (`packages/rest/src/rest-server.ts:1520`, `:1549`), and neither
can an action body (`packages/runtime/src/domains/actions.ts:404`). It is
written by internal callers only, as an option on the engine call:

Expand DownExpand Up@@ -103,7 +103,7 @@ that silently does not happen.
| 14 | MCP stdio bridge skips the object API-exposure gate | mcp | Get: the bridge reaches objects whose `apiEnabled` / `apiMethods` would refuse an external caller | `stdio-data-bridge.ts:246` |
| 15 | **Read-audit rows are not written** | plugin-audit | Lose: the "a person opened this record" trail. `sudo()` keeps the caller's `userId`, so this flag is the only thing separating a human read from a platform one | `read-audit.ts:556` |
| 16 | Approval snapshot payload redaction skipped | plugin-approvals | Get: the whole snapshot on `find` / `findOne` — the audit/replay channel. Lose: field-visibility redaction over approval payloads | `payload-redaction-middleware.ts:115` |
| 17 | REST anonymous-deny seam satisfied | rest | Get: `enforceAuth` passes with no `userId`. Not reachable from the wire — `isSystem` is never set on an inbound request | `rest-server.ts:1554` |
| 17 | REST anonymous-deny seam satisfied | rest | Get: `enforceAuth` passes with no `userId`. Not reachable from the wire — `isSystem` is never set on an inbound request | `rest-server.ts:1552` |

### 2. Write pipeline and data integrity

Expand DownExpand Up@@ -199,7 +199,7 @@ assuming `isSystem` covers it is a documented source of bugs.
| "It preserves a supplied `updated_at` / `updated_by`" | **No.** That is `preserveAudit`, a separate opt-in — and an UPDATE-path exemption only | `field.zod.ts:1516` (#3493 / #6640) |
| "It stamps `created_by`" | **No.** Audit stamping reads `userId` from the context. A user-less system write stamps nothing — that is today's behaviour, not an error | `runtime-identity.ts:280`–`281` |
| "It bypasses every guard" | **No.** The last-admin guard applies to **every** context, `isSystem` included — the deprovision path that actually locks an org out is the system one | `last-admin-guard.ts:299` |
| "A client can request it" | **No.** Never settable from inbound HTTP or from an action body | `rest-server.ts:1522`, `:1551`; `domains/actions.ts:404` |
| "A client can request it" | **No.** Never settable from inbound HTTP or from an action body | `rest-server.ts:1520`, `:1549`; `domains/actions.ts:404` |

---

Expand Down
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
83 changes: 83 additions & 0 deletions .changeset/rest-server-config-dead-keys-retired.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
---
"@objectstack/spec": minor
"@objectstack/rest": minor
---

feat(spec): retire the ten inert `RestServerConfig` keys the liveness ledger recorded as `dead` (#14691, ADR-0049 enforce-or-remove)

<!-- adr-0087: registered rest-server-config-dead-keys-retired -->

**BREAKING** accept-set narrowing, landing after the v17.0.0 cut (the lockstep
launch-window convention ships it as `minor`; the prescription is registered
under protocol major 18, where `os migrate meta` users will look).

#14369 enrolled the four `RestServerConfig` sub-objects (`crud`, `metadata`,
`batch`, `routes`) in the spec liveness ledger and found 15 of their 32 rows
`dead`: parsed, defaulted and normalized into the REST server's config by
`normalizeConfig` (#11984) and never read back. This change is the
enforce-or-remove call on every one of them, taken per family, and every
family resolved to REMOVE — each promised capability either already exists at
its proper seat or would contradict a fixed contract. The closed-set cloud
sweep (#14796, `objectstack-ai/cloud` @ `9b6abe0f2fd5`) returned zero hits,
structurally: cloud never authors a `RestServerConfig`.

**What is refused:** authoring any of the ten keys below. Each is a
`retiredKey()` tombstone (all four sub-schemas are non-strict `z.object()`s,
so a plain deletion would have silently stripped the key), so authoring it is
a `tsc` error and a parse error carrying the prescription — and, because
`RestServer` parses these sub-objects at construction (#11984),
`new RestServer(...)` / `createRestApiPlugin().start()` now refuse a config
that carries one, naming the sub-object, the key and the declaring schema.

**FROM → TO** (delete the key in every case; none ever had an effect to preserve):

- `crud.patterns` → the mounted CRUD paths are the contract the client SDK, the
discovery document and the served `/openapi.json` all describe; `crud.dataPrefix`
moves them deployment-wide. An endpoint on a custom path or method is a
declarative `api` endpoint (`type: 'object_operation'`). Its value schema
`CrudEndpointPatternSchema` / type `CrudEndpointPattern` are removed with it
(no other consumer; `CrudOperation` stays — `GeneratedEndpoint.operation` reads it).
- `crud.objectParamStyle` → the object name is always a path segment.
- `metadata.cacheTtl` → `metadata.enableCache` is the live switch (it selects the
protocol's `getMetaItemCached` path, which takes no TTL); a declarative `api`
endpoint's `cacheTtl` is the key that reaches the wire. The unbounded negative
TTL this key accepted goes with it.
- `metadata.endpoints.schema` → gated `GET /meta/:type/:name/schema`, which does
not exist; `endpoints.types` / `items` / `item` gate real mounts and stay.
- `batch.operations.upsertMany` → gated `POST /data/:object/upsertMany`, which
was never built; upsert is an operation type of the generic
`POST /data/:object/batch` endpoint (`BatchOperationType` `'upsert'`), gated
by `batch.enableBatchEndpoint`.
- `batch.defaultAtomic` → atomicity is the per-request `options.atomic`
(ADR-0119 D4, opt-in); a server-side default that flipped it silently would
change the failure semantics of callers who send nothing, which that ADR
refused. Callers that need all-or-nothing send `options: { atomic: true }`.
- `routes.includeObjects` / `routes.excludeObjects` / `routes.overrides`
(`enabled` / `basePath` / `operations`) → per-object API exposure is declared
ON the object and enforced by the REST data surface: `enable.apiEnabled: false`
hides it (404), `enable.apiMethods` whitelists its operations (405). The data
base path is deployment-wide (`crud.dataPrefix`).
- `routes.nameTransform` → the object `name` is the canonical id on every
surface, the REST path segment included; there is no URL transform to configure.

**What stays, byte-identical:** every live key of the four sub-objects —
`crud.operations.*`, `crud.dataPrefix`, `metadata.prefix` / `enableCache` /
`maskObjectFields` / `endpoints.types|items|item`, `batch.maxBatchSize` /
`enableBatchEndpoint` / `operations.createMany|updateMany|deleteMany` — with
its default and its mount. The mounted REST surface does not change: none of
the ten keys ever reached it. `@objectstack/rest`'s normalized config no longer
carries the retired keys (they were written and never read), and the #11984
pins of their accept/reject behaviour are reversed to refusal pins, by design.

The retirement kit: `retiredKey()` tombstones on the four sub-schemas;
`RestServerConfigSchema`'s `@example` no longer advertises
`routes: { excludeObjects: [...] }`; ledger rows kept `dead` with a REMOVED
note and `evidenceScope: cross-repo` (the two container rows collapse into one
each, since their child keys left the walked shape); `RETIRED_KEYS_BY_MAJOR[18]`
× 10 and `RETIRED_DEFS_BY_MAJOR[18]` `api/CrudEndpointPattern`; D3 semantic
entry `rest-server-config-dead-keys-retired`. No D2 conversion: a
`RestServerConfig` is plugin TS configuration (REST plugin constructor /
`plugin-hono-server` `restConfig`), never a stack collection member or a
`sys_metadata` row (the `openApi31` precedent, #4579), so there is no source
for the chain to rewrite and the prescription carries no `os migrate meta`
sentence.
6 changes: 3 additions & 3 deletions content/docs/permissions/system-context.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -64,7 +64,7 @@ not on any flag.
## How the flag is set

`isSystem` is **server-constructed and never client-supplied**. Inbound HTTP
cannot set it (`packages/rest/src/rest-server.ts:1522`, `:1551`), and neither
cannot set it (`packages/rest/src/rest-server.ts:1520`, `:1549`), and neither
can an action body (`packages/runtime/src/domains/actions.ts:404`). It is
written by internal callers only, as an option on the engine call:

Expand DownExpand Up@@ -103,7 +103,7 @@ that silently does not happen.
| 14 | MCP stdio bridge skips the object API-exposure gate | mcp | Get: the bridge reaches objects whose `apiEnabled` / `apiMethods` would refuse an external caller | `stdio-data-bridge.ts:246` |
| 15 | **Read-audit rows are not written** | plugin-audit | Lose: the "a person opened this record" trail. `sudo()` keeps the caller's `userId`, so this flag is the only thing separating a human read from a platform one | `read-audit.ts:556` |
| 16 | Approval snapshot payload redaction skipped | plugin-approvals | Get: the whole snapshot on `find` / `findOne` — the audit/replay channel. Lose: field-visibility redaction over approval payloads | `payload-redaction-middleware.ts:115` |
| 17 | REST anonymous-deny seam satisfied | rest | Get: `enforceAuth` passes with no `userId`. Not reachable from the wire — `isSystem` is never set on an inbound request | `rest-server.ts:1554` |
| 17 | REST anonymous-deny seam satisfied | rest | Get: `enforceAuth` passes with no `userId`. Not reachable from the wire — `isSystem` is never set on an inbound request | `rest-server.ts:1552` |

### 2. Write pipeline and data integrity

Expand DownExpand Up@@ -199,7 +199,7 @@ assuming `isSystem` covers it is a documented source of bugs.
| "It preserves a supplied `updated_at` / `updated_by`" | **No.** That is `preserveAudit`, a separate opt-in — and an UPDATE-path exemption only | `field.zod.ts:1516` (#3493 / #6640) |
| "It stamps `created_by`" | **No.** Audit stamping reads `userId` from the context. A user-less system write stamps nothing — that is today's behaviour, not an error | `runtime-identity.ts:280`–`281` |
| "It bypasses every guard" | **No.** The last-admin guard applies to **every** context, `isSystem` included — the deprovision path that actually locks an org out is the system one | `last-admin-guard.ts:299` |
| "A client can request it" | **No.** Never settable from inbound HTTP or from an action body | `rest-server.ts:1522`, `:1551`; `domains/actions.ts:404` |
| "A client can request it" | **No.** Never settable from inbound HTTP or from an action body | `rest-server.ts:1520`, `:1549`; `domains/actions.ts:404` |

---

Expand Down
Loading
Loading