Repository navigation
Generate clients under gen and add OpenAPI spec - #4
Merged
Merged
Conversation
added 2 commits
November 6, 2026 20:43
Generate a merged OpenAPI 2.0 document from the proto HTTP annotations and add a client package that wraps the generated gRPC stubs and HTTP/JSON gateway. The new clients provide mTLS helpers, request-ID propagation, typed methods for every volume and admin RPC, and grpc-gateway error mapping.
Replace the hand-written client package with a protoc plugin that emits gen/client/client.gen.go from the proto google.api.http annotations. The generated client keeps the typed gRPC and HTTP APIs, mTLS helpers, request-ID propagation, and error mapping, while making gen/client reproducible through make proto.
msdmazvoid
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds generated clients and an OpenAPI document for the kouja agent API, all under
gen/.protoc-gen-kouja-client, a small protoc plugin that generatesgen/client/client.gen.gofrom the protogoogle.api.httpannotations.VolumeServiceandAdminServiceRPC.LoadTLSConfig,NewGRPCFromFiles,NewHTTPFromFiles) and request-ID propagation across both transports.*client.ErrorwithGRPCStatus()sostatus.Codeworks for both transports.gen/openapi/openapi.swagger.json(OpenAPI 2.0) viaprotoc-gen-openapiv2and adds the pinned tool tomake tools.proto/openapi.yamlfor the generated document title, version, description, and HTTPS scheme.docs/clients.mdand a short README section.Generation
make protonow emits:gen/kouja/v1/*— protobuf, gRPC stubs, and grpc-gatewaygen/client/client.gen.go— typed gRPC + HTTP clientgen/openapi/openapi.swagger.json— OpenAPI 2.0 documentValidation
go build ./...go vet ./...go test -tags=unit ./...golangci-lint runmake proto(idempotent; no diff in generated output)gen/client/gateway_test.go