From 1afb4310161e4fe1a7f9bd70a752c5066300d242 Mon Sep 17 00:00:00 2001 From: sarahalsmiller <100602640+sarahalsmiller@users.noreply.github.com> Date: Wed, 15 Nov 2023 11:49:22 -0600 Subject: [PATCH 1/5] Timeout Docs Update (#19601) * Update routetimeoutfilter.mdx * Update website/content/docs/connect/gateways/api-gateway/configuration/routetimeoutfilter.mdx Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> * Update website/content/docs/connect/gateways/api-gateway/configuration/routetimeoutfilter.mdx Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> * Update website/content/docs/connect/gateways/api-gateway/configuration/routetimeoutfilter.mdx Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> --------- Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> --- .../configuration/routetimeoutfilter.mdx | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/website/content/docs/connect/gateways/api-gateway/configuration/routetimeoutfilter.mdx b/website/content/docs/connect/gateways/api-gateway/configuration/routetimeoutfilter.mdx index 6be1f22ae358..3f0a5e6def6a 100644 --- a/website/content/docs/connect/gateways/api-gateway/configuration/routetimeoutfilter.mdx +++ b/website/content/docs/connect/gateways/api-gateway/configuration/routetimeoutfilter.mdx @@ -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 @@ -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. Must specify a parseable number and a unit, for example "5s". #### 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. Must specify a parseable number and a unit, for example "5s". #### Values -- Default: 0 -- Data type: Integer \ No newline at end of file +- Default: "" +- Data type: Integer From 6e779733faeadeed3807f72c4586b7ae8ab81b54 Mon Sep 17 00:00:00 2001 From: sarahalsmiller <100602640+sarahalsmiller@users.noreply.github.com> Date: Wed, 15 Nov 2023 14:17:34 -0600 Subject: [PATCH 2/5] Update routetimeoutfilter.mdx --- .../gateways/api-gateway/configuration/routetimeoutfilter.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/content/docs/connect/gateways/api-gateway/configuration/routetimeoutfilter.mdx b/website/content/docs/connect/gateways/api-gateway/configuration/routetimeoutfilter.mdx index 3f0a5e6def6a..1326271e6ed0 100644 --- a/website/content/docs/connect/gateways/api-gateway/configuration/routetimeoutfilter.mdx +++ b/website/content/docs/connect/gateways/api-gateway/configuration/routetimeoutfilter.mdx @@ -102,7 +102,7 @@ Specifies the total amount of time permitted for the request stream to be idle. #### Values - Default: "" -- Data type: string +- Data type: String ### `spec.requestTimeout` @@ -111,4 +111,4 @@ Specifies the total amount of time in nanoseconds, including retry attempts, Con #### Values - Default: "" -- Data type: Integer +- Data type: String From 68ed024d40ab363188fee1f0033769d9815d31c4 Mon Sep 17 00:00:00 2001 From: sarahalsmiller <100602640+sarahalsmiller@users.noreply.github.com> Date: Thu, 16 Nov 2023 10:29:09 -0600 Subject: [PATCH 3/5] Update website/content/docs/connect/gateways/api-gateway/configuration/routetimeoutfilter.mdx Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> --- .../gateways/api-gateway/configuration/routetimeoutfilter.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/content/docs/connect/gateways/api-gateway/configuration/routetimeoutfilter.mdx b/website/content/docs/connect/gateways/api-gateway/configuration/routetimeoutfilter.mdx index 1326271e6ed0..ef3368f4be7c 100644 --- a/website/content/docs/connect/gateways/api-gateway/configuration/routetimeoutfilter.mdx +++ b/website/content/docs/connect/gateways/api-gateway/configuration/routetimeoutfilter.mdx @@ -97,7 +97,7 @@ 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. Must specify a parseable number and a unit, for example "5s". +Specifies the total amount of time permitted for the request stream to be idle. Format the string as `""`, 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. #### Values From 2bb740feed2eaa3ff17cb0b23d35613b8740bc62 Mon Sep 17 00:00:00 2001 From: sarahalsmiller <100602640+sarahalsmiller@users.noreply.github.com> Date: Thu, 16 Nov 2023 10:30:46 -0600 Subject: [PATCH 4/5] Update website/content/docs/connect/gateways/api-gateway/configuration/routetimeoutfilter.mdx --- .../gateways/api-gateway/configuration/routetimeoutfilter.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/content/docs/connect/gateways/api-gateway/configuration/routetimeoutfilter.mdx b/website/content/docs/connect/gateways/api-gateway/configuration/routetimeoutfilter.mdx index ef3368f4be7c..00319bfafc8f 100644 --- a/website/content/docs/connect/gateways/api-gateway/configuration/routetimeoutfilter.mdx +++ b/website/content/docs/connect/gateways/api-gateway/configuration/routetimeoutfilter.mdx @@ -106,7 +106,7 @@ Specifies the total amount of time permitted for the request stream to be idle. ### `spec.requestTimeout` -Specifies the total amount of time in nanoseconds, including retry attempts, Consul permits for the entire downstream request to be processed. Must specify a parseable number and a unit, for example "5s". +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 `""`, 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 From 68155743e40b51b937da983b4679f266987ef72a Mon Sep 17 00:00:00 2001 From: sarahalsmiller <100602640+sarahalsmiller@users.noreply.github.com> Date: Thu, 16 Nov 2023 10:31:10 -0600 Subject: [PATCH 5/5] Update website/content/docs/connect/gateways/api-gateway/configuration/routetimeoutfilter.mdx --- .../gateways/api-gateway/configuration/routetimeoutfilter.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/content/docs/connect/gateways/api-gateway/configuration/routetimeoutfilter.mdx b/website/content/docs/connect/gateways/api-gateway/configuration/routetimeoutfilter.mdx index 00319bfafc8f..4effb11e1319 100644 --- a/website/content/docs/connect/gateways/api-gateway/configuration/routetimeoutfilter.mdx +++ b/website/content/docs/connect/gateways/api-gateway/configuration/routetimeoutfilter.mdx @@ -97,7 +97,7 @@ 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. Format the string as `""`, 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. +Specifies the total amount of time permitted for the request stream to be idle. Format the string as `""`, 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