Skip to content

fix: Fix the JSON schema of JsonConfigOverrides #1245

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
siegfriedweber merged 3 commits into from
Jul 7, 2026
Merged

fix: Fix the JSON schema of JsonConfigOverrides #1245

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
267de29
fix: Fix the JSON schema of JsonConfigOverrides
siegfriedweber Jul 7, 2026
8d7f40f
test: Test JsonConfigOverrides in the DummyCluster instead of a unit …
siegfriedweber Jul 7, 2026
3b98323
Extend the documentation of the userProvided JsonConfigOverrides
siegfriedweber Jul 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions crates/stackable-operator/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,10 @@ All notable changes to this project will be documented in this file.
### Fixed

- [v2] Don't require the `attributed_string_type` macro caller to have `std::str::FromStr` in scope ([#1244]).
- [v2] Fix the JSON schema of `JsonConfigOverrides` ([#1245]).

[#1244]: https://github.com/stackabletech/operator-rs/pull/1244
[#1245]: https://github.com/stackabletech/operator-rs/pull/1245

## [0.113.2] - 2026-07-07

Expand Down
80 changes: 16 additions & 64 deletions crates/stackable-operator/crds/DummyCluster.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -979,7 +979,7 @@ spec:
- required:
- jsonMergePatch
- required:
- jsonPatches
- jsonPatch
- required:
- userProvided
properties:
Expand All @@ -989,50 +989,26 @@ spec:
[RFC 7396](https://datatracker.ietf.org/doc/html/rfc7396) JSON merge patch.
type: object
x-kubernetes-preserve-unknown-fields: true
jsonPatches:
jsonPatch:
description: |-
List of [RFC 6902](https://datatracker.ietf.org/doc/html/rfc6902) JSON patches.
An [RFC 6902](https://datatracker.ietf.org/doc/html/rfc6902) JSON patch.

Can be used when more flexibility is needed, e.g. to only modify elements
in a list based on a condition.

A patch looks something like

`{"op": "test", "path": "/0/name", "value": "Andrew"}`
`- {"op": "test", "path": "/0/name", "value": "Andrew"}`

or

`{"op": "add", "path": "/0/happy", "value": true}`
`- {"op": "add", "path": "/0/happy", "value": true}`
items:
type: string
type: object
x-kubernetes-preserve-unknown-fields: true
type: array
userProvided:
description: |-
Override the entire config file with the specified JSON document.

Please note that you can in-line JSON into YAML as follows:

```yaml
# ... other YAML content
userProvided: {
"myString": "test",
"myList": ["test"],
"myBool": true,
"my": {"nested.field.with.dots": 42}
}
```

As an alternative you can also stick to YAML:

```yaml
# ... other YAML content
userProvided:
myString: test
myList: [test]
myBool: true
my:
nested.field.with.dots: 42
```
description: Override the entire config file with the specified JSON value.
Comment thread
sbernauer marked this conversation as resolved.
Outdated
type: object
x-kubernetes-preserve-unknown-fields: true
type: object
Expand Down Expand Up @@ -1657,7 +1633,7 @@ spec:
- required:
- jsonMergePatch
- required:
- jsonPatches
- jsonPatch
- required:
- userProvided
properties:
Expand All @@ -1667,50 +1643,26 @@ spec:
[RFC 7396](https://datatracker.ietf.org/doc/html/rfc7396) JSON merge patch.
type: object
x-kubernetes-preserve-unknown-fields: true
jsonPatches:
jsonPatch:
description: |-
List of [RFC 6902](https://datatracker.ietf.org/doc/html/rfc6902) JSON patches.
An [RFC 6902](https://datatracker.ietf.org/doc/html/rfc6902) JSON patch.

Can be used when more flexibility is needed, e.g. to only modify elements
in a list based on a condition.

A patch looks something like

`{"op": "test", "path": "/0/name", "value": "Andrew"}`
`- {"op": "test", "path": "/0/name", "value": "Andrew"}`

or

`{"op": "add", "path": "/0/happy", "value": true}`
`- {"op": "add", "path": "/0/happy", "value": true}`
items:
type: string
type: object
x-kubernetes-preserve-unknown-fields: true
type: array
userProvided:
description: |-
Override the entire config file with the specified JSON document.

Please note that you can in-line JSON into YAML as follows:

```yaml
# ... other YAML content
userProvided: {
"myString": "test",
"myList": ["test"],
"myBool": true,
"my": {"nested.field.with.dots": 42}
}
```

As an alternative you can also stick to YAML:

```yaml
# ... other YAML content
userProvided:
myString: test
myList: [test]
myBool: true
my:
nested.field.with.dots: 42
```
description: Override the entire config file with the specified JSON value.
type: object
x-kubernetes-preserve-unknown-fields: true
type: object
Expand Down
7 changes: 5 additions & 2 deletions crates/stackable-operator/src/v2/config_overrides.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@ use serde_json::json;
use tracing::warn;

use crate::{
config::merge::Merge, k8s_openapi::DeepMerge, schemars, utils::crds::raw_object_schema,
config::merge::Merge,
k8s_openapi::DeepMerge,
schemars,
utils::crds::{raw_object_list_schema, raw_object_schema},
};

// Variant of [`crate::config_overrides::KeyValueConfigOverrides`] that implements
Expand Down Expand Up @@ -93,7 +96,7 @@ pub enum JsonConfigOverrides {
/// or
///
/// `- {"op": "add", "path": "/0/happy", "value": true}`
#[schemars(schema_with = "raw_object_schema")]
#[schemars(schema_with = "raw_object_list_schema")]
JsonPatch(json_patch::Patch),

/// Override the entire config file with the specified JSON value.
Expand Down
8 changes: 6 additions & 2 deletions crates/xtask/src/crd/dummy.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,11 @@ use serde::{Deserialize, Serialize};
use stackable_operator::{
commons::resources::{JvmHeapLimits, Resources},
config::fragment::Fragment,
config_overrides::{JsonConfigOverrides, KeyValueConfigOverrides, KeyValueOverridesProvider},
crd::{authentication, authentication::oidc, git_sync::v1alpha2::GitSync},
config_overrides::{KeyValueConfigOverrides, KeyValueOverridesProvider},
crd::{
authentication::{self, oidc},
git_sync::v1alpha2::GitSync,
},
database_connections::{
databases::{
derby::DerbyConnection, mysql::MysqlConnection, postgresql::PostgresqlConnection,
Expand All @@ -21,6 +24,7 @@ use stackable_operator::{
role_utils::Role,
schemars::JsonSchema,
status::condition::ClusterCondition,
v2::config_overrides::JsonConfigOverrides,
versioned::versioned,
};
use strum::EnumIter;
Expand Down