Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
devalog merged 2 commits into from
Jul 20, 2026
Merged

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
15246dc
docs: document OpenAPI spec auth-gating and path-based multi-API URLs
devin-ai-integration[bot] Jul 20, 2026
e8f98a4
condense info
devalog Jul 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions fern/products/docs/pages/developer-tools/openapi-spec.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,11 @@ Every Fern docs site exposes the OpenAPI specification at these paths:
| `/openapi.yaml` | YAML | `application/x-yaml` |
| `/openapi.yml` | YAML | `application/x-yaml` |

The spec includes all endpoints with request/response schemas, authentication schemes (Bearer, Basic, API Key, OAuth), webhooks, type definitions as component schemas, and server URLs from your environment configuration. The [`info.version`](/learn/api-definitions/openapi/extensions/api-version) field from your source spec is preserved as-is, including non-SemVer formats like CalVer. The spec is generated from the same API definition that powers your docs, so it's always up to date.
The spec includes your endpoints with request/response schemas, authentication schemes (Bearer, Basic, API Key, OAuth), webhooks, type definitions as component schemas, and server URLs from your environment configuration. The [`info.version`](/learn/api-definitions/openapi/extensions/api-version) field from your source spec is preserved as-is, including non-SemVer formats like CalVer. The spec is generated from the same API definition that powers your docs, so it's always up to date.

<Info>
Endpoints and API references marked `hidden: true` are excluded.
</Info>

## Usage

Expand All @@ -32,9 +36,14 @@ curl https://your-docs-site.com/openapi.json
curl https://your-docs-site.com/openapi.yaml
```

If your docs site includes multiple API definitions, the endpoint returns a listing of available APIs. Use the `api` query parameter to select a specific one:
If your docs site includes multiple API definitions, the endpoint returns a listing of available APIs. To select a specific one, use the path-based form, which serves the spec directly and is CDN-friendly:

```bash
# Get a specific API's spec
curl https://your-docs-site.com/openapi.json?api=my-api-id
curl https://your-docs-site.com/openapi/my-api-id.json
```

The `my-api-id` segment resolves against an API's slug, title, or UUID.

<Note>
If your docs site has password or SSO authentication configured, the spec endpoints inherit that authentication and return `401` to unauthenticated requests.
</Note>
Loading