Skip to content
Last updated

outputs-defined

The output value should be defined before usage.

ArazzoCompatibility
1.x

Design principles

In Arazzo, every outputs mapping—linking a friendly name to a dynamic output value—must be explicitly defined before it is referenced or used elsewhere in the description.

Configuration

OptionTypeDescription
severitystringPossible values: off, warn, error. Default off.

An example configuration:

rules:
  outputs-defined: error

Examples

Given the following configuration:

rules:
  outputs-defined: error

Example of a correct outputs description:

workflows:
  - workflowId: events-crud
    steps:
      - stepId: create-event
        operationPath: $sourceDescriptions.museum-api#/paths/~1special-events/post
        requestBody:
          payload:
            name: 'Mermaid Treasure Identification and Analysis'
            description: 'Identify and analyze mermaid treasures'
        outputs:
          specialEventId: $response.body#/id
    outputs:
      createdEventId: $steps.create-event.outputs.specialEventId

Resources