docs: add v6 migration guide for breaking changes in v6.0.0 - #1368
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1368 +/- ##
========================================
Coverage 89.72% 89.72%
========================================
Files 433 433
Lines 20115 20115
Branches 9426 9786 +360
========================================
Hits 18048 18048
Misses 2067 2067
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
harshithRai
approved these changes
Jul 10, 2026
fern-api Bot
added a commit
that referenced
this pull request
Jul 14, 2026
Patches applied (1): - patch-066ff9e0: docs: add v6 migration guide for breaking changes in v6.0.0 (#1368)
fern-api Bot
added a commit
that referenced
this pull request
Jul 15, 2026
Patches applied (1): - patch-066ff9e0: docs: add v6 migration guide for breaking changes in v6.0.0 (#1368)
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.
Changes
Adds a v6_MIGRATION_GUIDE.md to help consumers migrate from 5.x to 6.x. This is needed as v6.0.0 introduces breaking changes that were previously shipped in minor releases under v5.x.
Breaking changes documented:
ConnectionAttributeIdentifierremoved - replaced with three identifier-specific types (EmailAttributeIdentifier,PhoneAttributeIdentifier,UsernameAttributeIdentifier) to correctly type thedefault_methodfield per identifier. Before/after code examples included.PhoneProviderProtectionBackoffStrategyEnum.None: "none"→Default: "default"- reflects an API-side change confirmed in the api2 spec. Before/after code examples included.References
Testing
Documentation-only change, no code changes.
Checklist