Document filter property and improve audiences documentation #3424
+16
−6
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)Review & Testing Checklist for Human
#openapianchor in generators-yml-reference and#groupsanchor from openapi-specs/learn/sdks/guides/filter-your-endpoints-audiences/learn/docs/api-references/audiences/learn/api-definitions/openapi/extensions/audiences/learn/api-definitions/ferndef/audiencesfilterandaudiencesdocumentation render correctly on the generators.yml reference pageNotes
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