Skip to content

docs: fix typo in HTTPRoute reference docs #2137

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

Merged
travisbeckham merged 7 commits into from
Jul 22, 2026
Merged

docs: fix typo in HTTPRoute reference docs #2137

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2a38494
docs: fix typo in HTTPRoute reference docs
bezarsnba Jun 26, 2026
08903a6
Merge branch 'main' into fix-typy-httproute
bezarsnba Jul 11, 2026
6891bd3
docs: fix typo and standardize HTTPRoute reference headings
bezarsnba Jul 14, 2026
5011e93
docs: standardize HTTPRoute reference headings in all versions
bezarsnba Jul 18, 2026
3c215b1
Merge branch 'main' into fix-typy-httproute
bezarsnba Jul 18, 2026
1eaead4
docs: clarify HTTPRoute field descriptions with "resources" wording
bezarsnba Jul 20, 2026
b52a1c1
docs: keep HTTPRoute reference wording consistent
bezarsnba Jul 21, 2026
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
72 changes: 36 additions & 36 deletions linkerd.io/content/2-edge/reference/httproute.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,23 +110,23 @@ GEP-1426][ns-boundaries] for details on producer and consumer routes.

{{< /keyval >}}

### httpRouteRule
### HTTPRouteRule

HTTPRouteRule defines semantics for matching an HTTP request based on conditions
(matches) and processing it (filters).

{{< keyval >}}

| field | value |
| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `matches` | A list of [httpRouteMatches](#httproutematch). Each match is independent, i.e. this rule will be matched if **any** one of the matches is satisfied. |
| `filters` | A list of [httpRouteFilters](#httproutefilter) which will be applied to each request which matches this rule. |
| `backendRefs` | An array of [HTTPBackendRefs](#httpbackendref) to declare where the traffic should be routed to (only allowed with Service [parentRefs](#parentreference)). |
| `timeouts` | An optional [httpRouteTimeouts](#httproutetimeouts) object which configures timeouts for requests matching this rule. |
| field | value |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `matches` | A list of [HTTPRouteMatch](#httproutematch) resources. Each match is independent, i.e. this rule will be matched if **any** one of the matches is satisfied. |
| `filters` | A list of [HTTPRouteFilter](#httproutefilter) resources which will be applied to each request which matches this rule. |
| `backendRefs` | An array of [HTTPBackendRef](#httpbackendref) resources to declare where the traffic should be routed to (only allowed with Service [parentRefs](#parentreference)). |
| `timeouts` | An optional [HTTPRouteTimeouts](#httproutetimeouts) object which configures timeouts for requests matching this rule. |

{{< /keyval >}}

### httpRouteMatch
### HTTPRouteMatch

HTTPRouteMatch defines the predicate used to match requests to a given action.
Multiple match types are ANDed together, i.e. the match will evaluate to true
Expand All @@ -136,14 +136,14 @@ only if all conditions are satisfied.

| field | value |
| ------------- | ----------------------------------------------------------------------------------------------------------------------- |
| `path` | An [httpPathMatch](#httppathmatch). If this field is not specified, a default prefix match on the "/" path is provided. |
| `headers` | A list of [httpHeaderMatches](#httpheadermatch). Multiple match values are ANDed together. |
| `queryParams` | A list of [httpQueryParamMatches](#httpqueryparammatch). Multiple match values are ANDed together. |
| `path` | An [HTTPPathMatch](#httppathmatch). If this field is not specified, a default prefix match on the "/" path is provided. |
| `headers` | A list of [HTTPHeaderMatch](#httpheadermatch) resources. Multiple match values are ANDed together. |
| `queryParams` | A list of [HTTPQueryParamMatch](#httpqueryparammatch) resources. Multiple match values are ANDed together. |
| `method` | When specified, this route will be matched only if the request has the specified method. |

{{< /keyval >}}

### httpPathMatch
### HTTPPathMatch

`HTTPPathMatch` describes how to select a HTTP route by matching the HTTP
request path.
Expand All @@ -157,7 +157,7 @@ request path.

{{< /keyval >}}

### httpHeaderMatch
### HTTPHeaderMatch

`HTTPHeaderMatch` describes how to select a HTTP route by matching HTTP request
headers.
Expand All @@ -172,7 +172,7 @@ headers.

{{< /keyval >}}

### httpQueryParamMatch
### HTTPQueryParamMatch

`HTTPQueryParamMatch` describes how to select a HTTP route by matching HTTP
query parameters.
Expand All @@ -187,7 +187,7 @@ query parameters.

{{< /keyval >}}

### httpRouteFilter
### HTTPRouteFilter

HTTPRouteFilter defines processing steps that must be completed during the
request or response lifecycle.
Expand All @@ -197,27 +197,27 @@ request or response lifecycle.
| field | value |
| ------------------------ | -------------------------------------------------------------------------- |
| `type` | One of: RequestHeaderModifier, ResponseHeaderModifier, or RequestRedirect. |
| `requestHeaderModifier` | An [httpHeaderFilter](#httpheaderfilter) which modifies request headers. |
| `responseHeaderModifier` | An [httpHeaderFilter](#httpheaderfilter) which modifies response headers. |
| `requestRedirect` | An [httpRequestRedirectFilter](#httprequestredirectfilter). |
| `requestHeaderModifier` | An [HTTPHeaderFilter](#httpheaderfilter) which modifies request headers. |
| `responseHeaderModifier` | An [HTTPHeaderFilter](#httpheaderfilter) which modifies response headers. |
| `requestRedirect` | An [HTTPRequestRedirectFilter](#httprequestredirectfilter). |

{{< /keyval >}}

### httpHeaderFilter
### HTTPHeaderFilter

A filter which modifies HTTP request or response headers.

{{< keyval >}}

| field | value |
| -------- | ----------------------------------------------------------------------------------------------------------- |
| `set` | A list of [httpHeaders](#httpheader) to overwrite on the request or response. |
| `add` | A list of [httpHeaders](#httpheader) to add on to the request or response, appending to any existing value. |
| `remove` | A list of header names to remove from the request or response. |
| field | value |
| -------- | -------------------------------------------------------------------------------------------------------------------- |
| `set` | A list of [HTTPHeader](#httpheader) resources to overwrite on the request or response. |
| `add` | A list of [HTTPHeader](#httpheader) resources to add on to the request or response, appending to any existing value. |
| `remove` | A list of header names to remove from the request or response. |

{{< /keyval >}}

### httpHeader
### HTTPHeader

`HTTPHeader` represents an HTTP Header name and value as defined by RFC 7230.

Expand All @@ -230,23 +230,23 @@ A filter which modifies HTTP request or response headers.

{{< /keyval >}}

### httpRequestRedirectFilter
### HTTPRequestRedirectFilter

`HTTPRequestRedirect` defines a filter that redirects a request.

{{< keyval >}}

| field | value |
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `scheme` | The scheme to be used in the value of the `Location` header in the response. When empty, the scheme of the request is used. |
| `hostname` | The hostname to be used in the value of the `Location` header in the response. When empty, the hostname of the request is used. |
| `path` | An [httpPathModfier](#httppathmodfier) which modifies the path of the incoming request and uses the modified path in the `Location` header. |
| `port` | The port to be used in the value of the `Location` header in the response. When empty, port (if specified) of the request is used. |
| `statusCode` | The HTTP status code to be used in response. |
| field | value |
| ------------ | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `scheme` | The scheme to be used in the value of the `Location` header in the response. When empty, the scheme of the request is used. |
| `hostname` | The hostname to be used in the value of the `Location` header in the response. When empty, the hostname of the request is used. |
| `path` | An [HTTPPathModifier](#httppathmodifier) which modifies the path of the incoming request and uses the modified path in the `Location` header. |
| `port` | The port to be used in the value of the `Location` header in the response. When empty, port (if specified) of the request is used. |
| `statusCode` | The HTTP status code to be used in response. |

{{< /keyval >}}

### httpPathModfier
### HTTPPathModifier

`HTTPPathModifier` defines configuration for path modifiers.

Expand All @@ -260,7 +260,7 @@ A filter which modifies HTTP request or response headers.

{{< /keyval >}}

### httpBackendRef
### HTTPBackendRef

`HTTPBackendRef` defines the list of objects where matching requests should be
sent to. Only allowed when a route has Service [parentRefs](#parentreference).
Expand All @@ -276,7 +276,7 @@ sent to. Only allowed when a route has Service [parentRefs](#parentreference).

{{< /keyval >}}

### httpRouteTimeouts
### HTTPRouteTimeouts

`HTTPRouteTimeouts` defines the timeouts that can be configured for an HTTP
request.
Expand Down
62 changes: 31 additions & 31 deletions linkerd.io/content/2.12/reference/authorization-policy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,21 +188,21 @@ A reference to the [Servers] this `HTTPRoute` is a part of.

{{< /keyval >}}

#### httpRouteRule
#### HTTPRouteRule

`HTTPRouteRule` defines semantics for matching an HTTP request based on
conditions (matches) and processing it (filters).

{{< keyval >}}

| field | value |
| --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| `matches` | A list of [httpRouteMatches](#httproutematch). Each match is independent, i.e. this rule will be matched if **any** one of the matches is satisfied. |
| `filters` | A list of [httpRouteFilters](#httproutefilter) which will be applied to each request which matches this rule. |
| field | value |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `matches` | A list of [HTTPRouteMatch](#httproutematch) resources. Each match is independent, i.e. this rule will be matched if **any** one of the matches is satisfied. |
| `filters` | A list of [HTTPRouteFilter](#httproutefilter) resources which will be applied to each request which matches this rule. |

{{< /keyval >}}

#### httpRouteMatch
#### HTTPRouteMatch

`HTTPRouteMatch` defines the predicate used to match requests to a given action.
Multiple match types are ANDed together, i.e. the match will evaluate to true
Expand All @@ -212,14 +212,14 @@ only if all conditions are satisfied.

| field | value |
| ------------- | ----------------------------------------------------------------------------------------------------------------------- |
| `path` | An [httpPathMatch](#httppathmatch). If this field is not specified, a default prefix match on the "/" path is provided. |
| `headers` | A list of [httpHeaderMatches](#httpheadermatch). Multiple match values are ANDed together. |
| `queryParams` | A list of [httpQueryParamMatches](#httpqueryparammatch). Multiple match values are ANDed together. |
| `path` | An [HTTPPathMatch](#httppathmatch). If this field is not specified, a default prefix match on the "/" path is provided. |
| `headers` | A list of [HTTPHeaderMatch](#httpheadermatch) resources. Multiple match values are ANDed together. |
| `queryParams` | A list of [HTTPQueryParamMatch](#httpqueryparammatch) resources. Multiple match values are ANDed together. |
| `method` | When specified, this route will be matched only if the request has the specified method. |

{{< /keyval >}}

#### httpPathMatch
#### HTTPPathMatch

`HTTPPathMatch` describes how to select a HTTP route by matching the HTTP
request path.
Expand All @@ -233,7 +233,7 @@ request path.

{{< /keyval >}}

#### httpHeaderMatch
#### HTTPHeaderMatch

`HTTPHeaderMatch` describes how to select a HTTP route by matching HTTP request
headers.
Expand All @@ -248,7 +248,7 @@ headers.

{{< /keyval >}}

#### httpQueryParamMatch
#### HTTPQueryParamMatch

`HTTPQueryParamMatch` describes how to select a HTTP route by matching HTTP
query parameters.
Expand All @@ -263,7 +263,7 @@ query parameters.

{{< /keyval >}}

#### httpRouteFilter
#### HTTPRouteFilter

`HTTPRouteFilter` defines processing steps that must be completed during the
request or response lifecycle.
Expand All @@ -273,26 +273,26 @@ request or response lifecycle.
| field | value |
| ----------------------- | ----------------------------------------------------------- |
| `type` | One of: RequestHeaderModifier, RequestRedirect. |
| `requestHeaderModifier` | An [httpRequestHeaderFilter](#httprequestheaderfilter). |
| `requestRedirect` | An [httpRequestRedirectFilter](#httprequestredirectfilter). |
| `requestHeaderModifier` | An [HTTPRequestHeaderFilter](#httprequestheaderfilter). |
| `requestRedirect` | An [HTTPRequestRedirectFilter](#httprequestredirectfilter). |

{{< /keyval >}}

#### httpRequestHeaderFilter
#### HTTPRequestHeaderFilter

A filter which modifies request headers.

{{< keyval >}}

| field | value |
| -------- | -------------------------------------------------------------------------------------------- |
| `set` | A list of [httpHeaders](#httpheader) to overwrites on the request. |
| `add` | A list of [httpHeaders](#httpheader) to add on the request, appending to any existing value. |
| `remove` | A list of header names to remove from the request. |
| field | value |
| -------- | ----------------------------------------------------------------------------------------------------- |
| `set` | A list of [HTTPHeader](#httpheader) resources to overwrites on the request. |
| `add` | A list of [HTTPHeader](#httpheader) resources to add on the request, appending to any existing value. |
| `remove` | A list of header names to remove from the request. |

{{< /keyval >}}

#### httpHeader
#### HTTPHeader

`HTTPHeader` represents an HTTP Header name and value as defined by RFC 7230.

Expand All @@ -305,23 +305,23 @@ A filter which modifies request headers.

{{< /keyval >}}

#### httpRequestRedirectFilter
#### HTTPRequestRedirectFilter

`HTTPRequestRedirect` defines a filter that redirects a request.

{{< keyval >}}

| field | value |
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `scheme` | The scheme to be used in the value of the `Location` header in the response. When empty, the scheme of the request is used. |
| `hostname` | The hostname to be used in the value of the `Location` header in the response. When empty, the hostname of the request is used. |
| `path` | An [httpPathModfier](#httppathmodfier) which modifies the path of the incoming request and uses the modified path in the `Location` header. |
| `port` | The port to be used in the value of the `Location` header in the response. When empty, port (if specified) of the request is used. |
| `statusCode` | The HTTP status code to be used in response. |
| field | value |
| ------------ | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `scheme` | The scheme to be used in the value of the `Location` header in the response. When empty, the scheme of the request is used. |
| `hostname` | The hostname to be used in the value of the `Location` header in the response. When empty, the hostname of the request is used. |
| `path` | An [HTTPPathModifier](#httppathmodifier) which modifies the path of the incoming request and uses the modified path in the `Location` header. |
| `port` | The port to be used in the value of the `Location` header in the response. When empty, port (if specified) of the request is used. |
| `statusCode` | The HTTP status code to be used in response. |

{{< /keyval >}}

#### httpPathModfier
#### HTTPPathModifier

`HTTPPathModifier` defines configuration for path modifiers.

Expand Down
Loading
Loading