grpc-ecosystem/grpc-gateway

protoc-gen-swagger doesn't output to specified --swagger_out directory

Open

#383 opened on May 11, 2017

View on GitHub
 (7 comments) (1 reaction) (0 assignees)Go (2,250 forks)batch import
bughelp wantedopenapi

Repository metrics

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

Description

Invoking protoc-gen-swagger with:

protoc -I/usr/local/include -I. -I$GOPATH/src \
  -I$GOPATH/src/github.com/grpc-ecosystem/grpc-gateway/third_party/googleapis \
  --swagger_out=logtostderr=true:. \
  mycorp/api/user/v1/user_service.proto

The outputted file ends up in mycorp/api/user/v1/, not the current working directory.

Contributor guide

Research direction
Investigate the output path logic in protoc gen swagger to see why the swagger out directory is ignored. Trace from the generated file path construction to find where the working directory overrides the specified output directory.
Tech stack
go
Domain
backendapi
Issue type
Bug
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.
1-3 hours
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
GoProtocol Buffers
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70