mirror of https://github.com/different-ai/openwork synced 2026-04-26 01:25:10 +02:00

Files

Source Open 87a543df69 fix(den): validate TypeIDs and refine OpenAPI docs (#1376 )

* fix(den): validate TypeIDs in API schemas

Use the shared TypeID utility in den-api request and response schemas so invalid IDs are rejected consistently and Swagger documents the expected prefixes. Keep the API docs aligned with the live validation rules used by the app.

* docs(den): refine OpenAPI route visibility

Hide internal and sensitive Den routes from Swagger so the published docs stay focused on public workflows. Clarify route tags and permission descriptions so ownership and workspace-admin requirements are easier to understand.

---------

Co-authored-by: src-opn <src-opn@users.noreply.github.com>

2026-04-06 17:38:20 -07:00

2.2 KiB

Raw Blame History

Den API

Hono-based Den control plane implementation (den-api, formerly den-controller).

This package is the active Den control plane implementation.

It carries the full migrated Den API route surface in a foldered Hono structure so agents can navigate one area at a time without scanning the whole service.

Quick start

pnpm --filter @openwork-ee/den-api dev:local

Current routes

GET / -> 302 https://openworklabs.com
GET /health
Better Auth mount at /api/auth/*
desktop handoff routes under /v1/auth/*
current user routes under /v1/me*
organization routes under /v1/orgs*
admin routes under /v1/admin*
worker lifecycle and billing routes under /v1/workers*

Folder map

src/routes/auth/: Better Auth mount + desktop handoff endpoints
src/routes/me/: current user and current user's org resolution routes
src/routes/org/: organization CRUD-ish surfaces, split by area
src/routes/admin/: admin-only reporting endpoints
src/routes/workers/: worker lifecycle, billing, runtime, and heartbeat endpoints
src/middleware/: reusable Hono middleware for auth context, org context, teams, and validation

Each major folder also has its own README.md so future agents can inspect one area in isolation.

TypeID validation

Shared Den TypeID validation lives in ee/packages/utils/src/typeid.ts.
Use typeId.schema("...") or the compatibility helpers like normalizeDenTypeId("...", value) when an endpoint accepts or returns a Den TypeID.
ee/apps/den-api/src/openapi.ts exposes denTypeIdSchema(...) so path params, request bodies, and response fields all share the same validation rules and Swagger examples.
Swagger now documents Den IDs with their required prefix and fixed 26-character TypeID suffix, so invalid IDs fail request validation before route logic runs.

Migration approach

Keep den-api (formerly den-controller) as the source of truth for Den control-plane behavior.
Add endpoints in focused Hono route groups one surface at a time.
Reuse shared middleware and Zod validators instead of duplicating request/session/org plumbing.
Leave a short README in each route area when the structure changes so later agents can recover context fast.

2.2 KiB Raw Blame History