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

support annotating fields as required (in swagger/oapi generation)? #175

Closed
tmc opened this issue Jun 4, 2016 · 2 comments
Closed

support annotating fields as required (in swagger/oapi generation)? #175

tmc opened this issue Jun 4, 2016 · 2 comments

Comments

@tmc
Copy link
Collaborator

tmc commented Jun 4, 2016

Obviously proto3 doesn't have required fields so this might not be a fit or be appropriate but it might be nice to allow more detailed annotation of fields. Thoughts?

@johanbrandhorst
Copy link
Collaborator

You can put comments in your proto files and the swagger generator will put those comments in your swagger.json. See https://github.com/gengo/grpc-gateway/blob/master/examples/examplepb/echo_service.proto for an example of how to format the comments.

@achew22
Copy link
Collaborator

achew22 commented Jan 4, 2017

@tmc additionally yugui has stated that she doesn't want to implement any features in here that aren't in the spec as defined by Google. Right now they don't have required fields. If their spec changes to support that I think we should implement this feature then. Again, I'm going to close this just to tidy up a bit. If you decide to file an issue upstream with the google repo, would you please comment on here to indicate that you did it. I would love to track the progress and implement if their schema changes.

@achew22 achew22 closed this as completed Jan 4, 2017
@tamalsaha tamalsaha mentioned this issue Mar 30, 2017
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants