quaik8/sdb2-claude
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update CLAUDE.md to add health check endpoint and reorganize API documentation links for clarity

Browse Source
This commit is contained in:
JSC
2025-08-16 01:23:39 +02:00
parent 267ff65da4
commit f054b0143e
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
CLAUDE.md
View File

@@ -595,9 +595,10 @@ Multiple API documentation interfaces with modern documentation tools.
### Documentation Interfaces ### Documentation Interfaces
- **Swagger UI**: Available at `/api/docs` - Interactive API exploration - **Swagger UI**: Available at `/api/docs` - Interactive API exploration
- **ReDoc**: Available at `/api/redoc` - Clean, responsive documentation - **ReDoc**: Available at `/api/redoc` - Clean, responsive documentation
- **Scalar**: Available at `/api/v1/scalar-docs` - Modern API reference - **Health Check**: Available at `/api/v1/health` - API health status endpoint
- **RapiDoc**: Available at `/api/v1/rapidoc-docs` - Fast, customizable docs - **Scalar**: Available at `/api/v1/docs/scalar` - Modern API reference
- **Stoplight Elements**: Available at `/api/v1/elements-docs` - Feature-rich documentation - **RapiDoc**: Available at `/api/v1/docs/rapidoc` - Fast, customizable docs
- **Stoplight Elements**: Available at `/api/v1/docs/elements` - Feature-rich documentation
### Technical Implementation ### Technical Implementation
- **OpenAPI Schema**: Available at `/api/openapi.json` - Machine-readable API specification - **OpenAPI Schema**: Available at `/api/openapi.json` - Machine-readable API specification