Skip to content

docs(sdks): document Java user-agent generator config#6185

Open
fern-api[bot] wants to merge 1 commit into
mainfrom
devin/1783683913-java-user-agent-config
Open

docs(sdks): document Java user-agent generator config#6185
fern-api[bot] wants to merge 1 commit into
mainfrom
devin/1783683913-java-user-agent-config

Conversation

@fern-api

@fern-api fern-api Bot commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Summary

Documents the user-agent generator config for the Java SDK on the Java configuration page, addressing a customer request (Twilio #22109) about customizing the generated User-Agent header.

Adds a user-agent <ParamField> covering:

  • What it does: sets a User-Agent header template resolved at generation time.
  • Supported placeholders: {packageName}, {version}, {language}, {generatorVersion}, {organization}, {apiName}.
  • Default when omitted: {packageName}/{version}.
  • A practical generators.yml example for the java-sdk group and the resulting header.

Also clarifies the existing omit-fern-headers field to note it omits User-Agent in addition to the X-Fern-* headers.

Verified against fern-api/fern (getUserAgentTemplateFromGeneratorConfig in packages/commons/api-workspace-commons/src/checkVersionExists.ts): user-agent is a CLI-consumed config key under config, not forwarded to generators.

@fern-api fern-api Bot requested a review from devalog as a code owner July 10, 2026 11:45
@github-actions

Copy link
Copy Markdown
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant