-
Notifications
You must be signed in to change notification settings - Fork 2.2k
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
Generate Swagger description for service methods using proto comments. #134
Commits on Apr 18, 2016
-
Generate Swagger description for service methods using proto comments.
While this is a first step in resolving grpc-ecosystem#128, this needs to be cleaned up, and the same approach needs to be used for messages, message fields, et al. echo_service.proto has been annotated with extra comments in order to demo the new descriptions. Only the Swagger example has been regenerated, as my local generator does not output all the expected fields in proto struct tags.
Configuration menu - View commit details
-
Copy full SHA for d2fd8af - Browse repository at this point
Copy the full SHA d2fd8afView commit details
Commits on Apr 27, 2016
-
Configuration menu - View commit details
-
Copy full SHA for 06b3e56 - Browse repository at this point
Copy the full SHA 06b3e56View commit details -
Generate Swagger description for enum types, enum values and nested m…
…essages using proto comments
Configuration menu - View commit details
-
Copy full SHA for 97558d4 - Browse repository at this point
Copy the full SHA 97558d4View commit details
Commits on May 1, 2016
-
Documented protoPathIndex. Improved error handling.
Also, fixed a few typos and renamed protoPath into protoPathIndex (as we are not returning the entire path in that method).
Configuration menu - View commit details
-
Copy full SHA for 081be28 - Browse repository at this point
Copy the full SHA 081be28View commit details -
Configuration menu - View commit details
-
Copy full SHA for 8bdac72 - Browse repository at this point
Copy the full SHA 8bdac72View commit details -
Fix test which was not setting the SourceCodeInfo field.
This field should generally be non-nil while running the generator. This commit also adds a trivial check to make panic more informative in case a future test breaks in a similar fashion.
Configuration menu - View commit details
-
Copy full SHA for bdceda1 - Browse repository at this point
Copy the full SHA bdceda1View commit details
Commits on May 7, 2016
-
Swagger: summary, description, custom JSON, package docs.
This patch will extract summary separately from description in Swagger objects that happen to support both summary and description. It will do so by splitting the relevant proto comment based on paragraphs, and using the first paragraph as the summary. This patch will also allow updating the Swagger schema's otherwise hard-to-map fields by allowing custom JSON to be placed within the proto comment. The syntax leaves something to be desired, but it works. Use of JSON is, on the other hand, rather universal. This patch will also allow describing the whole API by attaching the comments to the 'package' stanza inside the proto. In this case, summary will be applied to info.title, and description will be applied to info.description. Other properties have to be set through JSON. Schema has been slightly updated to allow for fields such as termsOfService, contact, license, externalDocs, etc. If a method is not documented, stub summary for Swagger Operation is no longer generated. Documentation for enum values is now multiline with dashes before values.
Configuration menu - View commit details
-
Copy full SHA for 26727f7 - Browse repository at this point
Copy the full SHA 26727f7View commit details -
Swagger: Default response's key is now 200.
While the spec does not seem to dictate this, most of the examples seem to have HTTP status codes as the keys. This patch replaces the text 'default' with value of '200'.
Configuration menu - View commit details
-
Copy full SHA for cc33223 - Browse repository at this point
Copy the full SHA cc33223View commit details -
Configuration menu - View commit details
-
Copy full SHA for 0d71621 - Browse repository at this point
Copy the full SHA 0d71621View commit details -
Configuration menu - View commit details
-
Copy full SHA for f45fe56 - Browse repository at this point
Copy the full SHA f45fe56View commit details -
Configuration menu - View commit details
-
Copy full SHA for 562956f - Browse repository at this point
Copy the full SHA 562956fView commit details