consider generating Swagger from JSON schema

jeffmcaffer commented 5 years ago

In #285 we updated Swagger and the schemas to be shared so there was one source of truth. There is still a gap around patternProperties which show up in the curations schema (and are not supported by Swagger).

There are a couple approaches we can take:

Translating from JSON schema to Swagger using something like https://github.com/wework/json-schema-to-openapi-schema. See also the related article https://philsturgeon.uk/api/2018/04/13/openapi-and-json-schema-divergence-solved/
Wait until OpenAPI 3.1 which apparently will have support for more of this

@moranthomas has been looking at this and may have some thoughts.

jeffmcaffer commented 5 years ago

Note: right now I am inclined to defer this unless the generation is really easy. We are only missing patternProperties in one place and while that's a pain, there are lots of other things to do. Open to suggestions and help...

AlexWebYourmind commented 5 years ago

@moranthomas can you spend 1 hour estimating how much work is required (assuming the conversion wework library serves our purpose) to complete the swagger implementation?

Let's make sure to take into account comments on #285, if we realize there's a lot of work involved we can wait until OpenAPI 3.1 is available.

jeffmendoza commented 4 years ago

Look to see current state

clearlydefined / service

consider generating Swagger from JSON schema #289