From 159c97e71faee1ef8319f370f583ebc614debe69 Mon Sep 17 00:00:00 2001 From: Timon Back Date: Fri, 27 Oct 2023 16:00:59 +0200 Subject: [PATCH] chore(core): deprecated AsyncApiDocket bean Use spring properties instead Co-authored-by: sam0r040 <93372330+sam0r040@users.noreply.github.com> --- .../channels/operationdata/AbstractOperationDataScanner.java | 1 + .../channels/operationdata/ConsumerOperationDataScanner.java | 1 + .../channels/operationdata/ProducerOperationDataScanner.java | 1 + .../stavshamir/springwolf/configuration/AsyncApiDocket.java | 2 ++ .../configuration/DefaultAsyncApiDocketService.java | 3 +++ .../configuration/properties/SpringwolfConfigProperties.java | 4 +++- .../springwolf/asyncapi/types/AmqpConsumerData.java | 1 + .../springwolf/asyncapi/types/AmqpProducerData.java | 1 + .../springwolf/asyncapi/types/KafkaConsumerData.java | 1 + .../springwolf/asyncapi/types/KafkaProducerData.java | 1 + 10 files changed, 15 insertions(+), 1 deletion(-) diff --git a/springwolf-core/src/main/java/io/github/stavshamir/springwolf/asyncapi/scanners/channels/operationdata/AbstractOperationDataScanner.java b/springwolf-core/src/main/java/io/github/stavshamir/springwolf/asyncapi/scanners/channels/operationdata/AbstractOperationDataScanner.java index dbcae7099..907c3443a 100644 --- a/springwolf-core/src/main/java/io/github/stavshamir/springwolf/asyncapi/scanners/channels/operationdata/AbstractOperationDataScanner.java +++ b/springwolf-core/src/main/java/io/github/stavshamir/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/springwolf-core/src/main/java/io/github/stavshamir/springwolf/asyncapi/scanners/channels/operationdata/ConsumerOperationDataScanner.java b/springwolf-core/src/main/java/io/github/stavshamir/springwolf/asyncapi/scanners/channels/operationdata/ConsumerOperationDataScanner.java index fefaffea7..269d1ad5f 100644 --- a/springwolf-core/src/main/java/io/github/stavshamir/springwolf/asyncapi/scanners/channels/operationdata/ConsumerOperationDataScanner.java +++ b/springwolf-core/src/main/java/io/github/stavshamir/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/springwolf-core/src/main/java/io/github/stavshamir/springwolf/asyncapi/scanners/channels/operationdata/ProducerOperationDataScanner.java b/springwolf-core/src/main/java/io/github/stavshamir/springwolf/asyncapi/scanners/channels/operationdata/ProducerOperationDataScanner.java index 0de186c44..c66e02735 100644 --- a/springwolf-core/src/main/java/io/github/stavshamir/springwolf/asyncapi/scanners/channels/operationdata/ProducerOperationDataScanner.java +++ b/springwolf-core/src/main/java/io/github/stavshamir/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/springwolf-core/src/main/java/io/github/stavshamir/springwolf/configuration/AsyncApiDocket.java b/springwolf-core/src/main/java/io/github/stavshamir/springwolf/configuration/AsyncApiDocket.java index ced1ec009..dd1282dec 100644 --- a/springwolf-core/src/main/java/io/github/stavshamir/springwolf/configuration/AsyncApiDocket.java +++ b/springwolf-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 producers; @Singular + @Deprecated(forRemoval = true) private final List consumers; /** diff --git a/springwolf-core/src/main/java/io/github/stavshamir/springwolf/configuration/DefaultAsyncApiDocketService.java b/springwolf-core/src/main/java/io/github/stavshamir/springwolf/configuration/DefaultAsyncApiDocketService.java index d40d3e29f..d71710bd6 100644 --- a/springwolf-core/src/main/java/io/github/stavshamir/springwolf/configuration/DefaultAsyncApiDocketService.java +++ b/springwolf-core/src/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/springwolf-core/src/main/java/io/github/stavshamir/springwolf/configuration/properties/SpringwolfConfigProperties.java b/springwolf-core/src/main/java/io/github/stavshamir/springwolf/configuration/properties/SpringwolfConfigProperties.java index 727e61d33..61c38d550 100644 --- a/springwolf-core/src/main/java/io/github/stavshamir/springwolf/configuration/properties/SpringwolfConfigProperties.java +++ b/springwolf-core/src/main/java/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/springwolf-plugins/springwolf-amqp-plugin/src/main/java/io/github/stavshamir/springwolf/asyncapi/types/AmqpConsumerData.java b/springwolf-plugins/springwolf-amqp-plugin/src/main/java/io/github/stavshamir/springwolf/asyncapi/types/AmqpConsumerData.java index 73cbe9b04..31ed7fd89 100644 --- a/springwolf-plugins/springwolf-amqp-plugin/src/main/java/io/github/stavshamir/springwolf/asyncapi/types/AmqpConsumerData.java +++ b/springwolf-plugins/springwolf-amqp-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/springwolf-plugins/springwolf-amqp-plugin/src/main/java/io/github/stavshamir/springwolf/asyncapi/types/AmqpProducerData.java b/springwolf-plugins/springwolf-amqp-plugin/src/main/java/io/github/stavshamir/springwolf/asyncapi/types/AmqpProducerData.java index 88c716cb7..119da3fe3 100644 --- a/springwolf-plugins/springwolf-amqp-plugin/src/main/java/io/github/stavshamir/springwolf/asyncapi/types/AmqpProducerData.java +++ b/springwolf-plugins/springwolf-amqp-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/springwolf-plugins/springwolf-kafka-plugin/src/main/java/io/github/stavshamir/springwolf/asyncapi/types/KafkaConsumerData.java b/springwolf-plugins/springwolf-kafka-plugin/src/main/java/io/github/stavshamir/springwolf/asyncapi/types/KafkaConsumerData.java index 14c95bd90..fa4c43ebb 100644 --- a/springwolf-plugins/springwolf-kafka-plugin/src/main/java/io/github/stavshamir/springwolf/asyncapi/types/KafkaConsumerData.java +++ b/springwolf-plugins/springwolf-kafka-plugin/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/springwolf-plugins/springwolf-kafka-plugin/src/main/java/io/github/stavshamir/springwolf/asyncapi/types/KafkaProducerData.java b/springwolf-plugins/springwolf-kafka-plugin/src/main/java/io/github/stavshamir/springwolf/asyncapi/types/KafkaProducerData.java index dce468489..fcb651d6f 100644 --- a/springwolf-plugins/springwolf-kafka-plugin/src/main/java/io/github/stavshamir/springwolf/asyncapi/types/KafkaProducerData.java +++ b/springwolf-plugins/springwolf-kafka-plugin/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")