docs: document OpenAPI spec auth-gating and path-based multi-API URLs#6319
Merged
Conversation
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Contributor
|
🌿 Preview your docs: https://fern-preview-devin-1784560230-openapi-spec-auth-paths.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
devalog
approved these changes
Jul 20, 2026
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
Updates the Download OpenAPI spec page to cover three behaviors that were missing or inaccurate. All confirmed against fern-platform source (
packages/fern-docs/bundle/src/app/[domain]/(main)/api/fern-docs/openapi/route.ts)./openapi/<apiId>.json(also.yaml/.yml) as the recommended, CDN-friendly way to select a specific API alongside the existing?api=<id>query param. Notes that the<apiId>segment resolves by slug, title, or UUID, and briefly mentions the?title=<api title>param.401to unauthenticated requests; there is no separate public toggle.hidden: trueare excluded from the served spec.No changelog entry: this is a documentation-accuracy fix for existing behavior, not a new feature.
Source: Slack thread https://buildwithfern.slack.com/archives/C052DFWVCG6/p1784157608928309
Checks
pre-commit(vale) on the changed file: passed.fern check --warnings: 0 errors (warnings are preexisting and unrelated).Link to Devin session: https://app.devin.ai/sessions/e593e9c759f544a2a50462a6b464d59b