Update documentation file paths

Author: RICHARD-Quentin

.gitignore

@@ -37,5 +37,4 @@ lerna-debug.log*
 docker/docker-compose.yml
 docker/docker-compose.yml
 
-docs/*
-!docs/*.md
+documentation/*

docs/summary.json

@@ -31,7 +31,7 @@
         "children": [
             {
                 "title": "Documentation du Systeme de Validation des schemas complémentaires de l'identité",
-                "file": "./user/Documentation_Systeme_Validation_Identite.md"
+                "file": "./user/IdentitiesValidation.md"
             }
         ]
     }

docs/user/IdentitiesValidation.md

@@ -1,84 +1,92 @@
 
-# Documentation Utilisateur - Validation des Identités
-
-## Introduction
-Ce guide explique comment interagir avec le système de validation des identités dans notre application. Cette fonctionnalité assure que toutes les données relatives aux identités sont valides et conformes aux exigences de l'organisation.
-
-## Validation des Données
-
-### Résumé
-Lorsque vous soumettez des données d'identité (par exemple, via un formulaire ou une API), le système effectue les vérifications suivantes :
-- Tous les champs obligatoires sont présents.
-- Les données correspondent aux types attendus (chaînes, nombres, dates, etc.).
-- Les valeurs respectent les contraintes spécifiques (par exemple, formats d'email ou de téléphone).
-
-### Données a passer
-Pour valider les données, vous devez fournir :
-Un fichier XML nommé selon le nom de l'objet à valider (par exemple, `supann.xml`).
-Dans le json de la requête, vous devez fournir :
-- Le champs "state" a -1 pour une creation
-- l'object avec comme clé inetorgperson et comme valeur un objet contenant les champs a valider
-- un objet "additionalFields" contenant deux champs :
-- - "objectClasses" : un tableau de string contenant les objectClasses a ajouter a l'objet
-- - "attributes" : un objet contenant les champs a ajouter a l'objet
-
-Par exemple, pour valider un objet supann, vous devez fournir :
-```json
-{
-    "state": -1,
-    "inetorgperson": {
-        "sn": "Doe",
-        "uid": "John",
-        "cn": "John Doe",
-    },
-    "additionalFields": {
-        "objectClasses": ["supann"],
-		"attributes":{
-			"supann": {
-				"supannEmpId": "123456",
-                "supannCivilite": "Mr",
-                "supannBirthName": "Doe"
-            }
-        }
-    }
-}
-```
+# Documentation du Système de Validation d'Identité
+
+## Vue d'ensemble
+
+Le système de validation d'identité utilise des fichiers de configuration YAML pour définir des règles de validation pour différents types d'objets d'identité. Chaque fichier YAML correspond à une `objectClass` spécifique et définit les attributs requis et leurs types pour cette classe.
+
+## Fichiers de Configuration
 
-Avec comme fichier de configuration :
-```yml
+Le fichier de configuration YAML doit être nommé selon le nom de l'`objectClass` qu'il définit, par exemple `supann.yml` pour l'`objectClass` `supannPerson`. Il doit être placé dans le dossier `TBD`.
+
+### Exemple de Fichier YAML (`supann.yml`)
+
+Ce fichier définit la structure et les attributs requis pour l'`objectClass` `supannPerson`.
+
+```yaml
 objectClasses:
   - name: supannPerson
     desc: 'SUPANN person object class'
     attributes:
       - supannEmpId
       - supannCivilite
       - supannBirthName
+      # more attributes...
 
 attributes:
   - name: supannEmpId
     desc: 'Employee ID'
     type: string
-    
+
   - name: supannCivilite
     desc: 'Title (Mr, Ms, etc.)'
     type: string
 
   - name: supannBirthName
     desc: 'Birth name'
     type: string
+    # more attributes...
 ```
 
+### Exemple Générique de Fichier YAML
+
+```yaml
+objectClasses:
+  - name: [Nom de l'ObjectClass]
+    desc: '[Description de l'ObjectClass]'
+    attributes:
+      - [Nom de l'attribut 1]
+      - [Nom de l'attribut 2]
+      # plus d'attributs...
+
+attributes:
+  - name: [Nom de l'attribut 1]
+    desc: '[Description de l'attribut]'
+    type: [Type de l'attribut]
+    required: [true/false]
+    # plus de détails d'attributs...
+```
+
+## JSON de Validation
+
+Pour valider une entrée, un objet JSON doit être fourni avec les champs suivants :
+
+- `state`: État de l'entrée, -1 pour une création.
+- `inetOrgPerson`: Informations générales de la personne.
+- `additionalFields`: Contient `objectClasses` (un tableau de noms d'`objectClass`) et `attributes` (les attributs spécifiques pour chaque `objectClass`).
+
+## Exemple
+
+Voici un exemple de JSON à valider :
+
+```json
+{
+  "state": -1,
+  "inetOrgPerson": {
+    // [Détails de inetOrgPerson]
+  },
+  "additionalFields": {
+    "objectClasses": ["supann"],
+    "attributes": {
+      "supann": {
+        // [Détails des attributs supann]
+      }
+    }
+  }
+}
+```
 
-## Erreurs de Validation
-En cas d'erreur de validation, le système vous fournira un retour détaillé sur les problèmes rencontrés. Cela peut inclure :
-- Des champs manquants.
-- Des données de type incorrect.
-- Des violations de contraintes spécifiques.
+## Remarques
 
-## Conseils d'Utilisation
-- Assurez-vous de fournir toutes les informations requises.
-- Vérifiez que les données sont dans le bon format.
-- En cas d'erreur, consultez le message de retour pour des corrections spécifiques.
+Assurez-vous que le fichier YAML correspondant à votre `objectClass` est disponible et correctement configuré.
 
-## Contact
-Pour toute question ou problème, veuillez contacter notre équipe de support technique.

package.json

@@ -41,7 +41,7 @@
     "test:e2e": "jest --config ./test/jest-e2e.json",
     "schematics:inherit": "nest generate -c @kradihsoy/lt-schematics inherit",
     "generate:doc": "npx @compodoc/compodoc -c .compodocrc",
-    "generate:docServer": "npx @compodoc/compodoc -s -c .compodocrc"
+    "generate:docServer": "npx @compodoc/compodoc -s -c .compodocrc -d ./documentation"
   },
   "dependencies": {
     "@kradihsoy/lt-schematics": "^1.0.13",