Skip to content

JSON is also valid YAML#267

Open
Hypfer wants to merge 1 commit into
Surnet:v7from
Hypfer:patch-1
Open

JSON is also valid YAML#267
Hypfer wants to merge 1 commit into
Surnet:v7from
Hypfer:patch-1

Conversation

@Hypfer

@Hypfer Hypfer commented May 5, 2021

Copy link
Copy Markdown

Since YAML is a superset of JSON, we can also accept json files here.

Since YAML is a superset of JSON, we can also accept json files here
@daniloab

Copy link
Copy Markdown
Collaborator

can you add tests to your pr?

@Hypfer

Hypfer commented Jun 1, 2021

Copy link
Copy Markdown
Author

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.

@stale

stale Bot commented Jul 31, 2021

Copy link
Copy Markdown

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.

@stale stale Bot added the wontfix label Jul 31, 2021
@Hypfer

Hypfer commented Jul 31, 2021

Copy link
Copy Markdown
Author

ping

@stale stale Bot removed the wontfix label Jul 31, 2021
@SimonKocurek

SimonKocurek commented Aug 5, 2021

Copy link
Copy Markdown

@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

@daniloab daniloab added the pinned Issues that will not be automatically closed label Oct 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pinned Issues that will not be automatically closed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants