booknds / sge

A simple grahical editor to create Swagger definitions.
MIT License
6 stars 4 forks source link

Validate 2.0 JSON samples from OpenAPIs GitHub project #36

Open ckriley opened 8 years ago

ckriley commented 8 years ago

Track the examples from OpenAPIs project and confirm they successfully load into Booknds.

https://github.com/OAI/OpenAPI-Specification/tree/master/examples/v2.0/json

ckriley commented 8 years ago

Performing load and save testing on Booknds. Comparing saved file with input file from OpenAPIs project.

For example:

petstore.json -> booknds_petstore.json

Examination of files / comparisons identifies an issue with lack of support of Arrays in 0.5 of Booknds SGE. 0.6 Beta includes support for Arrays so will test in this release to confirm.

Example below shows the difference in Definitions for instance:

booknds_petstore.json "Pets": { "title": "Pets", "type": "array" }

petstore.json "Pets": { "type": "array", "items": { "$ref": "#/definitions/Pet" } }

ckriley commented 8 years ago

Confirmed for the example described above, booknds_0.6_petstore.json supports arrays properly:

"Pets": { "type": "array", \ "items": { "$ref": "#/definitions/Pet" }** }

ckriley commented 8 years ago

Tested petstore-with-external-docs.json and found that the definitions section for Pet was not handled properly in 0.5 or 0.6. The definition is as below and I will generate an issue for this specifically. It appears we do not support "allOf".

"Pet": { "type": "object", "allOf": [ { "$ref": "#/definitions/NewPet" }, { "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64" } } } ] }