Skip to content

Add reference to Audiences for filtering API endpoints in API Reference docs #397

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
merged 3 commits into from
Aug 11, 2025
+3 −1
Merged

Add reference to Audiences for filtering API endpoints in API Reference docs #397

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a1a67ce
Added information about how to include only specific API endpoints
BipinRimal314 Aug 10, 2025
d9c7519
Added information about displaying specific API Endpoints
BipinRimal314 Aug 10, 2025
3fe9b09
expand audiences description in reference table
devalog Aug 11, 2025
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
4 changes: 3 additions & 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 @@ -20,7 +20,7 @@ navigation:
| ---------------- | ------------------------------------------------------------------------------------------------------- |
| `api` (required) | Title of the API Reference Section |
| `api-name` | Name of the API we are referencing, if there are [multiple APIs](#include-more-than-one-api-reference) |
| `audiences` | List of [audiences](/learn/api-definition/fern/audiences) to filter the API Reference for |
| `audiences` | List of [audiences](/docs/api-references/audiences) that determines which endpoints, schemas, and properties are displayed in your API Reference |
| `display-errors` | Displays error schemas in the API References |
| `snippets` | Enable [generated SDK code snippets](/learn/api-reference/snippets/get) in your API Reference |
| `summary` | Relative path to the Markdown file; the summary is displayed at the top of the API section |
Expand All @@ -44,3 +44,5 @@ navigation:
- api: Garden
api-name: garden-api
```