Skip to content

Instantly share code, notes, and snippets.

Last active November 7, 2022 12:49
Show Gist options
  • Save smoya/7579feb4f1d76a77d1321111ea8ea698 to your computer and use it in GitHub Desktop.
Save smoya/7579feb4f1d76a77d1321111ea8ea698 to your computer and use it in GitHub Desktop.
AsyncAPI Spec and parsers update 🏖️Summer Edition part 2 🏖️ (July, August, and half of September 2022)

AsyncAPI Spec and parsers update 🏖️Summer Edition part 2 🏖️ (July, August, and half of September 2022)

This is a special entry on my bi-weekly update about the AsyncAPI Spec and parsers. I am grouping summer updates to happen every ~2 months. The reason is that there is less activity in the community during this period due to summer holidays, etc. This is the last special one, by the way.

Note This is not an official AsyncAPI update but a personal summary I volunteer to do.

What do I mean by AsyncAPI Spec and parsers update?. As most of the work around the AsyncAPI Spec is not only related to, each update will include the most significant recent activity from the following repositories:

Feel free to ask me to include any other repository if you consider it makes sense. Also, in case you want to help me with these updates :)



2.4.1 efforts were stopped 🔧

The release effort was considered not worth it. Instead, changes will be included in version 2.5.

See Work on 2.4.1 release.

2.5 release is going to happen soon! 🚀

For the record, AsyncAPI release cadence marks September as a release month. This time, the release version will be 2.5.0, and **Vladimír Gorej is the Release Coordinator 🙌.

Most of the changes are going to be clarifications on the spec. However, you can see the complete list of RFCs that are going to be included but also some candidates in Work on 2.5.0 release.

3.0 work is moving on! 🧑‍🍳

Work on 3.0 is moving forward slowly. These are the issues and PRs with recent activity:

  • Issue: Unify all referencing mechanisms in v3 by Fran Méndez.
    • Topic: At this moment, there is some inconsistency when referencing objects. In some places, $ref is required; in others, the value consists of the object's id (or the key in the map the object is located in). Removing such an inconsistency is the primary goal of this discussion.
    • Please join and leave your opinion. ✍️
  • PR: Move operations to its own root object by Fran Méndez.
    • Topic: As the title says, Operations will not be directly linked inside the channel but in the root document itself. This helps with decoupling and reusing Operations.
      • 👀 Code review is needed 👀
  • PR: Add new channels object by Fran Méndez.
    • Topic: Channel object gets revamped.
      • Name is no longer an address; instead, a new field address holds that information.
      • It is not tied directly to an operation.
      • Messages are still part of the channel but not anymore to the operation.
      • 👀 Code review is needed 👀
  • PR: Add more reusable objects to the components object by Maciej Urbańczyk.
    • Topic: adds External Documentation Object and Tag Object to become reusable objects by allowing them to be declared inside components.
    • 👀 Code review is needed 👀
  • PR: Move root tags and externalDocs to the info object by Maciej Urbańczyk.
    • Topic: move both tags and externalDocs fields from the root of the AsyncAPI document to the Info Object.
    • This PR is accepted by some Code Owners and seems ready to go. But still, you can review it!.

As a side note, more Spec 3.0 live meetings have been held 📹. See the list of issues with links to video recordings here.

A new schema referencing standard is being brewed! 💭

The main purpose behind this is to support referencing other schemas rather than JSON or convertible to JSON.

Jonas Lagoni opened this draft PR with the very first concepts on how this new referencing standard could work. More people joined the party, including maintainers of OpenAPI and JSON Schema, to set some base requirements and add clarifications about how existing technology, such as JSON Schema $Ref Parser works (used by Parser-JS).

Everything is very abstract and still a draft, but if you want to be part of this journey, do not hesitate to join asap!

Application of the Apache 2.0 license got fixed ⚖️

Because producing FOSS is not only about writing software but also about licensing. AsyncAPI is using Apache 2.0 license and still will keep using it. However, Vladimír Gorej detected a wrong application of it and created a fix. You can see it in the PR improve license application.


v3.1.0 got released! 🎉

Brought by Sergio Moya, this new version adds a new JSON Schema document listing all Schema-Store JSON Schema documents. This is needed to serve all the JSON Schema documents related to all AsyncAPI Spec versions through Schema-Store.

Custom validations are now listed in the documentation. 📝

Sandra made a great addition to the README file listing all custom validations needed to validate an AsyncAPI document and validating through the JSON Schema documents. See this fantastic new Custom Validation Needs section 🙌.

Bindings versioning is materializing! 🚀

Jonas Lagoni did excellent work on handling binding versions and integrating them into the specification.

TL;DR: All bindings will now be located in spec-json-schemas repository, following a concrete folder structure that will allow people to work on bindings alongside the spec itself and continuously release new binding versions.

Even though the PR is not merged yet, it has been approved by a few code owners. But still, your feedback is always needed! ✍️

A new tree shakeable module is on the way 🍃

Maciej Urbańczyk opened a PR that adds a "tree shakeable" module, which includes support for getting a list of supported AsyncAPI versions and TS types.

This new change will improve UX (by providing that list of supported versions) but also reduce the browser version size of this package.

Dropping support for schemas prior to 2.0 ❌

Lukasz Gornicki is suggesting in this issue that we should drop support for schemas before Spec 2.0. The reason seems to be pretty simple: we don’t really give support for those Spec versions, so we should not support those schemas either.

There is an ongoing discussion you might want to join at drop asyncapi json schemas prior 2.0 and release 4.0 ✍️👀.

Bug validating AsyncAPI files using VS Code editor 🐛

This issue is a bit broader than it seems. It is not a bug on the AsyncAPI side, but this is affecting it.

Thanks to Schema-Store now providing AsyncAPI schemas globally, VS Code YAML plugin takes advantage of auto-validation of AsyncAPI documents. However, there seems to be an issue with how the plugin parses references, breaking AsyncAPI JSON Schema documents.

Some possible solutions (or hacks) are being discussed in Vscode unable to resolve parts of the schema, so please join if you have some better alternative 🙏.


v1.16.0 got released! 🎉

This new release includes a commit that fixes several bugs when this library is used within a browser. The PR, brought by Viacheslav Turovskyi 🙌 fixes the following issues:

v2.0.0 is getting closer! 🧑‍🍳

Migrating project to TypeScript and Implementing Parser-API (Intent-Driven) moved forward, and now, only some last details are pending.

You can see all the pending work on Road to v2.0.0.

All the changes are being merged into the next-spec-major branch and brought by Maciej Urbańczyk, and Sergio Moya.

How to release the 2.0.0 version of the parser-js is an ongoing discussion you might want to join.

There is also an issue regarding how Spectral (the new parser used in this version) does not Support all edge cases with circular references. 👀 are needed!


Reworks and tune-ups to the API

Sergio Moya created Add Components, Security Requirement(s) models and other improvements. The PR contains all the required changes Maciej Urbańczyk and Sergio Moya found to be missing or wrong during the implementation of Implement Parser-API (Intent-Driven).

There is an ongoing discussion around the necessary existence of the Components object you might want to join 🙏.


Google Pub/Sub bindings are almost here! 🔜

Jeremy Whitlock submitted a PR adding googlepubsub bindings. Few owners accepted the PR, and it seems it will be merged soon 🚀.

Solace bindings rewording ✍️

Michael Davis reworded the Solace binding docs to reflect the reality around which type of operation a binding applies to, e.g. a queue can only be used on a publish operation. Solace decided this was too restrictive and removed this wording to allow any binding to be used with either type of operation. The change can be seen here.

Making usage of Schema Object consistent 🧑‍⚖️

Vladimír Gorej created this PR, which allows the use of Reference Object in binding objects fields and updates schemas to use the latest versions of AsyncAPI schemas (2.4.0).

Adding value parameters for websocket bindings 🌎

Souvik is adding 2 new value parameters for the websocket bindings:

  • headerValues
  • queryValues

The PR is still being reviewed, so feel free to join and give your thoughts! 👀

Align wording with RFC 2119 🔍

Vladimír Gorej is fixing some words that are not aligned with RFC 2119The PR is open and accepted by some owners.


v1.1.0 got released! 🎉

Thanks to Ludovic Dussart, the Avro Schema Parser now supports record references described in Manage reference to objects declared previously in avro schema. See the code changes in this PR.


v0.4.2 got released! 🎉

Thanks to Jonathan Buch, the Go Parser now supports recursive dereferencing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment