docs(openapi): guide + ADR-030 for authz-aware OpenAPI generation#53
Merged
Conversation
Document the pattern that generates an OpenAPI v3.1 contract reflecting Connectum proto authz, so the published spec cannot drift from what the runtime interceptor enforces. - en/guide/openapi.md: new guide — two-step generation (buf remote plugin base + authz overlay via resolveMethodAuth), the authz→OpenAPI mapping table, and limitations (streaming omitted, network dependency, internal marker = 1.1.0). - en/contributing/adr/030-openapi-authz-generation.md: rationale, the mapping, consequences, and alternatives (hand-written spec, framework CLI now, google.api.http only, protodocs) — all rejected/deferred with reasons. - Register the guide in the Operate sidebar group; add the ADR to the index; cross-link from the proto-authz guide. Ships as a reference pattern (car-sharing example, @connectum/auth 1.0.0); a first-class `connectum openapi` CLI command is a recorded follow-up. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01MdeH7fExPmiRHRirGuvGk3
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
1 participant
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.
What
Documents the pattern that generates an OpenAPI v3.1 contract reflecting Connectum proto authz, so the published spec cannot drift from what the runtime interceptor enforces. Companion to the
car-sharingexample PR.Changes
en/guide/openapi.md(new) — two-step generation (buf remote plugin base + authz overlay viaresolveMethodAuth), the authz→OpenAPI mapping table, and limitations (streaming RPCs get no operation, network dependency, theinternalmarker = 1.1.0). Registered in the Operate sidebar group.en/contributing/adr/030-openapi-authz-generation.md(new) — rationale, the mapping, consequences, and alternatives (hand-written spec, framework CLI now,google.api.httponly, protodocs) all rejected/deferred with reasons. Added to the ADR index.Notes
car-sharingexample on@connectum/auth1.0.0); a first-classconnectum openapiCLI command is a recorded follow-up.pnpm docs:build✓ (no dead links).proto-authz.mdis also touched by the still-open API/pages PR (docs: 1.1.0 API reference + auth/core/events package pages #52); the edit here is an isolated line in theRelatedsection, so the merge interaction is expected to be clean.🤖 Generated with Claude Code