API cleanup #11606
Open
API cleanup #11606
+238
−181
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Jenny Shu <[email protected]>
Signed-off-by: Jenny Shu <[email protected]>
Signed-off-by: Jenny Shu <[email protected]>
Signed-off-by: Jenny Shu <[email protected]>
github-actions
bot
added
do-not-merge/kind-invalid
Signed-off-by: Jenny Shu <[email protected]>
Signed-off-by: Jenny Shu <[email protected]>
Signed-off-by: Jenny Shu <[email protected]>
Signed-off-by: Jenny Shu <[email protected]>
github-actions
bot
added
kind/cleanup
shashankram
reviewed
Jul 8, 2025
Signed-off-by: Jenny Shu <[email protected]>
shashankram
reviewed
Jul 8, 2025
Comment on lines
+175
to
+177
| aggression := ptr.Deref(ir.aggression, "") | ||
| if aggression != "" { | ||
| aggressionValue, err := strconv.ParseFloat(aggression, 64) |
There was a problem hiding this comment.
Use nil checks and add MinLength validations to string values to prevent empty
Suggested change
| aggression := ptr.Deref(ir.aggression, "") | |
| if aggression != "" { | |
| aggressionValue, err := strconv.ParseFloat(aggression, 64) | |
| if ir.aggression != nil { | |
| aggressionValue, err := strconv.ParseFloat(*ir.aggression, 64) |
| @@ -207,7 +207,7 @@ type TLS struct { | |||
|
|
|||
| // The SNI domains that should be considered for TLS connection | |||
| // +optional | |||
| Sni string `json:"sni,omitempty"` | |||
| Sni *string `json:"sni,omitempty"` | |||
There was a problem hiding this comment.
Needs MinLength validation
Comment on lines
+270
to
+276
| TLSCertificate *string `json:"tlsCertificate,omitempty"` | ||
|
|
||
| // +optional | ||
| TLSKey string `json:"tlsKey,omitempty"` | ||
| TLSKey *string `json:"tlsKey,omitempty"` | ||
|
|
||
| // +optional | ||
| RootCA string `json:"rootCA,omitempty"` | ||
| RootCA *string `json:"rootCA,omitempty"` |
There was a problem hiding this comment.
Add MinLength validation
| @@ -181,7 +181,7 @@ type AwsLambda struct { | |||
| // (alphanumeric plus "-" or "_"), or the special literal "$LATEST". | |||
| // +optional | |||
| // +kubebuilder:validation:Pattern="^(\\$LATEST|[0-9]+|[A-Za-z0-9-_]{1,128})$" | |||
| Qualifier string `json:"qualifier,omitempty"` | |||
| Qualifier *string `json:"qualifier,omitempty"` | |||
There was a problem hiding this comment.
We should default this to $LATEST
func buildLambdaARN(in *v1alpha1.AwsBackend, region string) (string, error) {
qualifier := "$LATEST"
if in.Lambda.Qualifier != "" {
qualifier = in.Lambda.Qualifier
}
| @@ -42,7 +42,7 @@ type DirectResponseSpec struct { | |||
| // | |||
| // +kubebuilder:validation:MaxLength=4096 | |||
| // +optional | |||
| Body string `json:"body,omitempty"` | |||
| Body *string `json:"body,omitempty"` | |||
There was a problem hiding this comment.
Add MinLength validation
| @@ -124,13 +125,14 @@ func createRateLimitActions(descriptors []v1alpha1.RateLimitDescriptor) ([]*rout | |||
| }, | |||
| } | |||
| case v1alpha1.RateLimitDescriptorEntryTypeHeader: | |||
| if entry.Header == "" { | |||
| header := ptr.Deref(entry.Header, "") | |||
There was a problem hiding this comment.
Change to nil check and prevent empty header value using MinLength validation
timflannagan
reviewed
Jul 8, 2025
| - RBAC roles are generated in [install/helm/kgateway/templates/role.yaml](/install/helm/kgateway/templates/role.yaml) | ||
| - Updates the [api/applyconfiguration](/api/applyconfiguration), [pkg/generated](/pkg/generated) and [pkg/client](/pkg/client) folders with kube clients. These are used in plugin initialization and the fake client is used in tests. | ||
|
|
||
| ## API guidelines |
There was a problem hiding this comment.
Another potential line item: how to handle time related fields. The approach we've been taking is meta.Duration + CEL validation.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Some cleanup in our APIs for consistency:
omitemptyif it wasn't already there+optional/+requiredrather than the kubebuilder markersChange Type
/kind cleanup
Changelog
Additional Notes