Skip to content

Commit df03bd5

Browse files
authored
Merge pull request #1604 from youngnick/api-review-fixes
Update types to fix API review feedback
2 parents 24914d1 + 9a5e446 commit df03bd5

File tree

6 files changed

+50
-27
lines changed

6 files changed

+50
-27
lines changed

apis/v1alpha2/grpcroute_types.go

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -336,10 +336,10 @@ type GRPCMethodMatch struct {
336336
}
337337

338338
// MethodMatchType specifies the semantics of how gRPC methods and services are compared.
339-
// Valid MethodMatchType values are:
339+
// Valid MethodMatchType values, along with their conformance levels, are:
340340
//
341-
// * "Exact"
342-
// * "RegularExpression"
341+
// * "Exact" - Core
342+
// * "RegularExpression" - Implementation Specific
343343
//
344344
// Exact methods MUST be syntactically valid:
345345
//
@@ -389,10 +389,11 @@ type GRPCHeaderMatch struct {
389389
}
390390

391391
// GRPCHeaderMatchType specifies the semantics of how GRPC header values should
392-
// be compared. Valid GRPCHeaderMatchType values are:
392+
// be compared. Valid GRPCHeaderMatchType values, along with their conformance
393+
// levels, are:
393394
//
394-
// * "Exact"
395-
// * "RegularExpression"
395+
// * "Exact" - Core
396+
// * "RegularExpression" - Implementation Specific
396397
//
397398
// Note that new values may be added to this enum in future releases of the API,
398399
// implementations MUST ensure that unknown values will not cause a crash.

apis/v1alpha2/httproute_types.go

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,11 @@ type HTTPRouteSpec = v1beta1.HTTPRouteSpec
5656
type HTTPRouteRule = v1beta1.HTTPRouteRule
5757

5858
// PathMatchType specifies the semantics of how HTTP paths should be compared.
59-
// Valid PathMatchType values are:
59+
// Valid PathMatchType values, along with their conformance level, are:
6060
//
61-
// * "Exact"
62-
// * "PathPrefix"
63-
// * "RegularExpression"
61+
// * "Exact" - Core
62+
// * "PathPrefix" - Core
63+
// * "RegularExpression" - Implementation Specific
6464
//
6565
// PathPrefix and Exact paths must be syntactically valid:
6666
//
@@ -83,10 +83,10 @@ type PathMatchType = v1beta1.PathMatchType
8383
type HTTPPathMatch = v1beta1.HTTPPathMatch
8484

8585
// HeaderMatchType specifies the semantics of how HTTP header values should be
86-
// compared. Valid HeaderMatchType values are:
86+
// compared. Valid HeaderMatchType values, along with their conformance levels, are:
8787
//
88-
// * "Exact"
89-
// * "RegularExpression"
88+
// * "Exact" - Core
89+
// * "RegularExpression" - Implementation Specific
9090
//
9191
// Note that values may be added to this enum, implementations
9292
// must ensure that unknown values will not cause a crash.
@@ -124,10 +124,11 @@ type HTTPHeaderName = v1beta1.HTTPHeaderName
124124
type HTTPHeaderMatch = v1beta1.HTTPHeaderMatch
125125

126126
// QueryParamMatchType specifies the semantics of how HTTP query parameter
127-
// values should be compared. Valid QueryParamMatchType values are:
127+
// values should be compared. Valid QueryParamMatchType values, along with their
128+
// conformance levels, are:
128129
//
129-
// * "Exact"
130-
// * "RegularExpression"
130+
// * "Exact" - Core
131+
// * "RegularExpression" - Implementation Specific
131132
//
132133
// Note that values may be added to this enum, implementations
133134
// must ensure that unknown values will not cause a crash.

apis/v1beta1/gateway_types.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -494,7 +494,7 @@ type GatewayStatus struct {
494494
// +listType=map
495495
// +listMapKey=type
496496
// +kubebuilder:validation:MaxItems=8
497-
// +kubebuilder:default={{type: "Accepted", status: "Unknown", reason:"Pending", message:"Waiting for controller", lastTransitionTime: "1970-01-01T00:00:00Z"}}
497+
// +kubebuilder:default={{type: "Accepted", status: "Unknown", reason:"Pending", message:"Waiting for controller", lastTransitionTime: "1970-01-01T00:00:00Z"},{type: "Programmed", status: "Unknown", reason:"Pending", message:"Waiting for controller", lastTransitionTime: "1970-01-01T00:00:00Z"}}
498498
Conditions []metav1.Condition `json:"conditions,omitempty"`
499499

500500
// Listeners provide status for each unique listener port defined in the Spec.

apis/v1beta1/httproute_types.go

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -242,11 +242,11 @@ type HTTPRouteRule struct {
242242
}
243243

244244
// PathMatchType specifies the semantics of how HTTP paths should be compared.
245-
// Valid PathMatchType values are:
245+
// Valid PathMatchType values, along with their support levels, are:
246246
//
247-
// * "Exact"
248-
// * "PathPrefix"
249-
// * "RegularExpression"
247+
// * "Exact" - Core
248+
// * "PathPrefix" - Core
249+
// * "RegularExpression" - Implementation Specific
250250
//
251251
// PathPrefix and Exact paths must be syntactically valid:
252252
//
@@ -311,10 +311,10 @@ type HTTPPathMatch struct {
311311
}
312312

313313
// HeaderMatchType specifies the semantics of how HTTP header values should be
314-
// compared. Valid HeaderMatchType values are:
314+
// compared. Valid HeaderMatchType values, along with their conformance levels, are:
315315
//
316-
// * "Exact"
317-
// * "RegularExpression"
316+
// * "Exact" - Core
317+
// * "RegularExpression" - Implementation Specific
318318
//
319319
// Note that values may be added to this enum, implementations
320320
// must ensure that unknown values will not cause a crash.
@@ -392,10 +392,11 @@ type HTTPHeaderMatch struct {
392392
}
393393

394394
// QueryParamMatchType specifies the semantics of how HTTP query parameter
395-
// values should be compared. Valid QueryParamMatchType values are:
395+
// values should be compared. Valid QueryParamMatchType values, along with their
396+
// conformance levels, are:
396397
//
397-
// * "Exact"
398-
// * "RegularExpression"
398+
// * "Exact" - Core
399+
// * "RegularExpression" - Implementation Specific
399400
//
400401
// Note that values may be added to this enum, implementations
401402
// must ensure that unknown values will not cause a crash.

config/crd/experimental/gateway.networking.k8s.io_gateways.yaml

Lines changed: 10 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

config/crd/standard/gateway.networking.k8s.io_gateways.yaml

Lines changed: 10 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)