Skip to content

Commit 50f4f64

Browse files
authored
feat: prepare for release (#920)
1 parent d34cb00 commit 50f4f64

File tree

4 files changed

+35
-9
lines changed

4 files changed

+35
-9
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Updated bundle for the browser is always attached to the GitHub Release.
1313
> This package has rewrote the Model API (old one) to [Intent API](https://github.com/asyncapi/parser-api). If you still need to use the old API, read the [Convert to the old API](#convert-to-the-old-api) section.
1414
1515
> **Note**
16-
> Read the [migration guide from v1 to v2](./docs/migrations/v1-to-v2.md).
16+
> Read the [migration guide from v2 to v3](./docs/migrations/v2-to-v3.md).
1717
1818

1919
<!-- toc is generated with GitHub Actions do not remove toc markers -->

docs/migrations/v2-to-v3.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Migrating from v2 to v3
2+
3+
The ONLY thing that changes between v2 and v3 is that we now use [parser API v3](https://github.com/asyncapi/parser-api/commit/954a59e41ccdb70de51eb43901f61b79198fbb51) where v2 used [parser API v1](https://github.com/asyncapi/parser-api/commit/7dab1eeb796f8c8c079e5d0c4d671d55a60bc8ca).
4+
5+
## Parser API v1 to v3
6+
There are only very few changes, for message and message traits.
7+
8+
## Message
9+
10+
```diff
11+
- - messageId(): `string` | `undefined`
12+
- - schemaFormat(): `string`
13+
+ - schemaFormat(): `string` | `undefined`
14+
```
15+
16+
Since `messageId` have been removed, you need to use `id` instead.
17+
18+
## MessageTrait
19+
20+
```diff
21+
- - messageId(): `string` | `undefined`
22+
- - schemaFormat(): `string`
23+
+ - schemaFormat(): `string` | `undefined`
24+
```
25+
26+
Since `messageId` have been removed, you need to use `id` instead.

package-lock.json

+7-7
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
"prepublishOnly": "npm run generate:assets"
4242
},
4343
"dependencies": {
44-
"@asyncapi/specs": "^6.0.0-next-major-spec.9",
44+
"@asyncapi/specs": "^6.0.0",
4545
"@openapi-contrib/openapi-schema-to-json-schema": "~3.2.0",
4646
"@stoplight/json": "^3.20.2",
4747
"@stoplight/json-ref-readers": "^1.2.2",

0 commit comments

Comments
 (0)