grpc-ecosystem/grpc-gateway

docs: Improve documentation about http options

Open

#295 opened on Jan 10, 2017

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Go (16,971 stars) (2,250 forks)batch import
documentationhelp wanted

Description

I keep having to inspect the source code to remember how to declare http options that include values in the path.

Contributor guide

Tech stack
gogrpcrest 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.
1-3 hours
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
basic Go knowledgefamiliarity with protobuf
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Examine the source code in `runtime/` and `protoc gen grpc gateway/` to understand how HTTP options with path values are parsed. Then locate the documentation (e.g., README or docs folder) and add clear examples showing how to declare options that include values in the path. Verify the examples by testing with the actual code.