Skip to content

docs(clickstack): clarify dashboard validation and update bodies - #741

Merged
sdairs merged 1 commit into
stack/691-cdc-table-mappingsfrom
stack/693-validation-guidance
Sep 7, 2026
Merged

docs(clickstack): clarify dashboard validation and update bodies#741
sdairs merged 1 commit into
stack/691-cdc-table-mappingsfrom
stack/693-validation-guidance

Conversation

@sdairs

@sdairs sdairs commented Sep 5, 2026

Copy link
Copy Markdown
Collaborator

Problem

The dashboard documentation said dashboard validate could check the same body before either create or update. The validation command accepts the create dashboard schema, while updates use a distinct full replacement schema whose existing filters require their id values.

Result

  • Describe dashboard validate as create-body validation only.
  • Keep the dashboard update full replacement warning and tell users to preserve every existing filter ID.
  • Add a concrete update filter example and align the validate/update command help with those schemas.

Schema evidence

The typed validation method accepts ClickStackCreateDashboardRequest, whose filters are ClickStackFilterInput values without an id. ClickStackUpdateDashboardRequest instead uses ClickStackFilter, where id is required.

Validation

  • cargo fmt --all
  • cargo test -p clickhousectl clickstack::tests
  • cargo clippy -p clickhousectl -- -D warnings
  • cargo check -p clickhousectl --no-default-features
  • cargo clippy -p clickhousectl --all-targets --no-default-features -- -D warnings
  • Rendered dashboard validate --help and dashboard update --help

Refs #693

Follow-up to #718

@iskakaushik iskakaushik left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@sdairs
sdairs merged commit e4a5c8b into main Sep 7, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

ClickStack: expose dashboard CRUD and validation with full configuration support Support ClickStack in cloud commands

2 participants