Skip to content

Extensions for async api? #35

Closed
Closed

Description

@bielu

Hi,

I have a question regarding AsyncAPI extension support.

AsyncAPI allows custom extensions (x-*) throughout the specification, and I'm interested in using them to model additional protocol-specific metadata (potentially for a reusable SignalR binding in the future).

Does AsyncAPI.NET currently support:

Deserializing unknown x-* properties?
Exposing them through the object model?
Preserving them when serializing the document back to YAML/JSON?

For example, if a document contains:

channels:
notifications:
x-signalr:
hub: NotificationHub

would this information be available after parsing and survive a round-trip through the library?

If not, is extension support something that is planned, or would a custom implementation be required?

Thanks!

Activity

  1. VisualBean commented on Jun 21, 2026

    @VisualBean
    Contributor

    It does indeed support custom x-* formats both as simple values and objects (it's part of the 'any' modeling), and should be supported throughout (aside from in avro schema) let me find you an example tonight 👍

    Its documented here

    https://github.com/ByteBardOrg/AsyncAPI.NET/wiki/Extensions

  2. bielu commented on Jun 21, 2026

    @bielu
    ContributorAuthor

    Thanks implement now binding for signalr! so it actually works! thanks

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions