Clarify what to do if Schema Object contains $schema and message schemaFormat

[jonaslagoni]

Currently, in the specification, we dont mention anything about what to do with a payload, if we encounter such a use-case where someone decides to define both keywords.

asyncapi: '2.2.0'
...
channels:
  light/measured:
    publish:
      summary: Inform about environmental lighting conditions for a particular streetlight.
      operationId: onLightMeasured
      message:
        $ref: '#/components/messages/LightMeasured'
components:
  messages:
    LightMeasured: 
      name: LightMeasured
      schemaFormat: application/vnd.aai.asyncapi+yaml;version=2.2.0
      payload:
        $ref: '#/components/schemas/LightMeasurement'
  schemas:
    LightMeasurement:
      $schema: 'http://json-schema.org/draft-04/schema#'

Should tooling follow schemaFormat or $schema?

[magicmatatjahu]

If the AsyncAPI Schema Object is a draft-07 superset, then by default its $schema is (or rather should be) defined as draft-07. On the other hand, if one uses a different version of the $schema field than draft 07, then the parser implementation for custom scheme (as plugin) should validate the schema according to the version specified in the $schema field and try to convert the schema to be compatible with draft 07 - just like we do now with AVRO and Raml - we convert it to AsyncAPI Object. Also we should indicates in spec that additional keywords like deprecated, externalDocs and discriminator is also allowed with other than draft-07 schema.

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

[jonaslagoni]

Still relevant.