refactor(core): add sdk re-export convention for api types#257
Merged
harishsundar-okta merged 5 commits intomainfrom May 6, 2026
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #257 +/- ##
=======================================
Coverage 89.42% 89.42%
=======================================
Files 159 159
Lines 13325 13325
Branches 1435 1435
=======================================
Hits 11916 11916
Misses 1409 1409 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
…ctor/replace-custom-api-types-with-sdk-exports
rax7389
approved these changes
May 5, 2026
…nto refactor/replace-custom-api-types-with-sdk-exports
0bb7775 to
c127d2b
Compare
rax7389
approved these changes
May 6, 2026
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
Documents all intentionally custom API request/response types and adds an SDK re-export convention to prevent type drift when SDK packages are updated.
Why
Custom types that mirror SDK API request/response shapes were scattered across the codebase with no documentation explaining whether they were intentional or simply missing SDK re-exports. When SDK packages are updated, these custom types must be manually synced with no compiler error to flag drift. An audit of all ~38 custom API types confirmed they are either already SDK re-exports or intentionally custom (no SDK equivalent available), but this was not documented anywhere.
What
Packages
Testing
Please describe how this can be tested by reviewers. Be specific about anything not tested and reasons why. If this library has unit and tests should be added for new functionality and existing tests should complete without errors.
Checklist