Added comments to base_path to explain behavior

[nu11ptr]

Added comments to base_path to explain how it doesn't modify generated paths and has to be handled manually

Closes #918

[johanbrandhorst]

Thanks for this, however, could we start the comment out by saying what this does and give an example of where this might be useful, then add the note about how it doesn't change the generated paths in the http field? Thanks.

[johanbrandhorst]

Great, thanks for this!

[johanbrandhorst]

Ah, looks like you still need to regenerate the files with this new comment. There's a one liner in CONTRIBUTING.md that should work.

[johanbrandhorst]

Are you still interested in this PR? The CI build failure can be fixed by running two simple docker commands and committing the changes:

docker run -v $(pwd):/src/grpc-gateway --rm jfbrandhorst/grpc-gateway-build-env:1.12 \
    /bin/bash -c 'cd /src/grpc-gateway && \
        make realclean && \
        make examples SWAGGER_CODEGEN="${SWAGGER_CODEGEN}"'
docker run -itv $(pwd):/grpc-gateway -w /grpc-gateway --entrypoint /bin/bash --rm \
    l.gcr.io/google/bazel -c 'bazel run :gazelle; bazel run :buildifier'

[codecov-io]

Codecov Report

Merging #919 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #919   +/-   ##
=======================================
  Coverage   53.22%   53.22%           
=======================================
  Files          40       40           
  Lines        4004     4004           
=======================================
  Hits         2131     2131           
  Misses       1675     1675           
  Partials      198      198

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d54b361...d384353. Read the comment docs.

[johanbrandhorst]

Thanks for your contribution!