docs: document omit option for basic auth username/password#5412
Open
devin-ai-integration[bot] wants to merge 7 commits intomainfrom
Open
docs: document omit option for basic auth username/password#5412devin-ai-integration[bot] wants to merge 7 commits intomainfrom
omit option for basic auth username/password#5412devin-ai-integration[bot] wants to merge 7 commits intomainfrom
Conversation
Co-Authored-By: Devin Logan <devinannlogan@gmail.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-devin-1778091767-document-basic-auth-omit.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
devalog
approved these changes
May 6, 2026
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
Documents the
omit: trueoption onusernameandpasswordfields in basic auth schemes. Settingomit: trueremoves the field from the generated SDK's public API and uses an empty string when encoding theAuthorizationheader (e.g., omittingpasswordproducesbase64("username:")). When both fields are omitted, theAuthorizationheader is skipped entirely.This option is supported across the major SDK generators (Python, TypeScript, Java, Go, C#, Ruby v2, PHP) — see fern-api/fern#14407 for the Python implementation; the same flags are wired through the IR (
usernameOmit/passwordOmit) for the other generators.Changes:
fern/products/sdks/snippets/basic-auth-params.mdx— addedusername.omit/password.omit<ParamField>(the canonicalauth-schemesreference, rendered on thegenerators.ymlreference page).fern/products/api-def/openapi/auth.mdx— one-liner under the Basic accordion to surface the option, with details deferred to the reference page that the section already links to.Review & Testing Checklist for Human
versions.yml).Notes
convertSecurityScheme.ts,SecuritySchemeConverter.ts) does not currently extractomitfromx-fern-basic; OpenAPI users wire this up viaauth-schemesingenerators.yml. Happy to file a follow-up to extend the parser if you wantx-fern-basic.username.omitto work.Link to Devin session: https://app.devin.ai/sessions/9a4b0d9b8abc45b79f97ee45e7e1f2e7
Requested by: @devalog