Skip to content

Commit b6fb76b

Browse files
committed
Add additional comments
1 parent d91b389 commit b6fb76b

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

docs/proposals/authentication-filter.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,11 +113,13 @@ type AuthenticationFilterSpec struct {
113113
Type AuthType `json:"type"`
114114

115115
// Basic configures HTTP Basic Authentication.
116+
// Required when Type == Basic
116117
//
117118
// +optional
118119
Basic *BasicAuth `json:"basic,omitempty"`
119120

120121
// JWT configures JSON Web Token authentication (NGINX Plus).
122+
// Required when Type == JWT
121123
//
122124
// +optional
123125
JWT *JWTAuth `json:"jwt,omitempty"`
@@ -170,6 +172,7 @@ type JWTAuth struct {
170172
Mode JWTKeyMode `json:"mode,omitempty"`
171173

172174
// File specifies local JWKS configuration.
175+
// Required when Mode == File.
173176
//
174177
// +optional
175178
File *JWTFileKeySource `json:"file,omitempty"`

0 commit comments

Comments
 (0)