Problem
The current README.md is a generic copy-paste template shared across range42 repos. It describes the entire range42 platform instead of this repository, contains vague repository content description, references "from the UI (coming soon)" (outdated), and provides no usage guidance.
Proposed change
Replace the generic README with spec-specific content covering:
- What this repo is (OpenAPI spec for CR42 backend API)
- File inventory (
openapi.json, openapi.json.pretty)
- API summary table (80 endpoints, grouped by route)
- How to browse via Swagger UI
- How to use for Kong gateway bootstrap
- How to regenerate the spec from the backend-api app
Tracked in branch docs/readme-api-definitions.
Problem
The current README.md is a generic copy-paste template shared across range42 repos. It describes the entire range42 platform instead of this repository, contains vague repository content description, references "from the UI (coming soon)" (outdated), and provides no usage guidance.
Proposed change
Replace the generic README with spec-specific content covering:
openapi.json,openapi.json.pretty)Tracked in branch
docs/readme-api-definitions.