UIP-API-Workflow-Validierung

Syntax und Optionen für „uip api-workflow validate“, das die Struktur einer API Workflow JSON-Datei überprüft, bevor sie gepackt oder ausgeführt wird.

uip api-workflow validate prüft die Struktur einer API Workflow-JSON-Datei – Aufgabenstrukturen, Ausdrücke und Metadaten – anhand des Schemas, ohne sie auszuführen. Verwenden Sie es als schnelle Pre-Flight-Prüfung vor run oder pack.

Zusammenfassung

uip api-workflow validate <file> [options]

• <file> – Der Pfad zur zu validierenden API Workflow-JSON-Datei.

Optionen

Markieren	Beschreibung
--verbose	Aktivieren Sie die Verbose-Protokollierung, einschließlich einer Ablaufverfolgung, wenn die Validierung selbst ausgelöst wird.

Beispiele

uip api-workflow validate ./workflow.json

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

Datenform (--output json)

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

Wenn die Validierung mit Warnungen erfolgreich ist, fügt Data ein Warnings -Feld hinzu, das die Anzahl und den Pfad und die Meldung jeder Warnung zusammenfasst. Wenn die Validierung fehlschlägt (Fehler vorhanden), wird der Befehl ungleich Null beendet und meldet ein Failure -Ergebnis, dessen Instructions -Feld jedes gefundene Problem auflistet, wobei jedes mit dem Tag [error] oder [warning] versehen wird.

Zugehörig

• uip api-workflow run – Führen Sie den Workflow aus, nachdem er sauber validiert wurde.
• uip api-workflow pack – Verpacken Sie einen validierten Workflow für die Veröffentlichung.

Siehe auch

• Übersicht über das API-Workflow-Tool
• Globale Optionen
• Exitcodes