Skip to content

Commit dc67a94

Browse files
committed
wip(spec): regenerated artifacts and reference pages for the system/ renames (#15679)
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01G4138K1EG7kQ81FNba5Kp4
1 parent 28f60ba commit dc67a94

12 files changed

Lines changed: 85 additions & 55 deletions

File tree

‎content/docs/references/system/cache.mdx‎

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Cache avalanche/stampede prevention configuration
5353
| Property | Type | Required | Description |
5454
| :--- | :--- | :--- | :--- |
5555
| **jitterTtl** | `{ enabled: boolean; maxJitterSeconds: number }` | optional | TTL jitter to prevent simultaneous expiration |
56-
| **circuitBreaker** | `{ enabled: boolean; failureThreshold: number; resetTimeout: number }` | optional | Circuit breaker for backend protection |
56+
| **circuitBreaker** | `{ enabled: boolean; failureThreshold: number; resetTimeoutSeconds: number }` | optional | Circuit breaker for backend protection |
5757
| **lockout** | `{ enabled: boolean; lockTimeoutMs: number }` | optional | Lock-based stampede prevention |
5858

5959
### Nested Shape: `CacheAvalanchePrevention.jitterTtl`
@@ -69,7 +69,8 @@ Cache avalanche/stampede prevention configuration
6969
| :--- | :--- | :--- | :--- |
7070
| **enabled** | `boolean` | optional (default: `false`) | Enable circuit breaker for backend protection |
7171
| **failureThreshold** | `number` | optional (default: `5`) | Failures before circuit opens |
72-
| **resetTimeout** | `number` | optional (default: `30`) | Seconds before half-open state |
72+
| **resetTimeoutSeconds** | `number` | optional (default: `30`) | Seconds before half-open state |
73+
| **resetTimeout** | `never` | optional | [REMOVED] `CacheAvalanchePrevention.circuitBreaker.resetTimeout` was renamed to `resetTimeoutSeconds` in @objectstack/spec 17 — the unit of a duration-shaped number lives in the key name, not only in the describe prose, and the sibling `lockout` block on this same schema already spells `lockTimeoutMs`. Rename the key to `resetTimeoutSeconds`; the value (seconds) and the 30 default are unchanged. Note the two are NOT the same unit: this one is seconds, `lockTimeoutMs` is milliseconds. |
7374

7475
### Nested Shape: `CacheAvalanchePrevention.lockout`
7576

@@ -90,7 +91,7 @@ Top-level application cache configuration
9091
| Property | Type | Required | Description |
9192
| :--- | :--- | :--- | :--- |
9293
| **enabled** | `boolean` | optional (default: `false`) | Enable application-level caching |
93-
| **tiers** | `{ name: string; type: Enum<'memory' \| 'redis' \| 'memcached' \| 'cdn'>; maxSize?: number; ttl: number; … }[]` | ✅ | Ordered cache tier hierarchy |
94+
| **tiers** | `{ name: string; type: Enum<'memory' \| 'redis' \| 'memcached' \| 'cdn'>; maxSize?: number; ttlSeconds: number; … }[]` | ✅ | Ordered cache tier hierarchy |
9495
| **invalidation** | `{ trigger: Enum<'create' \| 'update' \| 'delete' \| 'manual'>; scope: Enum<'key' \| 'pattern' \| 'tag' \| 'all'>; pattern?: string; tags?: string[] }[]` | ✅ | Cache invalidation rules |
9596
| **prefetch** | `boolean` | optional (default: `false`) | Enable cache prefetching |
9697
| **compression** | `boolean` | optional (default: `false`) | Enable data compression in cache |
@@ -105,7 +106,8 @@ Configuration for a single cache tier in the hierarchy
105106
| **name** | `string` | ✅ | Unique cache tier name |
106107
| **type** | `Enum<'memory' \| 'redis' \| 'memcached' \| 'cdn'>` | ✅ | Cache backend type |
107108
| **maxSize** | `number` | optional | Max size in MB |
108-
| **ttl** | `number` | optional (default: `300`) | Default TTL in seconds |
109+
| **ttlSeconds** | `number` | optional (default: `300`) | Default TTL in seconds |
110+
| **ttl** | `never` | optional | [REMOVED] `CacheTier.ttl` was renamed to `ttlSeconds` in @objectstack/spec 17 — the unit of a duration-shaped number lives in the key name, not only in the describe prose, and the sibling `maxSize` on this same tier is a size in MB. Rename the key to `ttlSeconds`; the value (seconds) and the 300 default are unchanged. |
109111
| **strategy** | `Enum<'lru' \| 'lfu' \| 'fifo' \| 'ttl'>` | optional (default: `"lru"`) | Eviction strategy |
110112
| **warmup** | `boolean` | optional (default: `false`) | Pre-populate cache on startup |
111113

@@ -178,7 +180,8 @@ Configuration for a single cache tier in the hierarchy
178180
| **name** | `string` | ✅ | Unique cache tier name |
179181
| **type** | `Enum<'memory' \| 'redis' \| 'memcached' \| 'cdn'>` | ✅ | Cache backend type |
180182
| **maxSize** | `number` | optional | Max size in MB |
181-
| **ttl** | `number` | optional (default: `300`) | Default TTL in seconds |
183+
| **ttlSeconds** | `number` | optional (default: `300`) | Default TTL in seconds |
184+
| **ttl** | `never` | optional | [REMOVED] `CacheTier.ttl` was renamed to `ttlSeconds` in @objectstack/spec 17 — the unit of a duration-shaped number lives in the key name, not only in the describe prose, and the sibling `maxSize` on this same tier is a size in MB. Rename the key to `ttlSeconds`; the value (seconds) and the 300 default are unchanged. |
182185
| **strategy** | `Enum<'lru' \| 'lfu' \| 'fifo' \| 'ttl'>` | optional (default: `"lru"`) | Eviction strategy |
183186
| **warmup** | `boolean` | optional (default: `false`) | Pre-populate cache on startup |
184187

@@ -211,7 +214,7 @@ Distributed cache configuration with consistency and avalanche prevention
211214
| Property | Type | Required | Description |
212215
| :--- | :--- | :--- | :--- |
213216
| **enabled** | `boolean` | optional (default: `false`) | Enable application-level caching |
214-
| **tiers** | `{ name: string; type: Enum<'memory' \| 'redis' \| 'memcached' \| 'cdn'>; maxSize?: number; ttl?: number; … }[]` | ✅ | Ordered cache tier hierarchy |
217+
| **tiers** | `{ name: string; type: Enum<'memory' \| 'redis' \| 'memcached' \| 'cdn'>; maxSize?: number; ttlSeconds?: number; … }[]` | ✅ | Ordered cache tier hierarchy |
215218
| **invalidation** | `{ trigger: Enum<'create' \| 'update' \| 'delete' \| 'manual'>; scope: Enum<'key' \| 'pattern' \| 'tag' \| 'all'>; pattern?: string; tags?: string[] }[]` | ✅ | Cache invalidation rules |
216219
| **prefetch** | `boolean` | optional (default: `false`) | Enable cache prefetching |
217220
| **compression** | `boolean` | optional (default: `false`) | Enable data compression in cache |
@@ -229,7 +232,8 @@ Configuration for a single cache tier in the hierarchy
229232
| **name** | `string` | ✅ | Unique cache tier name |
230233
| **type** | `Enum<'memory' \| 'redis' \| 'memcached' \| 'cdn'>` | ✅ | Cache backend type |
231234
| **maxSize** | `number` | optional | Max size in MB |
232-
| **ttl** | `number` | optional (default: `300`) | Default TTL in seconds |
235+
| **ttlSeconds** | `number` | optional (default: `300`) | Default TTL in seconds |
236+
| **ttl** | `never` | optional | [REMOVED] `CacheTier.ttl` was renamed to `ttlSeconds` in @objectstack/spec 17 — the unit of a duration-shaped number lives in the key name, not only in the describe prose, and the sibling `maxSize` on this same tier is a size in MB. Rename the key to `ttlSeconds`; the value (seconds) and the 300 default are unchanged. |
233237
| **strategy** | `Enum<'lru' \| 'lfu' \| 'fifo' \| 'ttl'>` | optional (default: `"lru"`) | Eviction strategy |
234238
| **warmup** | `boolean` | optional (default: `false`) | Pre-populate cache on startup |
235239

@@ -249,7 +253,7 @@ Rule defining when and how cached entries are invalidated
249253
| Property | Type | Required | Description |
250254
| :--- | :--- | :--- | :--- |
251255
| **jitterTtl** | `{ enabled?: boolean; maxJitterSeconds?: number }` | optional | TTL jitter to prevent simultaneous expiration |
252-
| **circuitBreaker** | `{ enabled?: boolean; failureThreshold?: number; resetTimeout?: number }` | optional | Circuit breaker for backend protection |
256+
| **circuitBreaker** | `{ enabled?: boolean; failureThreshold?: number; resetTimeoutSeconds?: number }` | optional | Circuit breaker for backend protection |
253257
| **lockout** | `{ enabled?: boolean; lockTimeoutMs?: number }` | optional | Lock-based stampede prevention |
254258

255259
### Nested Shape: `DistributedCacheConfig.warmup`

‎content/docs/references/system/collaboration.mdx‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -346,10 +346,11 @@ This schema accepts one of the following structures:
346346
| **enablePresence** | `boolean` | optional (default: `true`) | Enable presence tracking |
347347
| **enableAwareness** | `boolean` | optional (default: `true`) | Enable awareness state |
348348
| **maxUsers** | `integer` | optional | Maximum concurrent users |
349-
| **idleTimeout** | `integer` | optional (default: `300000`) | Idle timeout in milliseconds |
349+
| **idleTimeoutMs** | `integer` | optional (default: `300000`) | Idle timeout in milliseconds |
350+
| **idleTimeout** | `never` | optional | [REMOVED] `CollaborationSessionConfig.idleTimeout` was renamed to `idleTimeoutMs` in @objectstack/spec 17 — the unit of a duration-shaped number lives in the key name, not only in the describe prose. This one was the live 1000x collision the rule exists to remove: the tenant surface carried its own `idleTimeout` in SECONDS, so the same bare name meant five minutes here and three and a half days there. Rename the key to `idleTimeoutMs`; the value (milliseconds) and the 300000 default are unchanged. |
350351
| **conflictResolution** | `Enum<'ot' \| 'crdt' \| 'manual'>` | optional (default: `"ot"`) | Conflict resolution strategy |
351352
| **persistence** | `boolean` | optional (default: `true`) | Enable operation persistence |
352-
| **snapshot** | `{ enabled: boolean; interval: integer }` | optional | Snapshot configuration |
353+
| **snapshot** | `{ enabled: boolean; intervalMs: integer }` | optional | Snapshot configuration |
353354

354355
### Nested Shape: `CollaborationSession.users[number]`
355356

@@ -421,17 +422,19 @@ This schema accepts one of the following structures:
421422
| **enablePresence** | `boolean` | optional (default: `true`) | Enable presence tracking |
422423
| **enableAwareness** | `boolean` | optional (default: `true`) | Enable awareness state |
423424
| **maxUsers** | `integer` | optional | Maximum concurrent users |
424-
| **idleTimeout** | `integer` | optional (default: `300000`) | Idle timeout in milliseconds |
425+
| **idleTimeoutMs** | `integer` | optional (default: `300000`) | Idle timeout in milliseconds |
426+
| **idleTimeout** | `never` | optional | [REMOVED] `CollaborationSessionConfig.idleTimeout` was renamed to `idleTimeoutMs` in @objectstack/spec 17 — the unit of a duration-shaped number lives in the key name, not only in the describe prose. This one was the live 1000x collision the rule exists to remove: the tenant surface carried its own `idleTimeout` in SECONDS, so the same bare name meant five minutes here and three and a half days there. Rename the key to `idleTimeoutMs`; the value (milliseconds) and the 300000 default are unchanged. |
425427
| **conflictResolution** | `Enum<'ot' \| 'crdt' \| 'manual'>` | optional (default: `"ot"`) | Conflict resolution strategy |
426428
| **persistence** | `boolean` | optional (default: `true`) | Enable operation persistence |
427-
| **snapshot** | `{ enabled: boolean; interval: integer }` | optional | Snapshot configuration |
429+
| **snapshot** | `{ enabled: boolean; intervalMs: integer }` | optional | Snapshot configuration |
428430

429431
### Nested Shape: `CollaborationSessionConfig.snapshot`
430432

431433
| Property | Type | Required | Description |
432434
| :--- | :--- | :--- | :--- |
433435
| **enabled** | `boolean` | ✅ | Enable periodic snapshots |
434-
| **interval** | `integer` | ✅ | Snapshot interval in milliseconds |
436+
| **intervalMs** | `integer` | ✅ | Snapshot interval in milliseconds |
437+
| **interval** | `never` | optional | [REMOVED] `CollaborationSessionConfig.snapshot.interval` was renamed to `intervalMs` in @objectstack/spec 17 — the unit of a duration-shaped number lives in the key name, not only in the describe prose. Rename the key to `intervalMs`; the value (milliseconds) is unchanged. |
435438

436439

437440
---

‎content/docs/references/system/disaster-recovery.mdx‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ Complete disaster recovery plan configuration
112112
| **rpo** | `{ value: number; unit?: Enum<'seconds' \| 'minutes' \| 'hours'> }` | ✅ | Recovery Point Objective |
113113
| **rto** | `{ value: number; unit?: Enum<'seconds' \| 'minutes' \| 'hours'> }` | ✅ | Recovery Time Objective |
114114
| **backup** | `{ strategy?: Enum<'full' \| 'incremental' \| 'differential'>; schedule?: string \| object; retention: object; destination: object; … }` | ✅ | Backup configuration |
115-
| **failover** | `{ mode?: Enum<'active_passive' \| 'active_active' \| 'pilot_light' \| 'warm_standby'>; autoFailover?: boolean; healthCheckInterval?: number; failureThreshold?: number; … }` | optional | Multi-region failover configuration |
115+
| **failover** | `{ mode?: Enum<'active_passive' \| 'active_active' \| 'pilot_light' \| 'warm_standby'>; autoFailover?: boolean; healthCheckIntervalSeconds?: number; failureThreshold?: number; … }` | optional | Multi-region failover configuration |
116116
| **replication** | `{ mode?: Enum<'synchronous' \| 'asynchronous' \| 'semi_synchronous'>; maxLagSeconds?: number; includeObjects?: string[]; excludeObjects?: string[] }` | optional | Data replication settings |
117117
| **testing** | `{ enabled?: boolean; schedule?: string \| object; notificationChannel?: string }` | optional | Automated disaster recovery testing |
118118
| **runbookUrl** | `string` | optional | URL to disaster recovery runbook/playbook |
@@ -150,7 +150,8 @@ Complete disaster recovery plan configuration
150150
| :--- | :--- | :--- | :--- |
151151
| **mode** | `Enum<'active_passive' \| 'active_active' \| 'pilot_light' \| 'warm_standby'>` | optional (default: `"active_passive"`) | Failover mode |
152152
| **autoFailover** | `boolean` | optional (default: `true`) | Enable automatic failover |
153-
| **healthCheckInterval** | `number` | optional (default: `30`) | Health check interval in seconds |
153+
| **healthCheckIntervalSeconds** | `number` | optional (default: `30`) | Health check interval in seconds |
154+
| **healthCheckInterval** | `never` | optional | [REMOVED] `FailoverConfig.healthCheckInterval` was renamed to `healthCheckIntervalSeconds` in @objectstack/spec 17 — the unit of a duration-shaped number lives in the key name, not only in the describe prose. Rename the key to `healthCheckIntervalSeconds`; the value (seconds) and the 30 default are unchanged. |
154155
| **failureThreshold** | `number` | optional (default: `3`) | Consecutive failures before failover |
155156
| **regions** | `{ name: string; role: Enum<'primary' \| 'secondary' \| 'witness'>; endpoint?: string; priority?: number }[]` | ✅ | Multi-region configuration (minimum 2 regions) |
156157
| **dns** | `{ ttl?: number; provider?: Enum<'route53' \| 'cloudflare' \| 'azure_dns' \| 'custom'> }` | optional | DNS failover settings |
@@ -194,7 +195,8 @@ Failover configuration
194195
| :--- | :--- | :--- | :--- |
195196
| **mode** | `Enum<'active_passive' \| 'active_active' \| 'pilot_light' \| 'warm_standby'>` | optional (default: `"active_passive"`) | Failover mode |
196197
| **autoFailover** | `boolean` | optional (default: `true`) | Enable automatic failover |
197-
| **healthCheckInterval** | `number` | optional (default: `30`) | Health check interval in seconds |
198+
| **healthCheckIntervalSeconds** | `number` | optional (default: `30`) | Health check interval in seconds |
199+
| **healthCheckInterval** | `never` | optional | [REMOVED] `FailoverConfig.healthCheckInterval` was renamed to `healthCheckIntervalSeconds` in @objectstack/spec 17 — the unit of a duration-shaped number lives in the key name, not only in the describe prose. Rename the key to `healthCheckIntervalSeconds`; the value (seconds) and the 30 default are unchanged. |
198200
| **failureThreshold** | `number` | optional (default: `3`) | Consecutive failures before failover |
199201
| **regions** | `{ name: string; role: Enum<'primary' \| 'secondary' \| 'witness'>; endpoint?: string; priority?: number }[]` | ✅ | Multi-region configuration (minimum 2 regions) |
200202
| **dns** | `{ ttl: number; provider?: Enum<'route53' \| 'cloudflare' \| 'azure_dns' \| 'custom'> }` | optional | DNS failover settings |

0 commit comments

Comments
 (0)