Upgrade to SpringDoc 2.7.0 (#7072)

* Upgrade to SpringDoc 2.7.0 Signed-off-by: John Niang <[email protected]>
halo-dev · Nov 25, 2024 · d985b7a · d985b7a
1 parent 0b505a9
commit d985b7a
Show file tree

Hide file tree

Showing 347 changed files with 360 additions and 359 deletions.
diff --git a/api-docs/openapi/v3_0/aggregated.json b/api-docs/openapi/v3_0/aggregated.json
@@ -2,7 +2,7 @@
   "openapi": "3.0.1",
   "info": {
     "title": "Halo",
-    "version": "2.20.9-SNAPSHOT"
+    "version": "2.20.10-SNAPSHOT"
   },
   "servers": [
     {
@@ -19391,10 +19391,10 @@
           "menuItems": {
             "uniqueItems": true,
             "type": "array",
-            "description": "Names of menu children below this menu.",
+            "description": "Menu items of this menu.",
             "items": {
               "type": "string",
-              "description": "Names of menu children below this menu."
+              "description": "Name of menu item."
             }
           }
         },

diff --git a/api-docs/openapi/v3_0/apis_console.api_v1alpha1.json b/api-docs/openapi/v3_0/apis_console.api_v1alpha1.json
@@ -2,7 +2,7 @@
   "openapi": "3.0.1",
   "info": {
     "title": "Halo",
-    "version": "2.20.9-SNAPSHOT"
+    "version": "2.20.10-SNAPSHOT"
   },
   "servers": [
     {

diff --git a/api-docs/openapi/v3_0/apis_extension.api_v1alpha1.json b/api-docs/openapi/v3_0/apis_extension.api_v1alpha1.json
@@ -2,7 +2,7 @@
   "openapi": "3.0.1",
   "info": {
     "title": "Halo",
-    "version": "2.20.9-SNAPSHOT"
+    "version": "2.20.10-SNAPSHOT"
   },
   "servers": [
     {
@@ -11912,10 +11912,10 @@
           "menuItems": {
             "uniqueItems": true,
             "type": "array",
-            "description": "Names of menu children below this menu.",
+            "description": "Menu items of this menu.",
             "items": {
               "type": "string",
-              "description": "Names of menu children below this menu."
+              "description": "Name of menu item."
             }
           }
         },

diff --git a/api-docs/openapi/v3_0/apis_public.api_v1alpha1.json b/api-docs/openapi/v3_0/apis_public.api_v1alpha1.json
@@ -2,7 +2,7 @@
   "openapi": "3.0.1",
   "info": {
     "title": "Halo",
-    "version": "2.20.9-SNAPSHOT"
+    "version": "2.20.10-SNAPSHOT"
   },
   "servers": [
     {
@@ -642,7 +642,7 @@
     "/apis/api.halo.run/v1alpha1/comments": {
       "get": {
         "description": "List comments.",
-        "operationId": "ListComments",
+        "operationId": "ListComments_1",
         "parameters": [
           {
             "description": "Page number. Default is 0.",
@@ -744,7 +744,7 @@
       },
       "post": {
         "description": "Create a comment.",
-        "operationId": "CreateComment",
+        "operationId": "CreateComment_1",
         "requestBody": {
           "content": {
             "application/json": {
@@ -853,7 +853,7 @@
       },
       "post": {
         "description": "Create a reply.",
-        "operationId": "CreateReply",
+        "operationId": "CreateReply_1",
         "parameters": [
           {
             "in": "path",
@@ -2375,10 +2375,10 @@
           "menuItems": {
             "uniqueItems": true,
             "type": "array",
-            "description": "Names of menu children below this menu.",
+            "description": "Menu items of this menu.",
             "items": {
               "type": "string",
-              "description": "Names of menu children below this menu."
+              "description": "Name of menu item."
             }
           }
         }

diff --git a/api-docs/openapi/v3_0/apis_uc.api_v1alpha1.json b/api-docs/openapi/v3_0/apis_uc.api_v1alpha1.json
@@ -2,7 +2,7 @@
   "openapi": "3.0.1",
   "info": {
     "title": "Halo",
-    "version": "2.20.9-SNAPSHOT"
+    "version": "2.20.10-SNAPSHOT"
   },
   "servers": [
     {
@@ -1340,7 +1340,7 @@
     "/apis/uc.api.storage.halo.run/v1alpha1/attachments/-/upload-from-url": {
       "post": {
         "description": "Upload attachment from the given URL.",
-        "operationId": "ExternalTransferAttachment",
+        "operationId": "ExternalTransferAttachment_1",
         "parameters": [
           {
             "description": "Wait for permalink.",

diff --git a/api/src/main/java/run/halo/app/core/extension/Menu.java b/api/src/main/java/run/halo/app/core/extension/Menu.java
@@ -27,8 +27,8 @@ public static class Spec {
         @Schema(description = "The display name of the menu.", requiredMode = REQUIRED)
         private String displayName;
 
-        @Schema(description = "Names of menu children below this menu.")
         @ArraySchema(
+            uniqueItems = true,
             arraySchema = @Schema(description = "Menu items of this menu."),
             schema = @Schema(description = "Name of menu item.")
         )

diff --git a/api/src/main/java/run/halo/app/core/extension/MenuItem.java b/api/src/main/java/run/halo/app/core/extension/MenuItem.java
@@ -62,6 +62,7 @@ public static class MenuItemSpec {
         private Integer priority;
 
         @ArraySchema(
+            uniqueItems = true,
             arraySchema = @Schema(description = "Children of this menu item"),
             schema = @Schema(description = "The name of menu item child"))
         private LinkedHashSet<String> children;

diff --git a/application/src/main/java/run/halo/app/core/endpoint/theme/CommentFinderEndpoint.java b/application/src/main/java/run/halo/app/core/endpoint/theme/CommentFinderEndpoint.java
@@ -76,7 +76,7 @@ public RouterFunction<ServerResponse> endpoint() {
         final var tag = "CommentV1alpha1Public";
         return SpringdocRouteBuilder.route()
             .POST("comments", this::createComment,
-                builder -> builder.operationId("CreateComment")
+                builder -> builder.operationId("CreateComment_1")
                     .description("Create a comment.")
                     .tag(tag)
                     .requestBody(requestBodyBuilder()
@@ -90,7 +90,7 @@ public RouterFunction<ServerResponse> endpoint() {
                         .implementation(Comment.class))
             )
             .POST("comments/{name}/reply", this::createReply,
-                builder -> builder.operationId("CreateReply")
+                builder -> builder.operationId("CreateReply_1")
                     .description("Create a reply.")
                     .tag(tag)
                     .parameter(parameterBuilder().name("name")
@@ -108,7 +108,7 @@ public RouterFunction<ServerResponse> endpoint() {
                         .implementation(Reply.class))
             )
             .GET("comments", this::listComments, builder -> {
-                builder.operationId("ListComments")
+                builder.operationId("ListComments_1")
                     .description("List comments.")
                     .tag(tag)
                     .response(responseBuilder()

diff --git a/application/src/main/java/run/halo/app/core/endpoint/uc/UcAttachmentEndpoint.java b/application/src/main/java/run/halo/app/core/endpoint/uc/UcAttachmentEndpoint.java
@@ -112,7 +112,7 @@ public RouterFunction<ServerResponse> endpoint() {
             .POST("/attachments/-/upload-from-url", contentType(MediaType.APPLICATION_JSON),
                 this::uploadFromUrlForPost,
                 builder -> builder
-                    .operationId("ExternalTransferAttachment")
+                    .operationId("ExternalTransferAttachment_1")
                     .description("Upload attachment from the given URL.")
                     .tag(tag)
                     .parameter(parameterBuilder()

diff --git a/gradle.properties b/gradle.properties
@@ -1 +1 @@
-version=2.20.9-SNAPSHOT
+version=2.20.10-SNAPSHOT
diff --git a/platform/application/build.gradle b/platform/application/build.gradle
@@ -18,7 +18,7 @@ ext {
     guava = "33.3.1-jre"
     jsoup = '1.18.1'
     jsonPatch = "1.13"
-    springDocOpenAPI = "2.6.0"
+    springDocOpenAPI = "2.7.0"
     lucene = "9.12.0"
     resilience4jVersion = "2.2.0"
     twoFactorAuth = "1.3"

diff --git a/ui/packages/api-client/src/api.ts b/ui/packages/api-client/src/api.ts
@@ -4,7 +4,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.20.10-SNAPSHOT
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

diff --git a/ui/packages/api-client/src/api/annotation-setting-v1alpha1-api.ts b/ui/packages/api-client/src/api/annotation-setting-v1alpha1-api.ts
@@ -4,7 +4,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.20.10-SNAPSHOT
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

diff --git a/ui/packages/api-client/src/api/attachment-v1alpha1-api.ts b/ui/packages/api-client/src/api/attachment-v1alpha1-api.ts
@@ -4,7 +4,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.20.10-SNAPSHOT
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

diff --git a/ui/packages/api-client/src/api/attachment-v1alpha1-console-api.ts b/ui/packages/api-client/src/api/attachment-v1alpha1-console-api.ts
@@ -4,7 +4,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.20.10-SNAPSHOT
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

diff --git a/ui/packages/api-client/src/api/attachment-v1alpha1-uc-api.ts b/ui/packages/api-client/src/api/attachment-v1alpha1-uc-api.ts
@@ -4,7 +4,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.20.10-SNAPSHOT
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

diff --git a/ui/packages/api-client/src/api/auth-provider-v1alpha1-api.ts b/ui/packages/api-client/src/api/auth-provider-v1alpha1-api.ts
@@ -4,7 +4,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.20.10-SNAPSHOT
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

diff --git a/ui/packages/api-client/src/api/auth-provider-v1alpha1-console-api.ts b/ui/packages/api-client/src/api/auth-provider-v1alpha1-console-api.ts
@@ -4,7 +4,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.20.10-SNAPSHOT
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

diff --git a/ui/packages/api-client/src/api/backup-v1alpha1-api.ts b/ui/packages/api-client/src/api/backup-v1alpha1-api.ts
@@ -4,7 +4,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.20.10-SNAPSHOT
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

diff --git a/ui/packages/api-client/src/api/category-v1alpha1-api.ts b/ui/packages/api-client/src/api/category-v1alpha1-api.ts
@@ -4,7 +4,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.20.10-SNAPSHOT
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

diff --git a/ui/packages/api-client/src/api/category-v1alpha1-public-api.ts b/ui/packages/api-client/src/api/category-v1alpha1-public-api.ts
@@ -4,7 +4,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.20.10-SNAPSHOT
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

diff --git a/ui/packages/api-client/src/api/comment-v1alpha1-api.ts b/ui/packages/api-client/src/api/comment-v1alpha1-api.ts
@@ -4,7 +4,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.20.10-SNAPSHOT
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

diff --git a/ui/packages/api-client/src/api/comment-v1alpha1-console-api.ts b/ui/packages/api-client/src/api/comment-v1alpha1-console-api.ts
@@ -4,7 +4,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.20.10-SNAPSHOT
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

diff --git a/ui/packages/api-client/src/api/comment-v1alpha1-public-api.ts b/ui/packages/api-client/src/api/comment-v1alpha1-public-api.ts
@@ -4,7 +4,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.20.10-SNAPSHOT
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

diff --git a/ui/packages/api-client/src/api/config-map-v1alpha1-api.ts b/ui/packages/api-client/src/api/config-map-v1alpha1-api.ts
@@ -4,7 +4,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.20.10-SNAPSHOT
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

diff --git a/ui/packages/api-client/src/api/counter-v1alpha1-api.ts b/ui/packages/api-client/src/api/counter-v1alpha1-api.ts
@@ -4,7 +4,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.20.10-SNAPSHOT
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

diff --git a/ui/packages/api-client/src/api/default-api.ts b/ui/packages/api-client/src/api/default-api.ts
@@ -4,7 +4,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.20.10-SNAPSHOT
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

diff --git a/ui/packages/api-client/src/api/device-v1alpha1-api.ts b/ui/packages/api-client/src/api/device-v1alpha1-api.ts
@@ -4,7 +4,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.20.10-SNAPSHOT
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

diff --git a/ui/packages/api-client/src/api/device-v1alpha1-uc-api.ts b/ui/packages/api-client/src/api/device-v1alpha1-uc-api.ts
@@ -4,7 +4,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.20.10-SNAPSHOT
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

diff --git a/ui/packages/api-client/src/api/extension-definition-v1alpha1-api.ts b/ui/packages/api-client/src/api/extension-definition-v1alpha1-api.ts
@@ -4,7 +4,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.20.10-SNAPSHOT
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

diff --git a/ui/packages/api-client/src/api/extension-point-definition-v1alpha1-api.ts b/ui/packages/api-client/src/api/extension-point-definition-v1alpha1-api.ts
@@ -4,7 +4,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.20.10-SNAPSHOT
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

diff --git a/ui/packages/api-client/src/api/group-v1alpha1-api.ts b/ui/packages/api-client/src/api/group-v1alpha1-api.ts
@@ -4,7 +4,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.20.10-SNAPSHOT
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

diff --git a/ui/packages/api-client/src/api/index-v1alpha1-public-api.ts b/ui/packages/api-client/src/api/index-v1alpha1-public-api.ts
@@ -4,7 +4,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.20.10-SNAPSHOT
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

diff --git a/ui/packages/api-client/src/api/indices-v1alpha1-console-api.ts b/ui/packages/api-client/src/api/indices-v1alpha1-console-api.ts
@@ -4,7 +4,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.20.10-SNAPSHOT
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).