Skip to content

Commit b66acd4

Browse files
Update documentation links in Documentation_technique.md and Documentation_utilisateur.md
1 parent fe856fd commit b66acd4

File tree

4 files changed

+44
-12
lines changed

4 files changed

+44
-12
lines changed

docs/Documentation_technique.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,6 @@
1-
# Table des matières
1+
# Table des matières
2+
3+
- [DAEMON](https://libertech-fr.github.io/sesame-orchestrator/additional-documentation/documentation-technique/demon.html)
4+
- [IdentitiesValidation](https://libertech-fr.github.io/sesame-orchestrator/additional-documentation/documentation-technique/validation-des-identités.html)
5+
- [QueueProcessorService](https://libertech-fr.github.io/sesame-orchestrator/additional-documentation/documentation-technique/queue-processor-service.html)
6+
- [Tests](https://libertech-fr.github.io/sesame-orchestrator/additional-documentation/documentation-technique/ecriture-des-test-et-utilisation-des-utilitaires.html)

docs/Documentation_utilisateur.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
# Table des matières
1+
# Table des matières
2+
3+
- [Documentation du système de validation](https://libertech-fr.github.io/sesame-orchestrator/additional-documentation/documentation-utilisateur/documentation-du-systeme-de-validation-des-schemas-compl%C3%A9mentaires-de-l'identit%C3%A9.html)

docs/summary.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
"file": "./technical/Tests.md"
2121
},
2222
{
23-
"title": "Validation des attributss additionnels des identités",
23+
"title": "Validation des identités",
2424
"file": "./technical/IdentitiesValidation.md"
2525
}
2626
]

docs/user/IdentitiesValidation.md

Lines changed: 34 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,42 @@
55

66
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.
77

8-
## Fichiers de Configuration
8+
## Validation des champs InetOrgPerson
99

10-
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`.
10+
Les champs de base de l'objet `inetOrgPerson` sont validés par défaut.
1111

12-
### Exemple de Fichier YAML (`supann.yml`)
12+
### Champs obligatoires :
13+
- `cn`
14+
- `sn`
15+
- `uid`
1316

14-
Ce fichier définit la structure et les attributs requis pour l'`objectClass` `supannPerson`.
17+
### Champs facultatifs :
18+
- `displayName`
19+
- `facsimileTelephoneNumber`
20+
- `givenName`
21+
- `labeledURI`
22+
- `mail`
23+
- `mobile`
24+
- `postalAddress`
25+
- `preferredLanguage`
26+
- `telephoneNumber`
27+
- `title`
28+
- `userCertificate`
29+
- `userPassword`
30+
31+
## Validation des champs des schema additionnels
32+
33+
### Fichiers de Configuration
34+
35+
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` `supann`. Il doit être placé dans le dossier `TBD`.
36+
37+
#### Exemple de Fichier YAML (`supann.yml`)
38+
39+
Ce fichier définit la structure et les attributs requis pour l'`objectClass` `supann`.
1540

1641
```yaml
1742
objectClasses:
18-
- name: supannPerson
43+
- name: supann
1944
desc: 'SUPANN person object class'
2045
attributes:
2146
- supannEmpId
@@ -38,7 +63,7 @@ attributes:
3863
# more attributes...
3964
```
4065

41-
### Exemple Générique de Fichier YAML
66+
#### Exemple Générique de Fichier YAML
4267

4368
```yaml
4469
objectClasses:
@@ -57,15 +82,15 @@ attributes:
5782
# plus de détails d'attributs...
5883
```
5984

60-
## JSON de Validation
85+
### JSON de Validation
6186

6287
Pour valider une entrée, un objet JSON doit être fourni avec les champs suivants :
6388

6489
- `state`: État de l'entrée, -1 pour une création.
6590
- `inetOrgPerson`: Informations générales de la personne.
6691
- `additionalFields`: Contient `objectClasses` (un tableau de noms d'`objectClass`) et `attributes` (les attributs spécifiques pour chaque `objectClass`).
6792

68-
## Exemple
93+
### Exemple
6994

7095
Voici un exemple de JSON à valider :
7196

@@ -86,7 +111,7 @@ Voici un exemple de JSON à valider :
86111
}
87112
```
88113

89-
## Remarques
114+
### Remarques
90115

91116
Assurez-vous que le fichier YAML correspondant à votre `objectClass` est disponible et correctement configuré.
92117

0 commit comments

Comments
 (0)