From 6c4c09e2499a5aaed0aed93dbbc25bb007519ce8 Mon Sep 17 00:00:00 2001
From: Andreas Hufler <andreas.hufler@aboutbits.it>
Date: Wed, 16 Oct 2024 17:05:31 +0200
Subject: [PATCH 1/2] update checkstyle IDE config

---
 .idea/checkstyle-idea.xml | 13 ++++++-------
 1 file changed, 6 insertions(+), 7 deletions(-)

diff --git a/.idea/checkstyle-idea.xml b/.idea/checkstyle-idea.xml
index 05f5e1f..cd93c1e 100644
--- a/.idea/checkstyle-idea.xml
+++ b/.idea/checkstyle-idea.xml
@@ -1,22 +1,21 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project version="4">
   <component name="CheckStyle-IDEA" serialisationVersion="2">
-    <checkstyleVersion>10.12.5</checkstyleVersion>
-    <scanScope>JavaOnlyWithTests</scanScope>
+    <checkstyleVersion>10.18.1</checkstyleVersion>
+    <scanScope>JavaOnly</scanScope>
     <option name="thirdPartyClasspath" />
     <option name="activeLocationIds">
-      <option value="e5e05351-1d19-4e8f-8139-4fee966b9e88" />
+      <option value="4cf94184-80ae-47a8-8a7e-ca8ee05f485e" />
     </option>
     <option name="locations">
       <list>
         <ConfigurationLocation id="bundled-sun-checks" type="BUNDLED" scope="All" description="Sun Checks">(bundled)</ConfigurationLocation>
         <ConfigurationLocation id="bundled-google-checks" type="BUNDLED" scope="All" description="Google Checks">(bundled)</ConfigurationLocation>
-        <ConfigurationLocation id="e5e05351-1d19-4e8f-8139-4fee966b9e88" type="LOCAL_FILE" scope="All" description="aboutbits">
-          $PROJECT_DIR$/checkstyle.xml
+        <ConfigurationLocation id="4cf94184-80ae-47a8-8a7e-ca8ee05f485e" type="LOCAL_FILE" scope="All" description="aboutbits">
+          $PROJECT_DIR$/target/checkstyle-checker.xml
           <option name="properties">
             <map>
-              <entry key="org.checkstyle.sun.suppressionfilter.config" value="" />
-              <entry key="org.checkstyle.sun.suppressionxpathfilter.config" value="" />
+              <entry key="org.checkstyle.sun.suppressionfilter.config" value="checkstyle-suppressions.xml" />
             </map>
           </option>
         </ConfigurationLocation>

From f13285f7bf34d5686bf723e33b8b77d92bc6d961 Mon Sep 17 00:00:00 2001
From: Andreas Hufler <andreas.hufler@aboutbits.it>
Date: Wed, 30 Oct 2024 16:09:04 +0100
Subject: [PATCH 2/2] fix some swagger issues

---
 .../OrderModelsCustomizer.java                        |  4 +++-
 .../default_not_null/NullableCustomizer.java          |  3 +++
 .../customization/logout_route/LogoutCustomizer.java  |  7 ++++++-
 .../swagger/type/CustomTypePropertyCustomizer.java    | 11 +++++++++++
 4 files changed, 23 insertions(+), 2 deletions(-)

diff --git a/src/main/java/it/aboutbits/springboot/toolbox/swagger/customization/alphabetical_model_order/OrderModelsCustomizer.java b/src/main/java/it/aboutbits/springboot/toolbox/swagger/customization/alphabetical_model_order/OrderModelsCustomizer.java
index 79d9006..d1bc35e 100644
--- a/src/main/java/it/aboutbits/springboot/toolbox/swagger/customization/alphabetical_model_order/OrderModelsCustomizer.java
+++ b/src/main/java/it/aboutbits/springboot/toolbox/swagger/customization/alphabetical_model_order/OrderModelsCustomizer.java
@@ -10,6 +10,8 @@ public class OrderModelsCustomizer implements OpenApiCustomizer {
     public void customise(OpenAPI openApi) {
         var components = openApi.getComponents();
 
-        components.schemas(new TreeMap<>(components.getSchemas()));
+        if (components != null && components.getSchemas() != null) {
+            components.schemas(new TreeMap<>(components.getSchemas()));
+        }
     }
 }
diff --git a/src/main/java/it/aboutbits/springboot/toolbox/swagger/customization/default_not_null/NullableCustomizer.java b/src/main/java/it/aboutbits/springboot/toolbox/swagger/customization/default_not_null/NullableCustomizer.java
index 41413a2..3250a6f 100644
--- a/src/main/java/it/aboutbits/springboot/toolbox/swagger/customization/default_not_null/NullableCustomizer.java
+++ b/src/main/java/it/aboutbits/springboot/toolbox/swagger/customization/default_not_null/NullableCustomizer.java
@@ -10,6 +10,9 @@ public class NullableCustomizer implements OpenApiCustomizer {
     @Override
     @SuppressWarnings("unchecked")
     public void customise(OpenAPI openApi) {
+        if (openApi.getComponents() == null || openApi.getComponents().getSchemas() == null) {
+            return;
+        }
         openApi.getComponents().getSchemas().values()
                 .forEach(schema -> {
                     var requiredProperties = new ArrayList<String>();
diff --git a/src/main/java/it/aboutbits/springboot/toolbox/swagger/customization/logout_route/LogoutCustomizer.java b/src/main/java/it/aboutbits/springboot/toolbox/swagger/customization/logout_route/LogoutCustomizer.java
index 3bf3ee5..ab8522c 100644
--- a/src/main/java/it/aboutbits/springboot/toolbox/swagger/customization/logout_route/LogoutCustomizer.java
+++ b/src/main/java/it/aboutbits/springboot/toolbox/swagger/customization/logout_route/LogoutCustomizer.java
@@ -4,18 +4,23 @@
 import io.swagger.v3.oas.models.Operation;
 import io.swagger.v3.oas.models.PathItem;
 import io.swagger.v3.oas.models.responses.ApiResponses;
+import lombok.NonNull;
 import lombok.RequiredArgsConstructor;
 import org.springdoc.core.customizers.OpenApiCustomizer;
 
 @RequiredArgsConstructor
 public class LogoutCustomizer implements OpenApiCustomizer {
+    @NonNull
     private final String logoutUrl;
+    @NonNull
+    private final String tag;
 
     @Override
     public void customise(OpenAPI openApi) {
         var operation = new Operation();
-        operation.addTagsItem("Authentication API");
+        operation.addTagsItem(tag);
         operation.summary("Logout the current user");
+        operation.operationId("logout");
         operation.responses(new ApiResponses());
 
         var pathItem = new PathItem();
diff --git a/src/main/java/it/aboutbits/springboot/toolbox/swagger/type/CustomTypePropertyCustomizer.java b/src/main/java/it/aboutbits/springboot/toolbox/swagger/type/CustomTypePropertyCustomizer.java
index 810f906..d34f3a5 100644
--- a/src/main/java/it/aboutbits/springboot/toolbox/swagger/type/CustomTypePropertyCustomizer.java
+++ b/src/main/java/it/aboutbits/springboot/toolbox/swagger/type/CustomTypePropertyCustomizer.java
@@ -20,6 +20,17 @@ public class CustomTypePropertyCustomizer implements PropertyCustomizer {
     public Schema<?> customize(Schema property, AnnotatedType annotatedType) {
         var type = annotatedType.getType();
 
+        if (type instanceof SimpleType simpleType) {
+            var rawClass = simpleType.getRawClass();
+
+            // We set the enum name as the description because swagger treats each usage as a new enum.
+            // This way we can preserve the information about the original enum type.
+            if (rawClass.isEnum()) {
+                var displayName = rawClass.getCanonicalName().replace(rawClass.getPackage().getName() + ".", "");
+                property.setDescription(displayName);
+            }
+        }
+
         if (type instanceof SimpleType simpleType && CustomType.class.isAssignableFrom(simpleType.getRawClass())) {
             var rawClass = simpleType.getRawClass();