Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: prepare next-major-spec for release #421

Merged
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.
jonaslagoni marked this conversation as resolved.
Show resolved Hide resolved