Skip to content

Commit

Permalink
Merge pull request #72 from ctasada/ctasada/update-spec-links
Browse files Browse the repository at this point in the history
chore: Updated AsyncAPI reference links to 3.0
  • Loading branch information
ctasada authored Apr 9, 2024
2 parents 39261a4 + 8e5a311 commit 9b4bd36
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions docs/behind-the-scenes.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The following paragraphs describe how Springwolf works internally.

## Big Picture
When the Spring Boot application is started, Springwolf uses its scanners to find defined consumers and producers within the application.
Based on the results, the channels/topics are extracted including payload type and merged together into an [AsyncAPI conform document](https://www.asyncapi.com/docs/reference/specification/v2.6.0).
Based on the results, the channels/topics are extracted including payload type and merged together into an [AsyncAPI conform document](https://www.asyncapi.com/docs/reference/specification/v3.0.0).

The AsyncAPI document is accessible an endpoint.
When the Springwolf UI is opened, the browser fetches the document and renders it (see demo).
Expand All @@ -26,7 +26,7 @@ When building own scanner plugins, your plugin will need to implement the `Chann
`springwolf-core` runs all scanners and merges the found results together into one AsyncAPI document.
When the same channel/topic is found multiple times, it's merged as well.

The result is a [`ChannelItem`](https://www.asyncapi.com/docs/reference/specification/v2.6.0#channelItemObject).
The result is a [`ChannelItem`](https://www.asyncapi.com/docs/reference/specification/v3.0.0#channelObject).
The `ChannelObject` contains the `Message` for the receive and/or send operation.

## Building an example payload
Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/documenting-bindings.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,4 +153,4 @@ The Message Binding Object is used to describe the Google Cloud Pub/Sub PubsubMe
- name: The name of the schema


[operation-binding]: https://www.asyncapi.com/docs/reference/specification/v2.6.0#operationBindingsObject
[operation-binding]: https://www.asyncapi.com/docs/reference/specification/v3.0.0#operationBindingsObject

0 comments on commit 9b4bd36

Please sign in to comment.