From 340e842a3a27498361022e743b4239fbb77d593e Mon Sep 17 00:00:00 2001 From: "jonas-lt@live.dk" Date: Mon, 9 Oct 2023 10:16:34 +0200 Subject: [PATCH] add v6 migration guide --- migrations/migrate-to-version-6.md | 20 +------------------- 1 file changed, 1 insertion(+), 19 deletions(-) diff --git a/migrations/migrate-to-version-6.md b/migrations/migrate-to-version-6.md index b7b381bf..438a01f2 100644 --- a/migrations/migrate-to-version-6.md +++ b/migrations/migrate-to-version-6.md @@ -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. \ No newline at end of file +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. \ No newline at end of file