docs: document optional-auth config flag for Python and TypeScript SDKs - #6450
Open
devin-ai-integration[bot] wants to merge 1 commit into
Open
docs: document optional-auth config flag for Python and TypeScript SDKs#6450devin-ai-integration[bot] wants to merge 1 commit into
devin-ai-integration[bot] wants to merge 1 commit into
Conversation
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.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-1785344977-optional-auth-config.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
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
The Python and TypeScript SDK generators gained an opt-in
optional-authconfig flag (fern-api/fern#16932). When the API spec mandates auth on every endpoint, generated clients today require a credential at construction time and fail without one. Some users authenticate through a different mechanism entirely (cloud provider credentials such as AWS Bedrock/SageMaker or OCI), so they are forced to pass dummy values. Withoptional-auth: true, the client can be built without credentials and simply omits the auth header; the defaultfalsekeeps existing behavior.Documents the flag as a new
<ParamField>in both generator configuration references, placed alphabetically alongside the other options:fern/products/sdks/generators/typescript/configuration.mdx—optional-authfern/products/sdks/generators/python/configuration.mdx—optional_auth, noting thatoptional-authandoptionalAuthare also accepted (the Python generator normalizes all three, and this page uses snake_case option names)No SDK changelog entries, per instructions.
fern check --warningsreports 0 errors; Vale flags only pre-existing lines.Link to Devin session: https://app.devin.ai/sessions/446a477726ed42f39a093c15c411339c