Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: broken format displayed under JWT reference #2239

Closed
ardikabs opened this issue Nov 24, 2023 · 2 comments · Fixed by #2240
Closed

docs: broken format displayed under JWT reference #2239

ardikabs opened this issue Nov 24, 2023 · 2 comments · Fixed by #2240
Assignees
Labels
documentation Improvements or additions to documentation kind/bug Something isn't working

Comments

@ardikabs
Copy link
Contributor

ardikabs commented Nov 24, 2023

Description:
Link to v0.6.0 docs: https://gateway.envoyproxy.io/v0.6.0/api/extension_types/#jwt.
Link to latest docs: https://gateway.envoyproxy.io/latest/api/extension_types/#jwt.

image Reference:

| `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. |

Repro steps:

A newline result in the docs site to add additional columns on providers field under JWT references.
Code:

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
.

Note: If there are privacy concerns, sanitize the data prior to
sharing.

Environment:
v0.6.0 and latest

Logs:

Include the access logs and the Envoy logs.

@ardikabs ardikabs added kind/bug Something isn't working triage labels Nov 24, 2023
@zirain
Copy link
Member

zirain commented Nov 24, 2023

@ardikabs would you like to send a fix?

@ardikabs
Copy link
Contributor Author

sure @zirain .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation kind/bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants