docs: document user-agent template behavior with platform headers - #6487
Open
devin-ai-integration[bot] wants to merge 1 commit into
Open
docs: document user-agent template behavior with platform headers#6487devin-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-1785517757-user-agent-platform-headers.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
SDKs can send a custom
User-Agentbuilt from auser-agenttemplate ingenerators.yml, and they can also send a structuredUser-Agentcarrying OS, architecture, and runtime info when platform headers are enabled. Until recently, Python, TypeScript, and C# dropped the configured template when platform headers were on and fell back to the package name. That's now fixed, so customers who set a customUser-Agentfor attribution or analytics get their exact product token in every request regardless of platform headers, and server-side telemetry is consistent across languages.Implements docs for: fix(python, typescript, csharp): honor user-agent template with platform headers (fern-api/fern#17298)
Changes:
user-agentconfig option to the Python, TypeScript, and C# generator configuration references (previously only documented for Java), covering the placeholders and the resulting header.plantstore-python-sdk/0.1.0 (linux; x86_64) Python/3.11.0), and a resolved value whose trailing segment isn't a version (@plantstore/sdk) is used as-is with no version appended.includePlatformHeadersoption on each page to theuser-agentoption.Link to Devin session: https://app.devin.ai/sessions/384516bc2ebb49da81745c0a619bfcdf