docs: improve api.auth documentation with complete example #3188
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 the
generators.ymlreference documentation forapi.authto better explain how to specify a default security scheme across the API. Previously, the documentation only said "Authentication configuration for the API" with no details on usage.Changes:
auth-schemessection pointing users toapi.authfor applying schemes as the defaultapi.authParamField with a clear explanation of what it does and what values it acceptsReview & Testing Checklist for Human
api.auth(it should accept a string referencing a scheme name)#auth-schemesand#override-api-authentication-settingsNotes
Requested by: kenny
Devin session: https://app.devin.ai/sessions/30976867fe374d578a9933819c799d71