Enhance webhooks documentation - #1500
Conversation
Le payload de test (envoyé à la création et lors des tests manuels) a un format distinct du payload d'événement classique
Le service MarkdownRenderer encapsule la configuration (fenced code blocks, tables, autolink, TOC anchors) et sera utilisé pour afficher la documentation des webhooks.
Rend le fichier docs/webhooks.md en HTML via MarkdownRenderer et l'affiche sur une page accessible depuis l'index des webhooks (bouton « Documentation »). La page est accessible sans authentification, comme la documentation OpenAPI existante.
53c0fc9 to
de1d404
Compare
|
Un lien vers les markdown dans github m'aurait suffit, hein, pas besoin de redcarpet là. M'enfin maintenant que c'est fait 🤷 |
|
J'ai hésité mais là on s'assure que c'est une 200 via un test, c'était gratuit |
There was a problem hiding this comment.
Je trouve qu'on doit beaucoup scroller avant d'atteindre la partie intéressante en tant que FD qui consomme des webhooks.
Les parties que je mettrai le plus en avant :
- Sécurité et authentification
- Implémentation côté récepteur
- Format des événements et du payload
- Gestion des échecs et retry
C'est ça que le consommateur veut voir en premier je pense.
Je trouve que Gestion des webhooks via l'interface c'est complètement du blabla, surtout qu'on a déjà fait ce chemin pour arriver à cette doc à priori.
EDIT : j'ai rien dit pour le sommaire.
JeSuisUnCaillou
left a comment
There was a problem hiding this comment.
M'enfin c'est déjà une bonne base. Tu peux itérer sur la doc pour mieux prioriser les parties de la doc si tu as le temps.
Met toi à la place d'un intégrateur de webhook : de quoi tu as besoin ? Quel est le TL;DR que tu veux voir ? (ne me répond pas osef je LLM please 🙏 )
|
Je n'ai pas vraiment changé la doc, juste ajouté un point sur le format de la payload de test (demandé par un intégrateur) + linké pour que la doc soit présente. Y'a un sommaire pour jump où c'est intéressant, ça me semble pas superflu. |
Pour le coup je trouve que c'est bien architecturé : y'a une intro, le pré-requis, une explication de l'UI, la conception, et enfin l'implémentation. Ça me parait assez standard. Le sommaire est aussi clair si t'as besoin de jump où il faut directement. |
testevent payload example