Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Align documentation about HTTPRouteTimeouts.BackendRequest timeout scope #3462

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion apis/v1/httproute_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -347,7 +347,7 @@ type HTTPRouteTimeouts struct {

// BackendRequest specifies a timeout for an individual request from the gateway
// to a backend. This covers the time from when the request first starts being
// sent from the gateway to when the full response has been received from the backend.
// sent from the gateway to when the response headers have been received from the backend.
//
// Setting a timeout to the zero duration (e.g. "0s") SHOULD disable the timeout
// completely. Implementations that cannot completely disable the timeout MUST
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions config/crd/standard/gateway.networking.k8s.io_httproutes.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions geps/gep-1742/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -270,15 +270,15 @@ sequenceDiagram
Note right of P: respondingTimeouts<br/>readTimeout
C->>P: Finishes request
deactivate P
P->>U: Connection Started
activate U
P->>U: Connection Started
Note right of U: forwardingTimeouts<br/>dialTimeout
deactivate U
activate U
P->>U: Starts sending Request
P->>U: Finishes request
P->>U: Finishes Headers
U->>P: Starts Response
activate U
note right of U: forwardingTimeouts<br/>responseHeaderTimeout
U->>P: Finishes Headers
deactivate U
Expand Down Expand Up @@ -418,7 +418,7 @@ type HTTPRouteTimeouts struct {

// BackendRequest specifies a timeout for an individual request from the gateway
// to a backend. This covers the time from when the request first starts being
// sent from the gateway to when the full response has been received from the backend.
// sent from the gateway to when the response headers have been received from the backend.
//
// An entire client HTTP transaction with a gateway, covered by the Request timeout,
// may result in more than one call from the gateway to the destination backend,
Expand Down
2 changes: 1 addition & 1 deletion pkg/generated/openapi/zz_generated.openapi.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.