mirror of
https://github.com/catlog22/Claude-Code-Workflow.git
synced 2026-03-07 16:41:06 +08:00
fb4f6e718e
- Added `__init__.py` in `codexlens/tools` for documentation generation. - Created `deepwiki_generator.py` to handle symbol extraction and markdown generation. - Introduced `MockMarkdownGenerator` for testing purposes. - Implemented `DeepWikiGenerator` class for managing documentation generation and file processing. - Added unit tests for `DeepWikiStore` to ensure proper functionality and error handling. - Created tests for DeepWiki TypeScript types matching.
1.4 KiB
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 |