clearlydefined / clearlydefined/service

consider generating Swagger from JSON schema

Open
#289 3 comments 0 reactions 1 assignee Claimed by @jeffmendoza View on GitHub
enhancement
Dominant language
TypeScript
Stars
51
Forks
46
PR merge metrics
No merged PRs in 30d

Description

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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.