feat(oas): add ref name to analyzer #918
Merged
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
reviewed
Dec 4, 2024
There was a problem hiding this comment.
i'll defer to @erunion for final sign off since this is squarely his wheelhouse but looks good to me!
| @@ -33,6 +33,7 @@ export interface OASAnalysis { | |||
| */ | |||
| raw_body?: OASAnalysisFeature; | |||
| 'x-default': OASAnalysisFeature; | |||
| 'x-readme-ref-name': OASAnalysisFeature; | |||
There was a problem hiding this comment.
mind adding a JS doc for this since this isn't a public extension?
There was a problem hiding this comment.
Done! Let me know if you would word it differently
erunion
reviewed
Dec 5, 2024
erunion
approved these changes
Dec 5, 2024
erunion
changed the title
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
Add a check to the analyzer if the definition previously had a reference in it. Once we dereference a file we add
x-readme-ref-nameas a way to keep track of the previous name. This surfaces if that extension exists in the definition being analyzed.🧬 QA & Testing
Tests should pass, and analyzer should have a new
x-readme-ref-namefield being returned.