FAQ

Quel est le circuit de validation des pages (files) ?

Puis-je modifier une page envoyée en validation (propose new file) ?

Une page doit elle passer en validation à chaque modification (commits) ?

Une page non complétée peut elle être mise en ligne ?

Ces 4 questions portent sur l'utilisation que nous faisons des fonctionnalités offertes par github : Fork, Commit+Push et Pull Request.

Les critères à respecter pour être référencés dans le catalogue sont décrits sur cette page.
Le processus de publication est décrit sur cette page.

Le plus simple est de suivre le processus tel qu’il s’est déroulé par le passé : https://github.com/sgmap/api.gouv.fr/pull/197

Cette Pull Request (PR) a abouti au référencement d'un service, une application Android (Pharma) consommatrice d’une API, medicapi, mais le schéma de référencement d'une API est à peu près le même.

Vous pouvez effectuer des modifications sur votre copie personnelle (“fork”) du dépôt api.gouv.fr, directement via Github dans votre branche “master”, ou bien localement sur votre machine de développement avant de les remonter (commit+push); ensuite vous devez utiliser la fonction “New Pull Request” à partir de la page de votre dépôt, et soumettre une PR ayant comme base le dépôt SGMAP et comme “head fork” votre propre branche master.

Ensuite il est possible que nous ayons besoin de dialoguer pour nous assurer que les éléments que vous proposez sont conformes sur le plan technique et sur le plan fonctionnel aux exigences du catalogue api.gouv.fr. Ce dialogue se fera idéalement par les commentaires sur la PR, mais nous pouvons bien sûr échanger par mail ou téléphone au besoin.

Nous avons également la possibilité technique de rendre les modifications d'une branche “prévisualisables” en ligne avant publication.

A l’issue de ce dialogue nous fusionnons vos modifications dans la branche “master” du catalogue, la mise en ligne étant alors automatique.

C’est le même processus (avec une nouvelle PR) pour soumettre des modifications.

Auriez-vous un contact qui puisse m’accompagner dans le référencement de nos API ?

Le mail pour entrer en contact avec nous est [email protected]

Chaque responsable d'API peut également être contacté directement : son mail est indiqué dans le cartouche à gauche de la description de son api.