This repository has been archived by the owner on Oct 28, 2022. It is now read-only.
Adding HTTP Annotations #717
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Change API version number
Fix indentation
The protobufjson doc generation process failed when receiving extensions or options in the protobuf descriptors. Added a few comments to make more clear what was happening and allowed for extensions and options to be in the indexed tree. Roll back reads change
david4096
force-pushed
the
696_http
branch
3 times, most recently
from
637d7e6
to
aaf820e
Compare
Change protobuf in environment.yml Documentation fixes
|
I have gone through the steps in the documentation and was able to use the swagger-codegen tool successfully. +1 |
|
@bwalsh can you give this a review please, especially the steps to create the swagger docs |
|
+1 I was able to follow the instructions for linux and generate target/swagger/ga4gh |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There has been an effort to standardize the methods for generating HTTP API descriptions that allow developers to rapidly develop gateways into their data. Since the GA4GH schemas are defined using Google Protocol Buffers IDL, it is possible to use this definition to generate documentation and code.
This PR adds this functionality to the GA4GH schemas by defining specially formatted options. These options allow one to specify the exact endpoint a message will be received at, as well as which fields to gather from the URL path. With these options in place, it is possible to inspect the compiled protobuf to generate service descriptions that include HTTP endpoints.
The plugin for
protocused is written in Go, and so this PR includes some cursory documentation for getting started with Go on Mac.With these annotations in place, one can use tools like swagger-codegen to generate server stubs, clients, and generated documentation. This will make integrating GA4GH APIs into existing data stores much easier.
Close #696