> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Pré-visualizar a requisição de um executor

> Utilize este endpoint para montar a requisição HTTP de saída que um node executor enviaria, sem enviá-la. A pré-visualização aplica a mesma interpolação, o mesmo mapeamento de entradas e a mesma montagem de autenticação usados em tempo de execução. Ela nunca abre uma conexão de rede nem lê o vault. O material secreto, incluindo campos de configuração somente de escrita e material de autenticação, é mascarado com `***`.



## OpenAPI

````yaml pt/openapi/v3-current/flowker.yaml post /v1/workflows/preview-request
openapi: 3.1.0
info:
  description: >-
    Referência completa da API para os serviços de orquestração de workflows do
    Flowker, incluindo gerenciamento de catálogo, definições de workflows,
    configurações de executor, configurações de provider e execuções de
    workflows.
  title: API do Flowker
  version: 1.2.0
servers:
  - url: https://flowker.sandbox.lerian.net
security:
  - BearerAuth: []
tags:
  - name: Catalog API
    description: >-
      Explore providers, executors e triggers integrados disponíveis no catálogo
      do Flowker.
  - name: Workflows API
    description: Crie, atualize, ative, desative, clone e exclua definições de workflows.
  - name: Executions API
    description: Inicie execuções de workflows e acompanhe seu status e resultados.
  - name: Executor Configurations API
    description: >-
      Liste, consulte, atualize e exclua os registros de configuração de
      executor que uma implantação mantém.
  - name: Provider Configurations API
    description: >-
      Crie, atualize, habilite e desabilite as configurações de provider pelas
      quais os nodes de workflow chamam.
  - name: Dashboard API
    description: >-
      Recupere resumos agregados de workflows e execuções para dashboards
      operacionais.
  - name: Webhooks API
    description: >-
      Receba callbacks de webhooks de sistemas externos para disparar execuções
      de workflows.
  - name: Schedule API
    description: >-
      Inspecione as ocorrências agendadas futuras, ignoradas e retidas de um
      workflow, e execute ou descarte as retidas.
  - name: Schema Registry API
    description: >-
      Publique versões globais de especificação OpenAPI para serviços nativos e
      fixe a versão que cada tenant resolve.
  - name: OpenAPI Schemas API
    description: >-
      Envie, consulte e exclua os esquemas OpenAPI externos do tenant, e derive
      o contrato de uma operação específica.
  - name: XSD Schemas API
    description: >-
      Envie, consulte e exclua os esquemas XSD do tenant que validam as cargas
      XML dos webhooks.
paths:
  /v1/workflows/preview-request:
    post:
      tags:
        - Executions API
      summary: Pré-visualizar a requisição de um executor
      description: >-
        Utilize este endpoint para montar a requisição HTTP de saída que um node
        executor enviaria, sem enviá-la. A pré-visualização aplica a mesma
        interpolação, o mesmo mapeamento de entradas e a mesma montagem de
        autenticação usados em tempo de execução. Ela nunca abre uma conexão de
        rede nem lê o vault. O material secreto, incluindo campos de
        configuração somente de escrita e material de autenticação, é mascarado
        com `***`.
      operationId: previewRequest
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PreviewRequestInput'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreviewRequestResult'
          description: >-
            Indica que a requisição foi bem-sucedida e a resposta contém os
            dados solicitados.
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Indica que a requisição falhou. O corpo é um documento de problema
            RFC 9457.
components:
  schemas:
    PreviewRequestInput:
      additionalProperties: false
      properties:
        node:
          additionalProperties: {}
          description: >-
            Configuração do node executor (executorId, providerConfigId, method,
            path, headers, body, config, inputMapping/transforms) — a mesma
            estrutura persistida no campo data de um node do workflow.
          type: object
          example:
            body:
              amount: ${body.amount}
            executorId: http.post-v1-pay
            method: POST
            path: /v1/pay
            providerConfigId: 018f3e2a-1c4d-7b9e-a1b2-c3d4e5f6c4d5
        providerConfig:
          $ref: '#/components/schemas/PreviewProviderConfigInput'
          description: >-
            Configuração de provider para a qual o node aponta, enviada inline
            para que a prévia seja uma função pura de suas entradas (sem
            leituras no banco de dados nem no vault).
          example:
            config:
              base_url: https://api.example.com
            providerId: http
        sampleInput:
          additionalProperties: {}
          description: >-
            JSON arbitrário usado como contexto do workflow para resolver os
            mapeamentos e as referências ${node.*}/${body.*}; as referências não
            resolvidas permanecem literais. Opcional (uma prévia sem contexto de
            exemplo é válida).
          type: object
          example:
            amount: 150
            currency: BRL
      required:
        - node
        - providerConfig
      type: object
    PreviewRequestResult:
      additionalProperties: false
      properties:
        body:
          type: string
          example: '{"amount":150.00,"currency":"BRL"}'
        curl:
          type: string
        headers:
          additionalProperties:
            type: string
          type: object
        method:
          type: string
          example: POST
        unresolved:
          items:
            type: string
          type:
            - array
            - 'null'
        url:
          type: string
          example: https://api.example.com/v1/pay
      required:
        - method
        - url
        - headers
        - body
        - curl
        - unresolved
      type: object
    ErrorResponse:
      properties:
        code:
          description: Código de erro do Flowker, estável e legível por máquina.
          example: FLK-0001
          type: string
        detail:
          description: >-
            Explicação legível desta ocorrência. Respostas com status 500 ou
            superior trazem uma mensagem genérica fixa.
          example: name is a required field
          type: string
        errors:
          description: Entradas por campo para uma requisição que não passou na validação.
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
        instance:
          description: Referência URI que identifica esta ocorrência específica.
          example: /v1/workflows
          format: uri
          type: string
        status:
          description: Código de status HTTP.
          example: 400
          type: integer
        title:
          description: Frase padrão do status HTTP. Ela não muda conforme o código de erro.
          example: Bad Request
          type: string
        type:
          description: >-
            Referência URI que identifica o erro. É sempre a base do catálogo de
            erros seguida do código.
          example: https://errors.lerian.studio/v1/FLK-0001
          format: uri
          type: string
      type: object
    PreviewProviderConfigInput:
      additionalProperties: false
      properties:
        allowedHosts:
          description: >-
            Lista de hosts de destino permitidos, enviada em linha. As entradas
            seguem as mesmas regras de `allowedHosts` na configuração de
            provider.
          items:
            maxLength: 253
            type: string
          maxItems: 100
          type:
            - array
            - 'null'
        allowedPrivateHosts:
          description: >-
            Hosts privados nomeados, enviados em linha. As entradas seguem as
            mesmas regras de `allowedPrivateHosts` na configuração de provider.
          items:
            maxLength: 253
            type: string
          maxItems: 100
          type:
            - array
            - 'null'
        config:
          additionalProperties: {}
          description: >-
            Mapa de configuração de provider (base_url, auth, credentials,
            etc.). Opcional — alguns providers não precisam de configuração.
          type: object
          example:
            base_url: https://api.example.com
        providerId:
          description: >-
            Id de provider do catálogo para o qual o node aponta (por exemplo,
            http, jd-spi, ledger).
          type: string
          example: http
      required:
        - providerId
      type: object
    ErrorDetail:
      properties:
        location:
          description: Onde está o problema, como body.nodes ou path.id.
          example: body.nodes
          type: string
        message:
          description: Descrição do problema no campo.
          example: expected array length >= 1
          type: string
        value:
          description: O valor que causou o erro, quando é seguro incluí-lo.
      type: object
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Token bearer JWT emitido pelo provider de identidade. Envie-o no
        cabeçalho Authorization como `Bearer <token>`.

````