docs: improve api.auth documentation with complete examples #3188
Conversation
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
- Expand api.auth ParamField to explain what it does and what values it accepts - Add complete example showing the two-step workflow: define scheme, then apply it - Add Note in auth-schemes section pointing users to api.auth - Include SDK usage example showing the result Co-Authored-By: kenny@buildwithfern.com <kenny@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
- Add Note at top of page pointing users to generators.yml for setting default auth - Rename 'Override security scheme' to 'Set default authentication in generators.yml' - Add complete two-step example showing how to define and apply auth schemes - Include SDK usage example showing the result - Add cross-references to generators.yml reference for full details Co-Authored-By: kenny@buildwithfern.com <kenny@buildwithfern.com>
devin-ai-integration
bot
changed the title
Contributor
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| ### Multiple auth schemes | ||
|
|
||
| You can configure endpoints to support multiple authentication schemes or combinations of schemes. In the `security` section, multiple security requirement objects (top-level list items) are treated as OR options, while multiple schemes within a single object are combined with AND. | ||
| Configure endpoints to support multiple authentication schemes or combinations. In the `security` section, multiple top-level items are OR options, while schemes within a single item are combined with AND. |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Acronyms] 'AND' has no definition.
devalog
approved these changes
Feb 4, 2026
kennyderek
approved these changes
Feb 4, 2026
- Update OpenAPI auth page intro to clarify auth applies across all Fern products - Update API Explorer page to mention generators.yml auth configuration - Add cross-references between pages Co-Authored-By: kenny@buildwithfern.com <kenny@buildwithfern.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
api.authto better explain how to specify a default security scheme across the API. Previously, the documentation was sparse and didn't clearly connect where you define authentication schemes (auth-schemes) with where you apply them (api.auth).Changes to generators.yml reference:
auth-schemessection pointing users toapi.authfor applying schemes as the defaultapi.authParamField with a clear explanation of what it does and what values it acceptsChanges to OpenAPI auth page:
Changes to API Explorer page:
generators.ymlReview & Testing Checklist for Human
api.auth(it should accept a string referencing a scheme name)#auth-schemesand#authon the generators.yml reference page#multiple-authentication-schemeswas renamed to#multiple-auth-schemes- check if any external pages link to the old anchor#override-api-authentication-settingswas renamed - check if any other pages link to this and need redirects/learn/sdks/reference/generators-yml#auth/learn/api-definitions/openapi/auth/learn/docs/api-references/api-explorerNotes
Requested by: kenny
Devin session: https://app.devin.ai/sessions/30976867fe374d578a9933819c799d71