chore(core): deprecated AsyncApiDocket bean (#422)

Use spring properties instead Co-authored-by: sam0r040 <[email protected]>
springwolf · Oct 27, 2023 · 6e61df1 · 6e61df1
1 parent 0e3009c
commit 6e61df1
Show file tree

Hide file tree

Showing 10 changed files with 15 additions and 1 deletion.
diff --git a/...mir/springwolf/asyncapi/scanners/channels/operationdata/AbstractOperationDataScanner.java b/...mir/springwolf/asyncapi/scanners/channels/operationdata/AbstractOperationDataScanner.java
@@ -26,6 +26,7 @@
 import static java.util.stream.Collectors.toSet;
 
 @Slf4j
+@Deprecated(forRemoval = true)
 public abstract class AbstractOperationDataScanner implements ChannelsScanner {
 
     protected abstract SchemasService getSchemaService();

diff --git a/...mir/springwolf/asyncapi/scanners/channels/operationdata/ConsumerOperationDataScanner.java b/...mir/springwolf/asyncapi/scanners/channels/operationdata/ConsumerOperationDataScanner.java
@@ -12,6 +12,7 @@
 
 @Slf4j
 @RequiredArgsConstructor
+@Deprecated(forRemoval = true)
 public class ConsumerOperationDataScanner extends AbstractOperationDataScanner {
 
     private final AsyncApiDocketService asyncApiDocketService;

diff --git a/...mir/springwolf/asyncapi/scanners/channels/operationdata/ProducerOperationDataScanner.java b/...mir/springwolf/asyncapi/scanners/channels/operationdata/ProducerOperationDataScanner.java
@@ -12,6 +12,7 @@
 
 @Slf4j
 @RequiredArgsConstructor
+@Deprecated(forRemoval = true)
 public class ProducerOperationDataScanner extends AbstractOperationDataScanner {
 
     private final AsyncApiDocketService asyncApiDocketService;

diff --git a/...wolf-core/src/main/java/io/github/stavshamir/springwolf/configuration/AsyncApiDocket.java b/...wolf-core/src/main/java/io/github/stavshamir/springwolf/configuration/AsyncApiDocket.java
@@ -48,9 +48,11 @@ public class AsyncApiDocket {
      * Provides information about the producers.
      */
     @Singular
+    @Deprecated(forRemoval = true)
     private final List<ProducerData> producers;
 
     @Singular
+    @Deprecated(forRemoval = true)
     private final List<ConsumerData> consumers;
 
     /**

diff --git a/...main/java/io/github/stavshamir/springwolf/configuration/DefaultAsyncApiDocketService.java b/...main/java/io/github/stavshamir/springwolf/configuration/DefaultAsyncApiDocketService.java
@@ -43,6 +43,9 @@ public AsyncApiDocket getAsyncApiDocket() {
     private void createDocket() {
         if (customDocket.isPresent()) {
             log.debug("Reading springwolf configuration from custom defined @Bean AsyncApiDocket");
+            log.warn("The usage of the @Bean AsyncApiDocket is deprecated and scheduled to be deleted. "
+                    + "Use the spring properties file instead. "
+                    + "More details: https://www.springwolf.dev/docs/quickstart");
             docket = customDocket.get();
         } else {
             log.debug("Reading springwolf configuration from application.properties files");

diff --git a/.../io/github/stavshamir/springwolf/configuration/properties/SpringwolfConfigProperties.java b/.../io/github/stavshamir/springwolf/configuration/properties/SpringwolfConfigProperties.java
@@ -178,6 +178,7 @@ public static class ConsumerData {
             /**
              * This mirrors the ConfigConstant {@see SpringwolfConfigConstants#SPRINGWOLF_SCANNER_PRODUCER_DATA_ENABLED}
              */
+            @Deprecated(forRemoval = true)
             private boolean enabled = true;
         }
 
@@ -188,6 +189,7 @@ public static class ProducerData {
             /**
              * This mirrors the ConfigConstant {@see SpringwolfConfigConstants#SPRINGWOLF_SCANNER_RABBIT_LISTENER_ENABLED}
              */
+            @Deprecated(forRemoval = true)
             private boolean enabled = true;
         }
     }
@@ -204,7 +206,7 @@ public static class Endpoint {
         private static class Actuator {
 
             /**
-             * Flag to move the endpoint that exposes the AsyncAPI document beneath Spring Boot’s actuator endpoint.
+             * Flag to move the endpoint that exposes the AsyncAPI document beneath Spring Boot's actuator endpoint.
              */
             private boolean enabled = false;
         }

diff --git a/...plugin/src/main/java/io/github/stavshamir/springwolf/asyncapi/types/AmqpConsumerData.java b/...plugin/src/main/java/io/github/stavshamir/springwolf/asyncapi/types/AmqpConsumerData.java
@@ -10,6 +10,7 @@
 import java.util.Collections;
 import java.util.Map;
 
+@Deprecated(forRemoval = true)
 public class AmqpConsumerData extends ConsumerData {
 
     @Builder(builderMethodName = "amqpConsumerDataBuilder")

diff --git a/...plugin/src/main/java/io/github/stavshamir/springwolf/asyncapi/types/AmqpProducerData.java b/...plugin/src/main/java/io/github/stavshamir/springwolf/asyncapi/types/AmqpProducerData.java
@@ -10,6 +10,7 @@
 import java.util.Collections;
 import java.util.Map;
 
+@Deprecated(forRemoval = true)
 public class AmqpProducerData extends ProducerData {
 
     @Builder(builderMethodName = "amqpProducerDataBuilder")

diff --git a/...lugin/src/main/java/io/github/stavshamir/springwolf/asyncapi/types/KafkaConsumerData.java b/...lugin/src/main/java/io/github/stavshamir/springwolf/asyncapi/types/KafkaConsumerData.java
@@ -9,6 +9,7 @@
 
 import java.util.Map;
 
+@Deprecated(forRemoval = true)
 public class KafkaConsumerData extends ConsumerData {
     @Builder(builderMethodName = "kafkaConsumerDataBuilder")
     public KafkaConsumerData(String topicName, Class<?> payloadType, String description, AsyncHeaders headers) {

diff --git a/...lugin/src/main/java/io/github/stavshamir/springwolf/asyncapi/types/KafkaProducerData.java b/...lugin/src/main/java/io/github/stavshamir/springwolf/asyncapi/types/KafkaProducerData.java
@@ -9,6 +9,7 @@
 
 import java.util.Map;
 
+@Deprecated(forRemoval = true)
 public class KafkaProducerData extends ProducerData {
 
     @Builder(builderMethodName = "kafkaProducerDataBuilder")