Skip to content

docs: document omit option for basic auth username/password#5412

Open
devin-ai-integration[bot] wants to merge 7 commits intomainfrom
devin/1778091767-document-basic-auth-omit
Open

docs: document omit option for basic auth username/password#5412
devin-ai-integration[bot] wants to merge 7 commits intomainfrom
devin/1778091767-document-basic-auth-omit

Conversation

@devin-ai-integration
Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot commented May 6, 2026

Summary

Documents the omit: true option on username and password fields in basic auth schemes. Setting omit: true removes the field from the generated SDK's public API and uses an empty string when encoding the Authorization header (e.g., omitting password produces base64("username:")). When both fields are omitted, the Authorization header 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 — added username.omit / password.omit <ParamField> (the canonical auth-schemes reference, rendered on the generators.yml reference 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

Notes

  • No SDK changelog entry needed — per the docs repo knowledge, SDK changelog entries are handled separately.
  • The OpenAPI parser (convertSecurityScheme.ts, SecuritySchemeConverter.ts) does not currently extract omit from x-fern-basic; OpenAPI users wire this up via auth-schemes in generators.yml. Happy to file a follow-up to extend the parser if you want x-fern-basic.username.omit to work.

Link to Devin session: https://app.devin.ai/sessions/9a4b0d9b8abc45b79f97ee45e7e1f2e7
Requested by: @devalog

Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
@devin-ai-integration
Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 6, 2026

devin-ai-integration Bot and others added 5 commits May 6, 2026 18:36
Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant