docs: clarify the user of multiple scanners (#84)

* docs: clarify the user of multiple scanners * Update configuration.mdx
springwolf · May 31, 2024 · 28b769a · 28b769a
1 parent 14a63a5
commit 28b769a
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/docs/behind-the-scenes.md b/docs/behind-the-scenes.md
@@ -28,6 +28,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.
+One example of such, is when a method uses the Springwolf `@AsyncListener` annotation together with the protocol annotation, like `@KafkaListener`.
 
 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.

diff --git a/docs/configuration/configuration.mdx b/docs/configuration/configuration.mdx
@@ -60,7 +60,7 @@ The following table contains additional properties that can be specified in the
 | `springwolf.init-mode`                                   | `fail_fast`        | Springwolf initializes during start up with `fail_fast` or in the `background` after the application has started.                                                                                                                                                                                                                                                                                                                                                                           |
 | `springwolf.paths.docs`                                  | `/springwolf/docs` | The path of the AsyncAPI document in JSON format. *Note that at the moment the UI will work only with the default value.*                                                                                                                                                                                                                                                                                                                                                                   |
 | `springwolf.endpoint.actuator.enabled`                   | `false`            | Publish the AsyncAPI document as part of Spring Boot’s actuator feature.                                                                                                                                                                                                                                                                                                                                                                                                                    |
-| `springwolf.use-fqn`                                     | `true`             | Use fully qualified names for the schema classes. **Required for publishing**                                                                                                                                                                                                                                                                                                                                                                                                               |
+| `springwolf.use-fqn`                                     | `true`             | Use fully qualified names for the schema classes. **Required for publishing with `springwolf-ui`**                                                                                                                                                                                                                                                                                                                                                                                          |
 | `springwolf.payload.extractable-classes..`               | N/A                | Extract additional payload types. See [message payloads](documenting-messages.mdx) for more details.                                                                                                                                                                                                                                                                                                                                                                                        |
 | `springwolf.scanner.async-listener.enabled`              | `true`             | Enable scanner to find methods annotated with `@AsyncListener`.                                                                                                                                                                                                                                                                                                                                                                                                                             |
 | `springwolf.scanner.async-publisher.enabled`             | `true`             | Enable scanner to find methods annotated with `@AsyncPublisher`.                                                                                                                                                                                                                                                                                                                                                                                                                            |
@@ -72,7 +72,7 @@ The following table contains additional properties that can be specified in the
 | `springwolf.plugin.jms.scanner.jms-listener.enabled`     | `true`             | Enable scanner to find methods annotated with `@JmsListener`.                                                                                                                                                                                                                                                                                                                                                                                                                               |
 | **Kafka**                                                |                    |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 | `springwolf.plugin.kafka.publishing.enabled`             | `false`            | Allow (anyone) to produce Kafka messages from the UI. *Note that this has security implications*                                                                                                                                                                                                                                                                                                                                                                                            |
-| `springwolf.plugin.kafka.publishing.producer`            | `null`             | Configure the Kafka producer used to publish messages from the UI. Uses identical parameters as `spring.kafka.producer`. [SpringwolfKafkaProducer](https://github.com/springwolf/springwolf-core/blob/b7c7fa508daf3e9c887eb8924cef78af4ed4de1f/springwolf-examples/springwolf-kafka-example/src/main/java/io/github/springwolf/example/kafka/configuration/CustomSpringwolfKafkaProducer.java#L20) demonstrates multiple producer configuration to publish to Avro and Protobuf. |
+| `springwolf.plugin.kafka.publishing.producer`            | `null`             | Configure the Kafka producer used to publish messages from the UI. Uses identical parameters as `spring.kafka.producer`. [SpringwolfKafkaProducer](https://github.com/springwolf/springwolf-core/blob/b7c7fa508daf3e9c887eb8924cef78af4ed4de1f/springwolf-examples/springwolf-kafka-example/src/main/java/io/github/springwolf/example/kafka/configuration/CustomSpringwolfKafkaProducer.java#L20) demonstrates multiple producer configuration to publish to Avro and Protobuf.            |
 | `springwolf.plugin.kafka.scanner.kafka-listener.enabled` | `true`             | Enable scanner to find methods annotated with `@KafkaListener`.                                                                                                                                                                                                                                                                                                                                                                                                                             |
 | **SNS**                                                  |                    |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 | `springwolf.plugin.sns.publishing.enabled`               | `false`            | Allow (anyone) to produce SNS messages from the UI. *Note that this has security implications*                                                                                                                                                                                                                                                                                                                                                                                              |