Skip to content

Commit 6a5f121

Browse files
committed
Merge remote-tracking branch 'origin/main' into feat/versioned-attr-passthru
2 parents 33c2092 + 46d77e1 commit 6a5f121

File tree

9 files changed

+247
-71
lines changed

9 files changed

+247
-71
lines changed

Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

crates/stackable-operator/CHANGELOG.md

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

55
## [Unreleased]
66

7-
- BREAKING: Replace `lazy_static` with `std::cell::LazyCell` (the original implementation was done in [#827] and reverted in [#835]) ([#840]).
7+
### Fixed
8+
9+
- Fix the CRD description of `ClientAuthenticationDetails` to not contain internal Rust doc, but a public CRD description ([#846]).
10+
11+
[#846]: https://github.com/stackabletech/operator-rs/pull/846
12+
13+
## [0.74.0] - 2024-08-22
814

915
### Added
1016

11-
- `iter::reverse_if` helper ([#838]).
17+
- Add `iter::reverse_if` helper ([#838]).
18+
- Add two new constants `CONFIG_OVERRIDE_FILE_HEADER_KEY` and `CONFIG_OVERRIDE_FILE_FOOTER_KEY` ([#843]).
19+
20+
### Changed
21+
22+
- BREAKING: Replace `lazy_static` with `std::cell::LazyCell` (the original implementation was done in [#827] and reverted in [#835]) ([#840]).
23+
- BREAKING: Swap priority order of role group config and role overrides in configuration merging to prioritize overrides in general ([#841]).
1224

1325
[#838]: https://github.com/stackabletech/operator-rs/pull/838
26+
[#840]: https://github.com/stackabletech/operator-rs/pull/840
27+
[#841]: https://github.com/stackabletech/operator-rs/pull/841
28+
[#843]: https://github.com/stackabletech/operator-rs/pull/843
1429

1530
## [0.73.0] - 2024-08-09
1631

crates/stackable-operator/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[package]
22
name = "stackable-operator"
33
description = "Stackable Operator Framework"
4-
version = "0.73.0"
4+
version = "0.74.0"
55
authors.workspace = true
66
license.workspace = true
77
edition.workspace = true

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

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -125,15 +125,17 @@ 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-
/// Use [`ClientAuthenticationDetails::oidc_or_error`] to get the value or report an error to the user.
136+
/// This field contains OIDC-specific configuration. It is only required in case OIDC is used.
137+
//
138+
// 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
139141
// changing the type of an AuthenticationClass harder).

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -232,8 +232,8 @@ pub struct ClientAuthenticationOptions<T = ()> {
232232
#[serde(default)]
233233
pub extra_scopes: Vec<String>,
234234

235-
/// If desired, operators can add custom fields that are only needed for this specific product.
236-
/// They need to create a struct holding them and pass that as `T`.
235+
// If desired, operators can add custom fields that are only needed for this specific product.
236+
// They need to create a struct holding them and pass that as `T`.
237237
#[serde(flatten)]
238238
pub product_specific_fields: T,
239239
}

0 commit comments

Comments
 (0)