grpc-ecosystem/grpc-gateway

Document protoc-gen-swagger

Open

#427 opened on Jul 4, 2017

View on GitHubContributor guide
 (5 comments) (0 reactions) (0 assignees)Go (2,250 forks)batch import
documentationhelp wantedopenapi

Repository metrics

Stars
 (16,971 stars)
PR merge metrics
 (Avg merge 8d 23h) (147 merged PRs in 30d)

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

Research direction
Examine the existing protoc gen swagger documentation and examples, then create a guide explaining how to add Swagger annotations to .proto files.
Tech stack
go
Domain
backendapi
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
ProtobufGo
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90