Move schema definition to yaml

[thompson-tomo]

Currently the schema specification is defined as a single markdown file which is very useful for documentation and user reading the doc. However the trade-off is that it is not easily possible to use the specification to generate SDK's just like Elastic does etc. As such I would like to propose that the specification is split into class based yaml files to enable language specific sdk's to be generated using the yaml files.

[derberg]

@thompson-tomo hey there, can you please provide some links as I'm not 100% sure what you mean by the schema specification is defined as a single markdown file - do you mean https://github.com/asyncapi/spec/blob/master/spec/asyncapi.md ?

not sure if you are aware we have https://github.com/asyncapi/spec-json-schemas

[thompson-tomo]

Yes I am aware of the schema project however the following is concerning:
These JSON Schema files do not reflect 1:1 the specification and shouldn't be treated as specification itself but rather as a tool (e.g., for validation).

Effectively wanting a reliable way to generate classes based on the schema.

[derberg]

oh, sorry, but the comment from readme is an info for people to remember that spec markdown is what is considered spec.

from model/classes generation perspective - it is highly reliable, and if there are some missing parts, just open an issue there.

it's just that json schema do not have all the validation features that we need. For example in markdown spec we can say message examples need to be valid with schema, but the same is not possible to define/specify with json schema

[derberg]

no further comments
assuming https://github.com/orgs/asyncapi/discussions/1141#discussioncomment-9352238 was the right answer