From dcc0ee070489453ce53dfdd4b68d55acc773b34b Mon Sep 17 00:00:00 2001 From: Ardika Bagus S Date: Fri, 24 Nov 2023 18:44:39 +0700 Subject: [PATCH] docs: fix broken format on JWT (#2240) Signed-off-by: Ardika Bagus --- api/v1alpha1/jwt_types.go | 1 - .../generated/gateway.envoyproxy.io_securitypolicies.yaml | 8 ++++---- site/content/en/latest/api/extension_types.md | 3 +-- 3 files changed, 5 insertions(+), 7 deletions(-) diff --git a/api/v1alpha1/jwt_types.go b/api/v1alpha1/jwt_types.go index 1b9ca41d42d..6700d28b854 100644 --- 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 index 2d32a0fa114..944672a9a99 100644 --- 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 index 0c5519f1b61..7379bf3cef7 100644 --- 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