docs(website): add /api/v2 skeleton (PR 1 scaffold) #46

Merged
whitlocktech merged 2 commits from docs/api-v2-skeleton into main 2026-07-22 21:57:22 +00:00
Member

Adds website/API_V2_SKELETON.md, the concrete scaffold for PR 1 in the v2 plan, and links it from API_V2_PLAN.md (which merged in #45). Docs-only; two-file diff (new skeleton doc + a one-line forward link in the plan).

What the skeleton covers

Stand up router/v2/ empty but wired next to a frozen /api/v1, with no behavior change:

  • Full router/v2/ file tree (domain-named capability routers + per-group index.js).
  • api.router.js / v2.router.js wiring, incl. a trivial GET /api/v2/version so the mount is testable before any real endpoint exists.
  • Empty capability-router stub shape (mounts cleanly, adds no routes — PR 2+ only adds handlers).
  • Acceptance criteria: server boots, /api/v2/version → 200, v1 untouched, tests green.
  • /internal deliberately stays off the public tree (unpublished port), same as v1.

Real endpoints, the auth merge, and Swagger regen are explicitly deferred to PR 2+.

Cross-links: the plan's PR-1 line now points here, and this doc points back to API_V2_PLAN.md for Phases 1/1b/2.


AI-assisted: authored with Claude (Claude Code). See the commit's Co-Authored-By trailer.

🤖 Generated with Claude Code

https://claude.ai/code/session_01NgyHnrNa8WwG3doxvxjuCr

Adds `website/API_V2_SKELETON.md`, the concrete scaffold for **PR 1** in the v2 plan, and links it from `API_V2_PLAN.md` (which merged in #45). Docs-only; two-file diff (new skeleton doc + a one-line forward link in the plan). ## What the skeleton covers Stand up `router/v2/` **empty but wired** next to a frozen `/api/v1`, with **no behavior change**: - Full `router/v2/` file tree (domain-named capability routers + per-group `index.js`). - `api.router.js` / `v2.router.js` wiring, incl. a trivial `GET /api/v2/version` so the mount is testable before any real endpoint exists. - Empty capability-router stub shape (mounts cleanly, adds no routes — PR 2+ only adds handlers). - Acceptance criteria: server boots, `/api/v2/version` → 200, v1 untouched, tests green. - `/internal` deliberately stays off the public tree (unpublished port), same as v1. Real endpoints, the auth merge, and Swagger regen are explicitly deferred to PR 2+. Cross-links: the plan's PR-1 line now points here, and this doc points back to `API_V2_PLAN.md` for Phases 1/1b/2. --- AI-assisted: authored with Claude (Claude Code). See the commit's `Co-Authored-By` trailer. 🤖 Generated with [Claude Code](https://claude.com/claude-code) https://claude.ai/code/session_01NgyHnrNa8WwG3doxvxjuCr
wtclaude added 1 commit 2026-07-22 21:55:53 +00:00
Companion doc to API_V2_PLAN.md describing PR 1: stand up router/v2/ empty but
wired next to a frozen /api/v1, with a trivial GET /api/v2/version to make the
mount testable and no behavior change. Includes the file tree, the api.router.js
/ v2.router.js wiring, empty capability-router stubs, and acceptance criteria.
Adds a forward link from the plan's PR-1 line to the skeleton doc.

Co-Authored-By: Claude <noreply@anthropic.com>
whitlocktech approved these changes 2026-07-22 21:57:04 +00:00
whitlocktech added 1 commit 2026-07-22 21:57:13 +00:00
whitlocktech merged commit 4810830c8a into main 2026-07-22 21:57:22 +00:00
whitlocktech deleted branch docs/api-v2-skeleton 2026-07-22 21:57:23 +00:00
Sign in to join this conversation.
No Reviewers
2 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: RunicGateway/docs#46
No description provided.