Skip to content

Commit b9852cd

Browse files
nshkiCopilot
andcommitted
docs(hub): keep mock contracts separate from real index routes
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 88d7ad2d-de3c-4d5a-95fc-ced290856050
1 parent 322f24f commit b9852cd

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

‎hub/docs/frontend.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -180,15 +180,13 @@ The shared JSON client awaits mock startup before sending any API request. It fo
180180

181181
Unsupported actions show a visible failure without requiring development controls. Credential and file submissions remain unprocessed; their technical diagnostics stay in the test toolbar.
182182

183-
The session and read-only index rows below describe implemented Express endpoints. The other product paths are mock contracts under [the application contracts](../client/application/hub/contracts/index.ts), not Prisma models or implemented Express endpoints. Repository and prototype identifiers are strings that accept UUIDs or positive whole numbers, so the server can issue UUIDs while mocks keep their numeric values. Template and share identifiers accept URL-safe opaque values rather than requiring the mock generator's format. Build commits accept full SHA-1 or SHA-256 object names. Coordinate real identifiers and contracts with backend work.
183+
These are frontend/mock contracts under [the application contracts](../client/application/hub/contracts/index.ts), not Prisma models or already-implemented Express endpoints. Repository and prototype identifiers are strings that accept UUIDs or positive whole numbers, so the server can issue UUIDs while mocks keep their numeric values. Template and share identifiers accept URL-safe opaque values rather than requiring the mock generator's format. Build commits accept full SHA-1 or SHA-256 object names. Coordinate real identifiers and contracts with backend work.
184184

185185
| HTTP interface | Result |
186186
| --- | --- |
187-
| `GET /api/auth/session` | Current real Hub session and role |
188-
| `POST /api/auth/session/sign-out` | End the current real Hub session |
189-
| Mock `GET /api/session` | Simulated viewer and capabilities |
190-
| `GET /api/workspace` | Real viewer and non-removed repositories |
191-
| `GET /api/repositories/:repositoryId` | First 24 eligible prototypes; search, filters, pagination, and Build status are not connected |
187+
| `GET`, `POST`, `DELETE /api/session` | Viewer and capabilities; no mock profile or revision metadata |
188+
| `GET /api/workspace` | Viewer and repository navigation |
189+
| `GET /api/repositories/:repositoryId` | Filtered, paginated prototypes and repository authors |
192190
| `GET /api/repositories/:repositoryId/authors` | Searchable author choices with a cursor |
193191
| `GET /api/repositories/:repositoryId/prototypes/:prototypeId` | Prototype, build options, and selected preview |
194192
| `GET /api/repositories/:repositoryId/prototypes/:prototypeId/builds` | Paginated build history |
@@ -204,6 +202,8 @@ The session and read-only index rows below describe implemented Express endpoint
204202
| `GET /api/settings/workspace`, `/api/settings/public`, `/api/settings/admin-candidates` | Settings records and synthetic page capabilities |
205203
| `POST /api/settings/actions` | Explicitly named local actions; administrator role changes return 501 without changing state |
206204

205+
In real mode, Express implements `GET /api/workspace` and `GET /api/repositories/:repositoryId`. The workspace lists the viewer and non-removed repositories. The repository index returns the first 24 eligible prototypes; search, filters, pagination, and Build status are not connected yet. The [authentication guide](authentication.md) owns the real session routes.
206+
207207
Real administrator management does not use the provisional settings contracts:
208208

209209
| HTTP interface | Result |

0 commit comments

Comments
 (0)