Skip to content

docs: replace generic template README with spec-specific content#2

Open
t0kubetsu wants to merge 1 commit into
mainfrom
docs/readme-api-definitions
Open

docs: replace generic template README with spec-specific content#2
t0kubetsu wants to merge 1 commit into
mainfrom
docs/readme-api-definitions

Conversation

@t0kubetsu
Copy link
Copy Markdown

Closes #1

Summary

  • Removes the generic range42 platform overview copied across all repos
  • Adds a one-sentence description of what this repo actually contains
  • Adds a file inventory table (openapi.json / openapi.json.pretty)
  • Adds an API summary table: 80 endpoints grouped by route prefix with descriptions
  • Documents how to browse the spec via Swagger UI and use it for Kong bootstrap
  • Documents how to regenerate openapi.json from the backend-api app
  • Retains Contributing and License sections, fixes the "coming soon" reference

Test plan

  • Render README.md in GitHub and verify table formatting displays correctly
  • Confirm endpoint counts match current openapi.json (80 total)
  • Verify regeneration command works against the running backend-api

Rewrites the README to describe this repository specifically: what files
it contains, a summary of the 80 API endpoints grouped by route, how to
browse the spec via Swagger UI, how to use it for Kong bootstrap, and
how to regenerate the spec from the backend-api app.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: replace generic template README with OpenAPI spec usage documentation

1 participant