File tree Expand file tree Collapse file tree 2 files changed +10
-2
lines changed
crates/stackable-operator/src/crd/authentication Expand file tree Collapse file tree 2 files changed +10
-2
lines changed Original file line number Diff line number Diff line change @@ -127,11 +127,13 @@ pub mod versioned {
127127 #[ serde( rename_all = "camelCase" ) ]
128128 #[ schemars( description = "" ) ]
129129 pub struct ClientAuthenticationDetails < O = ( ) > {
130- /// Name of the [AuthenticationClass](https://docs.stackable.tech/home/nightly/concepts/authentication) used to
131- /// authenticate users.
130+ /// Name of the [`AuthenticationClass`] used to authenticate users.
132131 ///
133132 /// To get the concrete [`AuthenticationClass`], we must resolve it. This resolution can be
134133 /// achieved by using [`ClientAuthenticationDetails::resolve_class`].
134+ #[ schemars(
135+ description = "Name of the [AuthenticationClass](DOCS_BASE_URL_PLACEHOLDER/concepts/authentication) used to authenticate users"
136+ ) ]
135137 #[ serde( rename = "authenticationClass" ) ]
136138 authentication_class_ref : String ,
137139
@@ -145,6 +147,9 @@ pub mod versioned {
145147 // added, so that user can not configure multiple options at the same time (yes we are aware
146148 // that this makes a changing the type of an AuthenticationClass harder). This is a
147149 // non-breaking change though :)
150+ #[ schemars(
151+ description = "This field contains OIDC-specific configuration. It is only required in case OIDC is used."
152+ ) ]
148153 oidc : Option < oidc:: v1alpha1:: ClientAuthenticationOptions < O > > ,
149154 }
150155}
Original file line number Diff line number Diff line change @@ -105,6 +105,9 @@ pub mod versioned {
105105 /// defined in the [`AuthenticationClass`][1].
106106 ///
107107 /// [1]: crate::crd::authentication::core::v1alpha1::AuthenticationClass
108+ #[ schemars(
109+ description = "An optional list of extra scopes which get merged with the scopes defined in the `AuthenticationClass`."
110+ ) ]
108111 #[ serde( default ) ]
109112 pub extra_scopes : Vec < String > ,
110113
You can’t perform that action at this time.
0 commit comments