Skip to content

Commit

Permalink
gateway: add config docstrings
Browse files Browse the repository at this point in the history
Signed-off-by: Jimmy Zelinskie <jimmy@zelinskie.com>
  • Loading branch information
jzelinskie committed Oct 20, 2021
1 parent 5567282 commit f441244
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions internal/gateway/gateway.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,19 @@ var histogram = promauto.NewHistogramVec(prometheus.HistogramOpts{

// Config represents the require configuration for initializing a REST gateway.
type Config struct {
Addr string
UpstreamAddr string
// Addr is the address on which the HTTP server will be configured to listen.
Addr string

// UpstreamAddr is the address of the gRPC serve to which requests will be
// forwarded.
UpstreamAddr string

// UpstreamTlsDisabled toggles whether or not the upstream connection will be
// secure.
UpstreamTlsDisabled bool

// UpstreamTlsCertPath is the filesystem location of the certificate used to
// secure the upstream connection.
UpstreamTlsCertPath string
}

Expand Down

0 comments on commit f441244

Please sign in to comment.