Improve ergonomics of the describeSchema() function used everywhere#132
Merged
Improve ergonomics of the describeSchema() function used everywhere#132
describeSchema() function used everywhere#132Conversation
... in addition to the existing:
- { schema: { id: string } }
- { schema: { yaml: string }
- { schema: JSONSchema }
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.
Recently-added tests do a whole bunch of schema-lookup using
describeSchema({ schema: { id }, pointer?: string }), which is overly verbose becausedescribeSchema()is very polymorphic to account for all the ways this function gets used in testing code and on the website.For now, I'm leaving it as "probably pretty useful" that this function is so polymorphic, but I wanted to simplify the syntax for simply obtaining a schema object for a particular ethdebug/format schema, so this PR just adds a new polymorphism,
describeSchema({ schema: string; })and treats that as equivalent toschema: { id: string }.