Add migration guides

[jonaslagoni]

Reason/Context

Currently, we have no docs that describe the migration guide between versions, we should add them.

This can be done by checking the commit history and looking for commits with !: i.e. feat!:, that describes a breaking change.

[jonaslagoni]

Here is the TLDR:

Message

- - messageId(): `string` | `undefined`
- - schemaFormat(): `string`
+ - schemaFormat(): `string` | `undefined`

MessageTrait

- - messageId(): `string` | `undefined`
- - schemaFormat(): `string`
+ - schemaFormat(): `string` | `undefined`

for messageId use id instead.

[Ibukun-tech]

what is the meaning of TLDR?

[jonaslagoni]

It's just the short answer to the changes that were between the two versions of v2 and v3 of the parser.

messageId got removed, and should use id instead, schemaFormat changed return types.

[Ibukun-tech]

can I be assigned to this

[Ibukun-tech]

@jonaslagoni

[jonaslagoni]

We got no assignments, just say you are working on it and that's it 👍

[Ibukun-tech]

I am working on this

[Ibukun-tech]

can this be changed to hasMessageId() to hasId()

[RegretfulWinter]

Hi @jonaslagoni, I'm Jiehui Ma (Claudia), a newcomer to AsyncAPI community. I came across this good first issue and based on the TLDR I made a draft version of the migration guide specially for Parser in this PR.

Looking forward to any feedbacks on the wording as well as format! Also if there are anything incorrectly documented, please let me know, I will improve it immediately.

Also, I am not sure if creating the migration document inside this repository is the ideal practice. Shall we integrate it into the main migration guide?

cc @Ibukun-tech also open to discussion so that we can work on together to make the document better!

[Ibukun-tech]

@RegretfulWinter lets work on this together