Skip to content

Feat/release 1.3.0 #87

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 31, 2024
Merged

Feat/release 1.3.0 #87

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fc1bc90
docs: Springwolf 1.3.0 release
timonback May 31, 2024
8e5220c
chore(deps): update dependencies
timonback May 31, 2024
7b5b841
docs: improve documentation on server name
timonback May 31, 2024
753e820
docs: add new bindings
timonback May 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/configuration/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ All provided fields will be present in the generated document, but not all will
### `Servers` (required)

The `Server` object provides metadata to help the reader understand the protocol, version, login details and more (see [AsyncAPI Server Object](https://www.asyncapi.com/docs/reference/specification/v3.0.0#serversObject)).
Any name (`kafka-server` in the example) can be chosen.

An AsyncAPI document can contain more than one server, but it's not common.

Expand Down
4 changes: 2 additions & 2 deletions docs/configuration/documenting-consumers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Below is an example to demonstrate the annotation:
@AsyncListener(operation = @AsyncOperation(
channelName = "example-consumer-topic",
description = "Customer uploaded an example payload", // Optional
servers = {"kafka"}, // Optional
servers = {"kafka-server"}, // Optional
headers = @AsyncOperation.Headers( // Optional
schemaName = "SpringKafkaDefaultHeaders",
values = {
Expand Down Expand Up @@ -73,7 +73,7 @@ Optional. The headers describing the metadata of the payload.
### Servers

Optional. Useful when an application is connect to multiple brokers and wants to indicate to which broker the channel belongs to.
The server needs to exist in [configuration > Servers](configuration.mdx) as well.
The server name needs to exist in [configuration > Servers](configuration.mdx) as well.

## `@JmsListener`, `@KafkaListener`, `@RabbitListener`, `@SqsListener`

Expand Down
4 changes: 2 additions & 2 deletions docs/configuration/documenting-producers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Below is an example to demonstrate the annotation:
@AsyncPublisher(operation = @AsyncOperation(
channelName = "example-producer-topic",
description = "Customer uploaded an example payload", // Optional
servers = {"kafka"}, // Optional
servers = {"kafka-server"}, // Optional
headers = @AsyncOperation.Headers( // Optional
schemaName = "SpringKafkaDefaultHeaders",
values = {
Expand Down Expand Up @@ -67,4 +67,4 @@ Optional. The headers describing the metadata of the payload.
### Servers

Optional. Useful when an application is connect to multiple brokers and wants to indicate to which broker the channel belongs to.
The server needs to exist in [configuration > Servers](configuration.mdx) as well.
The server name needs to exist in [configuration > Servers](configuration.mdx) as well.
4 changes: 2 additions & 2 deletions docs/configuration/snippets/_configuration_properties.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ springwolf.docket.base-package=io.github.springwolf.example
springwolf.docket.info.title=${spring.application.name}
springwolf.docket.info.version=1.0.0

springwolf.docket.servers.kafka.protocol=kafka
springwolf.docket.servers.kafka.host=${spring.kafka.bootstrap-servers}
springwolf.docket.servers.kafka-server.protocol=kafka
springwolf.docket.servers.kafka-server.host=${spring.kafka.bootstrap-servers}

# Springwolf - optional fields
springwolf.enabled=true
Expand Down
13 changes: 8 additions & 5 deletions docs/introduction/supported-protocols.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,14 @@ Springwolf also provides some libraries to document bindings. Those libraries pr

The supported binding annotations are:

| Protocol | Annotations | Latest Plugin Version |
|---------------|-------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| GooglePubSub | `@GooglePubSubAsyncChannelBinding` | ![Maven Central](https://img.shields.io/maven-central/v/io.github.springwolf/springwolf-googlepubsub-binding?color=green&label=springwolf-googlepubsub-binding&style=plastic) |
| SNS | `@SnsAsyncOperationBinding` | ![Maven Central](https://img.shields.io/maven-central/v/io.github.springwolf/springwolf-sns-binding?color=green&label=springwolf-sns-binding&style=plastic) |
| SQS | `@SqsAsyncOperationBinding` | ![Maven Central](https://img.shields.io/maven-central/v/io.github.springwolf/springwolf-sqs-binding?color=green&label=springwolf-sqs-binding&style=plastic) |
| Protocol | Annotations | Latest Plugin Version |
|--------------|------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| AMQP | `@AmqpAsyncOperationBinding` | ![Maven Central](https://img.shields.io/maven-central/v/io.github.springwolf/springwolf-amqp-binding?color=green&label=springwolf-amqp-binding&style=plastic) |
| GooglePubSub | `@GooglePubSubAsyncChannelBinding` | ![Maven Central](https://img.shields.io/maven-central/v/io.github.springwolf/springwolf-googlepubsub-binding?color=green&label=springwolf-googlepubsub-binding&style=plastic) |
| JMS | `@JmsAsyncOperationBinding` | ![Maven Central](https://img.shields.io/maven-central/v/io.github.springwolf/springwolf-jms-binding?color=green&label=springwolf-jms-binding&style=plastic) |
| Kafka | `@KafkaAsyncOperationBinding` | ![Maven Central](https://img.shields.io/maven-central/v/io.github.springwolf/springwolf-kafka-binding?color=green&label=springwolf-kafka-binding&style=plastic) |
| SNS | `@SnsAsyncOperationBinding` | ![Maven Central](https://img.shields.io/maven-central/v/io.github.springwolf/springwolf-sns-binding?color=green&label=springwolf-sns-binding&style=plastic) |
| SQS | `@SqsAsyncOperationBinding` | ![Maven Central](https://img.shields.io/maven-central/v/io.github.springwolf/springwolf-sqs-binding?color=green&label=springwolf-sqs-binding&style=plastic) |

:::info
See [Add-Ons / Generic Annotation Binding](../add-ons#generic-binding)
Expand Down
4 changes: 2 additions & 2 deletions docs/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ springwolf.docket.base-package=io.github.springwolf.example.consumers
springwolf.docket.info.title=${spring.application.name}
springwolf.docket.info.version=1.0.0

springwolf.docket.servers.kafka.protocol=kafka
springwolf.docket.servers.kafka.host=${kafka.bootstrap.servers:localhost:29092}
springwolf.docket.servers.kafka-server.protocol=kafka
springwolf.docket.servers.kafka-server.host=${kafka.bootstrap.servers:localhost:29092}
```

*Make sure to change the value of `springwolf.docket.base-package` to the package containing your listeners, so that Springwolf will automatically pick them up.*
Expand Down
2 changes: 1 addition & 1 deletion docs/snippets/_springwolf_common_model_converters_groovy.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
dependencies {
implementation 'io.github.springwolf:springwolf-common-model-converters:1.2.0'
implementation 'io.github.springwolf:springwolf-common-model-converters:1.3.0'
}
2 changes: 1 addition & 1 deletion docs/snippets/_springwolf_common_model_converters_maven.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
<dependency>
<groupId>io.github.springwolf</groupId>
<artifactId>springwolf-common-model-converters</artifactId>
<version>1.2.0</version>
<version>1.3.0</version>
</dependency>
</dependencies>
2 changes: 1 addition & 1 deletion docs/snippets/_springwolf_generic_binding_groovy.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
dependencies {
implementation 'io.github.springwolf:springwolf-generic-binding:1.2.0'
implementation 'io.github.springwolf:springwolf-generic-binding:1.3.0'
}
2 changes: 1 addition & 1 deletion docs/snippets/_springwolf_generic_binding_maven.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
<dependency>
<groupId>io.github.springwolf</groupId>
<artifactId>springwolf-generic-binding</artifactId>
<version>1.2.0</version>
<version>1.3.0</version>
</dependency>
</dependencies>
4 changes: 2 additions & 2 deletions docs/snippets/_springwolf_groovy.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
dependencies {
// Provides the documentation API
implementation 'io.github.springwolf:springwolf-kafka:1.2.0'
implementation 'io.github.springwolf:springwolf-kafka:1.3.0'

// Provides the UI - optional (recommended)
runtimeOnly 'io.github.springwolf:springwolf-ui:1.2.0'
runtimeOnly 'io.github.springwolf:springwolf-ui:1.3.0'
}
2 changes: 1 addition & 1 deletion docs/snippets/_springwolf_json_schema_groovy.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
dependencies {
implementation 'io.github.springwolf:springwolf-json-schema:1.2.0'
implementation 'io.github.springwolf:springwolf-json-schema:1.3.0'
}
2 changes: 1 addition & 1 deletion docs/snippets/_springwolf_json_schema_maven.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
<dependency>
<groupId>io.github.springwolf</groupId>
<artifactId>springwolf-json-schema</artifactId>
<version>1.2.0</version>
<version>1.3.0</version>
</dependency>
</dependencies>
2 changes: 1 addition & 1 deletion docs/snippets/_springwolf_kotlinx_serialization_model_converter_groovy.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
dependencies {
implementation 'io.github.springwolf:springwolf-kotlinx-serialization-model-converter:1.2.0'
implementation 'io.github.springwolf:springwolf-kotlinx-serialization-model-converter:1.3.0'
}
2 changes: 1 addition & 1 deletion docs/snippets/_springwolf_kotlinx_serialization_model_converter_maven.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
<dependency>
<groupId>io.github.springwolf</groupId>
<artifactId>springwolf-kotlinx-serialization-model-converter</artifactId>
<version>1.2.0</version>
<version>1.3.0</version>
</dependency>
</dependencies>
4 changes: 2 additions & 2 deletions docs/snippets/_springwolf_maven.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
<dependency>
<groupId>io.github.springwolf</groupId>
<artifactId>springwolf-kafka</artifactId>
<version>1.2.0</version>
<version>1.3.0</version>
</dependency>
<!-- Provides the UI - optional (recommended) -->
<dependency>
<groupId>io.github.springwolf</groupId>
<artifactId>springwolf-ui</artifactId>
<version>1.2.0</version>
<version>1.3.0</version>
</dependency>
</dependencies>
Loading
Loading