feat: introduce sdk-types from developer portal #4154
Closed
Conversation
This file contains 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
mmcshinsky-bitgo
force-pushed
the
PX-000000/mmcshinsky-use-developer-portal-types
branch
from
085f899 to
44c216e
Compare
OttoAllmendinger
approved these changes
Dec 14, 2023
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.
Experimental proposal to use the openapi spec from https://developers.bitgo.com as a source of truth for types. Much of the SDK interacts with the API layer but miss out on consistent and non-manually written types. Using the published API can also help reduce a lot of the
anytypes as well of which users have regularly complained about in the past.Since the developer portal is the central spec system published for requests and responses,
@bitgo/sdk-typesor@bitgo/sdk-openapican be published alongside as needed@bitgo/public-types.Included is a small example usage of what it would or could look like to replace manual types inside a module.
Open to probably a lot of feedback on peoples thoughts around this.
PX-000000
TICKET: PX-000000