Repository navigation
Arazzo 1.1 and Arazzo tooling
This release adds support for Arazzo 1.1.0 and brings a set of the tools we provide for OpenAPI to Arazzo documents (#305).
Arazzo 1.1 support
- Any
1.0.xor1.1.xdocument is accepted, and validation follows the version the document declares. A 1.1-only feature in a 1.0 document is reported with a pointer toopenapi arazzo upgrade. - New 1.1 features:
$self, AsyncAPI source descriptions and steps (channelPath,action,correlationId,timeout), stepdependsOn,in: querystring, success and failure actionparameters, Selector Objects, payload replacementtargetSelectorType, and therfc9535,xpath-31andrfc6901expression types. - The strict 1.1 runtime expression grammar applies to 1.1 documents. 1.0 documents keep the existing checks.
New and updated openapi arazzo commands
| Command | What it does |
|---|---|
upgrade |
Upgrades a 1.0.x document to 1.1.0, pinning criteria whose defaults changed and listing anything that needs a manual fix |
validate |
Now also loads the referenced OpenAPI and Arazzo documents and checks operations, parameters, request bodies and workflow inputs against them (--skip-sources to opt out) |
lint / list-rules |
Everything validate reports plus 11 semantic, style and security rules, with rulesets, config and --fix, like openapi spec lint |
graph |
Renders workflows as a Mermaid flowchart or Graphviz DOT diagram |
bootstrap |
Generates starter workflows from an OpenAPI document (--from openapi.yaml) |
explore |
Interactive terminal UI for browsing workflows, steps, inputs, outputs and actions |
The library exposes the same functionality: arazzo.Upgrade, arazzo.LoadSourceDescriptions, (*Arazzo).ValidateSources, arazzo.BootstrapFromOpenAPI, arazzo/linter and arazzo/graph.
Breaking changes for library users
arazzo.Outputsvalues are now*arazzo.OutputValueinstead ofexpression.Expression, because a 1.1 output can be an expression or a Selector Object. Seearazzo/README.mdfor the migration.- Validation is stricter for some existing 1.0 documents. Duplicate step and workflow parameters, operation step parameters missing
in, and$steps/$workflows/$inputsreferences to things that don't exist are now reported.
Other fixes
- Optional scalar fields such as
sourceDescription.typeare no longer written out as empty strings when unset. sourceDescription.typeis no longer treated as required.
OpenAPI CLI v1.27.0
This release includes binaries for Linux, macOS, and Windows on both x86_64 and ARM64 architectures.
Installation
Download the appropriate binary for your platform from the assets below, extract it, and add it to your PATH.
Changes
Changelog
Features
- 40c8fb7 feat!: add Arazzo 1.1 support with source validation, lint, graph, bootstrap and explore commands (#305)
Full Changelog: v1.26.5...v1.27.0
Released by GoReleaser.