Skip to content
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

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

Draft
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

rpgoldman
Copy link
Contributor

@rpgoldman rpgoldman commented Apr 11, 2022

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.

A couple of the API endpoints were missing the `schema` tag, causing
failure in processing by openapi-generator.
Note that this makes [pull request
136](phenoscape#136) obsolete.
@rpgoldman rpgoldman changed the title Add missing schemas to swagger.yaml. Fix swagger.yaml and validate it in GitHub Actions Apr 12, 2022
@rpgoldman
Copy link
Contributor Author

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

@rpgoldman
Copy link
Contributor Author

A quick follow-up: the schema additions are required because of a bug in openapi-generator (see OpenAPITools/openapi-generator#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 rpgoldman changed the title Fix swagger.yaml and validate it in GitHub Actions WIP: Fix swagger.yaml and validate it in GitHub Actions Apr 13, 2022
@rpgoldman
Copy link
Contributor Author

rpgoldman commented Apr 13, 2022

Debugging openAPI YAML is ... not easy.

@rpgoldman rpgoldman closed this Apr 13, 2022
@rpgoldman rpgoldman reopened this Apr 13, 2022
@balhoff
Copy link
Member

balhoff commented Apr 13, 2022

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).

@balhoff balhoff marked this pull request as draft April 13, 2022 19:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants