Skip to content

Commit 86e514e

Browse files
committed
Add API Reference documentation and update guides metadata
- Introduced a new API Reference documentation file detailing all available endpoints, request/response schemas, and service availability. - Updated the guides metadata to include the new API Reference page in the navigation.
1 parent d9ab616 commit 86e514e

5 files changed

Lines changed: 1034 additions & 698 deletions

File tree

content/docs/concepts/implementation-status.mdx

Lines changed: 68 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,10 @@ This matrix is generated from actual codebase analysis and represents the curren
4141
| **Events** |||| ✅ Full |
4242

4343
**Notes:**
44-
- Core package provides complete kernel implementation
44+
- Core package provides complete microkernel implementation
4545
- Plugin system supports lifecycle hooks, dependency resolution, and service injection
4646
- Event bus enables inter-plugin communication
47+
- ObjectQL serves as the **example kernel** — a reference implementation that will be modularized into plugins
4748

4849
### Data Infrastructure
4950

@@ -61,6 +62,16 @@ This matrix is generated from actual codebase analysis and represents the curren
6162
- Advanced query features (aggregations, window functions) require production drivers
6263
- Memory driver supports aggregations (groupBy, count, sum, avg, min, max)
6364

65+
### Metadata Framework
66+
67+
<Callout type="info">
68+
**Degraded Status** — Metadata is an in-memory registry framework. Database persistence for metadata storage is not yet implemented. Discovery reports this service as `degraded`.
69+
</Callout>
70+
71+
- Metadata API (list types, list items, get item) is fully functional
72+
- Metadata is loaded from config files at startup and held in memory
73+
- Future: metadata persistence to database for runtime modifications
74+
6475
### System Services
6576

6677
| Protocol | Implementation Package | Status | Notes |
@@ -211,49 +222,59 @@ This matrix is generated from actual codebase analysis and represents the curren
211222

212223
## Automation Layer
213224

214-
| Protocol | @objectstack/spec | @objectstack/objectql | Status |
215-
|:---------|:-----------------:|:---------------------:|:------:|
216-
| **Flow** ||| ❌ Spec only |
217-
| **Workflow** ||| ❌ Spec only |
218-
| **Approval** ||| ❌ Spec only |
219-
| **Webhook** ||| ❌ Spec only |
220-
| **ETL** ||| ❌ Spec only |
221-
| **Sync** ||| ❌ Spec only |
222-
| **Trigger Registry** ||| ❌ Spec only |
225+
<Callout type="warn">
226+
**Plugin-Provided Service** — The kernel does NOT include an automation engine. Flow, workflow, and approval services must be provided by plugins (e.g., `@objectstack/plugin-automation`).
227+
</Callout>
228+
229+
| Protocol | @objectstack/spec | Kernel | Plugin Required | Status |
230+
|:---------|:-----------------:|:------:|:---------------:|:------:|
231+
| **Flow** |||| 📋 Plugin |
232+
| **Workflow** |||| 📋 Plugin |
233+
| **Approval** |||| 📋 Plugin |
234+
| **Webhook** |||| 📋 Plugin |
235+
| **ETL** |||| 📋 Plugin |
236+
| **Sync** |||| 📋 Plugin |
237+
| **Trigger Registry** |||| 📋 Plugin |
223238

224239
**Notes:**
225-
- Hook system is implemented in ObjectQL (beforeFind, afterInsert, etc.)
226-
- Full workflow/automation engine not yet implemented
227-
- Protocols are complete and ready for implementation
240+
- Hook system is implemented in ObjectQL (beforeFind, afterInsert, etc.) — this is data-layer eventing, not workflow automation
241+
- Full workflow/automation engine will be provided by plugins
242+
- Protocols are complete and ready for plugin implementation
243+
- Discovery API reports automation service as `unavailable` until a plugin is registered
228244

229245
---
230246

231247
## Security Layer
232248

249+
<Callout type="warn">
250+
**Plugin-Provided Service** — The kernel does NOT handle authentication or authorization. Security services must be provided by plugins (e.g., `@objectstack/plugin-auth`). The Discovery API reports auth as `unavailable` until a plugin is registered.
251+
</Callout>
252+
233253
### Authentication
234254

235-
| Protocol | @objectstack/spec | Implementation | Status |
236-
|:---------|:-----------------:|:-------------:|:------:|
237-
| **Identity** ||| ❌ Spec only |
238-
| **Auth Config** ||| ❌ Spec only |
239-
| **Role** ||| ❌ Spec only |
240-
| **Organization** ||| ❌ Spec only |
241-
| **Policy** ||| ❌ Spec only |
242-
| **SCIM** ||| ❌ Spec only |
255+
| Protocol | @objectstack/spec | Kernel | Plugin Required | Status |
256+
|:---------|:-----------------:|:------:|:---------------:|:------:|
257+
| **Identity** ||| | 📋 Plugin |
258+
| **Auth Config** ||| | 📋 Plugin |
259+
| **Role** ||| | 📋 Plugin |
260+
| **Organization** ||| | 📋 Plugin |
261+
| **Policy** ||| | 📋 Plugin |
262+
| **SCIM** ||| | 📋 Plugin |
243263

244264
### Authorization
245265

246-
| Protocol | @objectstack/spec | Implementation | Status |
247-
|:---------|:-----------------:|:-------------:|:------:|
248-
| **Permission** ||| ❌ Spec only |
249-
| **Sharing** ||| ❌ Spec only |
250-
| **RLS** ||| ❌ Spec only |
251-
| **Territory** ||| ❌ Spec only |
266+
| Protocol | @objectstack/spec | Kernel | Plugin Required | Status |
267+
|:---------|:-----------------:|:------:|:---------------:|:------:|
268+
| **Permission** ||| | 📋 Plugin |
269+
| **Sharing** ||| | 📋 Plugin |
270+
| **RLS** ||| | 📋 Plugin |
271+
| **Territory** ||| | 📋 Plugin |
252272

253273
**Notes:**
254-
- Complete security protocols defined
255-
- Client SDK supports bearer token authentication
256-
- Fine-grained authorization not yet implemented
274+
- Complete security protocols defined in spec — ready for plugin implementation
275+
- Client SDK supports bearer token header — but token validation requires an auth plugin
276+
- Auth route (`/auth/*`) only appears in Discovery when an auth plugin is registered
277+
- Fine-grained authorization (RLS, sharing, territory) requires dedicated plugins
257278

258279
---
259280

@@ -360,17 +381,18 @@ This matrix is generated from actual codebase analysis and represents the curren
360381
- [ ] Dashboard Renderer
361382
- [ ] Theme Engine
362383

363-
### Phase 8: Automation 📋 **PLANNED**
364-
- [ ] Workflow Engine
365-
- [ ] Flow Builder
366-
- [ ] Approval Processes
367-
- [ ] ETL Pipelines
384+
### Phase 8: Automation (Plugin) 📋 **PLANNED**
385+
- [ ] Workflow Engine Plugin
386+
- [ ] Flow Builder Plugin
387+
- [ ] Approval Process Plugin
388+
- [ ] ETL Pipeline Plugin
389+
- [ ] Trigger Registry Plugin
368390

369-
### Phase 9: Security 📋 **PLANNED**
370-
- [ ] Authentication System
371-
- [ ] Authorization Engine
372-
- [ ] Row-Level Security
373-
- [ ] Multi-tenancy
391+
### Phase 9: Security (Plugin) 📋 **PLANNED**
392+
- [ ] Authentication Plugin
393+
- [ ] Authorization Plugin
394+
- [ ] Row-Level Security Plugin
395+
- [ ] Multi-tenancy Plugin
374396

375397
### Phase 10: AI Integration 📋 **PLANNED**
376398
- [ ] Agent Framework
@@ -390,9 +412,9 @@ This matrix is generated from actual codebase analysis and represents the curren
390412
| **UI** | 10 | 0 | 0 | 10 |
391413
| **API** | 14 | 11 | 1 | 2 |
392414
| **System** | 39 | 8 | 1 | 30 |
393-
| **Auth** | 6 | 0 | 0 | 6 |
394-
| **Permission** | 4 | 0 | 0 | 4 |
395-
| **Automation** | 7 | 1 | 0 | 6 |
415+
| **Auth** (plugin) | 6 | 0 | 0 | 6 |
416+
| **Permission** (plugin) | 4 | 0 | 0 | 4 |
417+
| **Automation** (plugin) | 7 | 1 | 0 | 6 |
396418
| **AI** | 12 | 0 | 0 | 12 |
397419
| **Integration** | 7 | 0 | 0 | 7 |
398420
| **QA** | 1 | 1 | 0 | 0 |
@@ -413,12 +435,12 @@ This matrix is generated from actual codebase analysis and represents the curren
413435
| **Query Engine** | ⚠️ | Partial (depends on driver) |
414436
| **REST API** || Yes |
415437
| **Client SDKs** || Yes |
416-
| **Metadata System** | | Yes |
438+
| **Metadata System** | ⚠️ | Partial (in-memory only, DB persistence pending) |
417439
| **HTTP Caching** || Yes |
418440
| **Testing Tools** || Yes |
419441
| **UI Rendering** || No |
420-
| **Workflows** || No |
421-
| **Security** || No |
442+
| **Workflows** || No (plugin required) |
443+
| **Security** || No (plugin required) |
422444
| **AI Features** || No |
423445

424446
---

0 commit comments

Comments
 (0)