Add Java SDK generator v5 migration guide - #7163
nerminamiller-postman wants to merge 3 commits into
Conversation
|
I'll fix CI failures and address comments from users with write access. I'll skip comments containing "(aside)".
|
|
🌿 Preview your docs: https://fern-preview-devin-1790634233-java-v5-migration-guide.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
- getType() returns String, not an enum, before and after; only the additional-properties-map behavior changed - removed 'Send frames require the discriminator' — no send-frame builder in Fern's generated output requires it; verified against generated output across three customers, not just one example Co-Authored-By: Claude <noreply@anthropic.com>
|
Pushed a correction to the WebSocket section, checked against Fern's real generated output (deepgram_bundled, basis_theory, bloomberg_sse_spec — 56 frame classes with a
Happy to share the generated SDKs I checked this against if useful. |
|
|
||
| ### Reconnection reports exhaustion | ||
|
|
||
| When the SDK runs out of reconnection attempts, it passes an `IllegalStateException` to your error handler instead of stopping silently. The same `maxRetries` value makes one more attempt than before. |
There was a problem hiding this comment.
📝 [vale] <FernStyles.Adverbs> reported by reviewdog 🐶
Remove 'silently' if it's not important to the meaning of the statement.
| When the SDK runs out of reconnection attempts, it passes an `IllegalStateException` to your error handler instead of stopping silently. The same `maxRetries` value makes one more attempt than before. | |
| When the SDK runs out of reconnection attempts, it passes an `IllegalStateException` to your error handler instead of stopping . The same `maxRetries` value makes one more attempt than before. |
|
Thanks for checking this against generated output. I looked over your commit (71d0ce8), and Vale and CI pass. I also updated the PR description: it no longer says |
Summary
Adds a hidden
generators/java/migration-v5.mdxpage (nav entryhidden: true) adapted from two internal SDKGEN Confluence guides: "Java Migration Guide" (synced to version 69) and "Java - WebSockets Migration Guide". Same pattern as the Go (#7154) and Swift (#7155) pages.generatorConfigPolicy.tsin the CLI.idiomatic-request-names: true). There's a new<Warning>to setpackage-prefixso the root package doesn't change (FSDK-2010).documentation/becomesreference.md, and there's an opt-ingenerateTests.Object,OptionalNullable→Optional, the OkHttp downgrade, and the socket client/handler renames. Also removed nested-type and merged-control-frame items, which aren't in the current guide.getType()staysStringbefore and after v5; the only change is thattypeis no longer duplicated into the additional-properties map..type(...).<Warning>.Reviewer checks:
validateResponses,idiomatic-request-names, andgenerateTestsare the user-facing config keys.getType()as an enum and send frames as requiringtype. Update it so later syncs don't bring those back.Link to Devin session: https://app.devin.ai/sessions/f35ec303b4df4315ae1ecfffa28c3295
Open in Devin Desktop: https://app.devin.ai/desktop/session/f35ec303b4df4315ae1ecfffa28c3295?variant=devin
Requested by: @nerminamiller-postman