mpa/logisticsAPI
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
b95ee46b1ccae36ad1e4fdb7e5e3286a6f89e3ae
logisticsAPI/memory-bank/projectbrief.md
Marvin bc82299aa6 Enhance API parameter documentation and introduce reusable component 
- Added a new Blade component `<x-logistics.param-table>` for displaying API parameter tables across all Filament pages, ensuring consistent styling and reducing HTML duplication.
- Integrated parameter tables for each endpoint in the Articles, Documents, Divers, Journaux, Tiers, and other pages, providing users with clear reference information.
- Updated the documentation to reflect the new structure and details of API parameters, including required fields and descriptions.
- Improved user experience by ensuring that endpoints without parameters do not display empty tables.
- Overall, enhanced the clarity and usability of API interactions within the application.
2026-02-23 13:55:00 +01:00

2.6 KiB
Raw Blame History

Project Brief

Dernière mise à jour : 2026-02-23

Vision

Application Laravel de test dont l'objectif est de comprendre le fonctionnement de l'API Logistics (Flex/ESI Gescom) et d'en produire une documentation complète et compréhensible.

Objectifs

  1. Comprendre le fonctionnement de l'API Logistics.
  2. Créer une application simple permettant d'envoyer et de récupérer des données vers/depuis l'API.
  3. Produire une documentation complète et compréhensible de l'API.

Périmètre fonctionnel

  • Dashboard Filament v5 accessible sans authentification sur /admin.
  • Pages de consultation et d'envoi pour les principales entités de l'API : tables, articles, documents, journaux, tiers, divers.
  • Toggle Lecture/Ecriture sur chaque page entité pour basculer entre les endpoints de récupération et d'envoi de données.
  • Page de documentation intégrée avec rendu stylisé du markdown et export PDF.
  • Formulaires de recherche et d'envoi paramétrables pour chaque endpoint (19 au total).
  • Tableaux de référence des paramètres sous chaque endpoint (type, obligatoire, description).
  • Affichage des résultats sous forme de tableaux structurés et de blocs JSON formatés.
  • Système de design unifié avec 11 composants Blade réutilisables (x-logistics.*).
  • Traçage des requêtes effectuées dans une table api_request_logs.
  • Gestion robuste des erreurs API (timeout, retry, messages utilisateur en français, traduction avec explications via ApiErrorTranslator).
  • Validation des champs obligatoires avant chaque appel API avec messages en français.
  • Distinction "jamais recherché" / "recherché sans résultat" via propriétés de tracking.
  • L'endpoint Document_GetPDF est fonctionnel (LAYOUT numérique). L'endpoint custom_geninv_updatestock est fonctionnel en MODE=1 (Restock) avec bandeau d'information sur les modes.

Contraintes

  • Pas d'authentification sur le dashboard (projet de test interne).
  • L'API Logistics est hébergée sur le serveur TSE-10-TEST (http://tse-10-test.esi.local).
  • Le serveur API est accessible via le réseau interne.
  • Toutes les requêtes API sont en POST et nécessitent un header X-API-KEY.
  • Le nom du dossier dans les URLs de l'API doit être en minuscules.

Convention d'écriture

Tous les contenus rédigés en français (documentation, memory bank, règles Cursor, commentaires) doivent utiliser les accents appropriés.

Ressources