DeveloperLaPoste / okapi-feedback

Feedback, ideas, propositions about Okapi platform and La Poste Open APIs (https://developer.laposte.fr/)
0 stars 1 forks source link

Détailler les champs Outputs des API #1

Closed frntn closed 5 years ago

frntn commented 7 years ago

Pour la ressource /controladresse/v1/adresses/{code} on peut lire dans la doc :

Le code d’adresse est un identifiant temporaire obtenu via la ressource /controladresse/v1/adresses{?q}.

Mais la documentation de la ressource /controladresse/v1/adresses{?q} ne mentionne rien au sujet de ce champ : son caractère temporaire, sa durée de validité, ...

Il serait donc intéressant d'avoir, pour toutes les ressources, les spécifications de chaque champ renvoyé dans le JSON de réponse. Par exemple :

openhoat commented 7 years ago

Tout à fait, c'est à cela que servent les schémas JSON qui peuvent (doivent) figurer dans la documentation pour augmenter sa qualité. Je vais remonter à nouveau le point au métier, car c'est à eux qu'il incombe de spécifier ces assets, donc je laisse ouvert ce ticket. Merci