Avro union not displayed correctly in the bindings bloc

[M3lkior]

I use the avro-parser (usage of avsc files) in the AsyncAPI specification for my kafka messages payload and key

When i use a record definition with union fields (like "type": ["null", { "type": "string", "avro.java.string": "String" }] or "type": ["null", { "type": "int" }], the definition is not correctly displayed :

Expected result

The display should be like the payload part (actually working like a charm with avro files):

the record type is not handle

Actual result

Steps to reproduce

• The avro schema definition :

{
  "namespace": "sample",
  "type": "record",
  "name": "SampleRecord",
  "version": 1,
  "fields": [
    {"name": "NoUnionField", "type": { "type": "string",  "avro.java.string": "String" }, "doc": "Any doc"},
    {"name": "UnionField", "type": ["null", { "type": "string",  "avro.java.string": "String" }], "doc": "any doc"}
  ]
}

• the spec file with avro reference :

asyncapi: '2.1.0'
id: 'urn:adeo:dev:euw1:sample'
info:
  version: ''
  description: 

channels:
  test:
    subscribe:
      summary: Get updated products
      message:
        $ref: "#/components/messages/example-value"

components:
  messages:
    example-value:
      schemaFormat: 'application/vnd.apache.avro;version=1.9.0'
      payload:
        $ref: "SampleRecord.avsc" 
      bindings:
        kafka:
          key: 
            $ref: "SampleRecord.avsc" 

Troubleshooting

[magicmatatjahu]

@M3lkior Hi! Sorry for late response, I was off in the previous week (to be more precise, I had holidays). I tested locally your schema and as I see (also you mentioned it in your comment), the payload for message renders correctly, but problem is with bindings.kafka.key. The problem is not related with component but with avro parser - you can look on code here https://github.com/asyncapi/avro-schema-parser/blob/master/index.js As you can see, parser transforms only the payload for the message, and doesn't look for schemas in the bindings.

We have such an issues to handle validation for the bindings - asyncapi/parser-js#315 and as I see we should also handle transforming schemas in the bindings.

I will move this issue to the avro parser repository. Do you have any questions?

[magicmatatjahu]

The problem is that we don't support the transforming of schemas in other places (like bindings) than message.payload -> https://github.com/asyncapi/avro-schema-parser/blob/master/index.js#L4

[M3lkior]

hi @magicmatatjahu ; thanks for the reply ! it is clear and precise ! i hope this issue will be resolved soon :)

[M3lkior]

i will take this issue and do a PR proposal :)

[M3lkior]

hi @magicmatatjahu @fmvilas @derberg ; i submit a first proposal of the avro bindings bloc support, but only for the protocol key part.
Any feedback on this ?

[asyncapi-bot]

🎉 This issue has been resolved in version 0.5.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀