Skip to content

docs: clarify api-name is only for multiple APIs #3400

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
Feb 4, 2026
Merged

docs: clarify api-name is only for multiple APIs #3400

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
96ceb9a
docs: clarify api-name is only for multiple APIs
devin-ai-integration[bot] Jan 30, 2026
2772a38
style: use contraction per Vale style guide
devin-ai-integration[bot] Jan 30, 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
2 changes: 1 addition & 1 deletion fern/products/docs/pages/api-references/generate-api-ref.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Fern will automatically populate your endpoints, types, and code snippets from y
| Property | Value |
| ---------------- | ------------------------------------------------------------------------------------------------------- |
| `api` (required) | Title of the API Reference Section |
| `api-name` | Name of the API you're referencing, if there are [multiple APIs](#include-more-than-one-api-reference) |
| `api-name` | Name of the API you're referencing. Required when you have [multiple APIs](#include-more-than-one-api-reference), but can't be used with a single API. |
| `audiences` | List of [audiences](/docs/api-references/audiences) that determines which endpoints, schemas, and properties are displayed in your API Reference |
| `availability` | Set the [availability status](/learn/docs/api-references/customize-api-reference-layout#adding-availability) for the entire API Reference or specific sections |
| `display-errors` | Displays error schemas in the API References |
Expand Down