Skip to content

docs: reconcile cases extension docs with ext-cases codebase#173

Merged
steveatlc merged 1 commit intomasterfrom
fix/cases-docs-reconcile-codebase
Apr 3, 2026
Merged

docs: reconcile cases extension docs with ext-cases codebase#173
steveatlc merged 1 commit intomasterfrom
fix/cases-docs-reconcile-codebase

Conversation

@steveatlc
Copy link
Copy Markdown
Contributor

@steveatlc steveatlc commented Apr 3, 2026

Summary

Companion to #172 — adds 5 additional fixes found during the same codebase reconciliation that weren't covered by that PR:

  • Bulk update field limitations: clarified that only status and classification are supported (not severity, assignees, tags, etc.)
  • Markdown support: noted that summary, conclusion, and note content fields support Markdown formatting
  • Detection ingestion rate limits: documented per-org limits (100/min default, 5/min for free-tier orgs)
  • __ prefix filtering: noted that internal detections (categories starting with __) are excluded in all ingestion mode
  • tags_updated event name: fixed inline reference to use correct case_tags_updated name

Test plan

  • Verify MkDocs builds cleanly (mkdocs build)
  • Confirm detection ingestion rate limits match ext-cases/internal/cases/types.go constants

Generated with Claude Code

Fix 10 discrepancies found by comparing docs against the ext-cases source:
- Correct audit event names to use case_ prefix matching codebase
- Add missing case_acknowledged event type
- Fix Add Detection REST body to use nested detection object
- Fix Add Telemetry REST body to use event.routing structure
- Document GET /api/v1/orgs endpoint
- Document PATCH note visibility endpoint
- Clarify bulk update only supports status and classification
- Add Markdown support note for summary, conclusion, and notes
- Document detection ingestion rate limits (100/min, 5/min free)
- Note that __ prefixed categories are excluded in all mode

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@steveatlc steveatlc force-pushed the fix/cases-docs-reconcile-codebase branch from ad247a0 to 3702b29 Compare April 3, 2026 18:15
@steveatlc steveatlc merged commit a7871da into master Apr 3, 2026
2 checks passed
@steveatlc steveatlc deleted the fix/cases-docs-reconcile-codebase branch April 3, 2026 18:17
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