[FIX] Fix the documentations of the project.
This commit is contained in:
+20
-2
@@ -259,6 +259,7 @@ NUM/PIECE/INSTRUMENT/VERSION/PARTIE.pdf
|
||||
| sax | Saxophone alto |
|
||||
| sab | Saxophone baryton |
|
||||
| sat | Saxophone ténor |
|
||||
| coa | Cor anglais |
|
||||
| cba | Contrebasse |
|
||||
| cor | Cor |
|
||||
| trp | Trompette |
|
||||
@@ -269,6 +270,10 @@ NUM/PIECE/INSTRUMENT/VERSION/PARTIE.pdf
|
||||
| per | Percussion |
|
||||
| crn | Cornet |
|
||||
| eup | Euphonium |
|
||||
| har | Harpe |
|
||||
| pia | Piano |
|
||||
| sup | Parties combinées ("supérieur") |
|
||||
| par | Parties combinées |
|
||||
|
||||
---
|
||||
|
||||
@@ -319,6 +324,10 @@ Content-Type: application/json
|
||||
- `compositor` - Nom du compositeur
|
||||
- `ressource` - Lien externe (YouTube, site éditeur, etc.)
|
||||
|
||||
> **Bug connu :** `ressource` n'est actuellement **pas persisté** par cette route
|
||||
> (`ScoreScanner::updateScore()` n'accepte pas le paramètre et la reconstruction de
|
||||
> `score.ini` ne réécrit pas `ressource`). À corriger côté backend.
|
||||
|
||||
---
|
||||
|
||||
### DELETE /admin/scores/:id
|
||||
@@ -412,6 +421,8 @@ key: sib (optionnel)
|
||||
clef: clesol (optionnel)
|
||||
variant: solo (optionnel)
|
||||
part: 1 (optionnel, défaut: 1)
|
||||
watermark: true (optionnel) # ajoute le numéro de partition sur le PDF
|
||||
watermarkPosition: left|right (optionnel, défaut: left)
|
||||
```
|
||||
|
||||
---
|
||||
@@ -421,9 +432,12 @@ part: 1 (optionnel, défaut: 1)
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | Succès |
|
||||
| 400 | Requête invalide (champ manquant, payload incorrect) |
|
||||
| 401 | Non authentifié |
|
||||
| 403 | Accès interdit (rôle insufficient) |
|
||||
| 403 | Accès interdit (rôle insuffisant) |
|
||||
| 404 | Ressource non trouvée |
|
||||
| 413 | Fichier trop volumineux |
|
||||
| 429 | Trop de requêtes (rate limiting) |
|
||||
| 500 | Erreur serveur |
|
||||
|
||||
---
|
||||
@@ -447,9 +461,13 @@ Les tests vérifient :
|
||||
|
||||
```bash
|
||||
cd api
|
||||
php -S localhost:8000 router.php
|
||||
php -c php-upload.ini -S localhost:8000 router.php
|
||||
```
|
||||
|
||||
> `-c php-upload.ini` est requis pour autoriser l'upload de PDF (64M max).
|
||||
> `ini_set()` ne peut pas modifier `upload_max_filesize`/`post_max_size` à l'exécution.
|
||||
> L'API répond sur `http://localhost:8000` (sans préfixe `/api`).
|
||||
|
||||
---
|
||||
|
||||
## Structure des fichiers
|
||||
|
||||
Reference in New Issue
Block a user