maruina / go-infrabin / 18807942439

56%

push

github

Enhance API documentation with OpenAPI spec generation (#406)

Add comprehensive protobuf documentation and auto-generated OpenAPI specification
to replace manually maintained endpoint documentation. This implements documentation
as code by using proto comments as the single source of truth.

Changes:
- Add detailed proto comments following protobuf style guide to infrabin.proto
- Enable OpenAPI v2 spec generation in Makefile with protoc-gen-openapiv2
- Implement /openapi.json HTTP endpoint to serve auto-generated spec
- Add openapi.swagger.json to .gitignore for generated artifacts
- Simplify README.md by replacing 200+ lines of manual endpoint docs with
  quick reference table and link to /openapi.json

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude <noreply@anthropic.com>

0 of 13 new or added lines in 2 files covered. (0.0%)

352 of 726 relevant lines covered (48.48%)

2.96 hits per line