Merge branch 'main' into feat/crd-versioning-type-change

Author: Techassi

Cargo.lock

@@ -4,9 +4,17 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+### Fixed
+
+- Fix the CRD description of `ClientAuthenticationDetails` to not contain internal Rust doc, but a public CRD description ([#846]).
+
+[#846]: https://github.com/stackabletech/operator-rs/pull/846
+
+## [0.74.0] - 2024-08-22
+
 ### Added
 
-- `iter::reverse_if` helper ([#838]).
+- Add `iter::reverse_if` helper ([#838]).
 - Add two new constants `CONFIG_OVERRIDE_FILE_HEADER_KEY` and `CONFIG_OVERRIDE_FILE_FOOTER_KEY` ([#843]).
 
 ### Changed
@@ -15,6 +23,7 @@ All notable changes to this project will be documented in this file.
 - BREAKING: Swap priority order of role group config and role overrides in configuration merging to prioritize overrides in general ([#841]).
 
 [#838]: https://github.com/stackabletech/operator-rs/pull/838
+[#840]: https://github.com/stackabletech/operator-rs/pull/840
 [#841]: https://github.com/stackabletech/operator-rs/pull/841
 [#843]: https://github.com/stackabletech/operator-rs/pull/843
 

crates/stackable-operator/CHANGELOG.md

@@ -1,7 +1,7 @@
 [package]
 name = "stackable-operator"
 description = "Stackable Operator Framework"
-version = "0.73.0"
+version = "0.74.0"
 authors.workspace = true
 license.workspace = true
 edition.workspace = true

crates/stackable-operator/Cargo.toml

@@ -125,15 +125,17 @@ impl AuthenticationClass {
 #[serde(rename_all = "camelCase")]
 #[schemars(description = "")]
 pub struct ClientAuthenticationDetails<O = ()> {
-    /// A name/key which references an authentication class. To get the concrete
-    /// [`AuthenticationClass`], we must resolve it. This resolution can be
-    /// achieved by using [`ClientAuthenticationDetails::resolve_class`].
+    /// Name of the [AuthenticationClass](https://docs.stackable.tech/home/nightly/concepts/authentication) used to
+    /// authenticate users.
+    //
+    // To get the concrete [`AuthenticationClass`], we must resolve it. This resolution can be achieved by using
+    // [`ClientAuthenticationDetails::resolve_class`].
     #[serde(rename = "authenticationClass")]
     authentication_class_ref: String,
 
-    /// This field contains authentication provider specific configuration.
-    ///
-    /// Use [`ClientAuthenticationDetails::oidc_or_error`] to get the value or report an error to the user.
+    /// This field contains OIDC-specific configuration. It is only required in case OIDC is used.
+    //
+    // Use [`ClientAuthenticationDetails::oidc_or_error`] to get the value or report an error to the user.
     // TODO: Ideally we want this to be an enum once other `ClientAuthenticationOptions` are added, so
     // that user can not configure multiple options at the same time (yes we are aware that this makes a
     // changing the type of an AuthenticationClass harder).

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

@@ -232,8 +232,8 @@ pub struct ClientAuthenticationOptions<T = ()> {
     #[serde(default)]
     pub extra_scopes: Vec<String>,
 
-    /// If desired, operators can add custom fields that are only needed for this specific product.
-    /// They need to create a struct holding them and pass that as `T`.
+    // If desired, operators can add custom fields that are only needed for this specific product.
+    // They need to create a struct holding them and pass that as `T`.
     #[serde(flatten)]
     pub product_specific_fields: T,
 }