Operation channel ref to external asyncapi

[gulecroc]

Hi @ivangsa

I would like to know if it's possible to ref the operation channel to an external asyncapi ?

• common-asyncapi.yaml :

asyncapi: 3.1.0
info:
  title: common
  version: 1.0.0

channels:
  sampleChannel:
    address: sample.topic
    messages:
      SampleMessage:
        $ref: '#/components/messages/SampleMessage'

components:
  messages:
    SampleMessage:
      name: SampleMessage
      payload:
        $ref: '#/components/schemas/SamplePayload'

  schemas:
    SamplePayload:
      type: object

• client-a-asyncapi.yaml KO (ref to external channel) :

asyncapi: 3.1.0
info:
  title: client-a operations
  version: 1.0.0

operations:
  publishSample:
    action: send
    channel:
      $ref: 'common-asyncapi.yaml#/channels/sampleChannel'
    messages:
      - $ref: 'common-asyncapi.yaml#/channels/sampleChannel/messages/SampleMessage'

Error :

java.lang.NullPointerException: Cannot invoke "java.util.List.iterator()" because "messages" is null
    at io.zenwave360.sdk.processors.AsyncApiProcessor.process (AsyncApiProcessor.java:178)
    at io.zenwave360.sdk.MainGenerator.generate (MainGenerator.java:58)
    at io.zenwave360.sdk.GeneratorMojo.execute (GeneratorMojo.java:150)

• client-a-asyncapi.yaml OK (ref to internal channel) :

asyncapi: 3.1.0
info:
  title: client-a operations
  version: 1.0.0

channels:
  sampleChannel:
    $ref: 'common-asyncapi.yaml#/channels/sampleChannel'

operations:
  publishSample:
    action: send
    channel:
      $ref: '#/channels/sampleChannel'
    messages:
      - $ref: '#/channels/sampleChannel/messages/SampleMessage'

Best regards,

[ivangsa]

hi @gulecroc
thanks for reporting this..

external $refs should work, but your api definition is not valid acording asyncapi 3.x:

operation channel must point to a root channels entry, while root channels entries may themselves be external

https://www.asyncapi.com/docs/reference/specification/v3.1.0#operation-object

So this should work

channels:
  sampleChannel:
    $ref: 'common-asyncapi.yaml#/channels/sampleChannel'

operations:
  publishSample:
    action: send
    channel:
      $ref: '#/channels/sampleChannel'

The reason zenwave fails is bc to keep compatibility from v2 and v3, the parser copies the messages to a common decorated property $.channel.x--messages that is only populated from the root channels

Test that a valid spec works for you..

I will leave this issue open to track it for a better error handling..