Documentation de la validation Zod

[silto]

Contexte

Documentation de la validation Zod

Comme discuté en séminaire, j'ai fait une petite doc décrivant le fonctionnement de la validation Zod, dont la structure est assez semblable à travers les différents bordereaux.

Documentation automatique des règles de validation (requis/scellé)

J'ai aussi ajouté un script permettant de créer automatiquement des tables qui récapitulent les règles de validation (champ requis/scellé) dans la doc API. Le script a encore quelques limitations, je l'améliorerai quand j'aurai le temps :

• il faut le faire tourner manuellement si il y a un changement de règles (j'ai mis un warning sur les objets de règles)
• il ne gère pas les objets de règles transporter/packaging séparés
• le tableau est écrit "seul" dans le fichier, donc il faudra éventuellement ajouter un peu d'explication en en-tête

De plus les règles BSDA/BSFF ne contiennent pas les path, donc l'info est manquante dans la doc. Il faudra les ajouter au passage des forulaires au DSFR pour avoir les erreurs remontées depuis la back, donc ça se résoudra avec.

Points de vigilance pour les intégrateurs

Démo

Lien pour voir la doc avec les schémas :

https://github.com/MTES-MCT/trackdechets/blob/doc-zod-2/docs/ZodValidation.md

Démo de la documentation générée automatiquement pour les règles de validation :

Enregistrement.de.l.ecran.2025-01-30.a.03.23.20.mov

Ticket Favro

Titre

Checklist

• Mettre à jour la documentation
• Mettre à jour le change log
• Documenter les manipulations à faire lors de la mise en production (sur le ticket Favro de release)
• Informer le data engineer de tout changement de schéma DB

[sonarqubecloud]

Quality Gate passed

Issues
6 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
2.0% Duplication on New Code

See analysis details on SonarQube Cloud