Skip to content

Document filter property and improve audiences documentation#3424

Open
devin-ai-integration[bot] wants to merge 10 commits intomainfrom
devin/1769877468-document-filter-property
Open

Document filter property and improve audiences documentation#3424
devin-ai-integration[bot] wants to merge 10 commits intomainfrom
devin/1769877468-document-filter-property

Conversation

@devin-ai-integration
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Jan 31, 2026

Summary

Improves documentation for the filter property and audiences property in the generators.yml reference. This addresses feedback that these filtering mechanisms were not adequately documented.

Changes:

  • Added a ParamField for settings.filter explaining it's used to limit which endpoints are included in the generated SDK
  • Enhanced the settings.filter.endpoints description to clarify the expected format (METHOD /path) and behavior (only listed endpoints are included, all others excluded)
  • Expanded the audiences property description to explain how it filters API elements based on audience tags, and linked to the comprehensive guide

Updates since last revision

Review & Testing Checklist for Human

  • Verify anchor links work correctly: #openapi, #audiences, #settingsfilter in generators-yml-reference
  • Verify all guide links work:
    • /learn/sdks/deep-dives/audiences
    • /learn/docs/api-references/audiences
    • /learn/api-definitions/openapi/extensions/audiences
    • /learn/api-definitions/ferndef/audiences
  • Check the preview deployment to ensure both filter and audiences documentation render correctly
  • Verify the Tip boxes appear correctly on both audiences pages (SDKs and OpenAPI)

Notes

Requested by Fern Support based on Slack thread where Josh Studt noted that filter was not documented in the generators.yml reference. Follow-up questions about audiences documentation and the relationship between the two filtering mechanisms led to the additional improvements.

Link to Devin run: https://app.devin.ai/sessions/2576905507da480ba340d749ead72d7a

Co-Authored-By: Fern Support <info@buildwithfern.com>
@devin-ai-integration
Copy link
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 and CI monitoring

@github-actions
Copy link
Contributor

github-actions bot commented Jan 31, 2026

Co-Authored-By: Fern Support <info@buildwithfern.com>
@devin-ai-integration devin-ai-integration bot changed the title Document filter property in generators.yml reference Document filter property and improve audiences documentation Jan 31, 2026
- **`audiences` (tag-based filtering):** Tag specific endpoints, schemas, or properties with audience labels, then filter SDKs and Docs to those tags. Best for creating variants based on user types (public vs. beta, free vs. enterprise) or feature maturity, regardless of URL structure.

<AccordionGroup>
- **`settings.filter` (path-based filtering):** Filter entire URL paths or patterns. Best when your API organization naturally divides by URL (like `/v1/*` vs. `/v2/*`, or `/admin/*` vs. `/user/*`). See the [`settings.filter` reference](/learn/sdks/reference/generators-yml#openapi) for configuration details.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] reported by reviewdog 🐶
[FernStyles.Adverbs] Remove 'naturally' if it's not important to the meaning of the statement.

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