Skip to content

Commit

Permalink
fix typo in doc type
Browse files Browse the repository at this point in the history
  • Loading branch information
sarahalsmiller committed Nov 16, 2023
1 parent e664799 commit c708ec4
Showing 1 changed file with 10 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ description: >-

# RouteTimeoutFilter configuration reference

This topic provides configuration reference information for details about the `RouteTimeoutFilter` resource, which defines timeout settings for specific routes from an API gateway listener to the destination service in Consul service mesh.
This topic provides configuration reference information for details about the `RouteTimeoutFilter` resource, which defines timeout settings for specific routes from an API gateway listener to the destination service in Consul service mesh.

To apply retry settings to a `HTTPRoute`, set the `rules.filters.type` parameter in an route to `extensionRef` and specify the name of the filter in `rules.filters.extensionRef.name` field. Refer to [Route resource configuration reference](/consul/docs/connect/gateways/api-gateway/configuration/routes) for additional information.
To apply retry settings to a `HTTPRoute`, set the `rules.filters.type` parameter in an route to `extensionRef` and specify the name of the filter in `rules.filters.extensionRef.name` field. Refer to [Route resource configuration reference](/consul/docs/connect/gateways/api-gateway/configuration/routes) for additional information.

## Configuration Model

Expand All @@ -18,15 +18,15 @@ The following list outlines field hierarchy, data types, and requirements in a `
- [`apiVersion`](#apiversion): string | required | must be set to `consul.hashicorp.com/v1alpha1`
- [`kind`](#kind): string | required | must be set to `RouteTimeoutFilter`
- [`metadata`](#metadata): map | required
- [`name`](#metadata-name): string | required
- [`name`](#metadata-name): string | required
- [`namespace`](#metadata-namespace): string | `default`
- [`spec`](#spec): map | required
- [`idleTimeout`](#spec-idletimeout): string | `""`
- [`requestTimeout`](#spec-retryonconnectfailure): string | `""`

## Complete configuration

When every field is defined, this resource has the following form:
When every field is defined, this resource has the following form:

```yaml
apiVersion: consul.hashicorp.com/v1alpha1
Expand Down Expand Up @@ -73,15 +73,15 @@ Map that contains an arbitrary name for the resource and the namespace it applie

### `metadata.name`

Specifies a name for the resource. The name is metadata that you can use to reference the resource when performing Consul operations, such as applying the resource to a specific cluster.
Specifies a name for the resource. The name is metadata that you can use to reference the resource when performing Consul operations, such as applying the resource to a specific cluster.

#### Values

- Default: None
- This field is required.
- Data type: String

### `metadata.namespace`
### `metadata.namespace`

Specifies the namespace that the configuration applies to. Refer to [namespaces](/consul/docs/enterprise/namespaces) for more information.

Expand All @@ -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. 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. Must specify a parseable number and a unit, for example "5s".

#### Values

- Default: ""
- Data type: string
- 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. 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. Must specify a parseable number and a unit, for example "5s".

#### Values

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

0 comments on commit c708ec4

Please sign in to comment.