[API Histologe] Améliorations route GET + Documentation

[sfinx13]

Ticket

#3424

Description

Changements apportés

• Réorganiser la réponse en sous objets (adresse, personne).
• Compléter la documentation API
• Suppression route et modèle de tests
• Initialisation des nouveaux statuts

Pré-requis

Tests

Documentation

• Vérifier que tous les champs soient documenté http://localhost:8080/api/doc
• Vérifier que la réponse d'exemple possède des valeurs pour chaque champs
• Vérifier que la documentation Swagger UI est accessible à l'URL http://localhost:8080/api/doc/swagger.

Configuration

• Importer le fichier openapi.json dans `POSTMAN
• Définissez la valeur de la variable d'env baseUrl et bearerToken et sauvgearder
  
• Copier ce script dans l'onglet Test de la route login et sauvegarder
  

var data = JSON.parse(responseBody);

if (data.data !== null) {
    pm.collectionVariables.set("bearerToken", data.token);
}

• Après s'etre authentifié, tester les 2 routes GET sur la récupération des signalement et vérifier que les personnes et adresses sont encapsulé dans des objets

[emilschn]

code géographique

[emilschn]

pourquoi ajouter un exemple ?

[sfinx13]

L’appellation vient de ce wiki
https://fr.wikipedia.org/wiki/Codes_g%C3%A9ographiques_de_la_France

L'exemple dans la doc est pour clarifier l’appellation code insee du département.

[emilschn]

Quelques retours et questions, pas encore testé !

[numew]

Quelques retours, bel effort et beau travail de doc.

[numew]

Il y'a aussi la possibilité "nsp" ("Ne sait pas"). D'ailleurs on pourrais renvoyer la valeur "Ne sait pas" en rajoutant le bon paramètre via getBailDpeClasseEnergetique mais il faudrait généraliser a tout ces type de retour donc je ne sais pas si on le fait ou pas ?

[sfinx13]

Je pense avoir fait le tour des nsp j'ai donc mis à jour la méthode afin de retourner les nsp
private function stringToBool(?string $value): bool|string|null {

[sonarqubecloud]

Quality Gate passed

Issues
3 New issues
0 Accepted issues

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

See analysis details on SonarQube Cloud