API développeur
Liste des requêtes disponibles pour le mode développeur.
Cette route permet de générer un jeu de données de test de manière asynchrone. Elle valide le contenu YAML envoyé, ajoute la tâche à la file RabbitMQ, et retourne un process_id permettant de suivre l'avancement via /dev/ping_generation_process.
Format de sortie souhaité (ex: csv, json)
Contenu YAML sous forme d'objet JSON
Règles optionnelles de génération
Identifiant de campagne, ignoré en mode dev
Nom de la fonction à exécuter
preprocessing_generationVariables faker personnalisées
ID du processus de génération et message de confirmation
Requête invalide : données manquantes ou incorrectes
Erreur de validation des champs (types, format)
POST /dev/generate_dataset HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 136
{
"end_format": "text",
"yaml_content": {},
"rulesContent": {},
"campaignid": "text",
"function": "preprocessing_generation",
"faker_name_dict": {}
}{
"message": "text",
"process_id": "text"
}Cette route permet de vérifier le statut d'un dataset en cours de génération. Le process_id est fourni en tant que paramètre de requête, il preivent de la requête de /dev/generate_dataset. Un token développeur valide est requis pour accéder à cette route.Le statut retourné peut être : waiting, running, success, error, ou None si le processus est inconnu.Lorsque le statut est success, un champs supplémentaire s3_url est retourné contenant le dataset généré. Attention, ce champs n'est disponible que 15 minutes avant expiration
Identifiant unique du processus de génération
Successful Response
Validation Error
GET /dev/ping_generation_process?process_id=text HTTP/1.1
Host:
Accept: */*
No content
Cette route prend un contenu YAML (déjà transformé en JSON), le valide et renvoie soit un succès, soit une liste d'erreurs.
Contenu YAML converti en objet JSON
Successful Response
Erreur dans le contenu YAML fourni
Validation Error
POST /dev/check_yaml HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 19
{
"yaml_content": {}
}{
"message": "text",
"is_valid": true
}Last updated