Skip to content

Commit

Permalink
add migration
Browse files Browse the repository at this point in the history
  • Loading branch information
jonaslagoni committed Nov 30, 2023
1 parent d34cb00 commit b43704b
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 9 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Updated bundle for the browser is always attached to the GitHub Release.
> 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.
> **Note**
> Read the [migration guide from v1 to v2](./docs/migrations/v1-to-v2.md).
> Read the [migration guide from v2 to v3](./docs/migrations/v2-to-v3.md).

<!-- toc is generated with GitHub Actions do not remove toc markers -->
Expand Down
26 changes: 26 additions & 0 deletions docs/migrations/v2-to-v3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Migrating from v2 to v3

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).

## Parser API v1 to v3
There are only very few changes, for message and message traits.

## Message

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

Since `messageId` have been removed, you need to use `id` instead.

## MessageTrait

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

Since `messageId` have been removed, you need to use `id` instead.
14 changes: 7 additions & 7 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
"prepublishOnly": "npm run generate:assets"
},
"dependencies": {
"@asyncapi/specs": "^6.0.0-next-major-spec.9",
"@asyncapi/specs": "^6.0.0",
"@openapi-contrib/openapi-schema-to-json-schema": "~3.2.0",
"@stoplight/json": "^3.20.2",
"@stoplight/json-ref-readers": "^1.2.2",
Expand Down

0 comments on commit b43704b

Please sign in to comment.