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

Create JSON Schema spec from Swagger model definitions during docs build #137

Closed
jaeddy opened this issue May 13, 2019 · 1 comment
Closed

Comments

@jaeddy
Copy link
Member

jaeddy commented May 13, 2019

See #135 for the origin of this ticket.

Idea (from @susheel) is "to allow a non-swagger client to still validate the JSON response without processing the swagger spec to extract the JSON schema."

Changes in #136 add this JSON Schema file manually, but should be part of the build process: the file doesn't need to be under version control — but we can include a step to process the Swagger/OpenAPI spec and host at a documented path on our GitHub pages site.

@jaeddy
Copy link
Member Author

jaeddy commented Sep 21, 2020

This issue is partially solved by maintaining schema definitions in (separate files)[https://github.com/ga4gh/workflow-execution-service-schemas/tree/develop/openapi/components/schemas] (converting from YAML to JSON Schema should be a trivial extra step). We'd need to think about whether to also include support for Swagger-specific structures (e.g., definitions instead of components).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants