Skip to content

Commit

Permalink
add v6 migration guide
Browse files Browse the repository at this point in the history
  • Loading branch information
jonaslagoni committed Oct 9, 2023
1 parent b43d3d6 commit 340e842
Showing 1 changed file with 1 addition and 19 deletions.
20 changes: 1 addition & 19 deletions migrations/migrate-to-version-6.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,3 @@
# Migrating to version 6

In version 6 and onwards, all pre-release spec versions will be released as a regular feature request, before the spec itself is released.

The pre-release version will be released as if it was not a pre-release, for example for AsyncAPI 3.0, it will be released as normal:
```js
module.exports = {
'schemas': {
...
'3.0.0': require('./schemas/3.0.0.json'),
},
'schemasWithoutId': {
...
'3.0.0': require('./schemas/3.0.0-without-$id.json'),
}
};
```

However, while the it's still a pre-release, the underlying schemas CAN contain breaking changes from version to version, up until the spec is released. This means that one AsyncAPI document using v3 in the pre-release stage might be valid in `6.0.0`, but invalid in the `6.1.0`. This ONLY applies to pre-release schemas, and NOT regular ones that is set in stone.

If you want to make sure you don't use a schema not released yet, you have to whitelist which versions you allow in your tool.
In version 6 and onwards, all bindings will now be validated along side the specification. This means that documents that was valid before might not be valid anymore if the bindings in their document is incorrect.

0 comments on commit 340e842

Please sign in to comment.