Produits Entr'ouvert » Publik

quand une API existe quelque part, la rendre utilisable par les gens.

Diffusion:

• chaque application a un /.well-known/apis = "wsdl" en JSON (dont nous devons définir le format)
• chaque consommateur interroge les autres autour de lui pour savoir ce qu'il propose...

Description de premier niveau: décrire les API de façon "fonctionnelle", ie qualifiée, ie son type :

• "cette BASE_URL propose une API compatible «newsletters»"
• "cette BASE_URL propose une API compatible «factures»"
• "cette BASE_URL propose une API compatible «datasources»"
• famille
• appairage
• agendas
• SIG (aka nominatim & référentiels d'adresses)
• SMS
• gestion de panier

fournir un type, une URL et un slug ex.: passerelle:spreadsheet-rue

Description de deuxième niveau pour w.c.s.:

• libellé
• endpoint (uri)
• parametres query-string et/ou payload (+ libellés)
• méthode HTTP
• codes de retour / libellés
• callback/trigger (+ libellés)

Point de vigilance : il y a des API qui nécessitent des valeurs dans l'URI, il faudra leur ajouter des variantes avec les valeurs dans la query-string et/ou le payload.

Chaque chose référencée doit avoir une référence qui sera la même en recette et en prod.

Amélioration dans combo : utiliser ces descriptions pour simplifier la configuration de cellules nécessitant une URL, utiliser le slug à l'import pour retrouver la bonne URL

Amélioration dans w.c.s. appel de web-service : proposer des actions de haut niveau à partir des descriptions

Amélioration dans passerelle : proposer le endpoint de description, ajouter un support au décorateur endpoint pour permettre de déclarer une description, sinon avoir une méthode get_api_description() sur la ressource, dans le cas d'un endpoint complexe (CsvDatasource.select) poser un get_select_api_description().

Amélioration dans chrono : publier description des endpoints des agendas

Amélioration dans corbo : publier description des endpoints des newsletters

Amélioration dans authentic : publier description pour endpoints « Créer un utilisateur », « Envoyer un/rappel du/changement du mot de passe», «Enregistrement», « Modifier un utilisateur ».