Repository navigation
Conversation
Currently, only "nouns" (more or less, i.e. the "models") are available in the published package.
The rest of the package's core public types are not available in the schemas: the operations
("verb"), their parameters, their results, and their options.
This PR adds the above.
The diff is big because I decided a single `schema.json` with top-level keys for `models` and
`verbs` was cleanest, so the whole current file moved "down" a level into `models`.
As far as I can tell, this vocabulary of "models" and "verbs" is consistent with the package's
current public API.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Important Draft PR not reviewedDraft PRs are not automatically reviewed by default.
To automatically review draft PRs, update your CodeRabbit configuration: reviews:
auto_review:
drafts: truePre-merge checks:
|
commit: |
Contributor
Bundle sizeBrowser entry bundles compared with the PR base. All sizes are in bytes. Lazy totals the minified chunks besides the entry, which load on demand or never.
Size changes are informational. Measured for |
This branch was successfully deployed
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.
🔗 Linked issue
N/A
🧭 Context
Currently, only "nouns" (more or less, i.e. the "models") are available in the published package.
The rest of the package's core public types are not available in the schemas: the operations ("verb"), their parameters, their results, and their options.
This PR adds the above.
The diff is big because I decided a single
schema.jsonwith top-level keys formodelsandverbswas cleanest, so the whole current file moved "down" a level intomodels.As far as I can tell, this vocabulary of "models" and "verbs" is consistent with the package's current public API.
Context: I ran into this while building a
forgeshttp proxy service. The package exports almost everything I need, but for verbs I needed to write like... 600 lines of disgusting code to re-generate these schemas from TS.BREAKING CHANGES
forges/schemanow contains a top-level keymodels, previously namedschemas.The representation of binary values in
forges/schemahas changed. Values are now boxed in a$bytestype:Potential breaking: A few fields were missing
Daterevivers. These are now included. (createdAfter,since, anduntil).🧪 Testing
Added unit tests
📚 Docs
Added to
forges/schemasAPI docs.