Changelog

Copy Markdown View Source

All notable changes to async_api_spex will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

0.1.0 - 2026-10-02

Added

  • Structs modelling the AsyncAPI 3.0 document: AsyncApiSpex.Document, .Info, .Server, .Channel, .Parameter, .Operation, .Message, .CorrelationId, .Tag, .Reference, and .Components.
  • use AsyncApiSpex.Schema and use AsyncApiSpex.Message for declaring reusable schemas and messages, compiled into components at resolve time.
  • AsyncApiSpex.resolve/1, to_map/1, encode!/1, and validate/1, with component extraction, lowerCamel JSON encoding, and named validation errors.
  • AsyncApiSpex.Plug.RenderSpec, a Plug that serves an encoded document with the application/asyncapi+json content type.
  • mix async_api_spex.gen to validate a spec module and write its document to a file.