maruina / go-infrabin

48%

master: 56%

LAST BUILD ON BRANCH docs

branch: docs

CHANGE BRANCH

x

Reset

• docs
• admin-port
• changelog
• ct
• delay
• dependabot/go_modules/golang.org/x/net-0.36.0
• dependabot/go_modules/golang.org/x/net-0.38.0
• deps
• docker
• egress
• fix-build
• fix-deploy
• fix-gor
• fix-gr
• fix-release
• fix-renovate
• github-actions
• github-actions-coverage
• go-improve
• go1.23
• gor
• grpc-health
• headers
• kubeinfo
• logs
• maruina-patch-1
• master
• multi-arch-docker
• prom
• renovate/actions-checkout-4.x
• renovate/aws-sdk-go-v2-monorepo
• renovate/docker-build-push-action-5.x
• renovate/docker-build-push-action-6.x
• renovate/docker-login-action-3.x
• renovate/gcr.io-distroless-base-debian12
• renovate/github-actions
• renovate/github.com-grpc-ecosystem-grpc-gateway-v2-2.x
• renovate/github.com-onsi-gomega-1.x
• renovate/go-google.golang.org-protobuf-vulnerability
• renovate/go-module-dependencies
• renovate/golang-1.x
• renovate/golangci-golangci-lint-action-6.x
• renovate/golangci-lint-2.x
• renovate/google.golang.org-genproto-googleapis-api-digest
• renovate/google.golang.org-grpc-1.x
• renovate/google.golang.org-grpc-cmd-protoc-gen-go-grpc-1.x
• renovate/google.golang.org-protobuf-1.x
• renovate/goreleaser-goreleaser-action-5.x
• renovate/goreleaser-goreleaser-action-6.x
• renovate/helm-chart-releaser-action-1.x
• renovate/helm-chart-testing-action-2.x
• renovate/helm-kind-action-1.x
• renovate/major-github-actions
• renovate/migrate-config
• root-handler
• slim-docker
• struct
• v0.1.0
• v0.1.1
• v0.1.2
• v0.1.3
• v0.1.4
• v0.1.5

Build # 18807754945

Build Type

Pull #406

github

Committed by maruina

Commit Message

Enhance API documentation with OpenAPI spec generation

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>

Pull Request Pull Request #406: Enhance API documentation with OpenAPI spec generation

Run Details

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