docs: document env and client-default on global headers#6403
Open
devin-ai-integration[bot] wants to merge 1 commit into
Open
docs: document env and client-default on global headers#6403devin-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-1784999233-global-header-client-default.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
A global header in a Fern API config (
generators.ymlor a Fern Definitionapi.yml) can now declare a runtime default value and an environment variable that supplies it. This means SDK users get sensible header defaults — an API version header, for example — without passing them on every call, and can override the value per environment with an env var. Every SDK language resolves the value the same way, so behavior no longer differs between TypeScript, Java, and the rest. The docs previously listed onlynameandtypeforgenerators.ymlheaders and never mentionedenvorclient-default, so this capability was invisible.Changed pages:
fern/products/sdks/reference/generators-yml-reference.mdx(most changed) — theapi.headersparam now lists all supported keys (name,type,env,client-default,default), clarifiesdefaultas documentation-only versusclient-defaultas the runtime SDK default, states the resolution order (explicit value >env>client-default) and that it's identical across TypeScript, Java, Python, Go, C#, Ruby, and PHP. The advanced example was also corrected to validapi.specs/api.headersstructure.fern/products/api-def/openapi/extensions/global-headers.mdx— thegenerators.ymlsection previously showed an invalidapi:list form and omittedenv/client-default; both fixed, with a pointer to the reference.fern/products/api-def/ferndef/api-yml/global-headers(ferndef/api-yml/global-configuration.mdx) — adds the object form of anapi.ymlglobal header withenvandclient-default, plus the resolution order.fern/products/sdks/deep-dives/configure-global-headers.mdx— the SDK-facing deep dive now shows theenv+client-defaultdeclaration and explains the precedence a caller sees.Validation:
pre-commit run --files <changed>(only pre-existing Vale suggestions remain) andfern check --warnings→ 0 errors.Link to Devin session: https://app.devin.ai/sessions/106856f134c9489c8b5b78689ef353b6