jwt_authn docs: fix Protobuf YAML examples (#3924)

Make the YAML examples use lists for `audiences` and avoid starting
lists for non-repeating fields.

Risk Level: Low
Testing: N/A
Docs Changes: N/A
Release Notes: N/A

Signed-off-by: Tal Nordan <tal.nordan@solo.io>

Mirrored from https://github.com/envoyproxy/envoy @ c4b6aecdd1bf5fb7a05a3f2a6f58e6ec42dc1393
pull/620/head
data-plane-api(CircleCI) 6 years ago
parent 38249244f7
commit c04c00865a
  1. 22
      envoy/config/filter/http/jwt_authn/v2alpha/config.proto

@ -22,13 +22,13 @@ import "validate/validate.proto";
// issuer: https://example.com // issuer: https://example.com
// audiences: // audiences:
// - bookstore_android.apps.googleusercontent.com // - bookstore_android.apps.googleusercontent.com
// bookstore_web.apps.googleusercontent.com // - bookstore_web.apps.googleusercontent.com
// remote_jwks: // remote_jwks:
// - http_uri: // http_uri:
// - uri: https://example.com/.well-known/jwks.json // uri: https://example.com/.well-known/jwks.json
// cluster: example_jwks_cluster // cluster: example_jwks_cluster
// cache_duration: // cache_duration:
// - seconds: 300 // seconds: 300
// //
// [#not-implemented-hide:] // [#not-implemented-hide:]
message JwtProvider { message JwtProvider {
@ -50,7 +50,7 @@ message JwtProvider {
// //
// audiences: // audiences:
// - bookstore_android.apps.googleusercontent.com // - bookstore_android.apps.googleusercontent.com
// bookstore_web.apps.googleusercontent.com // - bookstore_web.apps.googleusercontent.com
// //
repeated string audiences = 2; repeated string audiences = 2;
@ -67,11 +67,11 @@ message JwtProvider {
// .. code-block:: yaml // .. code-block:: yaml
// //
// remote_jwks: // remote_jwks:
// - http_uri: // http_uri:
// - uri: https://www.googleapis.com/oauth2/v1/certs // uri: https://www.googleapis.com/oauth2/v1/certs
// cluster: jwt.www.googleapis.com|443 // cluster: jwt.www.googleapis.com|443
// cache_duration: // cache_duration:
// - seconds: 300 // seconds: 300
// //
RemoteJwks remote_jwks = 3; RemoteJwks remote_jwks = 3;
@ -83,14 +83,14 @@ message JwtProvider {
// .. code-block:: yaml // .. code-block:: yaml
// //
// local_jwks: // local_jwks:
// - filename: /etc/envoy/jwks/jwks1.txt // filename: /etc/envoy/jwks/jwks1.txt
// //
// Example: inline_string // Example: inline_string
// //
// .. code-block:: yaml // .. code-block:: yaml
// //
// local_jwks: // local_jwks:
// - inline_string: "ACADADADADA" // inline_string: "ACADADADADA"
// //
envoy.api.v2.core.DataSource local_jwks = 4; envoy.api.v2.core.DataSource local_jwks = 4;
} }
@ -163,7 +163,7 @@ message RemoteJwks {
// .. code-block:: yaml // .. code-block:: yaml
// //
// http_uri: // http_uri:
// - uri: https://www.googleapis.com/oauth2/v1/certs // uri: https://www.googleapis.com/oauth2/v1/certs
// cluster: jwt.www.googleapis.com|443 // cluster: jwt.www.googleapis.com|443
// //
envoy.api.v2.core.HttpUri http_uri = 1; envoy.api.v2.core.HttpUri http_uri = 1;

Loading…
Cancel
Save