Files
Claude-Code-Workflow/.codex/skills/spec-generator/templates/profiles/api-profile.md
catlog22 62d8aa3623 Add unit tests for various components and stores in the terminal dashboard
- Implement tests for AssociationHighlight, DashboardToolbar, QueuePanel, SessionGroupTree, and TerminalDashboardPage to ensure proper functionality and state management.
- Create tests for cliSessionStore, issueQueueIntegrationStore, queueExecutionStore, queueSchedulerStore, sessionManagerStore, and terminalGridStore to validate state resets and workspace scoping.
- Mock necessary dependencies and state management hooks to isolate tests and ensure accurate behavior.
2026-03-08 21:38:20 +08:00

1.4 KiB

API Spec Profile

Defines additional required sections for API-type specifications.

Required Sections (in addition to base template)

In Architecture Document

  • Endpoint Definition: MUST list all endpoints with method, path, auth, request/response schema
  • Authentication Model: MUST define auth mechanism (OAuth2/JWT/API Key), token lifecycle
  • Rate Limiting: MUST define rate limits per tier/endpoint, throttling behavior
  • Error Codes: MUST define error response format, standard error codes with descriptions
  • API Versioning: MUST define versioning strategy (URL/header/query), deprecation policy
  • Pagination: SHOULD define pagination strategy for list endpoints
  • Idempotency: SHOULD define idempotency requirements for write operations

In Requirements Document

  • Endpoint Acceptance Criteria: Each requirement SHOULD map to specific endpoints
  • SLA Definitions: MUST define response time, availability targets per endpoint tier

Quality Gate Additions

Check Criteria Severity
Endpoints documented All endpoints with method + path Error
Auth model defined Authentication mechanism specified Error
Error codes defined Standard error format + codes Warning
Rate limits defined Per-endpoint or per-tier limits Warning
API versioning strategy Versioning approach specified Warning