Skip to content

v1.28.0

Latest

Choose a tag to compare

@TristanSpeakEasy TristanSpeakEasy released this 18 Nov 21:39
7ed38ff

AsyncAPI 3.x support

This release adds an asyncapi package for AsyncAPI 3.0.x and 3.1.x documents, and uses it to validate AsyncAPI sources referenced by Arazzo 1.1 workflows (#321).

The asyncapi package

  • Reads, creates, mutates, walks, validates and writes the full 3.x document: info, servers, channels, operations, messages, components, security schemes, bindings and traits. It works the same way as the openapi package.
  • ResolveAllReferences resolves references within and across documents (local files, VirtualFS and HTTP), reports cycles and references to the wrong kind of object, applies operation and message traits, and checks cross-object rules such as an operation's messages belonging to its channel.
  • The new jsonschema/asyncapi package models AsyncAPI schemas, which are a JSON Schema Draft 07 superset, including multi format {schemaFormat, schema} schemas. Schemas are validated against the bundled Draft 07 metaschema, so no network access is needed.
  • Foreign schema formats such as Avro and Protobuf are kept as-is and round-trip, but aren't validated. They're reported with a new validation-unsupported-format warning.

AsyncAPI sources in Arazzo

openapi arazzo validate and (*Arazzo).ValidateSources now load AsyncAPI source descriptions and check that:

  • operationId and channelPath targets exist
  • headers sent by a step are declared
  • action suits the source type
  • correlationId is only used with messages that declare one

New openapi asyncapi validate command

Validates an AsyncAPI 3.x document. Use --resolve to also follow references to other files and URLs, and --strict to fail on warnings.

Fixes

  • Syncing a changed value no longer writes through YAML aliases into the anchored node it shares (#328).
  • Explicit null values are kept when a document is synced, so documents round-trip unchanged.

OpenAPI CLI v1.28.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

  • 6693aa2 feat: add AsyncAPI 3.x support and AsyncAPI sources in Arazzo (#321)

Bug fixes

  • f4e32fe fix: don't write through YAML aliases when syncing changed values (#328)

Full Changelog: v1.27.0...v1.28.0

Released by GoReleaser.