docs: fix instant API key response casing in examples - #2006
Open
Osraka wants to merge 1 commit into
Open
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
1 participant
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
apiKeywhen destructuringOpenSeaSDK.requestInstantApiKey()in the README and quick-start guide.api_keyunchanged in the rawcurlexamplesWhy
The SDK camelizes the endpoint response and its return type exposes
apiKey. The current TypeScript examples use the wire-formatapi_key, which fails withTS2339and leaves the constructor without the returned key.Validation
Property api_key does not existapiKeyversion type-checks against the built declarationsnpm run format:check -- README.md developerDocs/quick-start.mdnpm run lintnpm run check-typesnpm run buildnpm test(49 files, 1016 tests)