Validar flujo de trabajo de API de UIP

Sintaxis y opciones para `uip api-workflow validate`, que comprueba la estructura de un archivo JSON de flujo de trabajo de API antes de empaquetarlo o ejecutarlo.

uip api-workflow validate comprueba la estructura de un archivo JSON de flujo de trabajo de API (formas de tareas, expresiones y metadatos) con el esquema, sin ejecutarlo. Úselo como una comprobación previa rápida antes de run o pack.

Sinopsis

uip api-workflow validate <file> [options]

• <file> — ruta al archivo JSON de flujo de trabajo de API para validar.

Opciones

Marca	Descripción
--verbose	Habilita el registro detallado, incluido un seguimiento de la pila si se lanza la propia validación.

Ejemplos

uip api-workflow validate ./workflow.json

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

Forma de datos (--json de salida)

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

Cuando la validación pasa con advertencias, Data añade un campo Warnings que resume el recuento y la ruta y mensaje de cada advertencia. Cuando la validación falla (errores presentes), el comando sale distinto de cero e informa de un resultado Failure cuyo campo Instructions enumera todas las incidencias encontradas, cada una etiquetada [error] o [warning] con su ruta JSON.

Relacionado

• uip api-workflow run : ejecuta el flujo de trabajo después de validar limpio.
• uip api-workflow pack : empaqueta un flujo de trabajo validado para su publicación.

Ver también

• Descripción general de la herramienta de flujo de trabajo de API
• Opciones globales
• Códigos de salida