perf(X-Pack): 优化 X-Pack 相关 API 文档信息

sdk/api/api-base/src/main/java/io/dataease/api/free/FreeApi.java

@@ -3,11 +3,13 @@ package io.dataease.api.free;
 import io.dataease.api.free.dto.*;
 import io.dataease.api.free.vo.FreeRelationVO;
 import io.dataease.api.free.vo.FreeVO;
+import io.swagger.v3.oas.annotations.Hidden;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestBody;
 
 import java.util.List;
 
+@Hidden
 public interface FreeApi {
 
     @PostMapping("/query")

sdk/api/api-base/src/main/java/io/dataease/api/report/ReportApi.java

@@ -75,9 +75,11 @@ public interface ReportApi {
     @PostMapping("/deleteLog")
     void deleteInstance(@RequestBody ReportInstanceDelRequest request);
 
+    @Operation(summary = "日志错误信息")
     @PostMapping("/logMsg")
     String logMsg(@RequestBody ReportInstanceMsgRequest request);
 
+    @Operation(summary = "导出")
     @PostMapping("/export")
     ResponseEntity<ByteArrayResource> export(@RequestBody ReportExportRequest request);
 }

sdk/api/api-base/src/main/java/io/dataease/api/report/dto/ReportExportRequest.java

@@ -1,22 +1,23 @@
 package io.dataease.api.report.dto;
 
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Data;
 
 import java.io.Serial;
 import java.io.Serializable;
-
+@Schema(description = "导出请求")
 @Data
 public class ReportExportRequest implements Serializable {
     @Serial
     private static final long serialVersionUID = -5372551595882128201L;
-
+    @Schema(description = "资源ID")
     private Long resourceId;
-
+    @Schema(description = "资源类型")
     private String busiType;
-
+    @Schema(description = "分辨率")
     private String pixel;
-
+    @Schema(description = "额外等待时间")
     private Integer extWaitTime = 0;
-
+    @Schema(description = "导出格式")
     private Integer resultFormat = 0;
 }

sdk/api/api-base/src/main/java/io/dataease/api/report/dto/ReportInstanceMsgRequest.java

@@ -1,16 +1,18 @@
 package io.dataease.api.report.dto;
 
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Data;
 
 import java.io.Serial;
 import java.io.Serializable;
 
+@Schema(description = "日志错误信息请求")
 @Data
 public class ReportInstanceMsgRequest implements Serializable {
     @Serial
     private static final long serialVersionUID = 7192222037770564561L;
-
+    @Schema(description = "任务ID")
     private Long taskId;
-
+    @Schema(description = "任务实例ID")
     private Long instanceId;
 }

sdk/api/api-base/src/main/java/io/dataease/api/xpack/appearance/api/XpackAppearanceApi.java

@@ -1,6 +1,9 @@
 package io.dataease.api.xpack.appearance.api;
 
 import io.dataease.api.xpack.appearance.vo.AppearanceItemVO;
+import io.swagger.v3.oas.annotations.Hidden;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.GetMapping;
@@ -11,14 +14,18 @@ import org.springframework.web.multipart.MultipartFile;
 
 import java.util.List;
 
+@Tag(name = "外观设置")
 public interface XpackAppearanceApi {
 
+    @Operation(summary = "保存")
     @PostMapping(value = "/save", consumes = {"multipart/form-data"})
     void save(@RequestPart("request") List<AppearanceItemVO> items, @RequestPart(value = "files", required = false) List<MultipartFile> files);
 
+    @Operation(summary = "查询")
     @GetMapping("/query")
     List<AppearanceItemVO> query();
 
+    @Hidden
     @GetMapping(value = "/image/{imageId}", produces = {MediaType.IMAGE_JPEG_VALUE, MediaType.IMAGE_PNG_VALUE, "image/svg+xml"})
     ResponseEntity<byte[]> image(@PathVariable("imageId") String imageId);
 }

sdk/api/api-base/src/main/java/io/dataease/api/xpack/dataFilling/DataFillingApi.java

@@ -11,6 +11,7 @@ import io.dataease.exception.DEException;
 import io.dataease.extensions.datasource.dto.SimpleDatasourceDTO;
 import io.dataease.model.BusiNodeRequest;
 import io.dataease.model.BusiNodeVO;
+import io.swagger.v3.oas.annotations.Hidden;
 import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.servlet.http.HttpServletResponse;
 import org.springframework.web.bind.annotation.*;
@@ -21,6 +22,7 @@ import java.util.Map;
 
 import static io.dataease.constant.AuthResourceEnum.DATA_FILLING;
 
+@Hidden
 @Tag(name = "数据填报")
 @ApiSupport(order = 1000, author = "fit2cloud-someone")
 @DeApiPath(value = "/data-filling", rt = DATA_FILLING)

sdk/api/api-base/src/main/java/io/dataease/api/xpack/plugin/PluginApi.java

@@ -3,6 +3,7 @@ package io.dataease.api.xpack.plugin;
 import com.github.xiaoymin.knife4j.annotations.ApiSupport;
 import io.dataease.api.xpack.plugin.dto.PluginEditor;
 import io.dataease.api.xpack.plugin.vo.PluginVO;
+import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
@@ -16,15 +17,19 @@ import java.util.List;
 @ApiSupport(order = 2)
 public interface PluginApi {
 
+    @Operation(summary = "查询")
     @GetMapping("/query")
     List<PluginVO> query();
 
+    @Operation(summary = "安装")
     @PostMapping(value = "/install", consumes = {"multipart/form-data"})
     void install(@RequestPart(value = "file") MultipartFile file);
 
+    @Operation(summary = "卸载")
     @PostMapping("/uninstall/{id}")
     void uninstall(@PathVariable("id") String id);
 
+    @Operation(summary = "更新")
     @PostMapping(value = "/update", consumes = {"multipart/form-data"})
     void update(@RequestPart("request") PluginEditor request, @RequestPart(value = "file") MultipartFile file);
 

sdk/api/api-base/src/main/java/io/dataease/api/xpack/settings/XpackAuthenticationApi.java

@@ -25,44 +25,55 @@ public interface XpackAuthenticationApi {
     @PostMapping("/switchEnable")
     void switchEnable(@RequestBody XpackAuthenticationEditor editor);
 
+    @Operation(summary = "保存OIDC")
     @PostMapping("/save/oidc")
     String saveOidc(@RequestBody XpackOidcVO editor);
 
+    @Operation(summary = "保存CAS")
     @PostMapping("/save/cas")
     String saveCas(@RequestBody XpackCasVO editor);
 
+    @Operation(summary = "保存LDAP")
     @PostMapping("/save/ldap")
     String saveLdap(@RequestBody XpackLdapVO editor);
 
+    @Operation(summary = "保存OAuth2")
     @PostMapping("/save/oauth2")
     String saveOauth2(@RequestBody XpackOauth2VO editor);
 
-
+    @Operation(summary = "OIDC信息")
     @GetMapping("/info/oidc")
     XpackOidcVO oidcInfo();
 
+    @Operation(summary = "CAS信息")
     @GetMapping("/info/cas")
     XpackCasVO casInfo();
 
+    @Operation(summary = "LDAP信息")
     @GetMapping("/info/ldap")
     XpackLdapVO ldapInfo();
 
+    @Operation(summary = "OAuth2信息")
     @GetMapping("/info/oauth2")
     XpackOauth2VO oauth2Info();
 
-
+    @Operation(summary = "验证OIDC")
     @PostMapping("/validate/oidc")
     String validateOidc(@RequestBody XpackOidcVO editor);
 
+    @Operation(summary = "验证CAS")
     @PostMapping("/validate/cas")
     String validateCas(@RequestBody XpackCasVO editor);
 
+    @Operation(summary = "验证LDAP")
     @PostMapping("/validate/ldap")
     String validateLdap(@RequestBody XpackLdapVO editor);
 
+    @Operation(summary = "验证OAuth2")
     @PostMapping("/validate/oauth2")
     String validateOauth2(@RequestBody XpackOauth2VO editor);
 
+    @Operation(summary = "验证")
     @PostMapping("/validateId/{id}")
     String validate(@PathVariable("id") Long id);
 

sdk/api/api-base/src/main/java/io/dataease/api/xpack/settings/XpackOauth2Api.java

@@ -4,11 +4,13 @@ import com.github.xiaoymin.knife4j.annotations.ApiSupport;
 import io.dataease.api.xpack.settings.request.XpackOauth2TokenRequest;
 import io.dataease.api.xpack.settings.vo.XpackOauthAuthVO;
 import io.dataease.api.xpack.settings.vo.XpackOauthTokenVO;
+import io.swagger.v3.oas.annotations.Hidden;
 import io.swagger.v3.oas.annotations.tags.Tag;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestBody;
 
+@Hidden
 @Tag(name = "Oauth2认证")
 @ApiSupport(order = 899)
 public interface XpackOauth2Api {

sdk/api/api-permissions/src/main/java/io/dataease/api/permissions/dataset/api/ColumnPermissionsApi.java

@@ -3,6 +3,7 @@ package io.dataease.api.permissions.dataset.api;
 import com.baomidou.mybatisplus.core.metadata.IPage;
 import io.dataease.api.permissions.dataset.dto.DataSetColumnPermissionsDTO;
 import io.dataease.auth.DeApiPath;
+import io.swagger.v3.oas.annotations.Hidden;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
 import org.springframework.web.bind.annotation.GetMapping;
@@ -14,6 +15,7 @@ import java.util.List;
 
 import static io.dataease.constant.AuthResourceEnum.DATASET;
 
+@Hidden
 @Tag(name = "列权限")
 @DeApiPath(value = "/dataset/columnPermissions", rt = DATASET)
 public interface ColumnPermissionsApi {

sdk/api/api-permissions/src/main/java/io/dataease/api/permissions/dataset/api/RowPermissionsApi.java

@@ -4,6 +4,7 @@ import com.baomidou.mybatisplus.core.metadata.IPage;
 import io.dataease.api.permissions.dataset.dto.*;
 import io.dataease.api.permissions.user.vo.UserFormVO;
 import io.dataease.auth.DeApiPath;
+import io.swagger.v3.oas.annotations.Hidden;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
 import org.springframework.web.bind.annotation.GetMapping;
@@ -15,6 +16,7 @@ import java.util.List;
 
 import static io.dataease.constant.AuthResourceEnum.DATASET;
 
+@Hidden
 @Tag(name = "行权限")
 @DeApiPath(value = "/dataset/rowPermissions", rt = DATASET)
 public interface RowPermissionsApi {

sdk/api/api-permissions/src/main/java/io/dataease/api/permissions/embedded/api/EmbeddedApi.java

@@ -68,9 +68,12 @@ public interface EmbeddedApi {
     @PostMapping("/initIframe")
     void initIframe(@RequestBody EmbeddedOrigin origin);
 
+    @ApiOperationSupport(order = 7)
+    @Operation(summary = "获取Token参数")
     @GetMapping("/getTokenArgs")
     Map<String, Object> getTokenArgs();
 
+    @Hidden
     @GetMapping("/limitCount")
     int getLimitCount();
 }

sdk/api/api-permissions/src/main/java/io/dataease/api/permissions/login/api/LoginApi.java

@@ -8,6 +8,7 @@ import io.dataease.api.permissions.login.dto.PwdLoginDTO;
 import io.dataease.api.permissions.login.vo.MfaQrVO;
 import io.dataease.api.permissions.user.dto.ModifyPwdRequest;
 import io.dataease.auth.vo.TokenVO;
+import io.swagger.v3.oas.annotations.Hidden;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.validation.Valid;
@@ -43,14 +44,19 @@ public interface LoginApi {
     @ApiOperationSupport(order = 3)
     @PostMapping("/login/platformLogin/{origin}")
     TokenVO platformLogin(@PathVariable("origin") Integer origin);
+
     @Operation(summary = "登出")
     @ApiOperationSupport(order = 4)
     @GetMapping("/logout")
     void logout();
 
+    @Operation(summary = "MFA二维码信息")
+    @ApiOperationSupport(order = 5)
     @PostMapping("/mfa/qr/{id}")
     MfaQrVO mfaQr(@PathVariable("id") Long id);
 
+    @Operation(summary = "MFA登录")
+    @ApiOperationSupport(order = 6)
     @PostMapping("/mfa/login")
     TokenVO mfaLogin(@RequestBody MfaLoginDTO dto);
 

sdk/api/api-permissions/src/main/java/io/dataease/api/permissions/login/dto/MfaLoginDTO.java

@@ -1,18 +1,20 @@
 package io.dataease.api.permissions.login.dto;
 
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Data;
 
 import java.io.Serial;
 import java.io.Serializable;
 
+@Schema(description = "MFA登录DTO")
 @Data
 public class MfaLoginDTO implements Serializable {
     @Serial
     private static final long serialVersionUID = -8218773323394184937L;
-
+    @Schema(description = "ID")
     private Long id;
-
+    @Schema(description = "CODE")
     private String code;
-
+    @Schema(description = "KEY")
     private String key;
 }

sdk/api/api-permissions/src/main/java/io/dataease/api/permissions/login/vo/MfaQrVO.java

@@ -1,16 +1,19 @@
 package io.dataease.api.permissions.login.vo;
 
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Data;
 
 import java.io.Serial;
 import java.io.Serializable;
-
+@Schema(description = "MFA二维码信息")
 @Data
 public class MfaQrVO implements Serializable {
     @Serial
     private static final long serialVersionUID = -3465640829593927730L;
 
+    @Schema(description = "图片")
     private String img;
 
+    @Schema(description = "KEY")
     private String key;
 }

sdk/api/api-permissions/src/main/java/io/dataease/api/permissions/org/api/OrgApi.java

@@ -24,7 +24,6 @@ import org.springframework.web.bind.annotation.RequestBody;
 import java.util.List;
 
 import static io.dataease.constant.AuthResourceEnum.ORG;
-import static io.dataease.constant.AuthResourceEnum.ROLE;
 
 @Tag(name = "组织")
 @ApiSupport(order = 886, author = "fit2cloud-someone")

sdk/api/api-permissions/src/main/java/io/dataease/api/permissions/user/api/UserApi.java

@@ -207,21 +207,27 @@ public interface UserApi {
 
     List<Map<String, Object>> listUserInfosByIds(List<Long> ids);
 
+    @Operation(summary = "MFA二维码信息")
     @GetMapping("/mfaQr")
     MfaQrVO mfaQr();
 
+    @Operation(summary = "MFA绑定状态")
     @GetMapping("/mfabound")
     Boolean mfaBound();
 
+    @Operation(summary = "绑定MFA")
     @PostMapping("/mfaBind")
     void mfaBind(@RequestBody MfaLoginDTO dto);
 
+    @Operation(summary = "解绑MFA")
     @PostMapping("/mfaUnbind/{code}")
     String mfaUnbind(@PathVariable("code") String code);
 
+    @Operation(summary = "重置MFA绑定状态")
     @PostMapping("/mfaRest/{id}")
     void resetBind(@PathVariable("id") Long id);
 
+    @Hidden
     @GetMapping("/lang")
     String userLang();
 

sdk/api/api-permissions/src/main/java/io/dataease/api/permissions/variable/api/SysVariablesApi.java

@@ -6,6 +6,7 @@ import com.github.xiaoymin.knife4j.annotations.ApiSupport;
 import io.dataease.api.permissions.variable.dto.SysVariableDto;
 import io.dataease.api.permissions.variable.dto.SysVariableValueDto;
 import io.dataease.auth.DeApiPath;
+import io.swagger.v3.oas.annotations.Hidden;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
 import org.springframework.web.bind.annotation.GetMapping;
@@ -17,6 +18,7 @@ import java.util.List;
 
 import static io.dataease.constant.AuthResourceEnum.SYSTEM;
 
+@Hidden
 @Tag(name = "系统变量")
 @ApiSupport(order = 881, author = "fit2cloud-someone")
 @DeApiPath(value = "/sysVariable", rt = SYSTEM)