Commit Graph

6 Commits

Author SHA1 Message Date
Oleg Proskurin 1e080bd87c doc: new api 2025-11-28 10:49:01 +07:00
Oleg Proskurin fba243cfbd feat: add test 2025-11-23 23:01:46 +07:00
Oleg Proskurin e3ddf1294f fix: prompts storage 2025-11-23 20:47:48 +07:00
Oleg Proskurin a1c47a37f0 docs: update admin documentation with IP rate limiting and scope error codes
Update admin.md to reflect Phase 3 Part 3 implementation changes:

**Rate Limiting Section:**
- Split into two subsections: API Key Rate Limiting and IP-Based Rate Limiting
- API Key Rate Limiting: Expanded affected endpoints list to include scope management
- IP-Based Rate Limiting: New section documenting 10/hour limit for live URLs
  - Separate from API key limits
  - Only cache MISS counts toward limit
  - Supports X-Forwarded-For header
  - In-memory store with automatic cleanup

**Error Codes Section:**
- Reorganized into categorized tables for better clarity
- Added HTTP 409 (Conflict) status code
- Added Authentication Error Codes table
- Added Rate Limiting Error Codes table with both API key and IP limits
- Added Live Scope Error Codes table:
  - SCOPE_INVALID_FORMAT (400)
  - SCOPE_ALREADY_EXISTS (409)
  - SCOPE_NOT_FOUND (404)
  - IMAGE_NOT_IN_SCOPE (400)

**Documentation Improvements:**
- All error responses include standard format
- Rate limit errors include Retry-After header
- Scope endpoints require project key authentication
- Comprehensive notes for each section

All documentation now accurately reflects current API v1 implementation.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-17 23:45:17 +07:00
Oleg Proskurin a38c2dd954 doc: update rest examples 2025-11-16 18:17:18 +07:00
Oleg Proskurin 213a378532 doc: update the documentation 2025-11-16 17:44:24 +07:00