search

phenoscape / owlery

Owlery is a set of REST web services which allow querying of an OWL reasoner containing a configured set of ontologies.
MIT License
16 stars 11 forks source link

WIP: Fix swagger.yaml and validate it in GitHub Actions #205

Open rpgoldman opened 2 years ago

rpgoldman commented 2 years ago

A couple of the API endpoints were missing the schema tag, causing failure in processing by openapi-generator.

Also added a schema with description for JSON prefix maps, making #136 obsolete.

Added OpenAPI/Swagger API validation to CI.

rpgoldman commented 2 years ago

@balhoff I think this could make the CI tests more informative. Please review it and let me know what you think.

rpgoldman commented 2 years ago

A quick follow-up: the schema additions are required because of a bug in openapi-generator (see https://github.com/OpenAPITools/openapi-generator/issues/11763), but I don't think it should harm anything for me to add them.

It looks like there are still one or two missing, so I am tagging this as Draft until I have added them.

rpgoldman commented 2 years ago

Debugging openAPI YAML is ... not easy.

balhoff commented 2 years ago

Thanks so much for doing this! Looks good so far. Do you want to make it a draft PR? There's a little link in the Reviewers box (I always have to search for it).