fix(oas): account for deep $ref pointers when reducing an API def
#926
Conversation
This file contains 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
kanadgupta
approved these changes
Jan 23, 2025
| } | ||
| } | ||
|
|
||
| console.logx = (obj: any) => { |
There was a problem hiding this comment.
this snuck in in a commit i made this morning where i added that skipped failing test. console.logx is a tool i use to dump full objects.
| if (!$refs.has(`#/components/${componentType}/${component}`)) { | ||
| // If our `$ref` either is a full, or deep match, then we should preserve it. | ||
| const refIsUsed = | ||
| $refs.has(`#/components/${componentType}/${component}`) || |
There was a problem hiding this comment.
(non-blocking) i feel like i've seen ref syntax that uses #components and not #/components — is that valid? should we account for that here?
There was a problem hiding this comment.
i have also seen that before but it is not valid. our parser doesn't pick up on it now, but should at some point.
There was a problem hiding this comment.
i had a note about this in one of my gitto PRs over the past two weeks but can't link those here.
julshotal
approved these changes
Jan 23, 2025
| @@ -39,6 +39,12 @@ function accumulateUsedRefs(schema: Record<string, unknown>, $refs: Set<string>, | |||
| } | |||
|
|
|||
| getUsedRefs($refSchema).forEach(({ value: currRef }) => { | |||
| // Because it's possible to have a parameter named `$ref`, which our lookup would pick up as a | |||
| // false positive, we want to exclude that from `$ref` matching as it's not really a reference. | |||
There was a problem hiding this comment.
of course you can do that 🙃
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.
🧰 Changes
This updates
oas/reducerto account for deep$refpointers like#/components/examples/event-min/value. Normally when we're running through components to remove we only look at#/components/examples/event-min, however when a schema like this is deeply referenced we won't pick up that it's used and end up removingevent-minfrom the components block, resulting in a corrupted schema that will no longer validate.