validation de workflow d’API uip

Syntaxe et options de `uip api-workflow validate`, qui vérifie la structure d'un fichier JSON de workflow d'API avant de le compresser ou de l'exécuter.

uip api-workflow validate vérifie la structure d'un fichier JSON de workflow d'API - formes de tâches, expressions et métadonnées - par rapport au schéma sans l'exécuter. Utilisez-le comme vérification en amont rapide avant run ou pack.

Synthèse

uip api-workflow validate <file> [options]

• <file> — chemin d'accès au fichier JSON du workflow d'API à valider.

Options

Drapeau	Description
--verbose	Activez la journalisation détaillée, y compris un traçage de pile si la validation est lancée.

Exemples

uip api-workflow validate ./workflow.json

uip api-workflow validate ./workflow.json --verbose

Format des données (--sortie json)

{
  "Code": "ApiwfValidate",
  "Data": {
    "File": "/abs/path/to/workflow.json",
    "Status": "Valid"
  }
}

Lorsque la validation est réussie avec des avertissements, Data ajoute un champ Warnings résumant le nombre et le chemin et le message de chaque avertissement. Lorsque la validation échoue (erreurs présentes), la commande quitte non-zéro et signale un résultat Failure dont le champ Instructions répertorie tous les problèmes trouvés, chaque [error] ou [warning] balisé avec son chemin JSON.

Associé

• uip api-workflow run — exécute le workflow après sa validation.
• uip api-workflow pack — empaqueter un workflow validé pour la publication.

Voir également

• Présentation de l’outil de workflow d’API
• Options globales
• Codes de sortie