feat: preserving ref schema names during dereferencing #481
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
Dashron
reviewed
Aug 16, 2021
| // dereferencing happens below those names will be preserved. | ||
| if (oas && oas.components && oas.components.schemas && typeof oas.components.schemas === 'object') { | ||
| Object.keys(oas.components.schemas).forEach(schemaName => { | ||
| oas.components.schemas[schemaName]['x-readme-ref-name'] = schemaName; |
There was a problem hiding this comment.
clean and simple, love it.
Dashron
approved these changes
Aug 16, 2021
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
With the work I did in #479, I accidentaly broke some functionality in our form generator where for an
anyOforoneOfschema we use the name of the component schema if there isn't atitlepresent. Since those schemas are no longer always present we need an alternative way to expose what the schema was called, and we're doing that now with thisx-readme-ref-nameextension.Pre-dereferencing we now run through all component schemas and note what their name is so that when we dereference that metadata will be preserved wherever that schema
$refis utilized.🧬 QA & Testing
See tests.