This repository has been archived by the owner on Nov 15, 2023. It is now read-only.
Add the ability to remove the bits of JSON Schema that Swagger doesn't support #7
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
…t support If you're already working with JSON Schema validation tools, then this functionality makes using Swagger for documentation easier
|
Thanks for the PR. I'm currently working on a plug-in model for Swagger Parser (and, by extension, Swagger CLI), and I think this is a perfect example of something that would make a great plug-in. So, I'll leave this PR open for now, and once I have all the plug-in stuff in place, you or I can refactor this to be a plug-in. |
allonzy
approved these changes
Feb 21, 2022
|
It's been so long I forgot this PR existed. Um. I assume what I wrote 5.5 years ago isn't fully compatible with what's here. Let me know if it's even worthwhile to adapt my new flag to what's here (or the plugin system if that ever came to be) |
|
Nah, don't bother we migrated to redocly |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
I ran into a case where I needed to support JSON Schema files for validating an API (that contained code I didn't control) and creating documentation in Swagger.
So I created 'swagger bundle -j' which bundles swagger files and removes JSON Schema bits that Swagger refuses to understand ('id', '$schema'). Doing this allows me to maintain one set of files for two separate sets of tools
If you think this would be useful to others, feel free to merge. This is my first PR, so if you see anything that looks wrong/off, let me know. This comes with a test case, but I was having trouble running all tests on my Windows machine. I assume this works better on your box.