search

ga4gh / task-execution-schemas

Apache License 2.0
81 stars 28 forks source link

Proposal: remove protobuf; switch to OpenAPI #109

Closed aniewielska closed 5 years ago

aniewielska commented 6 years ago

Now that WES has done the move and transitioned towards OpenAPI, I would welcome getting rid of proto in TES as well. It seems that the idea got recognition at Toronto as well: OpenAPI vs. gRPC -- confirm OpenAPI -> formal issue and announcement link. There seems to be nobody interested in calling TES via gRPC and for REST API OpenAPI is the right tool. With OpenAPI/Swagger such concepts as validation (required fields), optional fields, error description could be documented directly as parts of the spec and not only comments.

stewartadam commented 5 years ago

While we're on the topic of Swagger/OpenAPI migration - please leverage titles/descriptions to describe the models and avoid duplicate titles - per below many are lacking model names and are described as "output only", making it difficult to parent the model to where it's used.

image

delagoya commented 5 years ago

This is now complete as of PR #113. Closing.