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.

Sign up for GitHub

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

Timeout Docs Update (#19601) #19655

Merged
merged 5 commits into from
Nov 16, 2023
Merged

Timeout Docs Update (#19601) #19655

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1afb431
Timeout Docs Update (#19601)
sarahalsmiller Nov 15, 2023
6e77973
Update routetimeoutfilter.mdx
sarahalsmiller Nov 15, 2023
68ed024
Update website/content/docs/connect/gateways/api-gateway/configuratio…
sarahalsmiller Nov 16, 2023
2bb740f
Update website/content/docs/connect/gateways/api-gateway/configuratio…
sarahalsmiller Nov 16, 2023
6815574
Update website/content/docs/connect/gateways/api-gateway/configuratio…
sarahalsmiller Nov 16, 2023
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
16 changes: 8 additions & 8 deletions .../content/docs/connect/gateways/api-gateway/configuration/routetimeoutfilter.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ The following list outlines field hierarchy, data types, and requirements in a `
- [`name`](#metadata-name): string | required
- [`namespace`](#metadata-namespace): string | `default`
- [`spec`](#spec): map | required
- [`idleTimeout`](#spec-idletimeout): number | `0`
- [`requestTimeout`](#spec-retryonconnectfailure): number | `0`
- [`idleTimeout`](#spec-idletimeout): string | `""`
- [`requestTimeout`](#spec-retryonconnectfailure): string | `""`

## Complete configuration

Expand Down Expand Up @@ -97,18 +97,18 @@ Map that contains the details about the gateway policy. The `apiVersion`, `kind`

### `spec.idleTimeout

Specifies the total amount of time permitted for the request stream to be idle.
Specifies the total amount of time permitted for the request stream to be idle. Format the string as `"<number><unit>"`, for example `"5s"`. Consul uses the `metav1.Duration` package of parse the value. Refer to the [Go documentation](https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration) for additional information about defining parseable values.
sarahalsmiller marked this conversation as resolved.
Show resolved Hide resolved

#### Values

- Default: 0
- Data type: Integer
- Default: ""
- Data type: String

### `spec.requestTimeout`

Specifies the total amount of time in nanoseconds, including retry attempts, Consul permits for the entire downstream request to be processed.
Specifies the total amount of time in nanoseconds, including retry attempts, Consul permits for the entire downstream request to be processed. Format the string as `"<number><unit>"`, for example `"5s"`. Consul uses the `metav1.Duration` package to parse the value. Refer to the [Go documentation](https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration) for additional information about defining parseable values.

#### Values

- Default: 0
- Data type: Integer
- Default: ""
- Data type: String