Documentation API BIO certifications

etalab / entreprise.api.gouv.fr

Site publique d'API Entreprise

https://entreprise.api.gouv.fr

7 stars 7 forks source link

Documentation API BIO certifications #84

Closed DorineLam closed 3 years ago

DorineLam commented 3 years ago

Que fait cette PR ?

Elle permet de créer la doc du futur endpoint de l'agence BIO

DorineLam commented 3 years ago

J'ai avancé sur la doc avec les éléments que nous avons à disposition actuellement. Il y a une erreur d'affichage, je n'arrive pas à savoir si cela est dû au fait qu'on doit rebase avec la branche Sandbox (dans laquelle nous aurions résolu ce problème ?)

DorineLam commented 3 years ago

Éléments manquant pour une mise en prod de la documentation :

[ ] Régler le bug du volet lire la suite (capture d'écran ci-dessus)
[x] Enlever les clés gerant et date_notification
[x] Ajouter la dernière payload JSON valide
[x] Ajouter les commentaires dans la payload

DorineLam commented 3 years ago

@brindu suite à la réponse de l'Agence BIO, j'enlèverai deux clés :

dateNotification : Il s’agit de la date de déclaration initiale dans le SI de l’agence bio. Cette date apporte de la confusion et ne sert pas à grand chose. La plus importante étant la date d’engagement (ex- date_démarrage).
gerant => Cette info est soit déclarative soit récupérée de la base INSEE à la saisie du SIRET par l’opérateur. Je pense qu'on a intérêt à renvoyer nos utilisateurs directement vers l'endpoint entreprise

brindu commented 3 years ago

@brindu suite à la réponse de l'Agence BIO, j'enlèverai deux clés :

dateNotification : Il s’agit de la date de déclaration initiale dans le SI de l’agence bio. Cette date apporte de la confusion et ne sert pas à grand chose. La plus importante étant la date d’engagement (ex- date_démarrage).

gerant => Cette info est soit déclarative soit récupérée de la base INSEE à la saisie du SIRET par l’opérateur. Je pense qu'on a intérêt à renvoyer nos utilisateurs directement vers l'endpoint entreprise

Je n'ai ni l'un l'autre dans la payload jusqu'ici :)

DorineLam commented 3 years ago

@brindu je pense que la documentation est finie. Peux-tu relire la partie Payload notamment ? J'ai ajouté le champ numéro de pacage, je sais pas si j'ai fait ça correctement. J'ai aussi réorganisé certaines données.

Par ailleurs, j'ai tenté un truc qui est trop présent, mais qui a le mérite d'être visible :

DorineLam commented 3 years ago

@brindu merci bcp ! j'avais pas les yeux en face des trous ! Je viens de prendre en compte toutes tes remarques. De mon côté, on peut mettre en prod. Qu'en est-il du tien ? ^^

DorineLam commented 3 years ago

J'ai revert le dernier commit car il ne fonctionnait pas. Je ferai une PR dédiée

DorineLam commented 3 years ago

@brindu j'ai fait une dernière relecture, qui n'était pas de trop ^^ Tu peux merger