File tree Expand file tree Collapse file tree 2 files changed +11
-5
lines changed
crates/stackable-operator
src/commons/authentication Expand file tree Collapse file tree 2 files changed +11
-5
lines changed Original file line number Diff line number Diff line change @@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
4
4
5
5
## [ Unreleased]
6
6
7
+ ### Fixed
8
+
9
+ - Fix the CRD description of ` ClientAuthenticationDetails ` to not contain internal Rust doc, but a public CRD description([ #XXX] ).
10
+
7
11
## [ 0.74.0] - 2024-08-22
8
12
9
13
### Added
Original file line number Diff line number Diff line change @@ -125,14 +125,16 @@ impl AuthenticationClass {
125
125
#[ serde( rename_all = "camelCase" ) ]
126
126
#[ schemars( description = "" ) ]
127
127
pub struct ClientAuthenticationDetails < O = ( ) > {
128
- /// A name/key which references an authentication class. To get the concrete
129
- /// [`AuthenticationClass`], we must resolve it. This resolution can be
130
- /// achieved by using [`ClientAuthenticationDetails::resolve_class`].
128
+ /// Name of the [AuthenticationClass](https://docs.stackable.tech/home/nightly/concepts/authentication) used to
129
+ /// authenticate users.
130
+ //
131
+ // To get the concrete [`AuthenticationClass`], we must resolve it. This resolution can be achieved by using
132
+ // [`ClientAuthenticationDetails::resolve_class`].
131
133
#[ serde( rename = "authenticationClass" ) ]
132
134
authentication_class_ref : String ,
133
135
134
- /// This field contains authentication provider specific configuration.
135
- ///
136
+ /// This field contains OIDC- specific configuration. It is only required in case OIDC is used .
137
+ //
136
138
/// Use [`ClientAuthenticationDetails::oidc_or_error`] to get the value or report an error to the user.
137
139
// TODO: Ideally we want this to be an enum once other `ClientAuthenticationOptions` are added, so
138
140
// that user can not configure multiple options at the same time (yes we are aware that this makes a
You can’t perform that action at this time.
0 commit comments