1.4 KiB
1.4 KiB
Règles — Évolutions API
Détection
Si une demande ne peut pas être implémentée avec les endpoints API existants (endpoint manquant, champ absent, comportement insuffisant), ne pas contourner le problème côté frontend.
Action requise
Créer un fichier dans le dossier api-issues/ à la racine du projet, nommé en kebab-case selon le besoin :
api-issues/nom-du-besoin.md
Contenu du fichier
Le fichier doit décrire :
- Contexte — quelle fonctionnalité frontend nécessite cette évolution
- Problème — ce qui manque ou bloque dans l'API actuelle
- Besoin — le ou les endpoints à créer / modifier, avec le corps de requête et la réponse attendus
- Priorité — bloquant / important / nice-to-have
Exemple de fichier
# Filtrage des issues par milestone
## Contexte
La page Issues doit permettre de filtrer les issues déjà assignées à un milestone.
## Problème
L'endpoint `GET /issues` ne retourne pas le champ `milestoneId` dans la réponse.
## Besoin
Ajouter `milestoneId: number | null` dans le corps de réponse de `GET /issues` et `GET /issues/:id`.
## Priorité
Important
Comportement attendu
- Implémenter tout ce qui est possible avec l'API actuelle.
- Informer clairement que le fichier a été créé et son emplacement.
- Ne pas bloquer le reste de l'implémentation : simuler la donnée manquante si cela permet d'avancer.