feat(api-reference): show required permissions from x-epilot-permissions - #157
Merged
Merged
Conversation
Renders the x-epilot-permissions OpenAPI extension as a "Required permissions" note at the top of each operation in the API reference. Specs are still loaded at runtime from docs.api.epilot.io, then enriched before rendering; falls back to plain Redoc if loading fails. Co-Authored-By: Claude Opus 5.5 <[email protected]> Claude-Session: https://claude.ai/code/session_01C2A97XBNr735zXYDgBMs45
3 tasks
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
Implements the docs part of RFC: Required Permissions in API Specs. Operations that declare
x-epilot-permissionsin their OpenAPI spec now show a Required permissions note at the top of the operation in the API reference, linking to the Grant Actions page.→ Required permissions:
user:inviteand one ofrole:assignorrole:*.[]renders as "none – any authenticated caller".src/utils/openapi-permissions.ts: pure function that renders the extension into operation descriptions (Redoc ignores unknownx-extensions).RedocPage.tsx: still loads the spec at runtime fromdocs.api.epilot.io, so the reference stays live. It enriches the spec, then renders it. If loading fails, it falls back to plain Redoc. The download button still points to the original spec URL.grant-actions.md: short note on the extension.APIs without the extension render exactly as before. The companion Spectral rule is in https://gitlab.com/e-pilot/platform/epilot-ci/-/merge_requests/197.
Test plan
npm run buildpassesuser.yaml(x-epilot-permissionsadded toinviteUserandgetMeV2): the note renders with anyOf and empty-list variants🤖 Generated with Claude Code
https://claude.ai/code/session_01C2A97XBNr735zXYDgBMs45
Generated by Claude Code