Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upgrade to SpringDoc 2.7.0 #7072

Merged
merged 2 commits into from
Nov 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
6 changes: 3 additions & 3 deletions api-docs/openapi/v3_0/aggregated.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"openapi": "3.0.1",
"info": {
"title": "Halo",
"version": "2.20.9-SNAPSHOT"
"version": "2.20.10-SNAPSHOT"
},
"servers": [
{
Expand Down Expand Up @@ -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."
}
}
},
Expand Down
2 changes: 1 addition & 1 deletion api-docs/openapi/v3_0/apis_console.api_v1alpha1.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"openapi": "3.0.1",
"info": {
"title": "Halo",
"version": "2.20.9-SNAPSHOT"
"version": "2.20.10-SNAPSHOT"
},
"servers": [
{
Expand Down
6 changes: 3 additions & 3 deletions api-docs/openapi/v3_0/apis_extension.api_v1alpha1.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"openapi": "3.0.1",
"info": {
"title": "Halo",
"version": "2.20.9-SNAPSHOT"
"version": "2.20.10-SNAPSHOT"
},
"servers": [
{
Expand Down Expand Up @@ -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."
}
}
},
Expand Down
12 changes: 6 additions & 6 deletions api-docs/openapi/v3_0/apis_public.api_v1alpha1.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"openapi": "3.0.1",
"info": {
"title": "Halo",
"version": "2.20.9-SNAPSHOT"
"version": "2.20.10-SNAPSHOT"
},
"servers": [
{
Expand Down Expand Up @@ -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.",
Expand Down Expand Up @@ -744,7 +744,7 @@
},
"post": {
"description": "Create a comment.",
"operationId": "CreateComment",
"operationId": "CreateComment_1",
"requestBody": {
"content": {
"application/json": {
Expand Down Expand Up @@ -853,7 +853,7 @@
},
"post": {
"description": "Create a reply.",
"operationId": "CreateReply",
"operationId": "CreateReply_1",
"parameters": [
{
"in": "path",
Expand Down Expand Up @@ -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."
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions api-docs/openapi/v3_0/apis_uc.api_v1alpha1.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"openapi": "3.0.1",
"info": {
"title": "Halo",
"version": "2.20.9-SNAPSHOT"
"version": "2.20.10-SNAPSHOT"
},
"servers": [
{
Expand Down Expand Up @@ -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.",
Expand Down
2 changes: 1 addition & 1 deletion api/src/main/java/run/halo/app/core/extension/Menu.java
Original file line number Diff line number Diff line change
Expand Up @@ -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.")
)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
JohnNiang marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand All @@ -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")
Expand All @@ -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()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
@@ -1 +1 @@
version=2.20.9-SNAPSHOT
version=2.20.10-SNAPSHOT
2 changes: 1 addition & 1 deletion platform/application/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion ui/packages/api-client/src/api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
2 changes: 1 addition & 1 deletion ui/packages/api-client/src/api/attachment-v1alpha1-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
2 changes: 1 addition & 1 deletion ui/packages/api-client/src/api/backup-v1alpha1-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
2 changes: 1 addition & 1 deletion ui/packages/api-client/src/api/category-v1alpha1-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
2 changes: 1 addition & 1 deletion ui/packages/api-client/src/api/comment-v1alpha1-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
2 changes: 1 addition & 1 deletion ui/packages/api-client/src/api/config-map-v1alpha1-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
2 changes: 1 addition & 1 deletion ui/packages/api-client/src/api/counter-v1alpha1-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
2 changes: 1 addition & 1 deletion ui/packages/api-client/src/api/default-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
2 changes: 1 addition & 1 deletion ui/packages/api-client/src/api/device-v1alpha1-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
2 changes: 1 addition & 1 deletion ui/packages/api-client/src/api/device-v1alpha1-uc-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
2 changes: 1 addition & 1 deletion ui/packages/api-client/src/api/group-v1alpha1-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
Loading
Loading