-
Notifications
You must be signed in to change notification settings - Fork 230
JSON is also valid YAML #267
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Since YAML is a superset of JSON, we can also accept json files here
can you add tests to your pr?
Well that would essentially mean testing the YAML parser itself since that's just the spec.
See https://yaml.org/spec/1.2/spec.html#id2759572
YAML can therefore be viewed as a natural superset of JSON, offering improved human readability and a more complete information model. This is also the case in practice; every JSON file is also a valid YAML file. This makes it easy to migrate from JSON to YAML if/when the additional features are required.
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.
ping
@daniloab but tests are already loading files in JSON format: https://github.com/Surnet/swagger-jsdoc/blob/master/test/lib.spec.js#L208
EDIT: You could add test for .json format here to test your functionality: https://github.com/Surnet/swagger-jsdoc/blob/master/test/specification.spec.js#L106
Since YAML is a superset of JSON, we can also accept json files here.