Skip to content

docs: update CLI and helm reference for v2.51.0 - #477

Merged
mbevc1 merged 1 commit into
mainfrom
reference-docs/v2.51.0
Oct 29, 2026
Merged

mbevc1 merged 1 commit into
mainfrom
reference-docs/v2.51.0

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Automated update of CLI and Helm reference documentation for release v2.51.0.

@mintlify

mintlify Bot commented Oct 29, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
kosli 🟢 Ready View Preview Oct 29, 2026, 11:57 AM

@claude

claude Bot commented Oct 29, 2026 •

Copy link
Copy Markdown
Contributor

Claude finished @github-actions[bot]'s task in 1m 9s —— View job


Doc review — v2.51.0 reference update

The only new content in this release is the --personal flag on the five api-key commands. Most of the diff is new sample data in kosli_get_snapshot.md, kosli_log_environment.md, kosli_list_*, kosli_get_environment.md and kosli_diff_snapshots.md: new timestamps, snapshot numbers, flow lists and commit SHAs. Nothing else changes in those pages. The version line in overview.md is correct.

The PR doesn't touch the hand-written pages below, but --personal makes them out of date. They need a follow-up PR.

user/personal_api_keys.md

  • Improvement. Location: user/personal_api_keys.md:13-36. Issue: The page says personal keys can only be created and revoked in the web app (Profile → API keys). The CLI can now do this too: kosli create, list, get, rotate and delete api-key --personal. There are also two rules the reader won't find anywhere else:

    • A personal key created with another API key is revoked together with that key, and expires no later than it.
    • Deleting a key also deletes every key created with it.

    Recommendation: Add a short CLI section that links to /client_reference/kosli_create_api-key and the other four commands, and states both rules. Fix this →

administration/authentication/api_key_rotation.md

  • Improvement. Location: administration/authentication/api_key_rotation.md:7, :11, :26. Issue: The page describes rotation only for service account keys. Line 26 tells readers to "create a new personal key and revoke the old one", but kosli rotate api-key --personal now rotates personal keys directly. The page also doesn't mention a new limit: when you rotate a personal key using an API key as --api-token, you can only rotate that key and keys created with it, and the new key expires no later than that key. Recommendation: Say that personal keys can be rotated, update line 26, and add that limit to the Warning. If you want, also add a --personal example to the CLI tab in tutorials/rotating_api_keys.mdx:48. Fix this →

Upstream — does not block this merge

  • kosli-dev/cli → cmd/kosli/createApiKey.go (example "create a personal API key for yourself"). The example gives the personal key the description "key for CI". Two pages in this repo tell readers not to use personal keys in CI: user/personal_api_keys.md:10 and administration/managing_users/roles_in_kosli.md:239. Use a description like "local scripting" instead.

Summary: 0 Critical, 2 Improvement (both in follow-up pages), 1 upstream. This PR is a faithful regeneration and is fine to merge.

@mbevc1
mbevc1 merged commit 9aba4e4 into main Oct 29, 2026
6 checks passed
@mbevc1
mbevc1 deleted the reference-docs/v2.51.0 branch October 29, 2026 11:59

This branch was successfully deployed

1 active deployment
staging — 60cb84c6 Deployed Oct 29, 2026 by mintlify[bot]
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.

1 participant