Skip to content

docs: document runtime-version config for Python and Java SDK generators #6452

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
devalog merged 3 commits into from
Jul 30, 2026
Merged

docs: document runtime-version config for Python and Java SDK generators #6452

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8e91dbf
docs: document runtime-version config for Python and Java SDK generators
devin-ai-integration[bot] Jul 29, 2026
71627df
docs: drop tool name flagged by vale
devin-ai-integration[bot] Jul 29, 2026
e15e110
wording update
devalog Jul 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions fern/products/sdks/generators/java/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,10 @@ config:
Publish target for Maven packages. Use `central` for Maven Central Portal or `ossrh` for legacy Nexus Repository.
</ParamField>

<ParamField path="runtime-version" type="boolean" default="false" required={false} toc={true}>
When enabled, the generated SDK resolves the version it reports in the `X-Fern-SDK-Version` header and the `User-Agent` version segment at runtime from the jar manifest, instead of the version baked in at generation time. The generated `build.gradle` records the project version in the manifest, and the generation-time version is used as a fallback when the manifest attribute is absent. Enable this when external release tooling (such as `release-please`) determines the published version after generation, so the reported version always matches the published artifact.

@github-actions github-actions Bot Jul 29, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[FernStyles.Please] Avoid using 'please' in technical documentation.

</ParamField>

<ParamField path="use-local-date-for-dates" type="boolean" default="false" required={false} toc={true}>
When enabled, generates `java.time.LocalDate` instead of `String` for Fern date types. This provides better type safety and enables compile-time validation for date values, while maintaining the same string wire format for API communication.
</ParamField>
Expand Down
4 changes: 4 additions & 0 deletions fern/products/sdks/generators/python/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,10 @@ Allow specifying arbitrary configuration to your packages `pyproject.toml` by ad
```
</ParamField>

<ParamField path="runtime_version" type="bool" default="false" required={false} toc={true}>
When enabled, the generated SDK resolves the version it reports in the `X-Fern-SDK-Version` header and the `User-Agent` version segment at runtime with `importlib.metadata.version()`, instead of the version baked in at generation time. Enable this when external release tooling (such as `release-please`) determines the published version after generation, so the reported version always matches the installed package. The generation-time version is used as a fallback when the distribution isn't installed.

@github-actions github-actions Bot Jul 29, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[FernStyles.Please] Avoid using 'please' in technical documentation.

</ParamField>

<ParamField path="should_generate_websocket_clients" type="bool" default="false" required={false} toc={true}>
Enable generation of Python [WebSocket clients](/learn/sdks/deep-dives/websocket-clients).
</ParamField>
Expand Down
Loading