chore: rename allowMissing to optional

Signed-off-by: Ardika Bagus <me@ardikabs.com>
envoyproxy · Apr 17, 2024 · b90ad69 · b90ad69
1 parent 33b3bc0
commit b90ad69
Show file tree

Hide file tree

Showing 7 changed files with 124 additions and 125 deletions.
diff --git a/api/v1alpha1/jwt_types.go b/api/v1alpha1/jwt_types.go
@@ -8,9 +8,9 @@ package v1alpha1
 // JWT defines the configuration for JSON Web Token (JWT) authentication.
 type JWT struct {
 
-	// AllowMissing determines whether a missing JWT is acceptable, defaulting to false if not specified.
-	// Note: Even if allowMissing is set to true, JWT authentication will still fail if an invalid JWT is presented.
-	AllowMissing *bool `json:"allowMissing,omitempty"`
+	// Optional determines whether a missing JWT is acceptable, defaulting to false if not specified.
+	// Note: Even if optional is set to true, JWT authentication will still fail if an invalid JWT is presented.
+	Optional *bool `json:"optional,omitempty"`
 
 	// Providers defines the JSON Web Token (JWT) authentication provider type.
 	// When multiple JWT providers are specified, the JWT is considered valid if

diff --git a/api/v1alpha1/zz_generated.deepcopy.go b/api/v1alpha1/zz_generated.deepcopy.go
diff --git a/charts/gateway-helm/crds/generated/gateway.envoyproxy.io_securitypolicies.yaml b/charts/gateway-helm/crds/generated/gateway.envoyproxy.io_securitypolicies.yaml
@@ -422,10 +422,10 @@ spec:
                 description: JWT defines the configuration for JSON Web Token (JWT)
                   authentication.
                 properties:
-                  allowMissing:
+                  optional:
                     description: |-
-                      AllowMissing determines whether a missing JWT is acceptable, defaulting to false if not specified.
-                      Note: Even if allowMissing is set to true, JWT authentication will still fail if an invalid JWT is presented.
+                      Optional determines whether a missing JWT is acceptable, defaulting to false if not specified.
+                      Note: Even if optional is set to true, JWT authentication will still fail if an invalid JWT is presented.
                     type: boolean
                   providers:
                     description: |-

diff --git a/internal/gatewayapi/securitypolicy.go b/internal/gatewayapi/securitypolicy.go
@@ -527,7 +527,7 @@ func wildcard2regex(wildcard string) string {
 
 func (t *Translator) buildJWT(jwt *egv1a1.JWT) *ir.JWT {
 	return &ir.JWT{
-		AllowMissing: ptr.Deref(jwt.AllowMissing, false),
+		AllowMissing: ptr.Deref(jwt.Optional, false),
 		Providers:    jwt.Providers,
 	}
 }

diff --git a/internal/gatewayapi/testdata/securitypolicy-with-jwt-optional.in.yaml b/internal/gatewayapi/testdata/securitypolicy-with-jwt-optional.in.yaml
@@ -124,4 +124,4 @@ securityPolicies:
           - session_access_token
           params:
           - token
-      allowMissing: true
+      optional: true
diff --git a/internal/gatewayapi/testdata/securitypolicy-with-jwt-optional.out.yaml b/internal/gatewayapi/testdata/securitypolicy-with-jwt-optional.out.yaml
@@ -160,7 +160,7 @@ infraIR:
         name: envoy-gateway/gateway-1/http
         ports:
         - containerPort: 10080
-          name: http
+          name: http-80
           protocol: HTTP
           servicePort: 80
       metadata:
@@ -175,7 +175,7 @@ infraIR:
         name: envoy-gateway/gateway-2/http
         ports:
         - containerPort: 10080
-          name: http
+          name: http-80
           protocol: HTTP
           servicePort: 80
       metadata:
@@ -192,7 +192,7 @@ securityPolicies:
     namespace: default
   spec:
     jwt:
-      allowMissing: true
+      optional: true
       providers:
       - audiences:
         - three.foo.com

diff --git a/site/content/en/latest/api/extension_types.md b/site/content/en/latest/api/extension_types.md