Utilisation dans Bruno
Catalogue Pipedream : connexion du compte et droits nécessaires. Les actions réellement utilisables sont vérifiées dans Bruno lors de la connexion. Les déclencheurs sont documentés à titre de référence et ne sont pas activés automatiquement dans Bruno.
Exemples de demandes à Bruno
Ces exemples utilisent des noms et des données fictifs. Pour les essayer, connectez l’application et accordez les accès nécessaires. Bruno vous demandera de valider les actions qui l’exigent.
Documenter un fichier de code pour le projet Atelier Martin
Je veux générer la documentation du fichier service-client.js pour le projet Atelier Martin. Préparez l’action de documentation et dites-moi ce qu’il faut fournir.
Résultat attendu
Une documentation générée à partir du fichier source, si le délai d’exécution est adapté.
À préciser dans votre demande
- Le fichier source à documenter
- Le nom du projet ou du module concerné
- Le besoin de documentation, pas de simple résumé
Sources de cet exemple
Préparer des tests pour une classe de facture
Je dois créer des tests pour la classe InvoiceService du dossier facturation. Préparez la génération de tests et indiquez les entrées nécessaires.
Résultat attendu
Des tests unitaires ou d’intégration proposés à partir du code source.
À préciser dans votre demande
- Le fichier ou la classe à tester
- Le périmètre fonctionnel de la facture
- Le format attendu pour les tests
Sources de cet exemple
Lister les générations déjà produites pour le module API
Je veux retrouver les générations déjà faites pour le module API du projet Atelier Martin. Lancez une liste des générations avec un filtre si possible.
Résultat attendu
Une liste de générations de documentation, avec filtrage éventuel selon les paramètres fournis.
À préciser dans votre demande
- Le nom du module ou un filtre de recherche
- Le type de génération à retrouver si nécessaire
- Le contexte du projet
Sources de cet exemple
À savoir avant de commencer
- Les actions sur des fichiers volumineux demandent un délai d’exécution de 5 minutes ou plus.
- Chaque génération consomme un crédit, sauf la liste des générations.
- La génération OpenAPI et UML part d’un code source, pas d’un simple texte métier.
Pour connecter cette application
- Rechercher DocuWriter.ai dans Apps, puis vérifier la connexion et les droits proposés. Connexion indiquée par Pipedream : clé API.
- Les actions possibles dépendent de votre compte et des accès accordés. Un abonnement à l’application peut être nécessaire.
- Bruno demande votre confirmation avant de créer, modifier ou supprimer des données. Les actions proposées par un connecteur Bruno peuvent différer de celles du catalogue Pipedream.
- Le nom anglais est conservé sous chaque action pour la retrouver dans Pipedream.
Actions proposées
Générer la documentation du code
Produit une documentation assistée par IA à partir d’un fichier source.
Nom d’origine : Generate Code Documentation
Documentation Pipedream →Générer l’optimisation du code
Propose des améliorations et du code optimisé à partir d’un fichier source.
Nom d’origine : Generate Code Optimization
Documentation Pipedream →Générer des tests de code
Génère des tests unitaires ou d’intégration à partir d’un fichier source.
Nom d’origine : Generate Code Tests
Documentation Pipedream →Générer une spécification Swagger/OpenAPI
Produit une spécification OpenAPI ou Swagger à partir du code source.
Nom d’origine : Generate Swagger/OpenAPI Spec
Documentation Pipedream →Générer un diagramme UML
Produit un diagramme UML à partir du code source au format Mermaid.
Nom d’origine : Generate UML Diagram
Documentation Pipedream →Lister les générations
Liste les générations de documentation déjà produites, avec filtre facultatif.
Nom d’origine : List Generations
Documentation Pipedream →
Déclencheurs répertoriés par Pipedream
Aucune action ou aucun déclencheur répertorié ici. Une connexion ne suffit pas à rendre une action disponible dans Bruno.
Source vérifiée le : DocuWriter.ai sur Pipedream.