From c4ae7a0fa6bee2e57265a65ec18d63f1478ffb7a Mon Sep 17 00:00:00 2001 From: Markus Graf Date: Thu, 16 Oct 2025 13:47:40 +0200 Subject: [PATCH] Rename API contracts to web routes for clarity MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Changed terminology from "API" to "Routes" to better reflect server-rendered HTML approach: - Renamed submission_api.md → submission_routes.md - Renamed dashboard_api.md → dashboard_routes.md - Renamed admin_api.md → admin_routes.md - Updated headers to clarify "Response Type: Server-rendered HTML (no JavaScript required)" - Updated references in plan.md and quickstart.md This clarifies that the application uses traditional web routes with form submissions and HTML responses, not REST API endpoints with JSON. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude --- .../contracts/{admin_api.md => admin_routes.md} | 5 +++-- .../contracts/{dashboard_api.md => dashboard_routes.md} | 5 +++-- .../contracts/{submission_api.md => submission_routes.md} | 5 +++-- specs/001-build-an-application/plan.md | 2 +- specs/001-build-an-application/quickstart.md | 2 +- 5 files changed, 11 insertions(+), 8 deletions(-) rename specs/001-build-an-application/contracts/{admin_api.md => admin_routes.md} (98%) rename specs/001-build-an-application/contracts/{dashboard_api.md => dashboard_routes.md} (98%) rename specs/001-build-an-application/contracts/{submission_api.md => submission_routes.md} (96%) diff --git a/specs/001-build-an-application/contracts/admin_api.md b/specs/001-build-an-application/contracts/admin_routes.md similarity index 98% rename from specs/001-build-an-application/contracts/admin_api.md rename to specs/001-build-an-application/contracts/admin_routes.md index 7429f96..b9782ab 100644 --- a/specs/001-build-an-application/contracts/admin_api.md +++ b/specs/001-build-an-application/contracts/admin_routes.md @@ -1,7 +1,8 @@ -# Admin API Contract +# Admin Routes Contract -**Scope**: Product and user management endpoints (User Story P4) +**Scope**: Product and user management web routes (User Story P4) **Authentication**: Required (admin role only) +**Response Type**: Server-rendered HTML (no JavaScript required) --- diff --git a/specs/001-build-an-application/contracts/dashboard_api.md b/specs/001-build-an-application/contracts/dashboard_routes.md similarity index 98% rename from specs/001-build-an-application/contracts/dashboard_api.md rename to specs/001-build-an-application/contracts/dashboard_routes.md index 5bde73d..488fba9 100644 --- a/specs/001-build-an-application/contracts/dashboard_api.md +++ b/specs/001-build-an-application/contracts/dashboard_routes.md @@ -1,7 +1,8 @@ -# Dashboard API Contract +# Dashboard Routes Contract -**Scope**: Product owner dashboard endpoints (User Story P3) +**Scope**: Product owner dashboard web routes (User Story P3) **Authentication**: Required (session-based via Flask-Login) +**Response Type**: Server-rendered HTML (no JavaScript required) --- diff --git a/specs/001-build-an-application/contracts/submission_api.md b/specs/001-build-an-application/contracts/submission_routes.md similarity index 96% rename from specs/001-build-an-application/contracts/submission_api.md rename to specs/001-build-an-application/contracts/submission_routes.md index 903002d..3e5bbf7 100644 --- a/specs/001-build-an-application/contracts/submission_api.md +++ b/specs/001-build-an-application/contracts/submission_routes.md @@ -1,7 +1,8 @@ -# Submission API Contract +# Submission Routes Contract -**Scope**: Anonymous feedback submission endpoints (User Story P1) +**Scope**: Anonymous feedback submission web routes (User Story P1) **Authentication**: None (anonymous access) +**Response Type**: Server-rendered HTML (no JavaScript required) --- diff --git a/specs/001-build-an-application/plan.md b/specs/001-build-an-application/plan.md index 74ab63e..69e42bf 100644 --- a/specs/001-build-an-application/plan.md +++ b/specs/001-build-an-application/plan.md @@ -177,7 +177,7 @@ Data model and API contracts support independent implementation of P1→P2→P3 Generated artifacts: - ✅ research.md (7 decision records) - ✅ data-model.md (6 entities fully specified) -- ✅ contracts/ (3 API contract documents: submission, dashboard, admin) +- ✅ contracts/ (3 web route contracts: submission, dashboard, admin) - ✅ quickstart.md (developer onboarding guide) - ✅ CLAUDE.md (agent context updated) diff --git a/specs/001-build-an-application/quickstart.md b/specs/001-build-an-application/quickstart.md index 0f68f7b..13eda52 100644 --- a/specs/001-build-an-application/quickstart.md +++ b/specs/001-build-an-application/quickstart.md @@ -270,7 +270,7 @@ pytest --cov=app --cov-report=html --- -## API Endpoints Reference +## Web Routes Reference ### Anonymous Submission - `GET /submit/{product_slug}` - Submission form