Validação de fluxo de trabalho da API do UIP

Sintaxe e opções para "uip api-workflow validate", que verifica a estrutura de um arquivo JSON de fluxo de trabalho de API antes de empacotá-lo ou executá-lo.

uip api-workflow validate verifica a estrutura de um arquivo JSON de fluxo de trabalho de API — formas de tarefas, expressões e metadados — em relação ao esquema, sem executá-lo. Use-a como uma verificação rápida de simulação antes de run ou pack.

Resumo

uip api-workflow validate <file> [options]

• <file> — caminho para o arquivo JSON do fluxo de trabalho da API para validar.

Opções

Bandeira	Description
--verbose	Habilite o registro em log Verbose, incluindo um rastreamento de pilha, se a própria validação for gerada.

Exemplos

uip api-workflow validate ./workflow.json

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

Formato dos dados (--output json)

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

Quando a validação for aprovada com avisos, Data adiciona um campo Warnings que resume a contagem e o caminho e a mensagem de cada aviso. Quando a validação falha (erros presentes), o comando sai de um valor diferente de zero e relata um resultado Failure cujo campo Instructions lista todos os problemas encontrados, cada um marcado [error] ou [warning] com seu caminho JSON.

Relacionado

• uip api-workflow run — execute o fluxo de trabalho após a validação dele.
• uip api-workflow pack — empacote um fluxo de trabalho validado para publicação.

Veja também

• Visão geral da ferramenta Fluxo de trabalho da API
• Opções globais
• Códigos de saída