docs: fix broken format on JWT (#2240)

Signed-off-by: Ardika Bagus <me@ardikabs.com>
envoyproxy · Nov 24, 2023 · dcc0ee0 · dcc0ee0
1 parent 73fbd62
commit dcc0ee0
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 7 deletions.
diff --git a/api/v1alpha1/jwt_types.go b/api/v1alpha1/jwt_types.go
@@ -9,7 +9,6 @@ package v1alpha1
 type JWT struct {
 
 	// Providers defines the JSON Web Token (JWT) authentication provider type.
-	//
 	// When multiple JWT providers are specified, the JWT is considered valid if
 	// any of the providers successfully validate the JWT. For additional details,
 	// see https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/jwt_authn_filter.html.

diff --git a/charts/gateway-helm/crds/generated/gateway.envoyproxy.io_securitypolicies.yaml b/charts/gateway-helm/crds/generated/gateway.envoyproxy.io_securitypolicies.yaml
@@ -158,10 +158,10 @@ spec:
                   authentication.
                 properties:
                   providers:
-                    description: "Providers defines the JSON Web Token (JWT) authentication
-                      provider type. \n When multiple JWT providers are specified,
-                      the JWT is considered valid if any of the providers successfully
-                      validate the JWT. For additional details, see https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/jwt_authn_filter.html."
+                    description: Providers defines the JSON Web Token (JWT) authentication
+                      provider type. When multiple JWT providers are specified, the
+                      JWT is considered valid if any of the providers successfully
+                      validate the JWT. For additional details, see https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/jwt_authn_filter.html.
                     items:
                       description: JWTProvider defines how a JSON Web Token (JWT)
                         can be verified.

diff --git a/site/content/en/latest/api/extension_types.md b/site/content/en/latest/api/extension_types.md
@@ -892,8 +892,7 @@ _Appears in:_
 
 | Field | Description |
 | --- | --- |
-| `providers` _[JWTProvider](#jwtprovider) array_ | Providers defines the JSON Web Token (JWT) authentication provider type. 
- When multiple JWT providers are specified, the JWT is considered valid if any of the providers successfully validate the JWT. For additional details, see https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/jwt_authn_filter.html. |
+| `providers` _[JWTProvider](#jwtprovider) array_ | Providers defines the JSON Web Token (JWT) authentication provider type. When multiple JWT providers are specified, the JWT is considered valid if any of the providers successfully validate the JWT. For additional details, see https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/jwt_authn_filter.html. |
 
 
 #### JWTExtractor