Document filter property and improve audiences documentation#3424
Open
devin-ai-integration[bot] wants to merge 10 commits intomainfrom
Open
Document filter property and improve audiences documentation#3424devin-ai-integration[bot] wants to merge 10 commits intomainfrom
devin-ai-integration[bot] wants to merge 10 commits intomainfrom
Conversation
Co-Authored-By: Fern Support <info@buildwithfern.com>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Contributor
|
🌿 Preview your docs: https://fern-preview-041c4903-a053-4575-9940-403558f9085f.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
Co-Authored-By: Fern Support <info@buildwithfern.com>
Co-Authored-By: Fern Support <info@buildwithfern.com>
Co-Authored-By: Fern Support <info@buildwithfern.com>
Co-Authored-By: Fern Support <info@buildwithfern.com>
Co-Authored-By: Fern Support <info@buildwithfern.com>
…it-manager.devin.ai/proxy/github.com/fern-api/docs into devin/1769877468-document-filter-property
| - **`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. |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Adverbs] Remove 'naturally' if it's not important to the meaning of the statement.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Improves documentation for the
filterproperty andaudiencesproperty in the generators.yml reference. This addresses feedback that these filtering mechanisms were not adequately documented.Changes:
settings.filterexplaining it's used to limit which endpoints are included in the generated SDKsettings.filter.endpointsdescription to clarify the expected format (METHOD /path) and behavior (only listed endpoints are included, all others excluded)audiencesproperty description to explain how it filters API elements based on audience tags, and linked to the comprehensive guideUpdates since last revision
audiencesandfilterso users understand both filtering optionsaudiencesworks for both SDKs and docs (not just SDKs)filteras an alternative for path-based filteringReview & Testing Checklist for Human
#openapi,#audiences,#settingsfilterin generators-yml-reference/learn/sdks/deep-dives/audiences/learn/docs/api-references/audiences/learn/api-definitions/openapi/extensions/audiences/learn/api-definitions/ferndef/audiencesfilterandaudiencesdocumentation render correctlyNotes
Requested by Fern Support based on Slack thread where Josh Studt noted that
filterwas not documented in the generators.yml reference. Follow-up questions aboutaudiencesdocumentation and the relationship between the two filtering mechanisms led to the additional improvements.Link to Devin run: https://app.devin.ai/sessions/2576905507da480ba340d749ead72d7a