Skip to content

Commit cea0858

Browse files
timonbacksam0r040
andauthored
docs: Mark AsyncApiDocket as not recommended (#45)
* docs: Mark AsyncApiDocket as not recommended * Update configuration.md --------- Co-authored-by: sam0r040 <[email protected]>
1 parent d3097c7 commit cea0858

File tree

3 files changed

+18
-10
lines changed

3 files changed

+18
-10
lines changed

docs/configuration/configuration.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ import CodeConfigurationAsyncApiDocket from '!!raw-loader!./snippets/_configurat
99

1010
# Configuration
1111

12-
There are 2 ways to configure springwolf:
12+
There are 2 ways to configure springwolf which cannot be combined:
1313

14-
1. `application.properties`, which is simple and should suit most use-cases
15-
2. `AsyncApiDocket`, which allows adding producers and consumers via code (and avoiding annotations)
14+
1. `application.properties`, which is simple and moves all configuration to this file and annotations
15+
2. (deprecated) `AsyncApiDocket`, which allows adding producers and consumers via code (instead of annotations)
1616

1717
<Tabs>
1818
<TabItem value="application.properties" label="application.properties" default>
@@ -78,4 +78,4 @@ The following table contains additional properties that can be specified in the
7878
[identifier]: https://www.asyncapi.com/docs/reference/specification/v2.0.0#A2SIdString.
7979
[info]: https://www.asyncapi.com/docs/reference/specification/v2.0.0#infoObject.
8080
[server]: https://www.asyncapi.com/docs/reference/specification/v2.0.0#serversObject
81-
[default-content-type]: https://www.asyncapi.com/docs/reference/specification/v2.0.0#defaultContentTypeString
81+
[default-content-type]: https://www.asyncapi.com/docs/reference/specification/v2.0.0#defaultContentTypeString

docs/configuration/documenting-consumers.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,10 +88,10 @@ Associate this operation with kafka, see [operation-binding] for details.
8888
```
8989

9090

91-
## Option 2: `ConsumerData`
91+
## Option 2: `ConsumerData` (deprecated)
9292

93-
:::tip
94-
Use specific ConsumerData types `AmqpConsumerData` & `KafkaConsumerData` for protocol specific attributes
93+
:::note
94+
Must use configuration via `AsyncApiDocket` and cannot use `application.properties`.
9595
:::
9696

9797
Below is an example of describing a Kafka consumer:
@@ -119,6 +119,10 @@ public AsyncApiDocket asyncApiDocket() {
119119

120120
Multiple consumers can be configured by calling the `consumer()` method multiple times.
121121

122+
:::tip
123+
Use specific ConsumerData types `AmqpConsumerData` & `KafkaConsumerData` for protocol specific attributes
124+
:::
125+
122126
### Channel Name
123127

124128
The channel name (or topic name in case of Kafka) - this is the name that will be used to subscribe to messages to by the UI.

docs/configuration/documenting-producers.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -83,10 +83,10 @@ Associate this operation with kafka, see [operation-binding] for details.
8383
```
8484

8585

86-
## Option 2: `ProducerData`
86+
## Option 2: `ProducerData` (deprecated)
8787

88-
:::tip
89-
Use specific ProducerData types `AmqpProducerData` & `KafkaProducerData` for protocol specific attributes
88+
:::note
89+
Must use configuration via `AsyncApiDocket` and cannot use `application.properties`.
9090
:::
9191

9292
Below is an example of describing a Kafka producer:
@@ -114,6 +114,10 @@ public AsyncApiDocket asyncApiDocket() {
114114

115115
Multiple producers can be configured by calling the `producer()` method multiple times.
116116

117+
:::tip
118+
Use specific ProducerData types `AmqpProducerData` & `KafkaProducerData` for protocol specific attributes
119+
:::
120+
117121
### Channel Name
118122

119123
The channel name (or topic name in case of Kafka) - this is the name that will be used to publish messages to by the UI.

0 commit comments

Comments
 (0)