grpc-ecosystem/grpc-gateway

Document protoc-gen-swagger

Open

#427 opened on Jul 4, 2017

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Go (16,971 stars) (2,250 forks)batch import
documentationhelp wantedopenapi

Description

There's no obvious documentation on how to actually comment .proto files so they can be parsed by protoc-gen-swagger. It'd be useful if some was added.

Contributor guide

Tech stack
gorest api
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
understanding of Protocol Buffersfamiliarity with .proto files
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Review the existing documentation in the repository, particularly the README and any examples. Examine the protoc gen swagger plugin's source code to understand how it parses comments. Provide examples of common swagger annotations in .proto files and explain their effects.