docs: remove retired approvals from the docs - #345
Merged
Conversation
CLI v2.35.0 removed the approval commands and server #6309 removed the approval API from prod, so the hand-written pages that still describe approvals now document something users cannot do. The release automation only regenerates client_reference/ and the CLI nav, so everything here needed doing by hand. Add redirects for the five deleted client_reference pages - the update-cli-docs workflow deletes pages but never touches config/redirects.json, so those URLs were serving 404s to anyone arriving from a bookmark or a search result. Drop the approvals array from the documented custom-webhook payload, and the deployments array with it: the payload builder emits neither, and the deployments collection was dropped long ago. Repoint the kosli get trail live example at a July 2026 trail. The pinned March 2024 trail contains artifact_approval_reported events, and since the page is generated the only way to stop them reappearing on every CLI release is to pin a trail from after cyber-dojo stopped reporting approvals. Correct the built-in attestation type lists in the glossary and the controls table: approval was never an attestation type - the built-ins are generic, junit, snyk, pull_request, jira and sonar. Remove the now-dead kosli report approval live-docs modifier, and move the two tests that used it as their fixture onto commands that still exist. Docs stay slightly ahead of the server on roles: MEMBER still holds the update_approval UI action for legacy approvals, but nothing can create an approval any more, so the roles page should not advertise it.
Contributor
|
Claude finished @ToreMerkely's task in 2m 17s —— View job PR Review: Remove retired approvals from the docs
Clean, thorough removal. The changes are consistent across roles, webhook payload, tutorials, glossary, and controls. Redirects for the five deleted CLI reference pages are correct. Changelog entries follow the One thing slipped through the sweep: Improvement
This is the same issue fixed in File-by-file notes
Summary
Overall this is a well-scoped cleanup PR. The one missed file is a minor consistency issue. |
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
mbevc1
approved these changes
Jul 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Approvals are being retired (kosli-dev/server#5125). CLI v2.35.0 removed the approval commands and server kosli-dev/server#6309 removed the approval API, which is now in prod.
The
update-cli-docsworkflow already deleted the five generatedclient_referencepages and their nav entries in #343. This PR covers everything that automation cannot do.Changes
config/redirects.jsongets the five deletedclient_reference/kosli_*approval*URLs pointing at/client_reference/overview. The workflow deletes pages but never touches redirects, so those URLs were 404ing for bookmarks and search hits.tutorials/cli_and_http_proxy.md— removed thekosli request approvalexample; the page still shows two proxy examples.integrations/kosli_actions.md— the documented custom-webhook payload now matchesMessageProvider._webhook_base_payload: dropped theapprovalsarray, and thedeploymentsarray with it (the builder emits neither, and thedeploymentscollection was dropped long ago — stale independently of #5125).administration/managing_users/roles_in_kosli.md— removed the permission-matrix row and the four per-role bullets.understand_kosli/glossary.md/controls.md—approvalwas never a built-in attestation type; the built-ins aregeneric,junit,snyk,pull_request,jira,sonar.kosli get traillive example — repointed from the pinned March 2024 trail (which containsartifact_approval_reportedevents) toe4757683b74df7033c95aa544a7824b395c2f8bb(July 2026, 16 events, no approvals), and regenerated the page. Since the page is generated, pinning a newer trail is the only way to stop the approval events reappearing on every CLI release.kosli report approvalmodifier entry and moved the two tests that used it as their fixture onto commands that still exist.Test plan
pytest tests/— 22 passedpython scripts/test_update_cli_nav.py— PASSmint broken-links— no new breakages (the one hit,/getting_started/service-accountsintutorials/working_with_controls.mdx, is pre-existing and untouched here)rg -in approvalsweep — only concept/PR-approval prose and thehas-approvalpolicy name remainLive-docs test fixtures were deliberately left unrefreshed: regenerating them rewrites all five files with fresh live data and the suite passes without it.
🤖 Generated with Claude Code