Skip to content

Commit 86c16e3

Browse files
committed
fix: Fix the CRD description of ClientAuthenticationDetails
1 parent c77a542 commit 86c16e3

File tree

2 files changed

+11
-5
lines changed

2 files changed

+11
-5
lines changed

crates/stackable-operator/CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
44

55
## [Unreleased]
66

7+
### Fixed
8+
9+
- Fix the CRD description of `ClientAuthenticationDetails` to not contain internal Rust doc, but a public CRD description([#XXX]).
10+
711
## [0.74.0] - 2024-08-22
812

913
### Added

crates/stackable-operator/src/commons/authentication/mod.rs

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -125,14 +125,16 @@ impl AuthenticationClass {
125125
#[serde(rename_all = "camelCase")]
126126
#[schemars(description = "")]
127127
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`].
131133
#[serde(rename = "authenticationClass")]
132134
authentication_class_ref: String,
133135

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+
//
136138
/// Use [`ClientAuthenticationDetails::oidc_or_error`] to get the value or report an error to the user.
137139
// TODO: Ideally we want this to be an enum once other `ClientAuthenticationOptions` are added, so
138140
// that user can not configure multiple options at the same time (yes we are aware that this makes a

0 commit comments

Comments
 (0)