- Rewrite README.md with current architecture, features and stack - Update docs/API.md with all current endpoints (corporate, BI, client 360) - Update docs/ARCHITECTURE.md with cache, modular queries, services, ETL - Update docs/GUIA-USUARIO.md for all roles (admin, corporate, agente) - Add docs/INDEX.md documentation index - Add PROJETO.md comprehensive project reference - Add BI-CCC-Implementation-Guide.md - Include AI agent configs (.claude, .agents, .gemini, _bmad) - Add netbird VPN configuration - Add status report Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1.3 KiB
1.3 KiB
Data & API Requirements
Include when: Page requires data from APIs or external sources
Data Sources
| Data Element | Source | Type | Required | Notes |
|---|---|---|---|---|
{data-field} |
{API / static / localStorage} | {string / number / array} | {yes/no} | {notes} |
API Endpoints
{Endpoint Name}
| Property | Value |
|---|---|
| Method | {GET / POST / PUT / DELETE} |
| Path | /api/{path} |
| Purpose | {What this endpoint does} |
| Auth | {Required / Optional / None} |
Request:
{
"field": "value"
}
Response (Success):
{
"data": {}
}
Response (Error):
{
"error": "message",
"code": "ERR_XXX"
}
Error Codes:
| Code | Meaning | User Message |
|---|---|---|
{code} |
{technical meaning} | {user-friendly message} |
Loading States
| State | Duration | UI |
|---|---|---|
| Initial load | {expected ms} | {skeleton / spinner / etc.} |
| Refresh | {expected ms} | {indicator type} |
| Background | {expected ms} | {silent / toast} |
Caching Strategy
| Data | Cache Duration | Invalidation |
|---|---|---|
| {data type} | {duration} | {when to refresh} |