# Documentation — Olhar-API

## Wiki du projet

La documentation de Olhar-API est maintenue dans `../Olhar-API.wiki/` (chemin relatif à la racine du projet).

Les règles générales de mise à jour du wiki sont définies dans les règles workspace (`wiki.md`).

## Fichiers du wiki

| Fichier | Contenu |
|---------|---------|
| `Specification-Fonctionnelle.md` | Comportement visible : endpoints, règles métier, cas d'usage |
| `Specification-Technique.md` | Architecture, entités, flux de données, choix techniques |
| `Changelog.md` | Historique des modifications (entrée en tête, plus récent en premier) |

## Quand mettre à jour

- **Nouvel endpoint** → mettre à jour les deux specs (fonctionnelle et technique).
- **Nouvelle entité ou modification de schéma** → mettre à jour la spec technique.
- **Changement de règle métier** → mettre à jour la spec fonctionnelle.
- **Ajout de dépendance ou changement d'architecture** → mettre à jour la spec technique.

## Format des endpoints dans la spec technique

```markdown
### POST /auth/register

**Corps de la requête :**
\`\`\`json
{ "email": "...", "password": "..." }
\`\`\`

**Réponse (201) :**
\`\`\`json
{ "token": "...", "user": { "id": 1, "email": "..." } }
\`\`\`

**Erreurs :** 409 si email déjà utilisé, 400 si validation échoue.
```