docs: fix cases extension accuracy against implementation#172
Merged
docs: fix cases extension accuracy against implementation#172
Conversation
- Fix audit trail event names: add `case_` prefix to match implementation
(e.g. `created` → `case_created`, `status_changed` → `case_status_changed`)
- Add missing `case_acknowledged` event to audit trail table
- Fix detection link REST API example: use correct `{"detection": {...}}`
wrapper with proper field names (cat, source, routing, detect_mtd)
- Fix telemetry add REST API example: use correct `{"event": {"routing": {...}}}`
structure instead of flat fields
- Add missing telemetry update/remove REST API examples
- Add missing artifact list/remove REST API examples
- Add missing note visibility update (PATCH) documentation
- Document GET /api/v1/orgs endpoint for listing subscribed organizations
- Clarify ingestion_mode is extension-level config (UI only), not available
through the REST config API
- Fix get_case_count docs: remove nonexistent filter params, document actual
response format (counts by status + total)
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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.
Summary
Deep review of the Cases extension documentation against the
ext-casesimplementation revealed multiple inaccuracies and missing content.Fixes
case_prefix (e.g.createdinstead ofcase_created). Fixed all 28 event names to match implementation.case_acknowledgedevent: Added to audit trail table — fires on first transition toin_progress(TTA milestone).detection_cat,detection_source,detection_priority). Fixed to use the correct{"detection": {...}}wrapper with proper LC detection structure (cat,source,routing,detect_mtd).atom/sid/event_typefields. Fixed to use{"event": {"routing": {"this": "...", "sid": "...", "event_type": "..."}}}.GET /api/v1/orgsfor listing subscribed organizations.ingestion_modeconfig: Clarified it's extension-level config (UI only), not available through the REST config API.get_case_count: Removed nonexistent filter params, documented actual response format.Test plan
ext-cases/internal/cases/types.goext-cases/internal/api/handlers*.gorequest structs🤖 Generated with Claude Code