Enforce generated OpenAPI types as the source of truth for SDK and CLI APIs#1
Open
arawrdn wants to merge 1 commit into
Open
Enforce generated OpenAPI types as the source of truth for SDK and CLI APIs#1arawrdn wants to merge 1 commit into
arawrdn wants to merge 1 commit into
Conversation
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.
PR Description
This change formalizes the generated OpenAPI types as the single source of truth for all OpenSea v2 SDK and CLI endpoint work.
Performance and Reliability Impact
@opensea/api-typesdefinitions.src/generated.tsas a reproducible artifact generated directly from the OpenAPI spec.Required Development Flow
Before adding or modifying SDK/CLI endpoints:
Engineering Guidance
New endpoints should reuse
components["schemas"]or named exports frompackages/api-types/src/index.tsinstead of introducing parallel local types.CI enforcement should remain strict around
pnpm check-api-paths, ensuring SDK/CLI API-path changes are paired with regeneratedpackages/api-typesupdates whenever the OpenAPI spec changes.