From 8e5a31125f7d8615cdefe6cffbdc5448fa0b9d8b Mon Sep 17 00:00:00 2001 From: "carlos.tasada" <carlos.tasada@personio.de> Date: Mon, 8 Apr 2024 18:31:13 +0200 Subject: [PATCH] chore: Updated AsyncAPI reference links to 3.0 The links to AsyncAPI were still referencing to 2.6.0 --- docs/behind-the-scenes.md | 4 ++-- docs/configuration/documenting-bindings.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/behind-the-scenes.md b/docs/behind-the-scenes.md index df7da96..9f26ee8 100644 --- a/docs/behind-the-scenes.md +++ b/docs/behind-the-scenes.md @@ -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). @@ -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 diff --git a/docs/configuration/documenting-bindings.md b/docs/configuration/documenting-bindings.md index e9071dd..4eed49e 100644 --- a/docs/configuration/documenting-bindings.md +++ b/docs/configuration/documenting-bindings.md @@ -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