Skip to content

docs: document OpenAPI spec auth-gating and path-based multi-API URLs#6319

Merged
devalog merged 2 commits into
mainfrom
devin/1784560230-openapi-spec-auth-paths
Jul 20, 2026
Merged

docs: document OpenAPI spec auth-gating and path-based multi-API URLs#6319
devalog merged 2 commits into
mainfrom
devin/1784560230-openapi-spec-auth-paths

Conversation

@devin-ai-integration

Copy link
Copy Markdown
Contributor

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).

  • Path-based multi-API selection: documents /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.
  • Auth-gating: the spec endpoints inherit the site's password/SSO auth and return 401 to unauthenticated requests; there is no separate public toggle.
  • Hidden endpoints: corrected the "includes all endpoints" wording — endpoints and API references marked hidden: true are 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

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@devin-ai-integration
devin-ai-integration Bot requested a review from devalog as a code owner July 20, 2026 15:10
@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

@github-actions

Copy link
Copy Markdown
Contributor

@devalog
devalog merged commit f4c773c into main Jul 20, 2026
4 checks passed
@devalog
devalog deleted the devin/1784560230-openapi-spec-auth-paths branch July 20, 2026 18:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant