docs: document opt-in appInfo User-Agent option for TypeScript and Python SDKs - #6498
Open
devin-ai-integration[bot] wants to merge 1 commit into
Open
docs: document opt-in appInfo User-Agent option for TypeScript and Python SDKs#6498devin-ai-integration[bot] wants to merge 1 commit into
devin-ai-integration[bot] wants to merge 1 commit into
Conversation
…thon SDKs 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-1785604118-user-agent-app-info.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
Documents a new opt-in generator flag that lets an application built on top of a Fern SDK identify itself in the
User-Agentheader. When the flag is on, generated clients accept an app/product identifier (name, optional version, optional comment) whose token is appended to the User-Agent the SDK already sends. Partner platforms and integrators that redistribute or embed an SDK can attribute their traffic for support, analytics, and rate-limit attribution without forking generated code, and API owners can see which integration is calling them. The flag defaults tofalse, so generated output is unchanged until a user opts in.Implements docs for: feat(typescript): add opt-in appInfo client option appended to User-Agent (fern-api/fern#17290) and feat(python): add opt-in appInfo client option appended to User-Agent (fern-api/fern#17302)
Changes
fern/products/sdks/generators/typescript/configuration.mdx: newallowUserAgentAppInfoentry (defaultfalse) next toincludePlatformHeaders, with theappInfo: { name, version?, comment? }client option, the{name}/{version} ({comment})token format, and an example resulting header.fern/products/sdks/generators/python/configuration.mdx: newallow_user_agent_app_infoentry (defaultfalse, camelCase aliasallowUserAgentAppInfo) documenting theapp_infoconstructor argument, its composition withinclude_platform_headersandruntime_version, and suppression byomit_fern_headers.Both entries note that values are sanitized, an explicit
User-Agentstill takes precedence, and the header is unchanged when no app info is supplied. Only TypeScript and Python are documented — no other language pages were touched. No SDK changelog entries added.pre-commit run --files <changed files>passes with no new Vale findings, andfern check --warningsreports 0 errors.Link to Devin session: https://app.devin.ai/sessions/f8458cd5eb674d5c8fac324fdef72b3a