Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
devin-ai-integration wants to merge 7 commits into
base: main
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c527c4a
docs: document omit option for basic auth credentials
devin-ai-integration[bot] May 6, 2026
105f0f6
docs: drop ferndef auth changes
devin-ai-integration[bot] May 6, 2026
c5636fc
docs: remove openapi auth omit example, rely on reference snippet
devin-ai-integration[bot] May 6, 2026
c8b5662
docs: surface omit option in openapi basic auth accordion
devin-ai-integration[bot] May 6, 2026
33a1b7b
add cross reference
devalog May 6, 2026
11b3b19
small clarity edit
devalog May 6, 2026
694b83f
link fix
devalog May 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions fern/products/api-def/openapi/auth.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,8 @@ auth-schemes:
env: MY_CLIENT_SECRET
```

[Set `omit: true` on `username` or `password`](/learn/sdks/reference/generators-yml#usernameomit-passwordomit) to remove it from the generated SDK.

</Accordion>
<Accordion title="API key">

Expand Down
3 changes: 3 additions & 0 deletions fern/products/sdks/snippets/basic-auth-params.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,7 @@ auth-schemes:
</ParamField>
<ParamField path="username.env, password.env" type="string" required={false}>
Environment variable name that the SDK will automatically scan for the username or password value. When this environment variable is present, users don't need to explicitly provide the username parameter. Follow naming conventions like `YOUR_APP_USERNAME` or `SERVICE_CLIENT_ID`.
</ParamField>
<ParamField path="username.omit, password.omit" type="boolean" default="false" toc={true}>
Use when your API expects only one half of the basic auth credential pair. When `true`, the field is removed from the generated SDK's public API. The omitted field is treated as an empty string when encoding the `Authorization` header (omitting `password` produces `base64("username:")`; omitting `username` produces `base64(":password")`). When both are omitted, the `Authorization` header is skipped entirely.
</ParamField>
Loading