Skip to content

Commit 57daa5d

Browse files
authored
docs: fix comment on KongIngressRoute.Methods (#3426)
1 parent 8e60e0a commit 57daa5d

File tree

7 files changed

+7
-12
lines changed

7 files changed

+7
-12
lines changed

config/crd/bases/configuration.konghq.com_kongingresses.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,8 +106,7 @@ spec:
106106
type: integer
107107
methods:
108108
description: 'Methods is a list of HTTP methods that match this Route.
109-
Deprecated: use Ingress'' "konghq.com/override-protocols" annotation
110-
instead.'
109+
Deprecated: use Ingress'' "konghq.com/methods" annotation instead.'
111110
items:
112111
type: string
113112
type: array

deploy/single/all-in-one-dbless-k4k8s-enterprise.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -387,8 +387,7 @@ spec:
387387
type: integer
388388
methods:
389389
description: 'Methods is a list of HTTP methods that match this Route.
390-
Deprecated: use Ingress'' "konghq.com/override-protocols" annotation
391-
instead.'
390+
Deprecated: use Ingress'' "konghq.com/methods" annotation instead.'
392391
items:
393392
type: string
394393
type: array

deploy/single/all-in-one-dbless.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -387,8 +387,7 @@ spec:
387387
type: integer
388388
methods:
389389
description: 'Methods is a list of HTTP methods that match this Route.
390-
Deprecated: use Ingress'' "konghq.com/override-protocols" annotation
391-
instead.'
390+
Deprecated: use Ingress'' "konghq.com/methods" annotation instead.'
392391
items:
393392
type: string
394393
type: array

deploy/single/all-in-one-postgres-enterprise.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -387,8 +387,7 @@ spec:
387387
type: integer
388388
methods:
389389
description: 'Methods is a list of HTTP methods that match this Route.
390-
Deprecated: use Ingress'' "konghq.com/override-protocols" annotation
391-
instead.'
390+
Deprecated: use Ingress'' "konghq.com/methods" annotation instead.'
392391
items:
393392
type: string
394393
type: array

deploy/single/all-in-one-postgres.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -387,8 +387,7 @@ spec:
387387
type: integer
388388
methods:
389389
description: 'Methods is a list of HTTP methods that match this Route.
390-
Deprecated: use Ingress'' "konghq.com/override-protocols" annotation
391-
instead.'
390+
Deprecated: use Ingress'' "konghq.com/methods" annotation instead.'
392391
items:
393392
type: string
394393
type: array

docs/api-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ KongIngressRoute contains KongIngress route configuration. It contains the subse
131131

132132
| Field | Description |
133133
| --- | --- |
134-
| `methods` _string array_ | Methods is a list of HTTP methods that match this Route. Deprecated: use Ingress' "konghq.com/override-protocols" annotation instead. |
134+
| `methods` _string array_ | Methods is a list of HTTP methods that match this Route. Deprecated: use Ingress' "konghq.com/methods" annotation instead. |
135135
| `headers` _object (keys:string, values:string array)_ | Headers contains one or more lists of values indexed by header name that will cause this Route to match if present in the request. The Host header cannot be used with this attribute. Deprecated: use Ingress' "konghq.com/headers" annotation instead. |
136136
| `protocols` _[KongProtocol](#kongprotocol) array_ | Protocols is an array of the protocols this Route should allow. Deprecated: use Ingress' "konghq.com/protocols" annotation instead. |
137137
| `regex_priority` _integer_ | RegexPriority is a number used to choose which route resolves a given request when several routes match it using regexes simultaneously. Deprecated: use Ingress' "konghq.com/regex-priority" annotation instead. |

pkg/apis/configuration/v1/kongingress_types.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ type KongIngressService struct {
100100
// Deprecated: use Ingress' annotations instead.
101101
type KongIngressRoute struct {
102102
// Methods is a list of HTTP methods that match this Route.
103-
// Deprecated: use Ingress' "konghq.com/override-protocols" annotation instead.
103+
// Deprecated: use Ingress' "konghq.com/methods" annotation instead.
104104
Methods []*string `json:"methods,omitempty" yaml:"methods,omitempty"`
105105

106106
// Headers contains one or more lists of values indexed by header name

0 commit comments

Comments
 (0)