Skip to content

Commit 4b5b833

Browse files
timonbacktimonback
authored
Feat/release 1.3.0 (#87)
* docs: Springwolf 1.3.0 release * chore(deps): update dependencies * docs: improve documentation on server name * docs: add new bindings
1 parent 8c9a692 commit 4b5b833

18 files changed

+1579
-1674
lines changed

‎docs/configuration/configuration.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ All provided fields will be present in the generated document, but not all will
2727
### `Servers` (required)
2828

2929
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)).
30+
Any name (`kafka-server` in the example) can be chosen.
3031

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

‎docs/configuration/documenting-consumers.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Below is an example to demonstrate the annotation:
3030
@AsyncListener(operation = @AsyncOperation(
3131
channelName = "example-consumer-topic",
3232
description = "Customer uploaded an example payload", // Optional
33-
servers = {"kafka"}, // Optional
33+
servers = {"kafka-server"}, // Optional
3434
headers = @AsyncOperation.Headers( // Optional
3535
schemaName = "SpringKafkaDefaultHeaders",
3636
values = {
@@ -73,7 +73,7 @@ Optional. The headers describing the metadata of the payload.
7373
### Servers
7474

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

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

‎docs/configuration/documenting-producers.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Below is an example to demonstrate the annotation:
2424
@AsyncPublisher(operation = @AsyncOperation(
2525
channelName = "example-producer-topic",
2626
description = "Customer uploaded an example payload", // Optional
27-
servers = {"kafka"}, // Optional
27+
servers = {"kafka-server"}, // Optional
2828
headers = @AsyncOperation.Headers( // Optional
2929
schemaName = "SpringKafkaDefaultHeaders",
3030
values = {
@@ -67,4 +67,4 @@ Optional. The headers describing the metadata of the payload.
6767
### Servers
6868

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

‎docs/configuration/snippets/_configuration_properties.properties‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ springwolf.docket.base-package=io.github.springwolf.example
33
springwolf.docket.info.title=${spring.application.name}
44
springwolf.docket.info.version=1.0.0
55

6-
springwolf.docket.servers.kafka.protocol=kafka
7-
springwolf.docket.servers.kafka.host=${spring.kafka.bootstrap-servers}
6+
springwolf.docket.servers.kafka-server.protocol=kafka
7+
springwolf.docket.servers.kafka-server.host=${spring.kafka.bootstrap-servers}
88

99
# Springwolf - optional fields
1010
springwolf.enabled=true

‎docs/introduction/supported-protocols.md‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,14 @@ Springwolf also provides some libraries to document bindings. Those libraries pr
3737

3838
The supported binding annotations are:
3939

40-
| Protocol | Annotations | Latest Plugin Version |
41-
|---------------|-------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
42-
| 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) |
43-
| 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) |
44-
| 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) |
40+
| Protocol | Annotations | Latest Plugin Version |
41+
|--------------|------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
42+
| 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) |
43+
| 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) |
44+
| 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) |
45+
| 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) |
46+
| 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) |
47+
| 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) |
4548

4649
:::info
4750
See [Add-Ons / Generic Annotation Binding](../add-ons#generic-binding)

‎docs/quickstart.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ springwolf.docket.base-package=io.github.springwolf.example.consumers
3636
springwolf.docket.info.title=${spring.application.name}
3737
springwolf.docket.info.version=1.0.0
3838

39-
springwolf.docket.servers.kafka.protocol=kafka
40-
springwolf.docket.servers.kafka.host=${kafka.bootstrap.servers:localhost:29092}
39+
springwolf.docket.servers.kafka-server.protocol=kafka
40+
springwolf.docket.servers.kafka-server.host=${kafka.bootstrap.servers:localhost:29092}
4141
```
4242

4343
*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.*

‎docs/snippets/_springwolf_common_model_converters_groovy.gradle‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
dependencies {
2-
implementation 'io.github.springwolf:springwolf-common-model-converters:1.2.0'
2+
implementation 'io.github.springwolf:springwolf-common-model-converters:1.3.0'
33
}

‎docs/snippets/_springwolf_common_model_converters_maven.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22
<dependency>
33
<groupId>io.github.springwolf</groupId>
44
<artifactId>springwolf-common-model-converters</artifactId>
5-
<version>1.2.0</version>
5+
<version>1.3.0</version>
66
</dependency>
77
</dependencies>

‎docs/snippets/_springwolf_generic_binding_groovy.gradle‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
dependencies {
2-
implementation 'io.github.springwolf:springwolf-generic-binding:1.2.0'
2+
implementation 'io.github.springwolf:springwolf-generic-binding:1.3.0'
33
}

‎docs/snippets/_springwolf_generic_binding_maven.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22
<dependency>
33
<groupId>io.github.springwolf</groupId>
44
<artifactId>springwolf-generic-binding</artifactId>
5-
<version>1.2.0</version>
5+
<version>1.3.0</version>
66
</dependency>
77
</dependencies>

0 commit comments

Comments
 (0)