Skip to content

Commit 42ee14c

Browse files
committed
docs(middleware): align RequestID header spelling with HeaderXRequestID
Godoc mixed X-Request-ID and X-Request-Id. Use X-Request-Id consistently to match echo.HeaderXRequestID.
1 parent ed8bbe4 commit 42ee14c

2 files changed

Lines changed: 4 additions & 4 deletions

File tree

middleware/request_id.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,15 @@ type RequestIDConfig struct {
2424
TargetHeader string
2525
}
2626

27-
// RequestID returns a middleware that reads RequestIDConfig.TargetHeader (`X-Request-ID`) header value or when
27+
// RequestID returns a middleware that reads RequestIDConfig.TargetHeader (`X-Request-Id`) header value or when
2828
// the header value is empty, generates that value and sets request ID to response
2929
// as RequestIDConfig.TargetHeader (`X-Request-Id`) value.
3030
func RequestID() echo.MiddlewareFunc {
3131
return RequestIDWithConfig(RequestIDConfig{})
3232
}
3333

3434
// RequestIDWithConfig returns a middleware with given valid config or panics on invalid configuration.
35-
// The middleware reads RequestIDConfig.TargetHeader (`X-Request-ID`) header value or when the header value is empty,
35+
// The middleware reads RequestIDConfig.TargetHeader (`X-Request-Id`) header value or when the header value is empty,
3636
// generates that value and sets request ID to response as RequestIDConfig.TargetHeader (`X-Request-Id`) value.
3737
func RequestIDWithConfig(config RequestIDConfig) echo.MiddlewareFunc {
3838
return toMiddlewareOrPanic(config)

middleware/request_logger.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ type RequestLoggerConfig struct {
154154
LogURIPath bool
155155
// LogRoutePath instructs logger to extract route path part to which request was matched to (i.e. `/user/:id`)
156156
LogRoutePath bool
157-
// LogRequestID instructs logger to extract request ID from request `X-Request-ID` header or response if request did not have value.
157+
// LogRequestID instructs logger to extract request ID from request `X-Request-Id` header or response if request did not have value.
158158
LogRequestID bool
159159
// LogReferer instructs logger to extract request referer values.
160160
LogReferer bool
@@ -205,7 +205,7 @@ type RequestLoggerValues struct {
205205
URIPath string
206206
// RoutePath is route path part to which request was matched to (i.e. `/user/:id`)
207207
RoutePath string
208-
// RequestID is request ID from request `X-Request-ID` header or response if request did not have value.
208+
// RequestID is request ID from request `X-Request-Id` header or response if request did not have value.
209209
RequestID string
210210
// Referer is request referer values.
211211
Referer string

0 commit comments

Comments
 (0)