Document role-scoped OpenAPI spec downloads on RBAC-gated docs sites - #7216
Open
fern-api[bot] wants to merge 3 commits into
Open
fern-api[bot] wants to merge 3 commits into
fern-api[bot] wants to merge 3 commits into
Conversation
fern-api
Bot
requested review from
jkonrath-postman and
nerminamiller-postman
as code owners
October 1, 2026 19:36
Contributor
|
🌿 Preview your docs: https://fern-preview-2026-10-01-fern-ai-1fb7a4-30109a6f.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
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
On docs sites that use authentication with role-based access control, the downloadable OpenAPI/AsyncAPI spec endpoints now return specs scoped to the signed-in viewer's roles. A viewer gets only the APIs and endpoints their roles can see, and APIs outside their roles return
404. Before this change, any signed-in viewer could download a spec containing endpoints their role couldn't see, so gated content could leak through the spec download.Implements docs for: feat(docs): 404 guessed spec URLs and serve role-scoped specs on gated sites (fern-api/fern-platform#15393)
Changed pages
fern/products/docs/pages/developer-tools/openapi-spec.mdx: added a sentence to the existing authentication<Note>stating that RBAC sites serve role-scoped specs (only permitted APIs and endpoints) and return404for APIs outside the viewer's roles, linking to the RBAC page. The existing401statement for unauthenticated requests is unchanged.The bot's original draft also mentioned a fallback to request-time generation above four role-requirement combinations. That's an internal implementation detail with no customer-visible effect, so it was removed.
Link to Devin session: https://app.devin.ai/sessions/e8a2323b525848d0a3b54a7f7037a419
Open in Devin Desktop: https://app.devin.ai/desktop/session/e8a2323b525848d0a3b54a7f7037a419?variant=devin