uip api-workflow 検証

「uip api-workflow validate」の構文とオプション - API ワークフローの JSON ファイルをパッケージ化または実行する前に、そのファイルの構造を確認します。

uip api-workflow validate は、API ワークフローの JSON ファイルの構造 (タスクの図形、式、メタデータ) をスキーマと照合します。スキーマは実行されません。runやpackの前に、フライト前の迅速なチェックとしてご利用ください。

概要

uip api-workflow validate <file> [options]

• <file> — 検証する API ワークフローの JSON ファイルへのパスです。

オプション

フラグ	説明
--verbose	検証自体がスローされる場合は、スタック トレースを含めて、詳細なログを有効化します。

例

uip api-workflow validate ./workflow.json

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

データシェイプ(--output json)

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

警告を使用して検証に合格すると、 Data は、カウントと各警告のパスとメッセージを要約した Warnings フィールドを追加します。検証に失敗する (エラーが存在する場合)、コマンドはゼロ以外の状態を終了し、 Failure 結果を報告します。この Instructions フィールドには、見つかったすべての問題が一覧表示されます。各問題には JSON パスでタグ付けされた [error] または [warning] が付けられます。

関連

• UIP API ワークフローの実行 — クリーンなことを検証した後にワークフローを実行します。
• uip api-workflow pack — 検証済みのワークフローをパッケージ化してパブリッシュします。

参照

• API ワークフロー ツールの概要
• グローバル オプション
• 終了コード