fix(types): improve PatchOperation specificity#60
Open
tris203 wants to merge 1 commit into
Open
Conversation
Generate PatchOperation as a discriminated union from the Manage OpenAPI schema so add and replace operations require a value while remove may omit it. Alias the public ManageAPI PatchOperation export to the generated schema type to keep a single source of truth, and add type tests for the accepted and rejected operation shapes.
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.
Changes
Why
The previous PatchOperation type allowed overly broad or inaccurate shapes, including unconstrained op values and optional/incorrectly typed fields. This change makes the public API safer and better aligned with expected patch semantics.