From 0b9e3247f94d61875048309ba7585b67d755fdbb Mon Sep 17 00:00:00 2001 From: yaoxuwan Date: Fri, 7 Feb 2025 11:47:16 +0800 Subject: [PATCH] =?UTF-8?q?feat:=20=E5=8D=87=E7=BA=A7swagger=20v3=20#2883?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/backend/README.md | 2 +- .../tencent/bkrepo/analyst/api/ScanClient.kt | 4 +- .../bkrepo/analyst/pojo/ArtifactScanReport.kt | 8 +- .../bkrepo/analyst/pojo/ArtifactScanStatus.kt | 12 +-- .../analyst/pojo/AutoScanConfiguration.kt | 10 +-- .../analyst/pojo/ProjectScanConfiguration.kt | 24 ++--- .../tencent/bkrepo/analyst/pojo/ScanPlan.kt | 38 ++++---- .../tencent/bkrepo/analyst/pojo/ScanTask.kt | 54 ++++++------ .../pojo/execution/DockerExecutionCluster.kt | 12 +-- .../pojo/execution/ExecutionCluster.kt | 12 +-- .../KubernetesDeploymentExecutionCluster.kt | 15 ++-- .../KubernetesExecutionClusterProperties.kt | 21 ++--- .../KubernetesJobExecutionCluster.kt | 9 +- .../analyst/pojo/license/SpdxLicenseInfo.kt | 34 +++---- .../request/ArrowheadLoadResultArguments.kt | 20 ++--- .../request/ArtifactPlanRelationRequest.kt | 18 ++-- .../request/ArtifactVulnerabilityRequest.kt | 24 ++--- .../pojo/request/CreateScanPlanRequest.kt | 20 ++--- .../request/FileScanResultDetailRequest.kt | 12 +-- .../request/FileScanResultOverviewRequest.kt | 16 ++-- .../analyst/pojo/request/GlobalScanRequest.kt | 16 ++-- .../pojo/request/LoadResultArguments.kt | 16 ++-- .../pojo/request/PipelineScanRequest.kt | 30 +++---- .../analyst/pojo/request/PlanCountRequest.kt | 17 ++-- .../ProjectScanConfigurationPageRequest.kt | 12 +-- .../pojo/request/ReportResultRequest.kt | 14 +-- .../pojo/request/SaveResultArguments.kt | 12 +-- .../pojo/request/ScanQualityUpdateRequest.kt | 26 +++--- .../analyst/pojo/request/ScanRequest.kt | 16 ++-- .../analyst/pojo/request/ScanTaskQuery.kt | 24 ++--- .../pojo/request/SubtaskInfoRequest.kt | 40 ++++----- .../pojo/request/UpdateScanPlanRequest.kt | 15 ++-- .../DependencyLoadResultArguments.kt | 14 +-- .../request/filter/ListFilterRuleRequest.kt | 14 +-- .../request/filter/MatchFilterRuleRequest.kt | 18 ++-- .../request/filter/UpdateFilterRuleRequest.kt | 38 ++++---- .../ArtifactLicensesDetailRequest.kt | 20 ++--- .../ScancodeToolkitResultArguments.kt | 11 +-- .../standard/StandardLoadResultArguments.kt | 21 ++--- .../request/trivy/TrivyLoadResultArguments.kt | 14 +-- .../pojo/response/ArtifactPlanRelation.kt | 22 ++--- .../pojo/response/ArtifactPlanRelations.kt | 10 +-- .../response/ArtifactVulnerabilityInfo.kt | 30 +++---- .../pojo/response/FileLicensesResultDetail.kt | 28 +++--- .../response/FileLicensesResultOverview.kt | 40 ++++----- .../pojo/response/FileScanResultDetail.kt | 12 +-- .../pojo/response/FileScanResultOverview.kt | 14 +-- .../pojo/response/ScanLicensePlanInfo.kt | 36 ++++---- .../analyst/pojo/response/ScanPlanInfo.kt | 42 ++++----- .../analyst/pojo/response/ScanQuality.kt | 24 ++--- .../analyst/pojo/response/ScannerBase.kt | 18 ++-- .../analyst/pojo/response/SubtaskInfo.kt | 36 ++++---- .../pojo/response/SubtaskResultOverview.kt | 50 +++++------ .../pojo/response/filter/FilterRule.kt | 38 ++++---- .../user/SystemFilterRuleController.kt | 14 +-- .../user/UserExecutionClusterController.kt | 14 +-- .../user/UserFilterRuleController.kt | 14 +-- .../controller/user/UserLicenseController.kt | 30 +++---- .../UserProjectScanConfigurationController.kt | 20 ++--- .../controller/user/UserScanController.kt | 42 ++++----- .../controller/user/UserScanPlanController.kt | 52 +++++------ .../user/UserScanQualityController.kt | 20 ++--- .../user/UserScanReportController.kt | 68 +++++++------- .../controller/user/UserScannerController.kt | 30 +++---- .../user/UserTemporaryScanController.kt | 16 ++-- .../bkrepo/auth/api/ServiceAccountClient.kt | 28 +++--- .../auth/api/ServiceBkiamV3ResourceClient.kt | 34 +++---- .../api/ServiceExternalPermissionClient.kt | 4 +- .../api/ServiceOauthAuthorizationClient.kt | 10 +-- .../auth/api/ServicePermissionClient.kt | 32 +++---- .../bkrepo/auth/api/ServicePipelineClient.kt | 22 ++--- .../bkrepo/auth/api/ServiceProxyClient.kt | 8 +- .../bkrepo/auth/api/ServiceRoleClient.kt | 18 ++-- .../auth/api/ServiceTemporaryTokenClient.kt | 14 +-- .../bkrepo/auth/api/ServiceUserClient.kt | 36 ++++---- .../api/cluster/ClusterPermissionClient.kt | 12 +-- .../cluster/ClusterTemporaryTokenClient.kt | 14 +-- .../auth/api/cluster/ClusterUserClient.kt | 12 +-- .../auth/api/proxy/ProxyAccountClient.kt | 20 ++--- .../bkrepo/auth/api/proxy/ProxyAuthClient.kt | 4 +- .../proxy/ProxyOauthAuthorizationClient.kt | 10 +-- .../auth/api/proxy/ProxyPermissionClient.kt | 8 +- .../bkrepo/auth/api/proxy/ProxyProxyClient.kt | 8 +- .../api/proxy/ProxyTemporaryTokenClient.kt | 8 +- .../bkrepo/auth/api/proxy/ProxyUserClient.kt | 18 ++-- .../com/tencent/bkrepo/auth/pojo/Key.kt | 13 ++- .../com/tencent/bkrepo/auth/pojo/Project.kt | 14 +-- .../bkrepo/auth/pojo/bkiam/BkResult.kt | 12 +-- .../CreateExtPermissionRequest.kt | 20 ++--- .../externalPermission/ExternalPermission.kt | 29 +++--- .../ListExtPermissionOption.kt | 20 ++--- .../UpdateExtPermissionRequest.kt | 22 ++--- .../tencent/bkrepo/auth/pojo/oauth/IdToken.kt | 4 +- .../pojo/permission/CheckPermissionRequest.kt | 4 +- .../auth/pojo/permission/ListPathResult.kt | 4 +- .../auth/pojo/proxy/ProxyCreateRequest.kt | 19 ++-- .../bkrepo/auth/pojo/proxy/ProxyInfo.kt | 26 +++--- .../auth/pojo/proxy/ProxyUpdateRequest.kt | 19 ++-- .../pojo/token/TemporaryTokenCreateRequest.kt | 23 +++-- .../auth/pojo/token/TemporaryTokenInfo.kt | 26 +++--- .../tencent/bkrepo/auth/pojo/token/Token.kt | 13 ++- .../bkrepo/auth/pojo/token/TokenResult.kt | 11 ++- .../auth/pojo/user/CreateUserRequest.kt | 22 ++--- .../pojo/user/CreateUserToProjectRequest.kt | 20 ++--- .../com/tencent/bkrepo/auth/pojo/user/User.kt | 29 +++--- .../tencent/bkrepo/auth/pojo/user/UserInfo.kt | 23 +++-- .../controller/UserBkiamv3AuthController.kt | 10 +-- .../service/ServiceUserController.kt | 4 +- .../auth/controller/user/AccountController.kt | 30 +++---- .../controller/user/AuthProxyController.kt | 16 ++-- .../user/BkiamCallbackController.kt | 24 ++--- .../user/ExternalPermissionController.kt | 14 +-- .../user/OauthAuthorizationController.kt | 18 ++-- .../controller/user/PermissionController.kt | 38 ++++---- .../auth/controller/user/RoleController.kt | 20 ++--- .../auth/controller/user/UserController.kt | 58 ++++++------ .../bkrepo/auth/pojo/account/Account.kt | 34 +++---- .../auth/pojo/account/CreateAccountRequest.kt | 24 ++--- .../bkrepo/auth/pojo/account/ScopeRule.kt | 9 +- .../auth/pojo/account/UpdateAccountRequest.kt | 21 ++--- .../permission/CreatePermissionRequest.kt | 30 +++---- .../bkrepo/auth/pojo/permission/Permission.kt | 4 +- .../auth/pojo/role/CreateRoleRequest.kt | 22 ++--- .../com/tencent/bkrepo/auth/pojo/role/Role.kt | 24 ++--- .../bkrepo/auth/pojo/role/RoleSource.kt | 4 +- .../bkrepo/auth/pojo/token/CredentialSet.kt | 15 ++-- .../auth/pojo/user/CreateUserToRepoRequest.kt | 22 ++--- .../auth/pojo/user/UpdateUserRequest.kt | 16 ++-- .../bkrepo/auth/pojo/user/UserResult.kt | 10 +-- src/backend/build.gradle.kts | 2 +- .../buildSrc/src/main/kotlin/Versions.kt | 2 +- .../pojo/scanner/ScanExecutorResult.kt | 10 +-- .../common/analysis/pojo/scanner/Scanner.kt | 43 +++++---- .../pojo/scanner/arrowhead/ApplicationItem.kt | 14 +-- .../arrowhead/ArrowheadScanExecutorResult.kt | 14 +-- .../scanner/arrowhead/ArrowheadScanner.kt | 38 ++++---- .../pojo/scanner/arrowhead/CveSecItem.kt | 52 +++++------ .../pojo/scanner/arrowhead/License.kt | 11 +-- .../pojo/scanner/arrowhead/SensitiveItem.kt | 20 ++--- .../dependencycheck/result/DependencyItem.kt | 30 +++---- .../result/DependencyScanExecutorResult.kt | 8 +- .../scanner/DependencyScanner.kt | 8 +- .../ScanCodeToolkitScanExecutorResult.kt | 8 +- .../scanCodeCheck/result/ScancodeItem.kt | 12 +-- .../result/ScancodeToolkitItem.kt | 6 +- .../scanCodeCheck/result/SubLicenseItem.kt | 4 +- .../scanner/ScancodeToolkitScanner.kt | 24 ++--- .../standard/StandardScanExecutorResult.kt | 5 +- .../pojo/scanner/standard/StandardScanner.kt | 26 +++--- .../scanner/trivy/TrivyScanExecutorResult.kt | 8 +- .../pojo/scanner/trivy/TrivyScanResult.kt | 18 ++-- .../pojo/scanner/trivy/TrivyScanner.kt | 36 ++++---- .../pojo/scanner/trivy/VulnerabilityItem.kt | 62 ++++++------- .../common/common-api/build.gradle.kts | 4 +- .../tencent/bkrepo/common/api/pojo/Page.kt | 16 ++-- .../bkrepo/common/api/pojo/Response.kt | 14 +-- .../configuration/RepositoryConfiguration.kt | 5 +- .../composite/CompositeConfiguration.kt | 8 +- .../composite/ProxyChannelSetting.kt | 18 ++-- .../composite/ProxyConfiguration.kt | 8 +- .../configuration/local/LocalConfiguration.kt | 5 +- .../local/webhook/WebHookConfiguration.kt | 8 +- .../local/webhook/WebHookSetting.kt | 10 +-- .../configuration/proxy/ProxyConfiguration.kt | 10 +-- .../cache/pojo/ArtifactPreloadPlan.kt | 23 +++-- .../pojo/ArtifactPreloadPlanCreateRequest.kt | 14 +-- .../cache/pojo/ArtifactPreloadStrategy.kt | 29 +++--- .../ArtifactPreloadStrategyCreateRequest.kt | 22 ++--- .../ArtifactPreloadStrategyUpdateRequest.kt | 22 ++--- .../bksync/transfer/http/HttpBkSyncCall.kt | 10 +-- .../metadata/pojo/file/FileReference.kt | 12 +-- .../metadata/pojo/log/OpLogListOption.kt | 31 ++++--- .../metadata/pojo/log/OperateLogResponse.kt | 4 +- .../metadata/pojo/node/NodeRestoreOption.kt | 10 +-- .../pojo/project/ProjectUsageStatistics.kt | 14 +-- .../ProjectUsageStatisticsListOption.kt | 13 +-- .../common/metadata/client/RAuthClient.kt | 44 +++++----- .../notify/api/NotifyChannelCredential.kt | 12 +-- .../weworkbot/WeworkBotChannelCredential.kt | 8 +- .../bkrepo/common/notify/pojo/BaseMessage.kt | 12 +-- .../bkrepo/common/notify/pojo/DevopsResult.kt | 12 +-- .../common/notify/pojo/EmailNotifyMessage.kt | 4 +- .../common/notify/pojo/RtxNotifyMessage.kt | 4 +- .../common/notify/pojo/SmsNotifyMessage.kt | 4 +- .../common/notify/pojo/WechatNotifyMessage.kt | 4 +- .../common/notify/service/DevopsNotify.kt | 4 +- .../bkrepo/common/query/model/PageLimit.kt | 14 +-- .../bkrepo/common/query/model/QueryModel.kt | 8 +- .../tencent/bkrepo/common/query/model/Rule.kt | 22 ++--- .../tencent/bkrepo/common/query/model/Sort.kt | 10 +-- .../security/interceptor/devx/PageResponse.kt | 13 +-- .../stream/binder/file/StreamFileUtils.kt | 2 +- .../bkrepo/composer/api/ComposerResource.kt | 14 +-- .../composer/api/ComposerWebResource.kt | 12 +-- .../composer/pojo/ArtifactUploadResponse.kt | 18 ++-- .../composer/util/pojo/ComposerArtifact.kt | 12 +-- .../bkrepo/composer/util/pojo/UriArgs.kt | 8 +- .../bkrepo/conan/api/ConanMetadataClient.kt | 6 +- .../bkrepo/conan/pojo/PackageVersionInfo.kt | 37 ++++---- .../conan/controller/UserConanController.kt | 40 ++++----- .../controller/CompressedBlobController.kt | 12 +-- .../controller/LegacyReferencesController.kt | 14 +-- .../ddc/controller/ReferencesController.kt | 24 ++--- .../com/tencent/bkrepo/ddc/pojo/BatchOps.kt | 4 +- .../ddc/service/ReferenceArtifactService.kt | 11 ++- .../bkrepo/ddc/pojo/SerializationTest.kt | 12 +-- .../bkrepo/generic/api/OperateResource.kt | 16 ++-- .../generic/api/ProxyTemporaryAccessClient.kt | 4 +- .../tencent/bkrepo/generic/pojo/BlockInfo.kt | 12 +-- .../tencent/bkrepo/generic/pojo/FileInfo.kt | 34 +++---- .../bkrepo/generic/pojo/SeparateBlockInfo.kt | 16 ++-- .../generic/pojo/TemporaryAccessToken.kt | 24 ++--- .../bkrepo/generic/pojo/TemporaryAccessUrl.kt | 24 ++--- .../generic/pojo/TemporaryUrlCreateRequest.kt | 25 +++--- .../generic/pojo/UploadTransactionInfo.kt | 10 +-- .../generic/controller/GenericController.kt | 16 ++-- .../controller/TemporaryAccessController.kt | 4 +- .../com/tencent/bkrepo/helm/api/HelmClient.kt | 16 ++-- .../bkrepo/helm/pojo/HelmErrorResponse.kt | 8 +- .../bkrepo/helm/pojo/HelmSuccessResponse.kt | 8 +- .../pojo/chart/ChartPackageDeleteRequest.kt | 14 +-- .../helm/pojo/chart/ChartUploadRequest.kt | 22 ++--- .../pojo/chart/ChartVersionDeleteRequest.kt | 16 ++-- .../helm/pojo/user/PackageVersionInfo.kt | 38 ++++---- .../controller/api/HelmFixToolController.kt | 6 +- .../helm/controller/api/UserHelmController.kt | 26 +++--- .../pojo/query/common/BackupCredentialSet.kt | 15 ++-- .../pojo/query/common/BackupScopeRule.kt | 9 +- .../pojo/query/enums/BackupRoleSource.kt | 4 +- .../bkrepo/job/backup/pojo/task/BackupTask.kt | 29 +++--- .../user/UserSeparationController.kt | 12 +-- .../CreateMigrateRepoStorageTaskRequest.kt | 14 +-- .../migrate/pojo/MigrateRepoStorageTask.kt | 36 ++++---- .../separation/pojo/task/SeparationTask.kt | 35 ++++---- .../bkrepo/maven/api/MavenMetadataClient.kt | 6 +- .../bkrepo/maven/api/MavenWebResource.kt | 14 +-- .../tencent/bkrepo/npm/api/AuthResource.kt | 10 +-- .../bkrepo/npm/api/ModuleDepsResource.kt | 48 +++++----- .../bkrepo/npm/api/NpmFixToolResource.kt | 16 ++-- .../npm/api/PackageDependentResource.kt | 6 +- .../bkrepo/npm/pojo/NpmDeleteResponse.kt | 12 +-- .../bkrepo/npm/pojo/NpmErrorResponse.kt | 10 +-- .../bkrepo/npm/pojo/NpmSearchResponse.kt | 9 +- .../bkrepo/npm/pojo/NpmSuccessResponse.kt | 4 +- .../npm/pojo/auth/NpmAuthFailResponse.kt | 8 +- .../bkrepo/npm/pojo/auth/NpmAuthResponse.kt | 12 +-- .../pojo/metadata/MetadataSearchRequest.kt | 18 ++-- .../pojo/migration/MigrationErrorDataInfo.kt | 18 ++-- .../migration/NpmDataMigrationResponse.kt | 15 ++-- .../NpmPackageDependentMigrationResponse.kt | 15 ++-- .../MigrationErrorDataCreateRequest.kt | 16 ++-- .../npm/pojo/module/des/ModuleDepsInfo.kt | 18 ++-- .../module/des/service/DepsCreateRequest.kt | 18 ++-- .../module/des/service/DepsDeleteRequest.kt | 16 ++-- .../bkrepo/npm/pojo/user/NpmPackageInfo.kt | 10 +-- .../pojo/user/NpmPackageLatestVersionInfo.kt | 32 +++---- .../npm/pojo/user/NpmPackageVersionInfo.kt | 22 ++--- .../bkrepo/npm/pojo/user/PackageInfo.kt | 44 +++++----- .../npm/pojo/user/PackageVersionInfo.kt | 49 ++++++----- .../pojo/user/request/PackageDeleteRequest.kt | 14 +-- .../request/PackageVersionDeleteRequest.kt | 16 ++-- .../UserModuleDependentsController.kt | 20 ++--- .../npm/controller/UserNpmController.kt | 26 +++--- .../UserPackageMigrationController.kt | 12 +-- .../nuget/controller/NugetWebController.kt | 26 +++--- .../pojo/request/PackageDeleteRequest.kt | 14 +-- .../request/PackageVersionDeleteRequest.kt | 16 ++-- .../nuget/pojo/user/PackageVersionInfo.kt | 39 ++++---- .../com/tencent/bkrepo/oci/api/OciClient.kt | 16 ++-- .../tencent/bkrepo/oci/pojo/user/BasicInfo.kt | 31 ++++--- .../oci/pojo/user/PackageVersionInfo.kt | 9 +- .../oci/controller/user/CatalogController.kt | 10 +-- .../oci/controller/user/UserOciController.kt | 52 +++++------ .../oci/pojo/response/OciErrorResponse.kt | 12 +-- .../bkrepo/oci/pojo/response/OciImage.kt | 18 ++-- .../oci/pojo/response/OciImageResult.kt | 10 +-- .../bkrepo/oci/pojo/response/OciTag.kt | 20 ++--- .../bkrepo/oci/pojo/response/OciTagResult.kt | 7 +- .../bkrepo/opdata/pojo/AnnotationsRequest.kt | 10 +-- .../com/tencent/bkrepo/opdata/pojo/Columns.kt | 7 +- .../com/tencent/bkrepo/opdata/pojo/Filter.kt | 9 +- .../tencent/bkrepo/opdata/pojo/NodeResult.kt | 10 +-- .../bkrepo/opdata/pojo/QueryRequest.kt | 29 +++--- .../tencent/bkrepo/opdata/pojo/QueryResult.kt | 9 +- .../com/tencent/bkrepo/opdata/pojo/Range.kt | 9 +- .../com/tencent/bkrepo/opdata/pojo/Raw.kt | 7 +- .../tencent/bkrepo/opdata/pojo/RepoMetrics.kt | 13 +-- .../bkrepo/opdata/pojo/SearchRequest.kt | 10 +-- .../com/tencent/bkrepo/opdata/pojo/Target.kt | 13 +-- .../opdata/pojo/config/GetConfigRequest.kt | 9 +- .../opdata/pojo/config/UpdateConfigRequest.kt | 12 +-- .../bkrepo/opdata/pojo/plugin/PluginDetail.kt | 23 +++-- .../opdata/pojo/registry/InstanceDetail.kt | 13 +-- .../opdata/pojo/registry/InstanceInfo.kt | 18 ++-- .../opdata/pojo/registry/ServiceInfo.kt | 10 +-- .../NotifyChannelCredentialController.kt | 12 +-- .../opdata/controller/PluginController.kt | 18 ++-- .../bkrepo/preview/pojo/FileAttribute.kt | 6 +- .../bkrepo/preview/pojo/PreviewInfo.kt | 18 ++-- .../bkrepo/preview/pojo/PreviewOptions.kt | 22 ++--- .../tencent/bkrepo/preview/pojo/Watermark.kt | 28 +++--- .../cache/PreviewFileCacheCreateRequest.kt | 13 +-- .../pojo/cache/PreviewFileCacheInfo.kt | 16 ++-- .../pypi/controller/PypiResourceController.kt | 6 +- .../controller/PypiWebResourceController.kt | 14 +-- .../tencent/bkrepo/pypi/util/pojo/PypiInfo.kt | 12 +-- .../replication/api/ArtifactPushClient.kt | 8 +- .../replication/api/ClusterNodeClient.kt | 4 +- .../replication/api/DistributionClient.kt | 8 +- .../replication/api/ReplicaTaskClient.kt | 8 +- .../api/ReplicaTaskOperationClient.kt | 12 +-- .../api/cluster/ClusterReplicaTaskClient.kt | 12 +-- .../pojo/cluster/ClusterListOption.kt | 14 +-- .../pojo/cluster/ClusterNodeInfo.kt | 46 +++++----- .../request/ClusterNodeCreateRequest.kt | 30 +++---- .../request/ClusterNodeStatusUpdateRequest.kt | 14 +-- .../request/ClusterNodeUpdateRequest.kt | 28 +++--- .../pojo/docker/OciErrorResponse.kt | 9 +- .../pojo/record/ReplicaRecordDetail.kt | 41 +++++---- .../record/ReplicaRecordDetailListOption.kt | 24 ++--- .../pojo/record/ReplicaRecordInfo.kt | 23 +++-- .../pojo/record/ReplicaRecordListOption.kt | 12 +-- .../pojo/record/ReplicaTaskRecordInfo.kt | 12 +-- .../request/RecordDetailInitialRequest.kt | 28 +++--- .../remote/request/ArtifactPushRequest.kt | 18 ++-- .../request/RemoteConfigCreateRequest.kt | 40 ++++----- .../request/RemoteConfigUpdateRequest.kt | 38 ++++---- .../remote/request/RemoteCreateRequest.kt | 8 +- .../request/RemoteRunOnceTaskCreateRequest.kt | 42 ++++----- .../pojo/task/ReplicaTaskDetail.kt | 10 +-- .../replication/pojo/task/ReplicaTaskInfo.kt | 51 ++++++----- .../pojo/task/objects/PackageConstraint.kt | 16 ++-- .../pojo/task/objects/PathConstraint.kt | 10 +-- .../pojo/task/objects/ReplicaObjectInfo.kt | 18 ++-- .../task/request/ReplicaTaskCopyRequest.kt | 12 +-- .../task/request/ReplicaTaskCreateRequest.kt | 28 +++--- .../pojo/task/request/ReplicaTaskObject.kt | 16 ++-- .../task/request/ReplicaTaskUpdateRequest.kt | 26 +++--- .../pojo/task/request/TaskPageParam.kt | 20 ++--- .../api/RemoteDistributionController.kt | 58 ++++++------ .../controller/api/ReplicaRecordController.kt | 22 ++--- .../controller/api/ReplicaTaskController.kt | 24 ++--- .../api/UserClusterNodeController.kt | 28 +++--- .../api/UserReplicationController.kt | 4 +- .../bkrepo/repository/api/MetadataClient.kt | 22 ++--- .../bkrepo/repository/api/NodeClient.kt | 88 +++++++++---------- .../bkrepo/repository/api/OperateLogClient.kt | 16 ++-- .../bkrepo/repository/api/PackageClient.kt | 36 ++++---- .../repository/api/PackageDownloadsClient.kt | 12 +-- .../repository/api/PackageMetadataClient.kt | 8 +- .../repository/api/PipelineNodeClient.kt | 8 +- .../bkrepo/repository/api/ProjectClient.kt | 26 +++--- .../api/ProjectUsageStatisticsClient.kt | 8 +- .../repository/api/ProxyChannelClient.kt | 14 +-- .../bkrepo/repository/api/RepositoryClient.kt | 54 ++++++------ .../bkrepo/repository/api/StageClient.kt | 6 +- .../api/cluster/ClusterMetadataClient.kt | 12 +-- .../api/cluster/ClusterNodeClient.kt | 30 +++---- .../api/cluster/ClusterNodeShareClient.kt | 10 +-- .../api/cluster/ClusterOperateLogClient.kt | 14 +-- .../api/cluster/ClusterPackageClient.kt | 12 +-- .../api/cluster/ClusterProjectClient.kt | 8 +- .../api/cluster/ClusterRepositoryClient.kt | 20 ++--- .../api/cluster/ClusterStageClient.kt | 4 +- .../api/proxy/ProxyFileReferenceClient.kt | 4 +- .../repository/api/proxy/ProxyNodeClient.kt | 28 +++--- .../api/proxy/ProxyOperateLogClient.kt | 14 +-- .../api/proxy/ProxyRepositoryClient.kt | 22 ++--- .../StorageCredentialsCreateRequest.kt | 12 +-- .../StorageCredentialsUpdateRequest.kt | 10 +-- .../dependent/PackageDependentsRelation.kt | 14 +-- .../pojo/download/DetailsQueryRequest.kt | 17 ++-- .../download/DownloadsMigrationRequest.kt | 20 ++--- .../pojo/download/PackageDownloadRecord.kt | 14 +-- .../pojo/download/PackageDownloadsDetails.kt | 8 +- .../pojo/download/PackageDownloadsSummary.kt | 14 +-- .../pojo/download/SummaryQueryRequest.kt | 14 +-- .../pojo/favorite/FavoriteCreateRequest.kt | 15 ++-- .../pojo/favorite/FavoriteRequest.kt | 14 +-- .../pojo/favorite/FavoriteResult.kt | 13 +-- .../pojo/metadata/MetadataDeleteRequest.kt | 16 ++-- .../pojo/metadata/MetadataSaveRequest.kt | 20 ++--- .../metadata/UserMetadataDeleteRequest.kt | 8 +- .../pojo/metadata/UserMetadataSaveRequest.kt | 10 +-- .../packages/PackageMetadataSaveRequest.kt | 18 ++-- .../UserPackageMetadataSaveRequest.kt | 12 +-- .../pojo/node/FileExtensionStatInfo.kt | 16 ++-- .../repository/pojo/node/NodeDeleteResult.kt | 11 ++- .../repository/pojo/node/NodeDeletedPoint.kt | 19 ++-- .../bkrepo/repository/pojo/node/NodeDetail.kt | 48 +++++----- .../bkrepo/repository/pojo/node/NodeInfo.kt | 52 +++++------ .../repository/pojo/node/NodeListOption.kt | 28 +++--- .../repository/pojo/node/NodeRestoreResult.kt | 9 +- .../repository/pojo/node/NodeSizeInfo.kt | 12 +-- .../pojo/node/service/NodeArchiveRequest.kt | 11 +-- .../node/service/NodeArchiveRestoreRequest.kt | 13 +-- .../pojo/node/service/NodeCleanRequest.kt | 13 +-- .../node/service/NodeCompressedRequest.kt | 11 +-- .../pojo/node/service/NodeCreateRequest.kt | 31 ++++--- .../pojo/node/service/NodeDeleteRequest.kt | 14 +-- .../pojo/node/service/NodeLinkRequest.kt | 26 +++--- .../pojo/node/service/NodeMoveCopyRequest.kt | 26 +++--- .../pojo/node/service/NodeRenameRequest.kt | 16 ++-- .../pojo/node/service/NodeSetLengthRequest.kt | 11 +-- .../node/service/NodeUnCompressedRequest.kt | 11 +-- .../pojo/node/service/NodeUpdateRequest.kt | 16 ++-- .../pojo/node/service/NodesDeleteRequest.kt | 16 ++-- .../user/UserNodeArchiveRestoreRequest.kt | 16 ++-- .../pojo/node/user/UserNodeCreateRequest.kt | 25 +++--- .../pojo/node/user/UserNodeLinkRequest.kt | 22 ++--- .../pojo/node/user/UserNodeMoveCopyRequest.kt | 22 ++--- .../pojo/node/user/UserNodeRenameRequest.kt | 14 +-- .../pojo/node/user/UserNodeUpdateRequest.kt | 8 +- .../pojo/packages/PackageListOption.kt | 12 +-- .../pojo/packages/PackageSummary.kt | 37 ++++---- .../pojo/packages/PackageVersion.kt | 38 ++++---- .../pojo/packages/VersionListOption.kt | 20 ++--- .../request/PackagePopulateRequest.kt | 28 +++--- .../packages/request/PackageUpdateRequest.kt | 17 ++-- .../request/PackageVersionCreateRequest.kt | 43 ++++----- .../request/PackageVersionUpdateRequest.kt | 27 +++--- .../request/PopulatedPackageVersion.kt | 28 +++--- .../pojo/project/ProjectCreateRequest.kt | 20 ++--- .../repository/pojo/project/ProjectInfo.kt | 26 +++--- .../pojo/project/ProjectListOption.kt | 18 ++-- .../pojo/project/ProjectMetricsInfo.kt | 12 +-- .../pojo/project/ProjectRangeQueryRequest.kt | 14 +-- .../pojo/project/ProjectSearchOption.kt | 12 +-- .../pojo/project/ProjectUpdateRequest.kt | 16 ++-- .../pojo/project/RepoRangeQueryRequest.kt | 14 +-- .../pojo/project/UserProjectCreateRequest.kt | 16 ++-- .../pojo/proxy/ProxyChannelCreateRequest.kt | 24 ++--- .../pojo/proxy/ProxyChannelDeleteRequest.kt | 14 +-- .../repository/pojo/proxy/ProxyChannelInfo.kt | 26 +++--- .../pojo/proxy/ProxyChannelUpdateRequest.kt | 24 ++--- .../repository/pojo/repo/RepoCreateRequest.kt | 30 +++---- .../repository/pojo/repo/RepoDeleteRequest.kt | 14 +-- .../repository/pojo/repo/RepoListOption.kt | 16 ++-- .../repository/pojo/repo/RepoMetricsInfo.kt | 11 +-- .../repository/pojo/repo/RepoQuotaInfo.kt | 10 +-- .../repository/pojo/repo/RepoUpdateRequest.kt | 22 ++--- .../repository/pojo/repo/RepositoryDetail.kt | 36 ++++---- .../repository/pojo/repo/RepositoryInfo.kt | 36 ++++---- .../pojo/repo/UserRepoCreateRequest.kt | 28 +++--- .../pojo/repo/UserRepoUpdateRequest.kt | 16 ++-- .../share/BatchShareRecordCreateRequest.kt | 18 ++-- .../pojo/share/ShareRecordCreateRequest.kt | 12 +-- .../repository/pojo/share/ShareRecordInfo.kt | 22 ++--- .../pojo/software/ProjectPackageOverview.kt | 4 +- .../pojo/token/TemporaryTokenCreateRequest.kt | 21 +++-- .../pojo/token/TemporaryTokenInfo.kt | 26 +++--- .../controller/user/FavoriteController.kt | 12 +-- .../user/UserArtifactPreloadController.kt | 22 ++--- .../user/UserBkCiWebhookController.kt | 4 +- .../user/UserFileReferenceController.kt | 14 +-- .../controller/user/UserListViewController.kt | 4 +- .../controller/user/UserMetadataController.kt | 14 +-- .../user/UserMetadataLabelController.kt | 16 ++-- .../controller/user/UserNodeController.kt | 64 +++++++------- .../user/UserOperateLogController.kt | 26 +++--- .../controller/user/UserPackageController.kt | 24 ++--- .../user/UserPackageDownloadsController.kt | 12 +-- .../user/UserPackageMetadataController.kt | 12 +-- .../user/UserPackageRepairController.kt | 8 +- .../controller/user/UserProjectController.kt | 46 +++++----- .../user/UserProxyChannelController.kt | 20 ++--- .../user/UserRepositoryController.kt | 78 ++++++++-------- .../controller/user/UserShareController.kt | 20 ++--- .../user/UserSoftwarePackageController.kt | 10 +-- .../user/UserSoftwareRepositoryController.kt | 20 ++--- .../controller/user/UserStageController.kt | 8 +- .../user/UserStorageCredentialsController.kt | 18 ++-- .../router/api/RouterControllerClient.kt | 16 ++-- .../contoller/user/RouterAdminController.kt | 20 ++--- .../tencent/bkrepo/rpm/api/RpmWebResource.kt | 18 ++-- .../bkrepo/rpm/pojo/RpmDeleteResponse.kt | 14 +-- .../bkrepo/rpm/pojo/RpmUploadResponse.kt | 18 ++-- .../tencent/bkrepo/rpm/pojo/RepoDataPojo.kt | 10 +-- .../webhook/pojo/CreateWebHookRequest.kt | 18 ++-- .../webhook/pojo/ListWebHookLogOption.kt | 16 ++-- .../webhook/pojo/UpdateWebHookRequest.kt | 16 ++-- .../tencent/bkrepo/webhook/pojo/WebHook.kt | 27 +++--- .../tencent/bkrepo/webhook/pojo/WebHookLog.kt | 27 +++--- .../webhook/controller/UserLogController.kt | 8 +- .../controller/UserWebHookController.kt | 20 ++--- 485 files changed, 4527 insertions(+), 4513 deletions(-) diff --git a/src/backend/README.md b/src/backend/README.md index 7aa7164436..a6dd62d96f 100644 --- a/src/backend/README.md +++ b/src/backend/README.md @@ -30,7 +30,7 @@ ### swagger地址 -${base-path}/v2/api-docs +${base-path}/v3/api-docs 配合chrome浏览器插件`Swagger UI Console`使用 diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/api/ScanClient.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/api/ScanClient.kt index 3521f3c808..22ed117928 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/api/ScanClient.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/api/ScanClient.kt @@ -34,7 +34,7 @@ import com.tencent.bkrepo.analyst.pojo.request.ReportResultRequest import com.tencent.bkrepo.analyst.pojo.request.ScanRequest import com.tencent.bkrepo.common.api.constant.SCANNER_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Parameter import org.springframework.cloud.openfeign.FeignClient import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable @@ -95,7 +95,7 @@ interface ScanClient { */ @PostMapping("/licenseIds") fun licenseInfoByIds( - @ApiParam(value = "许可证唯一标识集合") + @Parameter(name = "许可证唯一标识集合") @RequestBody licenseIds: List ): Response> diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/ArtifactScanReport.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/ArtifactScanReport.kt index e1255287d6..841fb40732 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/ArtifactScanReport.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/ArtifactScanReport.kt @@ -27,11 +27,11 @@ package com.tencent.bkrepo.analyst.pojo -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("扫描报告") + +@Schema(title = "扫描报告") data class ArtifactScanReport( - @ApiModelProperty("扫描报告") + @get:Schema(title = "扫描报告") private val report: String ) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/ArtifactScanStatus.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/ArtifactScanStatus.kt index ec15f24bcf..6c2d12c6de 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/ArtifactScanStatus.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/ArtifactScanStatus.kt @@ -27,15 +27,15 @@ package com.tencent.bkrepo.analyst.pojo -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("文件扫描状态") + +@Schema(title = "文件扫描状态") data class ArtifactScanStatus( - @ApiModelProperty("文件sha256") + @get:Schema(title = "文件sha256") val sha256: String, - @ApiModelProperty("文件路径") + @get:Schema(title = "文件路径") val fullPath: String, - @ApiModelProperty("文件扫描状态") + @get:Schema(title = "文件扫描状态") val status: String ) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/AutoScanConfiguration.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/AutoScanConfiguration.kt index 2c9408bc9f..3a39d76377 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/AutoScanConfiguration.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/AutoScanConfiguration.kt @@ -27,13 +27,13 @@ package com.tencent.bkrepo.analyst.pojo -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("自动扫描配置") + +@Schema(title = "自动扫描配置") data class AutoScanConfiguration( - @ApiModelProperty("自动扫描的仓库") + @get:Schema(title = "自动扫描的仓库") val autoScanRepoNames: List = emptyList(), - @ApiModelProperty("自动扫描制品匹配规则") + @get:Schema(title = "自动扫描制品匹配规则") val autoScanMatchRule: String? = null ) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/ProjectScanConfiguration.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/ProjectScanConfiguration.kt index 48de55a6e7..07def5b55c 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/ProjectScanConfiguration.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/ProjectScanConfiguration.kt @@ -28,30 +28,30 @@ package com.tencent.bkrepo.analyst.pojo import com.fasterxml.jackson.annotation.JsonInclude -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + @JsonInclude(JsonInclude.Include.NON_NULL) -@ApiModel("项目扫描配置") +@Schema(title = "项目扫描配置") data class ProjectScanConfiguration( - @ApiModelProperty("项目ID") + @get:Schema(title = "项目ID") val projectId: String, - @ApiModelProperty("项目优先级，值越小优先级越低") + @get:Schema(title = "项目优先级，值越小优先级越低") val priority: Int? = null, - @ApiModelProperty("项目限制的扫描任务数量") + @get:Schema(title = "项目限制的扫描任务数量") val scanTaskCountLimit: Int? = null, - @ApiModelProperty("项目扫描子任务数量限制") + @get:Schema(title = "项目扫描子任务数量限制") val subScanTaskCountLimit: Int? = null, - @ApiModelProperty("自动扫描配置") + @get:Schema(title = "自动扫描配置") val autoScanConfiguration: Map? = null, - @ApiModelProperty("子任务分发器") + @get:Schema(title = "子任务分发器") val dispatcherConfiguration: List? = null ) -@ApiModel("分发器配置") +@Schema(title = "分发器配置") data class DispatcherConfiguration( - @ApiModelProperty("使用的分发器") + @get:Schema(title = "使用的分发器") val dispatcher: String, - @ApiModelProperty("扫描器") + @get:Schema(title = "扫描器") val scanner: String ) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/ScanPlan.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/ScanPlan.kt index 47b6830199..aaee396f79 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/ScanPlan.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/ScanPlan.kt @@ -29,42 +29,42 @@ package com.tencent.bkrepo.analyst.pojo import com.fasterxml.jackson.annotation.JsonInclude import com.tencent.bkrepo.common.query.model.Rule -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + @JsonInclude(JsonInclude.Include.NON_NULL) -@ApiModel("扫描方案") +@Schema(title = "扫描方案") data class ScanPlan( - @ApiModelProperty("方案ID") + @get:Schema(title = "方案ID") var id: String? = null, - @ApiModelProperty("项目ID") + @get:Schema(title = "项目ID") var projectId: String? = null, - @ApiModelProperty("方案名称") + @get:Schema(title = "方案名称") var name: String? = null, - @ApiModelProperty("方案类型") + @get:Schema(title = "方案类型") var type: String? = null, - @ApiModelProperty("扫描类型") + @get:Schema(title = "扫描类型") var scanTypes: List? = null, - @ApiModelProperty("使用的扫描器") + @get:Schema(title = "使用的扫描器") var scanner: String? = null, - @ApiModelProperty("方案描述") + @get:Schema(title = "方案描述") var description: String? = null, - @ApiModelProperty("是否有新制品上传时自动扫描") + @get:Schema(title = "是否有新制品上传时自动扫描") var scanOnNewArtifact: Boolean? = null, - @ApiModelProperty("自动扫描仓库") + @get:Schema(title = "自动扫描仓库") var repoNames: List? = null, - @ApiModelProperty("自动扫描规则") + @get:Schema(title = "自动扫描规则") var rule: Rule? = null, - @ApiModelProperty("质量规则") + @get:Schema(title = "质量规则") var scanQuality: Map? = null, - @ApiModelProperty("创建者") + @get:Schema(title = "创建者") var createdBy: String? = null, - @ApiModelProperty("创建时间") + @get:Schema(title = "创建时间") var createdDate: String? = null, - @ApiModelProperty("修改者") + @get:Schema(title = "修改者") var lastModifiedBy: String? = null, - @ApiModelProperty("修改时间") + @get:Schema(title = "修改时间") var lastModifiedDate: String? = null, - @ApiModelProperty("是否只读") + @get:Schema(title = "是否只读") var readOnly: Boolean? = null ) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/ScanTask.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/ScanTask.kt index 0fe2069dfb..97a3f6e205 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/ScanTask.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/ScanTask.kt @@ -28,58 +28,58 @@ package com.tencent.bkrepo.analyst.pojo import com.tencent.bkrepo.common.query.model.Rule -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("扫描任务信息") + +@Schema(title = "扫描任务信息") data class ScanTask( - @ApiModelProperty("扫描任务名") + @get:Schema(title = "扫描任务名") val name: String? = null, - @ApiModelProperty("任务id") + @get:Schema(title = "任务id") val taskId: String, - @ApiModelProperty("项目id，只扫描单个项目时有值") + @get:Schema(title = "项目id，只扫描单个项目时有值") val projectId: String?, - @ApiModelProperty("项目id") + @get:Schema(title = "项目id") val projectIds: Set, - @ApiModelProperty("触发者") + @get:Schema(title = "触发者") val createdBy: String, - @ApiModelProperty("最后修改时间") + @get:Schema(title = "最后修改时间") val lastModifiedDateTime: String, - @ApiModelProperty("任务触发时间") + @get:Schema(title = "任务触发时间") val triggerDateTime: String, - @ApiModelProperty("任务开始执行时间") + @get:Schema(title = "任务开始执行时间") val startDateTime: String?, - @ApiModelProperty("任务执行结束时间") + @get:Schema(title = "任务执行结束时间") val finishedDateTime: String?, - @ApiModelProperty("触发方式") + @get:Schema(title = "触发方式") val triggerType: String, - @ApiModelProperty("任务状态") + @get:Schema(title = "任务状态") val status: String, - @ApiModelProperty("扫描方案") + @get:Schema(title = "扫描方案") val scanPlan: ScanPlan?, - @ApiModelProperty("扫描文件匹配规则") + @get:Schema(title = "扫描文件匹配规则") val rule: Rule?, - @ApiModelProperty("计划扫描文件总数") + @get:Schema(title = "计划扫描文件总数") val total: Long, - @ApiModelProperty("扫描中的文件总数") + @get:Schema(title = "扫描中的文件总数") val scanning: Long, - @ApiModelProperty("扫描失败的文件总数") + @get:Schema(title = "扫描失败的文件总数") val failed: Long, - @ApiModelProperty("已扫描文件总数") + @get:Schema(title = "已扫描文件总数") val scanned: Long, - @ApiModelProperty("通过质量规则的文件总数") + @get:Schema(title = "通过质量规则的文件总数") val passed: Long, - @ApiModelProperty("使用的扫描器") + @get:Schema(title = "使用的扫描器") val scanner: String, - @ApiModelProperty("扫描器类型") + @get:Schema(title = "扫描器类型") val scannerType: String, - @ApiModelProperty("扫描器版本") + @get:Schema(title = "扫描器版本") val scannerVersion: String, - @ApiModelProperty("扫描结果统计数据") + @get:Schema(title = "扫描结果统计数据") val scanResultOverview: Map?, - @ApiModelProperty("是否强制扫描") + @get:Schema(title = "是否强制扫描") val force: Boolean = false, - @ApiModelProperty("扫描任务元数据") + @get:Schema(title = "扫描任务元数据") val metadata: List ) { fun isGlobal() = metadata.any { it.key == TaskMetadata.TASK_METADATA_GLOBAL && it.value == "true" } diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/execution/DockerExecutionCluster.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/execution/DockerExecutionCluster.kt index 57aad6f860..51161abbcb 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/execution/DockerExecutionCluster.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/execution/DockerExecutionCluster.kt @@ -1,19 +1,19 @@ package com.tencent.bkrepo.analyst.pojo.execution -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema @Suppress("LongParameterList", "MagicNumber") data class DockerExecutionCluster( override val name: String, - @ApiModelProperty("docker host") + @get:Schema(title = "docker host") val host: String = "unix://var/run/docker.sock", - @ApiModelProperty("docker api version") + @get:Schema(title = "docker api version") val version: String = "1.23", - @ApiModelProperty("docker api connect timeout") + @get:Schema(title = "docker api connect timeout") val connectTimeout: Int = 5000, - @ApiModelProperty("docker api read timeout") + @get:Schema(title = "docker api read timeout") val readTimeout: Int = 0, - @ApiModelProperty("最大可同时执行的任务数量") + @get:Schema(title = "最大可同时执行的任务数量") val maxTaskCount: Int = 1 ) : ExecutionCluster(name, type) { companion object { diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/execution/ExecutionCluster.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/execution/ExecutionCluster.kt index 43ac2ae718..e5f6a75e86 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/execution/ExecutionCluster.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/execution/ExecutionCluster.kt @@ -3,10 +3,10 @@ package com.tencent.bkrepo.analyst.pojo.execution import com.fasterxml.jackson.annotation.JsonSubTypes import com.fasterxml.jackson.annotation.JsonSubTypes.Type import com.fasterxml.jackson.annotation.JsonTypeInfo -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("任务执行集群配置") + +@Schema(title = "任务执行集群配置") @JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.EXISTING_PROPERTY, property = "type") @JsonSubTypes( Type(value = KubernetesJobExecutionCluster::class, name = KubernetesJobExecutionCluster.type), @@ -14,10 +14,10 @@ import io.swagger.annotations.ApiModelProperty Type(value = DockerExecutionCluster::class, name = DockerExecutionCluster.type), ) open class ExecutionCluster( - @ApiModelProperty("执行集群名") + @get:Schema(title = "执行集群名") open val name: String, - @ApiModelProperty("类型") + @get:Schema(title = "类型") val type: String, - @ApiModelProperty("描述") + @get:Schema(title = "描述") val description: String = "", ) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/execution/KubernetesDeploymentExecutionCluster.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/execution/KubernetesDeploymentExecutionCluster.kt index eb8e50970d..a28ac376d8 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/execution/KubernetesDeploymentExecutionCluster.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/execution/KubernetesDeploymentExecutionCluster.kt @@ -1,20 +1,21 @@ package com.tencent.bkrepo.analyst.pojo.execution -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + data class KubernetesDeploymentExecutionCluster( override val name: String, - @ApiModelProperty("使用的扫描器") + @get:Schema(title = "使用的扫描器") val scanner: String, - @ApiModelProperty("k8s配置") + @get:Schema(title = "k8s配置") val kubernetesProperties: KubernetesExecutionClusterProperties, - @ApiModelProperty("最大副本数") + @get:Schema(title = "最大副本数") val maxReplicas: Int = 1, - @ApiModelProperty("最小副本数") + @get:Schema(title = "最小副本数") val minReplicas: Int = 1, - @ApiModelProperty("目标副本数与当前副本数之差绝对值超过这个配置时将触发扩缩容") + @get:Schema(title = "目标副本数与当前副本数之差绝对值超过这个配置时将触发扩缩容") val scaleThreshold: Int = 1, - @ApiModelProperty("扫描器重试拉取任务次数，-1表示一直拉取直到拉取任务成功") + @get:Schema(title = "扫描器重试拉取任务次数，-1表示一直拉取直到拉取任务成功") val pullRetry: Int = 3, ) : ExecutionCluster(name, type) { companion object { diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/execution/KubernetesExecutionClusterProperties.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/execution/KubernetesExecutionClusterProperties.kt index dd83876655..dcdc613ccb 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/execution/KubernetesExecutionClusterProperties.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/execution/KubernetesExecutionClusterProperties.kt @@ -1,27 +1,28 @@ package com.tencent.bkrepo.analyst.pojo.execution -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + data class KubernetesExecutionClusterProperties( - @ApiModelProperty("命名空间") + @get:Schema(title = "命名空间") val namespace: String = "default", - @ApiModelProperty("k8s api server url") + @get:Schema(title = "k8s api server url") val apiServer: String? = null, - @ApiModelProperty("certificateAuthorityData，未配置时取当前环境的~/.kube/config，或者当前部署的service account") + @get:Schema(title = "certificateAuthorityData，未配置时取当前环境的~/.kube/config，或者当前部署的service account") val certificateAuthorityData: String? = null, // token认证 - @ApiModelProperty("用于访问apiServer时进行认证，未配置时取当前环境的~/.kube/config，或者当前部署的service account") + @get:Schema(title = "用于访问apiServer时进行认证，未配置时取当前环境的~/.kube/config，或者当前部署的service account") val token: String? = null, // client cert认证 - @ApiModelProperty("clientCertificateData，未配置时取当前环境的~/.kube/config，或者当前部署的service account") + @get:Schema(title = "clientCertificateData，未配置时取当前环境的~/.kube/config，或者当前部署的service account") val clientCertificateData: String? = null, - @ApiModelProperty("clientKeyData，未配置时取当前环境的~/.kube/config，或者当前部署的service account") + @get:Schema(title = "clientKeyData，未配置时取当前环境的~/.kube/config，或者当前部署的service account") val clientKeyData: String? = null, - @ApiModelProperty("集群允许的单容器最大内存使用") + @get:Schema(title = "集群允许的单容器最大内存使用") val limitMem: Long = 32 * GB, - @ApiModelProperty("集群允许单容器使用的最大ephemeralStorage") + @get:Schema(title = "集群允许单容器使用的最大ephemeralStorage") val limitStorage: Long = 128 * GB, - @ApiModelProperty("集群允许单容器使用的最大cpu") + @get:Schema(title = "集群允许单容器使用的最大cpu") val limitCpu: Double = 16.0 ) { companion object { diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/execution/KubernetesJobExecutionCluster.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/execution/KubernetesJobExecutionCluster.kt index f283b7e08e..26a8e61cce 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/execution/KubernetesJobExecutionCluster.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/execution/KubernetesJobExecutionCluster.kt @@ -1,15 +1,16 @@ package com.tencent.bkrepo.analyst.pojo.execution -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + @Suppress("LongParameterList", "MagicNumber") data class KubernetesJobExecutionCluster( override val name: String, - @ApiModelProperty("k8s配置") + @get:Schema(title = "k8s配置") val kubernetesProperties: KubernetesExecutionClusterProperties, - @ApiModelProperty("job执行结束后，k8s中job对象保留时间为一小时") + @get:Schema(title = "job执行结束后，k8s中job对象保留时间为一小时") val jobTtlSecondsAfterFinished: Int = 60 * 60, - @ApiModelProperty("是否在执行成功后删除job，如果K8S集群的ttlSecondsAfterFinished参数可用，可将该参数设置为false") + @get:Schema(title = "是否在执行成功后删除job，如果K8S集群的ttlSecondsAfterFinished参数可用，可将该参数设置为false") val cleanJobAfterSuccess: Boolean = true, ) : ExecutionCluster(name, type) { diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/license/SpdxLicenseInfo.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/license/SpdxLicenseInfo.kt index 901f8e4c34..1a36d47bec 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/license/SpdxLicenseInfo.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/license/SpdxLicenseInfo.kt @@ -27,37 +27,37 @@ package com.tencent.bkrepo.analyst.pojo.license -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("SPDX许可证信息") + +@Schema(title = "SPDX许可证信息") data class SpdxLicenseInfo( - @ApiModelProperty("创建者") + @get:Schema(title = "创建者") val createdBy: String, - @ApiModelProperty("创建时间") + @get:Schema(title = "创建时间") val createdDate: String, - @ApiModelProperty("修改者") + @get:Schema(title = "修改者") val lastModifiedBy: String, - @ApiModelProperty("修改时间") + @get:Schema(title = "修改时间") val lastModifiedDate: String, - @ApiModelProperty("许可证名称") + @get:Schema(title = "许可证名称") val name: String, - @ApiModelProperty("许可证标识符") + @get:Schema(title = "许可证标识符") val licenseId: String, - @ApiModelProperty("指向其他许可证副本的交叉引用 URL") + @get:Schema(title = "指向其他许可证副本的交叉引用 URL") val seeAlso: MutableList, - @ApiModelProperty("对许可证文件的 HTML 格式的引用") + @get:Schema(title = "对许可证文件的 HTML 格式的引用") val reference: String, - @ApiModelProperty("是否被弃用") + @get:Schema(title = "是否被弃用") val isDeprecatedLicenseId: Boolean, - @ApiModelProperty("OSI 是否已批准许可证") + @get:Schema(title = "OSI 是否已批准许可证") val isOsiApproved: Boolean, - @ApiModelProperty("是否 FSF 认证免费") + @get:Schema(title = "是否 FSF 认证免费") val isFsfLibre: Boolean?, - @ApiModelProperty("包含许可证详细信息的 JSON 文件的 URL") + @get:Schema(title = "包含许可证详细信息的 JSON 文件的 URL") val detailsUrl: String, - @ApiModelProperty("是否信任") + @get:Schema(title = "是否信任") val isTrust: Boolean, - @ApiModelProperty("风险等级") + @get:Schema(title = "风险等级") val risk: String? ) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/ArrowheadLoadResultArguments.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/ArrowheadLoadResultArguments.kt index fc9e05e10b..1302d19d4d 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/ArrowheadLoadResultArguments.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/ArrowheadLoadResultArguments.kt @@ -27,23 +27,23 @@ package com.tencent.bkrepo.analyst.pojo.request -import com.tencent.bkrepo.common.query.model.PageLimit import com.tencent.bkrepo.common.analysis.pojo.scanner.arrowhead.ArrowheadScanner -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import com.tencent.bkrepo.common.query.model.PageLimit +import io.swagger.v3.oas.annotations.media.Schema + -@ApiModel("arrowhead扫描结果拉取参数") +@Schema(title = "arrowhead扫描结果拉取参数") data class ArrowheadLoadResultArguments( - @ApiModelProperty("需要的cve列表") + @get:Schema(title = "需要的cve列表") val vulIds: List = emptyList(), - @ApiModelProperty("需要的漏洞严重性等级列表") + @get:Schema(title = "需要的漏洞严重性等级列表") val vulnerabilityLevels: List = emptyList(), - @ApiModelProperty("需要的许可id列表") + @get:Schema(title = "需要的许可id列表") val licenseIds: List = emptyList(), - @ApiModelProperty("需要的许可风险等级列表") + @get:Schema(title = "需要的许可风险等级列表") val riskLevels: List = emptyList(), - @ApiModelProperty("扫描结果类型") + @get:Schema(title = "扫描结果类型") val reportType: String, - @ApiModelProperty("分页参数") + @get:Schema(title = "分页参数") val pageLimit: PageLimit = PageLimit() ) : LoadResultArguments(ArrowheadScanner.TYPE) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/ArtifactPlanRelationRequest.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/ArtifactPlanRelationRequest.kt index f0703ff08b..73c9751563 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/ArtifactPlanRelationRequest.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/ArtifactPlanRelationRequest.kt @@ -27,21 +27,21 @@ package com.tencent.bkrepo.analyst.pojo.request -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("制品与扫描方案关系请求") + +@Schema(title = "制品与扫描方案关系请求") data class ArtifactPlanRelationRequest( - @ApiModelProperty("制品所属项目") + @get:Schema(title = "制品所属项目") val projectId: String, - @ApiModelProperty("仓库名") + @get:Schema(title = "仓库名") val repoName: String, - @ApiModelProperty("仓库类型") + @get:Schema(title = "仓库类型") val repoType: String, - @ApiModelProperty("依赖包标识，比如gav://org.example:test-lib") + @get:Schema(title = "依赖包标识，比如gav://org.example:test-lib") val packageKey: String? = null, - @ApiModelProperty("依赖包版本号") + @get:Schema(title = "依赖包版本号") val version: String? = null, - @ApiModelProperty("制品完整路径") + @get:Schema(title = "制品完整路径") var fullPath: String? = null ) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/ArtifactVulnerabilityRequest.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/ArtifactVulnerabilityRequest.kt index 515f626601..897b05bbba 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/ArtifactVulnerabilityRequest.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/ArtifactVulnerabilityRequest.kt @@ -27,28 +27,28 @@ package com.tencent.bkrepo.analyst.pojo.request +import com.tencent.bkrepo.common.analysis.pojo.scanner.arrowhead.CveSecItem import com.tencent.bkrepo.common.api.constant.DEFAULT_PAGE_NUMBER import com.tencent.bkrepo.common.api.constant.DEFAULT_PAGE_SIZE -import com.tencent.bkrepo.common.analysis.pojo.scanner.arrowhead.CveSecItem -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + -@ApiModel("获取制品漏洞详情请求") +@Schema(title = "获取制品漏洞详情请求") data class ArtifactVulnerabilityRequest( - @ApiModelProperty("项目id") + @get:Schema(title = "项目id") var projectId: String? = null, - @ApiModelProperty("子任务id") + @get:Schema(title = "子任务id") var subScanTaskId: String? = null, - @ApiModelProperty("vulId") + @get:Schema(title = "vulId") val vulId: String? = null, - @ApiModelProperty("漏洞等级") + @get:Schema(title = "漏洞等级") var leakType: String? = null, - @ApiModelProperty("为true时将仅获取被忽略漏洞") + @get:Schema(title = "为true时将仅获取被忽略漏洞") var ignored: Boolean = false, - @ApiModelProperty("报告类型") + @get:Schema(title = "报告类型") val reportType: String = CveSecItem.TYPE, - @ApiModelProperty("页数") + @get:Schema(title = "页数") val pageNumber: Int = DEFAULT_PAGE_NUMBER, - @ApiModelProperty("每页数量") + @get:Schema(title = "每页数量") val pageSize: Int = DEFAULT_PAGE_SIZE ) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/CreateScanPlanRequest.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/CreateScanPlanRequest.kt index f503dbe325..304404a533 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/CreateScanPlanRequest.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/CreateScanPlanRequest.kt @@ -28,24 +28,24 @@ package com.tencent.bkrepo.analyst.pojo.request import com.fasterxml.jackson.annotation.JsonIgnoreProperties -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("创建扫描方案请求") + +@Schema(title = "创建扫描方案请求") @JsonIgnoreProperties(ignoreUnknown = true) data class CreateScanPlanRequest( - @ApiModelProperty("项目ID") + @get:Schema(title = "项目ID") val projectId: String, - @ApiModelProperty("方案名称") + @get:Schema(title = "方案名称") val name: String, - @ApiModelProperty("方案类型") + @get:Schema(title = "方案类型") val type: String, - @ApiModelProperty("扫描类型") + @get:Schema(title = "扫描类型") val scanTypes: List = emptyList(), - @ApiModelProperty("使用的扫描器") + @get:Schema(title = "使用的扫描器") val scanner: String = "default", - @ApiModelProperty("描述") + @get:Schema(title = "描述") val description: String = "", - @ApiModelProperty("是否自动扫描") + @get:Schema(title = "是否自动扫描") val autoScan: Boolean = false ) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/FileScanResultDetailRequest.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/FileScanResultDetailRequest.kt index a350847b27..3cb4b0008e 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/FileScanResultDetailRequest.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/FileScanResultDetailRequest.kt @@ -28,15 +28,15 @@ package com.tencent.bkrepo.analyst.pojo.request import com.tencent.bkrepo.common.artifact.api.ArtifactInfo -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("文件详细扫描报告请求") + +@Schema(title = "文件详细扫描报告请求") data class FileScanResultDetailRequest( - @ApiModelProperty("使用的扫描器") + @get:Schema(title = "使用的扫描器") val scanner: String, - @ApiModelProperty("扫描结果加载参数") + @get:Schema(title = "扫描结果加载参数") val arguments: LoadResultArguments, - @ApiModelProperty(hidden = true) + @get:Schema(hidden = true) var artifactInfo: ArtifactInfo? = null ) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/FileScanResultOverviewRequest.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/FileScanResultOverviewRequest.kt index bbc9fafca3..e4d532a6ed 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/FileScanResultOverviewRequest.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/FileScanResultOverviewRequest.kt @@ -27,21 +27,21 @@ package com.tencent.bkrepo.analyst.pojo.request -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("扫描报告预览请求") + +@Schema(title = "扫描报告预览请求") data class FileScanResultOverviewRequest( - @ApiModelProperty("扫描器名") + @get:Schema(title = "扫描器名") val scanner: String, - @ApiModelProperty("查询报告的文件sha256列表，key为credentials，value为sha256列表") + @get:Schema(title = "查询报告的文件sha256列表，key为credentials，value为sha256列表") val credentialsKeyFiles: List ) -@ApiModel("指定存储的文件") +@Schema(title = "指定存储的文件") data class CredentialsKeyFiles( - @ApiModelProperty("存储凭据") + @get:Schema(title = "存储凭据") val credentialsKey: String?, - @ApiModelProperty("存储中的文件sha256列表") + @get:Schema(title = "存储中的文件sha256列表") val sha256List: List ) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/GlobalScanRequest.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/GlobalScanRequest.kt index a8fca88811..af7845356e 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/GlobalScanRequest.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/GlobalScanRequest.kt @@ -30,19 +30,19 @@ package com.tencent.bkrepo.analyst.pojo.request import com.tencent.bkrepo.analyst.pojo.TaskMetadata import com.tencent.bkrepo.common.query.model.Rule import com.tencent.bkrepo.repository.pojo.project.ProjectMetadata -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("全局扫描请求") + +@Schema(title = "全局扫描请求") data class GlobalScanRequest( - @ApiModelProperty("扫描器名") + @get:Schema(title = "扫描器名") val scanner: String, - @ApiModelProperty("扫描文件匹配规则") + @get:Schema(title = "扫描文件匹配规则") val rule: Rule, - @ApiModelProperty("是否强制扫描，为true时无论是否存在扫描结果都会执行扫描") + @get:Schema(title = "是否强制扫描，为true时无论是否存在扫描结果都会执行扫描") val force: Boolean = false, - @ApiModelProperty("项目元数据，用于筛选待扫描项目") + @get:Schema(title = "项目元数据，用于筛选待扫描项目") val projectMetadata: List = emptyList(), - @ApiModelProperty("任务元数据") + @get:Schema(title = "任务元数据") val metadata: List = emptyList() ) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/LoadResultArguments.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/LoadResultArguments.kt index 30907818c8..6dadc34cfd 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/LoadResultArguments.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/LoadResultArguments.kt @@ -29,19 +29,19 @@ package com.tencent.bkrepo.analyst.pojo.request import com.fasterxml.jackson.annotation.JsonSubTypes import com.fasterxml.jackson.annotation.JsonTypeInfo +import com.tencent.bkrepo.analyst.pojo.request.dependencecheck.DependencyLoadResultArguments +import com.tencent.bkrepo.analyst.pojo.request.scancodetoolkit.ScancodeToolkitResultArguments +import com.tencent.bkrepo.analyst.pojo.request.standard.StandardLoadResultArguments +import com.tencent.bkrepo.analyst.pojo.request.trivy.TrivyLoadResultArguments import com.tencent.bkrepo.common.analysis.pojo.scanner.arrowhead.ArrowheadScanner import com.tencent.bkrepo.common.analysis.pojo.scanner.dependencycheck.scanner.DependencyScanner import com.tencent.bkrepo.common.analysis.pojo.scanner.scanCodeCheck.scanner.ScancodeToolkitScanner import com.tencent.bkrepo.common.analysis.pojo.scanner.standard.StandardScanner import com.tencent.bkrepo.common.analysis.pojo.scanner.trivy.TrivyScanner -import com.tencent.bkrepo.analyst.pojo.request.dependencecheck.DependencyLoadResultArguments -import com.tencent.bkrepo.analyst.pojo.request.scancodetoolkit.ScancodeToolkitResultArguments -import com.tencent.bkrepo.analyst.pojo.request.standard.StandardLoadResultArguments -import com.tencent.bkrepo.analyst.pojo.request.trivy.TrivyLoadResultArguments -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + -@ApiModel("加载制品扫描结果时的参数") +@Schema(title = "加载制品扫描结果时的参数") @JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.EXISTING_PROPERTY, property = "type") @JsonSubTypes( JsonSubTypes.Type(value = ArrowheadLoadResultArguments::class, name = ArrowheadScanner.TYPE), @@ -51,6 +51,6 @@ import io.swagger.annotations.ApiModelProperty JsonSubTypes.Type(value = StandardLoadResultArguments::class, name = StandardScanner.TYPE) ) open class LoadResultArguments( - @ApiModelProperty("扫描器类型") + @get:Schema(title = "扫描器类型") val type: String ) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/PipelineScanRequest.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/PipelineScanRequest.kt index 9ecf155890..11bb868b68 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/PipelineScanRequest.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/PipelineScanRequest.kt @@ -29,33 +29,33 @@ package com.tencent.bkrepo.analyst.pojo.request import com.tencent.bkrepo.common.artifact.pojo.RepositoryType import com.tencent.bkrepo.common.query.model.Rule -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("流水线触发扫描请求") + +@Schema(title = "流水线触发扫描请求") data class PipelineScanRequest( - @ApiModelProperty("项目id") + @get:Schema(title = "项目id") val projectId: String, - @ApiModelProperty("流水线id") + @get:Schema(title = "流水线id") val pid: String? = null, - @ApiModelProperty("构建id") + @get:Schema(title = "构建id") val bid: String? = null, - @ApiModelProperty("构建号") + @get:Schema(title = "构建号") val buildNo: String? = null, - @ApiModelProperty("流水线名") + @get:Schema(title = "流水线名") val pipelineName: String? = null, - @ApiModelProperty("使用的插件名") + @get:Schema(title = "使用的插件名") val pluginName: String? = null, - @ApiModelProperty("扫描方案id，未指定时会创建一个generic类型的默认方案") + @get:Schema(title = "扫描方案id，未指定时会创建一个generic类型的默认方案") val planId: String? = null, - @ApiModelProperty("未指定planId时默认创建的扫描方案类型") + @get:Schema(title = "未指定planId时默认创建的扫描方案类型") val planType: String = RepositoryType.GENERIC.name, - @ApiModelProperty("未指定planId时默认创建的扫描方案使用的扫描器") + @get:Schema(title = "未指定planId时默认创建的扫描方案使用的扫描器") val scanner: String? = null, - @ApiModelProperty("扫描文件匹配规则") + @get:Schema(title = "扫描文件匹配规则") val rule: Rule, - @ApiModelProperty("用于通知扫描结果的企业微信群机器人") + @get:Schema(title = "用于通知扫描结果的企业微信群机器人") val weworkBotUrl: String? = null, - @ApiModelProperty("用于通知扫描结果的企业微信群机器人会话，多个id用|分隔") + @get:Schema(title = "用于通知扫描结果的企业微信群机器人会话，多个id用|分隔") val chatIds: String? = null ) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/PlanCountRequest.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/PlanCountRequest.kt index d0831ae320..75a5af5dde 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/PlanCountRequest.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/PlanCountRequest.kt @@ -27,23 +27,22 @@ package com.tencent.bkrepo.analyst.pojo.request -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema import java.time.Instant import java.time.LocalDateTime -@ApiModel("指定扫描方案扫描过的制品统计信息请求") +@Schema(title = "指定扫描方案扫描过的制品统计信息请求") data class PlanCountRequest( - @ApiModelProperty("扫描方案所属项目id", required = true) + @get:Schema(title = "扫描方案所属项目id", required = true) val projectId: String, - @ApiModelProperty("扫描方案id", required = true) + @get:Schema(title = "扫描方案id", required = true) val id: String, - @ApiModelProperty("制品扫描任务创建时间(开始)") + @get:Schema(title = "制品扫描任务创建时间(开始)") val startTime: Instant? = null, - @ApiModelProperty("制品扫描任务创建时间(开始)") + @get:Schema(title = "制品扫描任务创建时间(开始)") var startDateTime: LocalDateTime? = null, - @ApiModelProperty("制品扫描任务创建时间(截止)") + @get:Schema(title = "制品扫描任务创建时间(截止)") val endTime: Instant? = null, - @ApiModelProperty("制品扫描任务创建时间(截止)") + @get:Schema(title = "制品扫描任务创建时间(截止)") var endDateTime: LocalDateTime? = null ) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/ProjectScanConfigurationPageRequest.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/ProjectScanConfigurationPageRequest.kt index 8ab3908997..e5c16515b6 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/ProjectScanConfigurationPageRequest.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/ProjectScanConfigurationPageRequest.kt @@ -29,15 +29,15 @@ package com.tencent.bkrepo.analyst.pojo.request import com.tencent.bkrepo.common.api.constant.DEFAULT_PAGE_NUMBER import com.tencent.bkrepo.common.api.constant.DEFAULT_PAGE_SIZE -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("分页获取项目扫描配置请求") + +@Schema(title = "分页获取项目扫描配置请求") data class ProjectScanConfigurationPageRequest( - @ApiModelProperty("用于匹配的项目ID") + @get:Schema(title = "用于匹配的项目ID") val projectId: String? = null, - @ApiModelProperty("分页页码") + @get:Schema(title = "分页页码") val pageNumber: Int = DEFAULT_PAGE_NUMBER, - @ApiModelProperty("分页大小") + @get:Schema(title = "分页大小") val pageSize: Int = DEFAULT_PAGE_SIZE ) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/ReportResultRequest.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/ReportResultRequest.kt index 24d4e51581..17605c06ec 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/ReportResultRequest.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/ReportResultRequest.kt @@ -28,17 +28,17 @@ package com.tencent.bkrepo.analyst.pojo.request import com.tencent.bkrepo.common.analysis.pojo.scanner.ScanExecutorResult -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("扫描结果上报请求") + +@Schema(title = "扫描结果上报请求") data class ReportResultRequest( - @ApiModelProperty("任务id") + @get:Schema(title = "任务id") val subTaskId: String, - @ApiModelProperty("扫描执行状态") + @get:Schema(title = "扫描执行状态") val scanStatus: String, - @ApiModelProperty("扫描执行器扫描结果") + @get:Schema(title = "扫描执行器扫描结果") val scanExecutorResult: ScanExecutorResult? = null, - @ApiModelProperty("临时凭据，用于接口鉴权") + @get:Schema(title = "临时凭据，用于接口鉴权") val token: String? = null ) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/SaveResultArguments.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/SaveResultArguments.kt index 0691407c76..d83543a98e 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/SaveResultArguments.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/SaveResultArguments.kt @@ -29,15 +29,15 @@ package com.tencent.bkrepo.analyst.pojo.request import com.fasterxml.jackson.annotation.JsonSubTypes import com.fasterxml.jackson.annotation.JsonTypeInfo +import com.tencent.bkrepo.analyst.pojo.request.dependencecheck.DependencySaveResultArguments +import com.tencent.bkrepo.analyst.pojo.request.trivy.TrivySaveResultArguments import com.tencent.bkrepo.common.analysis.pojo.scanner.arrowhead.ArrowheadScanner import com.tencent.bkrepo.common.analysis.pojo.scanner.dependencycheck.scanner.DependencyScanner import com.tencent.bkrepo.common.analysis.pojo.scanner.trivy.TrivyScanner -import com.tencent.bkrepo.analyst.pojo.request.dependencecheck.DependencySaveResultArguments -import com.tencent.bkrepo.analyst.pojo.request.trivy.TrivySaveResultArguments -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + -@ApiModel("存储制品扫描结果时的参数") +@Schema(title = "存储制品扫描结果时的参数") @JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.EXISTING_PROPERTY, property = "type") @JsonSubTypes( JsonSubTypes.Type(value = ArrowheadSaveResultArguments::class, name = ArrowheadScanner.TYPE), @@ -45,6 +45,6 @@ import io.swagger.annotations.ApiModelProperty JsonSubTypes.Type(value = TrivySaveResultArguments::class, name = TrivyScanner.TYPE) ) open class SaveResultArguments( - @ApiModelProperty("扫描器类型") + @get:Schema(title = "扫描器类型") val type: String ) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/ScanQualityUpdateRequest.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/ScanQualityUpdateRequest.kt index df32136689..3d23231427 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/ScanQualityUpdateRequest.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/ScanQualityUpdateRequest.kt @@ -27,31 +27,31 @@ package com.tencent.bkrepo.analyst.pojo.request +import com.tencent.bkrepo.common.analysis.pojo.scanner.Level import com.tencent.bkrepo.common.api.exception.ErrorCodeException import com.tencent.bkrepo.common.api.message.CommonMessageCode -import com.tencent.bkrepo.common.analysis.pojo.scanner.Level -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + -@ApiModel("更新质量规则") +@Schema(title = "更新质量规则") data class ScanQualityUpdateRequest( - @ApiModelProperty("严重漏洞数") + @get:Schema(title = "严重漏洞数") val critical: Long? = null, - @ApiModelProperty("高危漏洞数") + @get:Schema(title = "高危漏洞数") val high: Long? = null, - @ApiModelProperty("中危漏洞数") + @get:Schema(title = "中危漏洞数") val medium: Long? = null, - @ApiModelProperty("低危漏洞数") + @get:Schema(title = "低危漏洞数") val low: Long? = null, - @ApiModelProperty("扫描未完成是否禁用制品") + @get:Schema(title = "扫描未完成是否禁用制品") val forbidScanUnFinished: Boolean? = null, - @ApiModelProperty("质量规则未通过是否禁用制品") + @get:Schema(title = "质量规则未通过是否禁用制品") val forbidQualityUnPass: Boolean? = null, - @ApiModelProperty("许可是否推荐使用") + @get:Schema(title = "许可是否推荐使用") val recommend: Boolean? = null, - @ApiModelProperty("许可是否合规") + @get:Schema(title = "许可是否合规") val compliance: Boolean? = null, - @ApiModelProperty("许可是否未知") + @get:Schema(title = "许可是否未知") val unknown: Boolean? = null ) { fun toMap(): Map { diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/ScanRequest.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/ScanRequest.kt index 57fb0b4641..7df206e92e 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/ScanRequest.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/ScanRequest.kt @@ -30,20 +30,20 @@ package com.tencent.bkrepo.analyst.pojo.request import com.fasterxml.jackson.annotation.JsonAlias import com.tencent.bkrepo.analyst.pojo.TaskMetadata import com.tencent.bkrepo.common.query.model.Rule -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("扫描请求") + +@Schema(title = "扫描请求") data class ScanRequest( - @ApiModelProperty("扫描器名") + @get:Schema(title = "扫描器名") val scanner: String? = null, - @ApiModelProperty("扫描方案id") + @get:Schema(title = "扫描方案id") @JsonAlias("id") val planId: String? = null, - @ApiModelProperty("扫描文件匹配规则") + @get:Schema(title = "扫描文件匹配规则") val rule: Rule? = null, - @ApiModelProperty("是否强制扫描，为true时无论是否存在扫描结果都会执行扫描") + @get:Schema(title = "是否强制扫描，为true时无论是否存在扫描结果都会执行扫描") val force: Boolean = false, - @ApiModelProperty("任务元数据") + @get:Schema(title = "任务元数据") val metadata: List = emptyList() ) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/ScanTaskQuery.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/ScanTaskQuery.kt index 3bb90d8c45..f4697fe39a 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/ScanTaskQuery.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/ScanTaskQuery.kt @@ -27,27 +27,27 @@ package com.tencent.bkrepo.analyst.pojo.request -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("获取扫描任务") + +@Schema(title = "获取扫描任务") data class ScanTaskQuery( - @ApiModelProperty("任务所属项目") + @get:Schema(title = "任务所属项目") val projectId: String? = null, - @ApiModelProperty("任务名前缀") + @get:Schema(title = "任务名前缀") val namePrefix: String? = null, - @ApiModelProperty("扫描方案id") + @get:Schema(title = "扫描方案id") val planId: String? = null, - @ApiModelProperty("任务触发方式") + @get:Schema(title = "任务触发方式") val triggerType: String? = null, - @ApiModelProperty("在这个时间戳之后创建的任务") + @get:Schema(title = "在这个时间戳之后创建的任务") var after: Long? = null, - @ApiModelProperty("在这个时间戳之前创建的任务") + @get:Schema(title = "在这个时间戳之前创建的任务") var before: Long? = null, - @ApiModelProperty("使用的扫描器") + @get:Schema(title = "使用的扫描器") val scanner: String? = null, - @ApiModelProperty("使用的扫描器类型") + @get:Schema(title = "使用的扫描器类型") val scannerType: String? = null, - @ApiModelProperty("当前任务状态") + @get:Schema(title = "当前任务状态") val status: String? = null ) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/SubtaskInfoRequest.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/SubtaskInfoRequest.kt index f47b2fae06..7324601818 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/SubtaskInfoRequest.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/SubtaskInfoRequest.kt @@ -29,55 +29,55 @@ package com.tencent.bkrepo.analyst.pojo.request import com.tencent.bkrepo.common.api.constant.DEFAULT_PAGE_NUMBER import com.tencent.bkrepo.common.api.constant.DEFAULT_PAGE_SIZE -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + import java.time.Instant import java.time.LocalDateTime -@ApiModel("请求指定扫描方案扫描过的制品扫描结果信息") +@Schema(title = "请求指定扫描方案扫描过的制品扫描结果信息") data class SubtaskInfoRequest( - @ApiModelProperty("扫描方案所属项目id", required = true) + @get:Schema(title = "扫描方案所属项目id", required = true) val projectId: String, - @ApiModelProperty("扫描方案id", required = true) + @get:Schema(title = "扫描方案id", required = true) val id: String? = null, - @ApiModelProperty("扫描任务id，默认为扫描方案最新一次的扫描任务") + @get:Schema(title = "扫描任务id，默认为扫描方案最新一次的扫描任务") var parentScanTaskId: String? = null, - @ApiModelProperty("制品名关键字，只要制品名包含该关键字则匹配") + @get:Schema(title = "制品名关键字，只要制品名包含该关键字则匹配") val name: String? = null, /** * [com.tencent.bkrepo.analyst.pojo.LeakType] */ - @ApiModelProperty("制品最高等级漏洞") + @get:Schema(title = "制品最高等级漏洞") var highestLeakLevel: String? = null, /** * [com.tencent.bkrepo.common.artifact.pojo.RepositoryType] */ - @ApiModelProperty("制品所属仓库类型") + @get:Schema(title = "制品所属仓库类型") val repoType: String? = null, - @ApiModelProperty("制品所属仓库名") + @get:Schema(title = "制品所属仓库名") val repoName: String? = null, /** * [com.tencent.bkrepo.analyst.pojo.ScanStatus] */ - @ApiModelProperty("制品扫描状态") + @get:Schema(title = "制品扫描状态") @Deprecated("仅用于兼容旧接口", ReplaceWith("subScanTaskStatus")) val status: String? = null, - @ApiModelProperty("制品扫描状态") + @get:Schema(title = "制品扫描状态") var subScanTaskStatus: List? = null, - @ApiModelProperty("制品扫描任务创建时间(开始)") + @get:Schema(title = "制品扫描任务创建时间(开始)") val startTime: Instant? = null, - @ApiModelProperty("制品扫描任务创建时间(开始)") + @get:Schema(title = "制品扫描任务创建时间(开始)") var startDateTime: LocalDateTime? = null, - @ApiModelProperty("制品扫描任务创建时间(截止)") + @get:Schema(title = "制品扫描任务创建时间(截止)") val endTime: Instant? = null, - @ApiModelProperty("制品扫描任务创建时间(截止)") + @get:Schema(title = "制品扫描任务创建时间(截止)") var endDateTime: LocalDateTime? = null, - @ApiModelProperty("页码") + @get:Schema(title = "页码") var pageNumber: Int = DEFAULT_PAGE_NUMBER, - @ApiModelProperty("页大小") + @get:Schema(title = "页大小") val pageSize: Int = DEFAULT_PAGE_SIZE, - @ApiModelProperty("是否通过质量规则") + @get:Schema(title = "是否通过质量规则") var qualityRedLine: Boolean? = null, - @ApiModelProperty("未设置质量规则") + @get:Schema(title = "未设置质量规则") var unQuality: Boolean? = null ) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/UpdateScanPlanRequest.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/UpdateScanPlanRequest.kt index ad891ca501..b1a674f301 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/UpdateScanPlanRequest.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/UpdateScanPlanRequest.kt @@ -29,20 +29,21 @@ package com.tencent.bkrepo.analyst.pojo.request import com.fasterxml.jackson.annotation.JsonIgnoreProperties import com.tencent.bkrepo.common.query.model.Rule -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + @JsonIgnoreProperties(ignoreUnknown = true) data class UpdateScanPlanRequest( - @ApiModelProperty("方案ID") + @get:Schema(title = "方案ID") val id: String? = null, - @ApiModelProperty("项目ID") + @get:Schema(title = "项目ID") val projectId: String? = null, - @ApiModelProperty("方案名称") + @get:Schema(title = "方案名称") val name: String? = null, - @ApiModelProperty("描述") + @get:Schema(title = "描述") val description: String? = null, - @ApiModelProperty("是否自动扫描") + @get:Schema(title = "是否自动扫描") val scanOnNewArtifact: Boolean? = null, - @ApiModelProperty("自动扫描规则，包含仓库和制品规则") + @get:Schema(title = "自动扫描规则，包含仓库和制品规则") val rule: Rule? = null ) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/dependencecheck/DependencyLoadResultArguments.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/dependencecheck/DependencyLoadResultArguments.kt index 1daee5c7db..7feafffe1d 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/dependencecheck/DependencyLoadResultArguments.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/dependencecheck/DependencyLoadResultArguments.kt @@ -28,17 +28,17 @@ package com.tencent.bkrepo.analyst.pojo.request.dependencecheck import com.tencent.bkrepo.analyst.pojo.request.LoadResultArguments -import com.tencent.bkrepo.common.query.model.PageLimit import com.tencent.bkrepo.common.analysis.pojo.scanner.dependencycheck.scanner.DependencyScanner -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import com.tencent.bkrepo.common.query.model.PageLimit +import io.swagger.v3.oas.annotations.media.Schema + -@ApiModel("DependencyCheck扫描结果拉取参数") +@Schema(title = "DependencyCheck扫描结果拉取参数") data class DependencyLoadResultArguments( - @ApiModelProperty("需要的cve列表") + @get:Schema(title = "需要的cve列表") val vulIds: List = emptyList(), - @ApiModelProperty("需要的漏洞严重性等级列表") + @get:Schema(title = "需要的漏洞严重性等级列表") val vulnerabilityLevels: List = emptyList(), - @ApiModelProperty("分页参数") + @get:Schema(title = "分页参数") val pageLimit: PageLimit = PageLimit() ) : LoadResultArguments(DependencyScanner.TYPE) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/filter/ListFilterRuleRequest.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/filter/ListFilterRuleRequest.kt index f0d7731cdd..ef87acecd7 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/filter/ListFilterRuleRequest.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/filter/ListFilterRuleRequest.kt @@ -29,17 +29,17 @@ package com.tencent.bkrepo.analyst.pojo.request.filter import com.tencent.bkrepo.common.api.constant.DEFAULT_PAGE_NUMBER import com.tencent.bkrepo.common.api.constant.DEFAULT_PAGE_SIZE -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("分页获取忽略规则请求") + +@Schema(title = "分页获取忽略规则请求") data class ListFilterRuleRequest( - @ApiModelProperty("项目，空字符串表示列出系统级规则") + @get:Schema(title = "项目，空字符串表示列出系统级规则") val projectId: String, - @ApiModelProperty("扫描方案id") + @get:Schema(title = "扫描方案id") val planId: String? = null, - @ApiModelProperty("页码") + @get:Schema(title = "页码") val pageNumber: Int = DEFAULT_PAGE_NUMBER, - @ApiModelProperty("页大小") + @get:Schema(title = "页大小") val pageSize: Int = DEFAULT_PAGE_SIZE, ) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/filter/MatchFilterRuleRequest.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/filter/MatchFilterRuleRequest.kt index f048d781fe..6ed051885f 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/filter/MatchFilterRuleRequest.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/filter/MatchFilterRuleRequest.kt @@ -27,25 +27,25 @@ package com.tencent.bkrepo.analyst.pojo.request.filter -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("扫描结果忽略规则匹配请求") + +@Schema(title = "扫描结果忽略规则匹配请求") data class MatchFilterRuleRequest( - @ApiModelProperty("项目名") + @get:Schema(title = "项目名") val projectId: String, - @ApiModelProperty("仓库名") + @get:Schema(title = "仓库名") val repoName: String? = null, - @ApiModelProperty("扫描方案id") + @get:Schema(title = "扫描方案id") val planId: String? = null, - @ApiModelProperty("制品路径") + @get:Schema(title = "制品路径") val fullPath: String? = null, - @ApiModelProperty("包名") + @get:Schema(title = "包名") val packageKey: String? = null, - @ApiModelProperty("包版本") + @get:Schema(title = "包版本") val packageVersion: String? = null ) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/filter/UpdateFilterRuleRequest.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/filter/UpdateFilterRuleRequest.kt index 2a230ac4b0..f547c2ea35 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/filter/UpdateFilterRuleRequest.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/filter/UpdateFilterRuleRequest.kt @@ -35,57 +35,57 @@ import com.tencent.bkrepo.analyst.utils.VersionNumber import com.tencent.bkrepo.analyst.utils.VersionRange import com.tencent.bkrepo.common.api.exception.ErrorCodeException import com.tencent.bkrepo.common.api.message.CommonMessageCode -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("创建或更新扫描结果忽略规则") + +@Schema(title = "创建或更新扫描结果忽略规则") data class UpdateFilterRuleRequest( - @ApiModelProperty("id") + @get:Schema(title = "id") var id: String? = null, - @ApiModelProperty("规则名") + @get:Schema(title = "规则名") val name: String, - @ApiModelProperty("规则描述") + @get:Schema(title = "规则描述") val description: String, - @ApiModelProperty("目标项目，系统级的规则为空字符串") + @get:Schema(title = "目标项目，系统级的规则为空字符串") val projectId: String, - @ApiModelProperty("需要应用规则的项目，为空表示全部应用，该字段仅对系统级规则有效") + @get:Schema(title = "需要应用规则的项目，为空表示全部应用，该字段仅对系统级规则有效") val projectIds: List? = null, - @ApiModelProperty("目标仓库名") + @get:Schema(title = "目标仓库名") val repoName: String? = null, - @ApiModelProperty("目标扫描方案ID") + @get:Schema(title = "目标扫描方案ID") val planId: String? = null, - @ApiModelProperty("目标路径") + @get:Schema(title = "目标路径") val fullPath: String? = null, - @ApiModelProperty("目标包名") + @get:Schema(title = "目标包名") val packageKey: String? = null, - @ApiModelProperty("目标版本") + @get:Schema(title = "目标版本") val packageVersion: String? = null, - @ApiModelProperty("存在风险的包") + @get:Schema(title = "存在风险的包") val riskyPackageKeys: Set? = null, - @ApiModelProperty("存在风险的包和版本，key为存在风险的包名，value为存在风险的包版本范围") + @get:Schema(title = "存在风险的包和版本，key为存在风险的包名，value为存在风险的包版本范围") val riskyPackageVersions: Map? = null, - @ApiModelProperty("需要忽略的漏洞，空集合表示忽略所有") + @get:Schema(title = "需要忽略的漏洞，空集合表示忽略所有") val vulIds: Set? = null, - @ApiModelProperty("小于该等级的漏洞将被忽略") + @get:Schema(title = "小于该等级的漏洞将被忽略") val severity: Int? = null, - @ApiModelProperty("需要忽略的许可证，空集合表示忽略所有") + @get:Schema(title = "需要忽略的许可证，空集合表示忽略所有") val licenseNames: Set? = null, - @ApiModelProperty("匹配成功后忽略漏洞，false表示匹配成功时候保留漏洞其余的忽略") + @get:Schema(title = "匹配成功后忽略漏洞，false表示匹配成功时候保留漏洞其余的忽略") val type: Int = FILTER_RULE_TYPE_IGNORE ) { @Suppress("TooGenericExceptionCaught") diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/scancodetoolkit/ArtifactLicensesDetailRequest.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/scancodetoolkit/ArtifactLicensesDetailRequest.kt index dd7aff0892..9180a8c8e0 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/scancodetoolkit/ArtifactLicensesDetailRequest.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/scancodetoolkit/ArtifactLicensesDetailRequest.kt @@ -29,23 +29,23 @@ package com.tencent.bkrepo.analyst.pojo.request.scancodetoolkit import com.tencent.bkrepo.common.api.constant.DEFAULT_PAGE_NUMBER import com.tencent.bkrepo.common.api.constant.DEFAULT_PAGE_SIZE -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("获取许可扫描详情请求") + +@Schema(title = "获取许可扫描详情请求") data class ArtifactLicensesDetailRequest( - @ApiModelProperty("项目id") + @get:Schema(title = "项目id") var projectId: String?, - @ApiModelProperty("子任务id") + @get:Schema(title = "子任务id") var subScanTaskId: String?, - @ApiModelProperty("许可id") + @get:Schema(title = "许可id") val licenseId: String? = null, - @ApiModelProperty("风险等级") + @get:Schema(title = "风险等级") val riskLevel: String? = null, - @ApiModelProperty("是否仅包含被忽略的许可证") + @get:Schema(title = "是否仅包含被忽略的许可证") val ignored: Boolean = false, - @ApiModelProperty("页数") + @get:Schema(title = "页数") val pageNumber: Int = DEFAULT_PAGE_NUMBER, - @ApiModelProperty("每页数量") + @get:Schema(title = "每页数量") val pageSize: Int = DEFAULT_PAGE_SIZE ) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/scancodetoolkit/ScancodeToolkitResultArguments.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/scancodetoolkit/ScancodeToolkitResultArguments.kt index 880b5c2f99..3d515fa9aa 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/scancodetoolkit/ScancodeToolkitResultArguments.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/scancodetoolkit/ScancodeToolkitResultArguments.kt @@ -28,15 +28,16 @@ package com.tencent.bkrepo.analyst.pojo.request.scancodetoolkit import com.tencent.bkrepo.analyst.pojo.request.LoadResultArguments -import com.tencent.bkrepo.common.query.model.PageLimit import com.tencent.bkrepo.common.analysis.pojo.scanner.scanCodeCheck.scanner.ScancodeToolkitScanner -import io.swagger.annotations.ApiModelProperty +import com.tencent.bkrepo.common.query.model.PageLimit +import io.swagger.v3.oas.annotations.media.Schema + class ScancodeToolkitResultArguments( - @ApiModelProperty("需要的许可id列表") + @get:Schema(title = "需要的许可id列表") val licenseIds: List = emptyList(), - @ApiModelProperty("需要的许可风险等级列表") + @get:Schema(title = "需要的许可风险等级列表") val riskLevels: List = emptyList(), - @ApiModelProperty("分页参数") + @get:Schema(title = "分页参数") val pageLimit: PageLimit = PageLimit() ) : LoadResultArguments(ScancodeToolkitScanner.TYPE) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/standard/StandardLoadResultArguments.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/standard/StandardLoadResultArguments.kt index d6f1964815..816d02c5ba 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/standard/StandardLoadResultArguments.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/standard/StandardLoadResultArguments.kt @@ -31,26 +31,27 @@ import com.tencent.bkrepo.analyst.pojo.request.LoadResultArguments import com.tencent.bkrepo.analyst.pojo.response.filter.MergedFilterRule import com.tencent.bkrepo.common.analysis.pojo.scanner.standard.StandardScanner import com.tencent.bkrepo.common.query.model.PageLimit -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + @Suppress("LongParameterList") data class StandardLoadResultArguments( - @ApiModelProperty("需要的cve列表") + @get:Schema(title = "需要的cve列表") val vulIds: List = emptyList(), - @ApiModelProperty("需要的漏洞严重性等级列表") + @get:Schema(title = "需要的漏洞严重性等级列表") val vulnerabilityLevels: List = emptyList(), - @ApiModelProperty("需要的许可id列表") + @get:Schema(title = "需要的许可id列表") val licenseIds: List = emptyList(), - @ApiModelProperty("需要的许可id列表") + @get:Schema(title = "需要的许可id列表") val sensitiveContent: String? = null, - @ApiModelProperty("需要的许可id列表") + @get:Schema(title = "需要的许可id列表") val sensitiveType: String? = null, - @ApiModelProperty("扫描结果类型") + @get:Schema(title = "扫描结果类型") val reportType: String, - @ApiModelProperty("分页参数") + @get:Schema(title = "分页参数") val pageLimit: PageLimit = PageLimit(), - @ApiModelProperty("漏洞过滤规则") + @get:Schema(title = "漏洞过滤规则") val rule: MergedFilterRule? = null, - @ApiModelProperty("是否仅包含被忽略的结果") + @get:Schema(title = "是否仅包含被忽略的结果") val ignored: Boolean = false ) : LoadResultArguments(StandardScanner.TYPE) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/trivy/TrivyLoadResultArguments.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/trivy/TrivyLoadResultArguments.kt index c6be9eab6b..e579f5e3de 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/trivy/TrivyLoadResultArguments.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/request/trivy/TrivyLoadResultArguments.kt @@ -28,17 +28,17 @@ package com.tencent.bkrepo.analyst.pojo.request.trivy import com.tencent.bkrepo.analyst.pojo.request.LoadResultArguments -import com.tencent.bkrepo.common.query.model.PageLimit import com.tencent.bkrepo.common.analysis.pojo.scanner.trivy.TrivyScanner -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import com.tencent.bkrepo.common.query.model.PageLimit +import io.swagger.v3.oas.annotations.media.Schema + -@ApiModel("trivy扫描结果拉取参数") +@Schema(title = "trivy扫描结果拉取参数") data class TrivyLoadResultArguments( - @ApiModelProperty("需要的cve列表") + @get:Schema(title = "需要的cve列表") val vulIds: List = emptyList(), - @ApiModelProperty("需要的漏洞严重性等级列表") + @get:Schema(title = "需要的漏洞严重性等级列表") val vulnerabilityLevels: List = emptyList(), - @ApiModelProperty("分页参数") + @get:Schema(title = "分页参数") val pageLimit: PageLimit = PageLimit() ) : LoadResultArguments(TrivyScanner.TYPE) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/ArtifactPlanRelation.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/ArtifactPlanRelation.kt index b7c2e8652d..d4aa0d901f 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/ArtifactPlanRelation.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/ArtifactPlanRelation.kt @@ -27,27 +27,27 @@ package com.tencent.bkrepo.analyst.pojo.response -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("制品关联的扫描方案信息") + +@Schema(title = "制品关联的扫描方案信息") data class ArtifactPlanRelation( - @ApiModelProperty("扫描方案id") + @get:Schema(title = "扫描方案id") @Deprecated("仅用于兼容旧接口", ReplaceWith("planId")) val id: String, - @ApiModelProperty("扫描方案id") + @get:Schema(title = "扫描方案id") val planId: String, - @ApiModelProperty("扫描方案所属项目id") + @get:Schema(title = "扫描方案所属项目id") val projectId: String, - @ApiModelProperty("扫描方案类型") + @get:Schema(title = "扫描方案类型") val planType: String, - @ApiModelProperty("扫描方案名") + @get:Schema(title = "扫描方案名") val name: String, - @ApiModelProperty("制品当前扫描状态") + @get:Schema(title = "制品当前扫描状态") val status: String, - @ApiModelProperty("制品最新一次子扫描任务id") + @get:Schema(title = "制品最新一次子扫描任务id") @Deprecated("仅用于兼容旧接口", ReplaceWith("subTaskId")) val recordId: String, - @ApiModelProperty("制品最新一次子扫描任务id") + @get:Schema(title = "制品最新一次子扫描任务id") val subTaskId: String ) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/ArtifactPlanRelations.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/ArtifactPlanRelations.kt index 04e5ac208b..e10d8ca15f 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/ArtifactPlanRelations.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/ArtifactPlanRelations.kt @@ -27,13 +27,13 @@ package com.tencent.bkrepo.analyst.pojo.response -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("制品关联的扫描方案信息列表") + +@Schema(title = "制品关联的扫描方案信息列表") data class ArtifactPlanRelations( - @ApiModelProperty("制品扫描状态") + @get:Schema(title = "制品扫描状态") val scanStatus: String?, - @ApiModelProperty("方案信息列表") + @get:Schema(title = "方案信息列表") val scanPlans: List ) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/ArtifactVulnerabilityInfo.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/ArtifactVulnerabilityInfo.kt index d322d008e8..781673b93f 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/ArtifactVulnerabilityInfo.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/ArtifactVulnerabilityInfo.kt @@ -28,35 +28,35 @@ package com.tencent.bkrepo.analyst.pojo.response import com.tencent.bkrepo.common.analysis.pojo.scanner.standard.VersionPaths -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("制品漏洞信息") + +@Schema(title = "制品漏洞信息") data class ArtifactVulnerabilityInfo( - @ApiModelProperty("漏洞id") + @get:Schema(title = "漏洞id") val vulId: String, - @ApiModelProperty("CVE ID") + @get:Schema(title = "CVE ID") val cveId: String? = null, - @ApiModelProperty("漏洞等级") + @get:Schema(title = "漏洞等级") val severity: String, - @ApiModelProperty("所属依赖") + @get:Schema(title = "所属依赖") val pkgName: String, - @ApiModelProperty("安装版本") + @get:Schema(title = "安装版本") val installedVersion: Set, - @ApiModelProperty("漏洞标题") + @get:Schema(title = "漏洞标题") @Deprecated("仅用于兼容旧接口", ReplaceWith("vulnerabilityName")) val title: String, - @ApiModelProperty("漏洞名") + @get:Schema(title = "漏洞名") val vulnerabilityName: String, - @ApiModelProperty("漏洞描述") + @get:Schema(title = "漏洞描述") val description: String? = null, - @ApiModelProperty("修复建议") + @get:Schema(title = "修复建议") val officialSolution: String? = null, - @ApiModelProperty("相关信息") + @get:Schema(title = "相关信息") val reference: List? = null, - @ApiModelProperty("漏洞文件路径") + @get:Schema(title = "漏洞文件路径") @Deprecated("使用versionPaths") val path: String? = null, - @ApiModelProperty("漏洞文件路径") + @get:Schema(title = "漏洞文件路径") val versionsPaths: MutableSet? = null, ) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/FileLicensesResultDetail.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/FileLicensesResultDetail.kt index caa44bf6c6..d59a317a0a 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/FileLicensesResultDetail.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/FileLicensesResultDetail.kt @@ -27,32 +27,32 @@ package com.tencent.bkrepo.analyst.pojo.response -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("制品许可详细信息") + +@Schema(title = "制品许可详细信息") data class FileLicensesResultDetail( - @ApiModelProperty("许可id") + @get:Schema(title = "许可id") val licenseId: String, - @ApiModelProperty("许可全称") + @get:Schema(title = "许可全称") val fullName: String, - @ApiModelProperty("风险等级") + @get:Schema(title = "风险等级") val riskLevel: String?, - @ApiModelProperty("合规性") + @get:Schema(title = "合规性") val compliance: Boolean?, - @ApiModelProperty("OSI认证") + @get:Schema(title = "OSI认证") val isOsiApproved: Boolean?, - @ApiModelProperty("是否 FSF 认证免费") + @get:Schema(title = "是否 FSF 认证免费") val isFsfLibre: Boolean?, - @ApiModelProperty("是否推荐使用") + @get:Schema(title = "是否推荐使用") @Deprecated("兼容旧接口，前端调整后移除该字段", replaceWith = ReplaceWith("deprecated?.not()")) val recommended: Boolean?, - @ApiModelProperty("是否已弃用") + @get:Schema(title = "是否已弃用") val deprecated: Boolean?, - @ApiModelProperty("依赖路径") + @get:Schema(title = "依赖路径") val dependentPath: String, - @ApiModelProperty("描述") + @get:Schema(title = "描述") val description: String, - @ApiModelProperty("所属依赖") + @get:Schema(title = "所属依赖") val pkgName: String? = null ) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/FileLicensesResultOverview.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/FileLicensesResultOverview.kt index 5ed32bc033..7e0175d1cb 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/FileLicensesResultOverview.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/FileLicensesResultOverview.kt @@ -27,45 +27,45 @@ package com.tencent.bkrepo.analyst.pojo.response -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("制品许可扫描结果预览") + +@Schema(title = "制品许可扫描结果预览") class FileLicensesResultOverview( - @ApiModelProperty("子扫描任务id") + @get:Schema(title = "子扫描任务id") val subTaskId: String, - @ApiModelProperty("制品名") + @get:Schema(title = "制品名") val name: String, - @ApiModelProperty("packageKey") + @get:Schema(title = "packageKey") val packageKey: String? = null, - @ApiModelProperty("制品版本") + @get:Schema(title = "制品版本") val version: String? = null, - @ApiModelProperty("制品路径") + @get:Schema(title = "制品路径") val fullPath: String? = null, - @ApiModelProperty("仓库类型") + @get:Schema(title = "仓库类型") val repoType: String, - @ApiModelProperty("仓库名") + @get:Schema(title = "仓库名") val repoName: String, - @ApiModelProperty("高风险许可数") + @get:Schema(title = "高风险许可数") val high: Long = 0, - @ApiModelProperty("中风险许可数") + @get:Schema(title = "中风险许可数") val medium: Long = 0, - @ApiModelProperty("低风险许可数") + @get:Schema(title = "低风险许可数") val low: Long = 0, - @ApiModelProperty("无风险许可数") + @get:Schema(title = "无风险许可数") val nil: Long = 0, - @ApiModelProperty("许可总数") + @get:Schema(title = "许可总数") val total: Long = 0, - @ApiModelProperty("完成时间") + @get:Schema(title = "完成时间") val finishTime: String?, - @ApiModelProperty("是否通过质量规则") + @get:Schema(title = "是否通过质量规则") val qualityRedLine: Boolean? = null, - @ApiModelProperty("扫描时方案的质量规则") + @get:Schema(title = "扫描时方案的质量规则") val scanQuality: Map? = null, - @ApiModelProperty("扫描时长") + @get:Schema(title = "扫描时长") val duration: Long, - @ApiModelProperty("扫描状态") + @get:Schema(title = "扫描状态") val scanStatus: String ) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/FileScanResultDetail.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/FileScanResultDetail.kt index 370f9244e3..5255ac9b1b 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/FileScanResultDetail.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/FileScanResultDetail.kt @@ -28,16 +28,16 @@ package com.tencent.bkrepo.analyst.pojo.response import com.fasterxml.jackson.annotation.JsonInclude -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("文件详细扫描结果") + +@Schema(title = "文件详细扫描结果") @JsonInclude(JsonInclude.Include.NON_NULL) data class FileScanResultDetail( - @ApiModelProperty("当前扫描状态") + @get:Schema(title = "当前扫描状态") val status: String, - @ApiModelProperty("文件sha256") + @get:Schema(title = "文件sha256") val sha256: String, - @ApiModelProperty("扫描报告详情") + @get:Schema(title = "扫描报告详情") val detail: Any? ) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/FileScanResultOverview.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/FileScanResultOverview.kt index 990c222048..7aaeda622f 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/FileScanResultOverview.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/FileScanResultOverview.kt @@ -27,17 +27,17 @@ package com.tencent.bkrepo.analyst.pojo.response -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("文件扫描结果预览") + +@Schema(title = "文件扫描结果预览") data class FileScanResultOverview( - @ApiModelProperty("当前扫描状态") + @get:Schema(title = "当前扫描状态") val status: String, - @ApiModelProperty("文件sha256") + @get:Schema(title = "文件sha256") val sha256: String, - @ApiModelProperty("扫描日期") + @get:Schema(title = "扫描日期") val scanDate: String?, - @ApiModelProperty("扫描结果预览") + @get:Schema(title = "扫描结果预览") val overview: Map ) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/ScanLicensePlanInfo.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/ScanLicensePlanInfo.kt index ba1298130b..764457244b 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/ScanLicensePlanInfo.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/ScanLicensePlanInfo.kt @@ -27,39 +27,39 @@ package com.tencent.bkrepo.analyst.pojo.response -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("许可扫描方案信息") + +@Schema(title = "许可扫描方案信息") class ScanLicensePlanInfo( - @ApiModelProperty("方案id") + @get:Schema(title = "方案id") val id: String, - @ApiModelProperty("方案名") + @get:Schema(title = "方案名") val name: String?, - @ApiModelProperty("方案类型") + @get:Schema(title = "方案类型") val planType: String, - @ApiModelProperty("projectId") + @get:Schema(title = "projectId") val projectId: String, - @ApiModelProperty("方案状态") + @get:Schema(title = "方案状态") val status: String, - @ApiModelProperty("累计扫描制品数") + @get:Schema(title = "累计扫描制品数") val artifactCount: Long = 0, - @ApiModelProperty("许可证总数") + @get:Schema(title = "许可证总数") val total: Long = 0, - @ApiModelProperty("不推荐使用的许可数") + @get:Schema(title = "不推荐使用的许可数") val unRecommend: Long = 0, - @ApiModelProperty("未知的许可数") + @get:Schema(title = "未知的许可数") val unknown: Long = 0, - @ApiModelProperty("不合规的许可数") + @get:Schema(title = "不合规的许可数") val unCompliance: Long = 0, - @ApiModelProperty("创建者") + @get:Schema(title = "创建者") val createdBy: String, - @ApiModelProperty("创建时间") + @get:Schema(title = "创建时间") val createdDate: String, - @ApiModelProperty("修改者") + @get:Schema(title = "修改者") val lastModifiedBy: String, - @ApiModelProperty("修改时间") + @get:Schema(title = "修改时间") val lastModifiedDate: String, - @ApiModelProperty("最后扫描时间") + @get:Schema(title = "最后扫描时间") val lastScanDate: String? ) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/ScanPlanInfo.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/ScanPlanInfo.kt index 3d405326aa..026d59d38b 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/ScanPlanInfo.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/ScanPlanInfo.kt @@ -27,45 +27,45 @@ package com.tencent.bkrepo.analyst.pojo.response -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("扫描方案信息") + +@Schema(title = "扫描方案信息") data class ScanPlanInfo( - @ApiModelProperty("方案id") + @get:Schema(title = "方案id") val id: String, - @ApiModelProperty("方案名") + @get:Schema(title = "方案名") val name: String?, - @ApiModelProperty("方案类型") + @get:Schema(title = "方案类型") val planType: String, - @ApiModelProperty("扫描类型") + @get:Schema(title = "扫描类型") val scanTypes: List, - @ApiModelProperty("projectId") + @get:Schema(title = "projectId") val projectId: String, - @ApiModelProperty("方案状态") + @get:Schema(title = "方案状态") val status: String, - @ApiModelProperty("累计扫描制品数") + @get:Schema(title = "累计扫描制品数") val artifactCount: Long = 0, - @ApiModelProperty("严重漏洞数") + @get:Schema(title = "严重漏洞数") val critical: Long = 0, - @ApiModelProperty("高危漏洞数") + @get:Schema(title = "高危漏洞数") val high: Long = 0, - @ApiModelProperty("中危漏洞数") + @get:Schema(title = "中危漏洞数") val medium: Long = 0, - @ApiModelProperty("低危漏洞数") + @get:Schema(title = "低危漏洞数") val low: Long = 0, - @ApiModelProperty("漏洞总数") + @get:Schema(title = "漏洞总数") val total: Long = 0, - @ApiModelProperty("创建者") + @get:Schema(title = "创建者") val createdBy: String, - @ApiModelProperty("创建时间") + @get:Schema(title = "创建时间") val createdDate: String, - @ApiModelProperty("修改者") + @get:Schema(title = "修改者") val lastModifiedBy: String, - @ApiModelProperty("修改时间") + @get:Schema(title = "修改时间") val lastModifiedDate: String, - @ApiModelProperty("最后扫描时间") + @get:Schema(title = "最后扫描时间") val lastScanDate: String?, - @ApiModelProperty("是否只读") + @get:Schema(title = "是否只读") val readOnly: Boolean = false ) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/ScanQuality.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/ScanQuality.kt index 5f98f519de..1d0b656dc6 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/ScanQuality.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/ScanQuality.kt @@ -29,29 +29,29 @@ package com.tencent.bkrepo.analyst.pojo.response import com.fasterxml.jackson.annotation.JsonInclude import com.tencent.bkrepo.common.analysis.pojo.scanner.Level -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("质量规则") + +@Schema(title = "质量规则") @JsonInclude(JsonInclude.Include.NON_NULL) data class ScanQuality( - @ApiModelProperty("严重漏洞数") + @get:Schema(title = "严重漏洞数") val critical: Long?, - @ApiModelProperty("高危漏洞数") + @get:Schema(title = "高危漏洞数") val high: Long?, - @ApiModelProperty("中危漏洞数") + @get:Schema(title = "中危漏洞数") val medium: Long?, - @ApiModelProperty("低危漏洞数") + @get:Schema(title = "低危漏洞数") val low: Long?, - @ApiModelProperty("扫描未完成是否禁用制品") + @get:Schema(title = "扫描未完成是否禁用制品") val forbidScanUnFinished: Boolean?, - @ApiModelProperty("质量规则未通过是否禁用制品") + @get:Schema(title = "质量规则未通过是否禁用制品") val forbidQualityUnPass: Boolean?, - @ApiModelProperty("许可是否推荐使用") + @get:Schema(title = "许可是否推荐使用") val recommend: Boolean?, - @ApiModelProperty("许可是否合规") + @get:Schema(title = "许可是否合规") val compliance: Boolean?, - @ApiModelProperty("许可是否未知") + @get:Schema(title = "许可是否未知") val unknown: Boolean? ) { diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/ScannerBase.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/ScannerBase.kt index 6208c401c2..abf379f3a5 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/ScannerBase.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/ScannerBase.kt @@ -27,21 +27,21 @@ package com.tencent.bkrepo.analyst.pojo.response -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("扫描器基本信息") + +@Schema(title = "扫描器基本信息") data class ScannerBase( - @ApiModelProperty("扫描器名") + @get:Schema(title = "扫描器名") val name: String, - @ApiModelProperty("扫描器类型") + @get:Schema(title = "扫描器类型") val type: String, - @ApiModelProperty("扫描器描述信息") + @get:Schema(title = "扫描器描述信息") val description: String, - @ApiModelProperty("支持扫描的文件名后缀") + @get:Schema(title = "支持扫描的文件名后缀") val supportFileNameExt: List, - @ApiModelProperty("支持扫描的包类型") + @get:Schema(title = "支持扫描的包类型") val supportPackageTypes: List, - @ApiModelProperty("支持扫描的类型，如许可扫描、漏洞扫描") + @get:Schema(title = "支持扫描的类型，如许可扫描、漏洞扫描") val supportScanTypes: List ) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/SubtaskInfo.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/SubtaskInfo.kt index 52a5f33325..02a046c1b8 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/SubtaskInfo.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/SubtaskInfo.kt @@ -27,40 +27,40 @@ package com.tencent.bkrepo.analyst.pojo.response -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("扫描制品信息") + +@Schema(title = "扫描制品信息") data class SubtaskInfo( - @ApiModelProperty("子扫描任务id") + @get:Schema(title = "子扫描任务id") @Deprecated("仅用于兼容旧接口", replaceWith = ReplaceWith("subTaskId")) val recordId: String, - @ApiModelProperty("子扫描任务id") + @get:Schema(title = "子扫描任务id") val subTaskId: String, - @ApiModelProperty("制品名") + @get:Schema(title = "制品名") val name: String, - @ApiModelProperty("packageKey") + @get:Schema(title = "packageKey") val packageKey: String? = null, - @ApiModelProperty("制品版本") + @get:Schema(title = "制品版本") val version: String? = null, - @ApiModelProperty("制品路径") + @get:Schema(title = "制品路径") val fullPath: String? = null, - @ApiModelProperty("仓库类型") + @get:Schema(title = "仓库类型") val repoType: String, - @ApiModelProperty("仓库名") + @get:Schema(title = "仓库名") val repoName: String, - @ApiModelProperty("最高漏洞等级") + @get:Schema(title = "最高漏洞等级") val highestLeakLevel: String? = null, - @ApiModelProperty("扫描时长") + @get:Schema(title = "扫描时长") val duration: Long, - @ApiModelProperty("完成时间") + @get:Schema(title = "完成时间") val finishTime: String?, - @ApiModelProperty("状态") + @get:Schema(title = "状态") val status: String, - @ApiModelProperty("创建者") + @get:Schema(title = "创建者") val createdBy: String, - @ApiModelProperty("创建时间") + @get:Schema(title = "创建时间") val createdDate: String, - @ApiModelProperty("是否通过质量红线") + @get:Schema(title = "是否通过质量红线") val qualityRedLine: Boolean? = null ) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/SubtaskResultOverview.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/SubtaskResultOverview.kt index 60940c9655..dc5ec078e6 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/SubtaskResultOverview.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/SubtaskResultOverview.kt @@ -27,57 +27,57 @@ package com.tencent.bkrepo.analyst.pojo.response -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("制品扫描结果预览") + +@Schema(title = "制品扫描结果预览") data class SubtaskResultOverview( - @ApiModelProperty("子扫描任务id") + @get:Schema(title = "子扫描任务id") @Deprecated("仅用于兼容旧接口", replaceWith = ReplaceWith("subTaskId")) val recordId: String, - @ApiModelProperty("子扫描任务id") + @get:Schema(title = "子扫描任务id") val subTaskId: String, - @ApiModelProperty("扫描器") + @get:Schema(title = "扫描器") val scanner: String, - @ApiModelProperty("扫描器类型") + @get:Schema(title = "扫描器类型") val scannerType: String, - @ApiModelProperty("扫描类型") + @get:Schema(title = "扫描类型") val scanTypes: List = emptyList(), - @ApiModelProperty("制品名") + @get:Schema(title = "制品名") val name: String, - @ApiModelProperty("packageKey") + @get:Schema(title = "packageKey") val packageKey: String? = null, - @ApiModelProperty("制品版本") + @get:Schema(title = "制品版本") val version: String? = null, - @ApiModelProperty("制品路径") + @get:Schema(title = "制品路径") val fullPath: String? = null, - @ApiModelProperty("仓库类型") + @get:Schema(title = "仓库类型") val repoType: String, - @ApiModelProperty("仓库名") + @get:Schema(title = "仓库名") val repoName: String, - @ApiModelProperty("最高漏洞等级") + @get:Schema(title = "最高漏洞等级") val highestLeakLevel: String? = null, - @ApiModelProperty("严重漏洞数") + @get:Schema(title = "严重漏洞数") val critical: Long = 0, - @ApiModelProperty("高危漏洞数") + @get:Schema(title = "高危漏洞数") val high: Long = 0, - @ApiModelProperty("中危漏洞数") + @get:Schema(title = "中危漏洞数") val medium: Long = 0, - @ApiModelProperty("低危漏洞数") + @get:Schema(title = "低危漏洞数") val low: Long = 0, - @ApiModelProperty("漏洞总数") + @get:Schema(title = "漏洞总数") val total: Long = 0, - @ApiModelProperty("完成时间") + @get:Schema(title = "完成时间") val finishTime: String?, - @ApiModelProperty("是否通过质量规则") + @get:Schema(title = "是否通过质量规则") val qualityRedLine: Boolean? = null, - @ApiModelProperty("扫描时方案的质量规则") + @get:Schema(title = "扫描时方案的质量规则") val scanQuality: Map? = null, - @ApiModelProperty("扫描时长") + @get:Schema(title = "扫描时长") val duration: Long, - @ApiModelProperty("扫描状态") + @get:Schema(title = "扫描状态") val scanStatus: String ) diff --git a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/filter/FilterRule.kt b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/filter/FilterRule.kt index 23ae330e57..5fbd9d234e 100644 --- a/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/filter/FilterRule.kt +++ b/src/backend/analyst/api-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/pojo/response/filter/FilterRule.kt @@ -28,56 +28,56 @@ package com.tencent.bkrepo.analyst.pojo.response.filter import com.tencent.bkrepo.analyst.pojo.Constant.FILTER_RULE_TYPE_IGNORE -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("制品扫描结果忽略规则") + +@Schema(title = "制品扫描结果忽略规则") data class FilterRule( - @ApiModelProperty("id") + @get:Schema(title = "id") var id: String? = null, - @ApiModelProperty("规则名") + @get:Schema(title = "规则名") val name: String, - @ApiModelProperty("规则描述") + @get:Schema(title = "规则描述") val description: String, - @ApiModelProperty("目标项目，系统级的规则为空字符串") + @get:Schema(title = "目标项目，系统级的规则为空字符串") val projectId: String, - @ApiModelProperty("需要应用规则的项目，为空表示全部应用，该字段仅对系统级规则有效") + @get:Schema(title = "需要应用规则的项目，为空表示全部应用，该字段仅对系统级规则有效") val projectIds: List? = null, - @ApiModelProperty("目标仓库名") + @get:Schema(title = "目标仓库名") val repoName: String? = null, - @ApiModelProperty("目标扫描方案ID") + @get:Schema(title = "目标扫描方案ID") val planId: String? = null, - @ApiModelProperty("目标路径") + @get:Schema(title = "目标路径") val fullPath: String? = null, - @ApiModelProperty("目标包名") + @get:Schema(title = "目标包名") val packageKey: String? = null, - @ApiModelProperty("目标版本") + @get:Schema(title = "目标版本") val packageVersion: String? = null, - @ApiModelProperty("存在风险的包名") + @get:Schema(title = "存在风险的包名") val riskyPackageKeys: Set? = null, - @ApiModelProperty("存在风险的包和版本，key为存在风险的包名，value为存在风险的包版本范围") + @get:Schema(title = "存在风险的包和版本，key为存在风险的包名，value为存在风险的包版本范围") val riskyPackageVersions: Map? = null, - @ApiModelProperty("需要忽略的漏洞") + @get:Schema(title = "需要忽略的漏洞") val vulIds: Set? = null, - @ApiModelProperty("小于该等级的漏洞将被忽略") + @get:Schema(title = "小于该等级的漏洞将被忽略") val severity: Int? = null, - @ApiModelProperty("需要忽略的许可证") + @get:Schema(title = "需要忽略的许可证") val licenseNames: Set? = null, - @ApiModelProperty("是否忽略") + @get:Schema(title = "是否忽略") val type: Int = FILTER_RULE_TYPE_IGNORE ) diff --git a/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/SystemFilterRuleController.kt b/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/SystemFilterRuleController.kt index dda643edae..2252323451 100644 --- a/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/SystemFilterRuleController.kt +++ b/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/SystemFilterRuleController.kt @@ -39,8 +39,8 @@ import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.common.security.permission.Principal import com.tencent.bkrepo.common.security.permission.PrincipalType import com.tencent.bkrepo.common.service.util.ResponseBuilder -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable @@ -51,24 +51,24 @@ import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam import org.springframework.web.bind.annotation.RestController -@Api("分析结果忽略规则") +@Tag(name = "分析结果忽略规则") @RestController @RequestMapping("/api/filter/rules") @Principal(PrincipalType.ADMIN) class SystemFilterRuleController(private val filterRuleService: FilterRuleService) { - @ApiOperation("增加规则") + @Operation(summary = "增加规则") @PostMapping fun addSystemRule(@RequestBody request: UpdateFilterRuleRequest): Response { return ResponseBuilder.success(filterRuleService.create(request)) } - @ApiOperation("更新规则") + @Operation(summary = "更新规则") @PutMapping("/{ruleId}") fun updateSystemRule(@RequestBody request: UpdateFilterRuleRequest): Response { return ResponseBuilder.success(filterRuleService.update(request)) } - @ApiOperation("删除规则") + @Operation(summary = "删除规则") @DeleteMapping("/{ruleId}") fun deleteSystemRule( @PathVariable("ruleId") ruleId: String @@ -77,7 +77,7 @@ class SystemFilterRuleController(private val filterRuleService: FilterRuleServic return ResponseBuilder.success() } - @ApiOperation("分页获取规则") + @Operation(summary = "分页获取规则") @GetMapping fun listSystemRules( @RequestParam(required = false) pageNumber: Int = DEFAULT_PAGE_NUMBER, diff --git a/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserExecutionClusterController.kt b/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserExecutionClusterController.kt index 67f080b8ea..0ba43160c6 100644 --- a/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserExecutionClusterController.kt +++ b/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserExecutionClusterController.kt @@ -9,8 +9,8 @@ import com.tencent.bkrepo.common.metadata.annotation.LogOperate import com.tencent.bkrepo.common.security.permission.Principal import com.tencent.bkrepo.common.security.permission.PrincipalType import com.tencent.bkrepo.common.service.util.ResponseBuilder -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable @@ -20,12 +20,12 @@ import org.springframework.web.bind.annotation.RequestBody import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RestController -@Api("扫描执行集群配置接口") +@Tag(name = "扫描执行集群配置接口") @RestController @RequestMapping("/api/execution/clusters") @Principal(PrincipalType.ADMIN) class UserExecutionClusterController(private val executionClusterService: ExecutionClusterService) { - @ApiOperation("创建集群") + @Operation(summary = "创建集群") @PostMapping @LogOperate(type = "EXECUTION_CLUSTER_CREATE", desensitize = true) fun create( @@ -34,14 +34,14 @@ class UserExecutionClusterController(private val executionClusterService: Execut return ResponseBuilder.success(executionClusterService.create(executionCluster)) } - @ApiOperation("获取执行集群列表") + @Operation(summary = "获取执行集群列表") @GetMapping @LogOperate(type = "EXECUTION_CLUSTER_LIST") fun list(): Response> { return ResponseBuilder.success(executionClusterService.list()) } - @ApiOperation("删除执行集群") + @Operation(summary = "删除执行集群") @DeleteMapping("/{name}") @LogOperate(type = "EXECUTION_CLUSTER_DELETE") fun delete(@PathVariable("name") name: String): Response { @@ -49,7 +49,7 @@ class UserExecutionClusterController(private val executionClusterService: Execut return ResponseBuilder.success() } - @ApiOperation("更新执行集群") + @Operation(summary = "更新执行集群") @PutMapping("/{name}") @LogOperate(type = "EXECUTION_CLUSTER_UPDATE", desensitize = true) fun update( diff --git a/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserFilterRuleController.kt b/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserFilterRuleController.kt index 64bb3a596a..d188d7251b 100644 --- a/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserFilterRuleController.kt +++ b/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserFilterRuleController.kt @@ -40,8 +40,8 @@ import com.tencent.bkrepo.common.api.message.CommonMessageCode import com.tencent.bkrepo.common.api.pojo.Page import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.common.service.util.ResponseBuilder -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable @@ -52,14 +52,14 @@ import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam import org.springframework.web.bind.annotation.RestController -@Api("分析结果忽略规则") +@Tag(name = "分析结果忽略规则") @RestController @RequestMapping("/api/project/{projectId}/filter/rules") class UserFilterRuleController( private val filterRuleService: FilterRuleService, private val permissionCheckHandler: ScannerPermissionCheckHandler ) { - @ApiOperation("增加规则") + @Operation(summary = "增加规则") @PostMapping fun addRule( @PathVariable("projectId") projectId: String, @@ -72,7 +72,7 @@ class UserFilterRuleController( return ResponseBuilder.success(filterRuleService.create(request)) } - @ApiOperation("更新规则") + @Operation(summary = "更新规则") @PutMapping("/{ruleId}") fun updateRule( @PathVariable("projectId") projectId: String, @@ -86,7 +86,7 @@ class UserFilterRuleController( return ResponseBuilder.success(filterRuleService.update(request.copy(id = ruleId))) } - @ApiOperation("删除规则") + @Operation(summary = "删除规则") @DeleteMapping("/{ruleId}") fun deleteRule( @PathVariable("projectId") projectId: String, @@ -97,7 +97,7 @@ class UserFilterRuleController( return ResponseBuilder.success() } - @ApiOperation("分页获取规则") + @Operation(summary = "分页获取规则") @GetMapping fun listRules( @PathVariable("projectId") projectId: String, diff --git a/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserLicenseController.kt b/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserLicenseController.kt index fe9b611cd9..6bd50a97c3 100644 --- a/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserLicenseController.kt +++ b/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserLicenseController.kt @@ -36,9 +36,9 @@ import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.common.security.permission.Principal import com.tencent.bkrepo.common.security.permission.PrincipalType import com.tencent.bkrepo.common.service.util.ResponseBuilder -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable import org.springframework.web.bind.annotation.PostMapping @@ -46,14 +46,14 @@ import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam import org.springframework.web.bind.annotation.RestController -@Api("许可证接口") +@Tag(name = "许可证接口") @RestController @RequestMapping("/api/license") @Principal(PrincipalType.ADMIN) class UserLicenseController( private val licenseService: SpdxLicenseService ) { - @ApiOperation("导入许可证数据") + @Operation(summary = "导入许可证数据") @PostMapping("/import") fun importLicense( @RequestParam path: String @@ -61,17 +61,17 @@ class UserLicenseController( return ResponseBuilder.success(licenseService.importLicense(path)) } - @ApiOperation("分页查询许可证信息") + @Operation(summary = "分页查询许可证信息") @GetMapping("/list") fun listLicensePage( - @ApiParam(value = "许可证唯一标识或许可证名称") + @Parameter(name = "许可证唯一标识或许可证名称") @RequestParam name: String?, - @ApiParam(value = "是否可信") + @Parameter(name = "是否可信") @RequestParam isTrust: Boolean?, - @ApiParam("页数", required = false, defaultValue = "1") + @Parameter(name = "页数", required = false) @RequestParam(required = false, defaultValue = DEFAULT_PAGE_NUMBER.toString()) pageNumber: Int = DEFAULT_PAGE_NUMBER, - @ApiParam("每页数量", required = false, defaultValue = "20") + @Parameter(name = "每页数量", required = false) @RequestParam(required = false, defaultValue = DEFAULT_PAGE_SIZE.toString()) pageSize: Int = DEFAULT_PAGE_SIZE ): Response> { @@ -85,25 +85,25 @@ class UserLicenseController( ) } - @ApiOperation("列表查询许可证信息") + @Operation(summary = "列表查询许可证信息") @GetMapping("/all") fun listLicense(): Response> { return ResponseBuilder.success(licenseService.listLicense()) } - @ApiOperation("根据许可证唯一标识查询许可证信息") + @Operation(summary = "根据许可证唯一标识查询许可证信息") @GetMapping("/info") fun getLicenseInfo( - @ApiParam(value = "许可证唯一标识", required = true) + @Parameter(name = "许可证唯一标识", required = true) @RequestParam licenseId: String ): Response { return ResponseBuilder.success(licenseService.getLicenseInfo(licenseId)) } - @ApiOperation("切换许可证合规/不合规") + @Operation(summary = "切换许可证合规/不合规") @PostMapping("/{licenseId}") fun update( - @ApiParam(value = "许可证唯一标识") + @Parameter(name = "许可证唯一标识") @PathVariable licenseId: String ): Response { licenseService.toggleStatus(licenseId) diff --git a/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserProjectScanConfigurationController.kt b/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserProjectScanConfigurationController.kt index 0b3c87ac6c..472b32b417 100644 --- a/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserProjectScanConfigurationController.kt +++ b/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserProjectScanConfigurationController.kt @@ -29,15 +29,15 @@ package com.tencent.bkrepo.analyst.controller.user import com.tencent.bkrepo.analyst.pojo.ProjectScanConfiguration import com.tencent.bkrepo.analyst.pojo.request.ProjectScanConfigurationPageRequest +import com.tencent.bkrepo.analyst.service.ProjectScanConfigurationService import com.tencent.bkrepo.common.api.pojo.Page import com.tencent.bkrepo.common.api.pojo.Response +import com.tencent.bkrepo.common.metadata.annotation.LogOperate import com.tencent.bkrepo.common.security.permission.Principal import com.tencent.bkrepo.common.security.permission.PrincipalType import com.tencent.bkrepo.common.service.util.ResponseBuilder -import com.tencent.bkrepo.analyst.service.ProjectScanConfigurationService -import com.tencent.bkrepo.common.metadata.annotation.LogOperate -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable @@ -47,7 +47,7 @@ import org.springframework.web.bind.annotation.RequestBody import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RestController -@Api("项目扫描配置接口") +@Tag(name = "项目扫描配置接口") @RestController @RequestMapping("/api/scan/configurations") @Principal(PrincipalType.ADMIN) @@ -55,7 +55,7 @@ class UserProjectScanConfigurationController( private val projectScanConfigurationService: ProjectScanConfigurationService ) { - @ApiOperation("创建项目扫描配置") + @Operation(summary = "创建项目扫描配置") @PostMapping @LogOperate(type = "PROJECT_SCAN_CONFIG_CREATE") fun create(@RequestBody request: ProjectScanConfiguration): Response { @@ -63,7 +63,7 @@ class UserProjectScanConfigurationController( return ResponseBuilder.success(configuration) } - @ApiOperation("删除项目扫描配置") + @Operation(summary = "删除项目扫描配置") @DeleteMapping("/{projectId}") @LogOperate(type = "PROJECT_SCAN_CONFIG_DELETE") fun delete(@PathVariable projectId: String): Response { @@ -71,7 +71,7 @@ class UserProjectScanConfigurationController( return ResponseBuilder.success() } - @ApiOperation("更新项目扫描配置") + @Operation(summary = "更新项目扫描配置") @PutMapping @LogOperate(type = "PROJECT_SCAN_CONFIG_UPDATE") fun update(@RequestBody request: ProjectScanConfiguration): Response { @@ -79,7 +79,7 @@ class UserProjectScanConfigurationController( return ResponseBuilder.success(configuration) } - @ApiOperation("分页获取项目扫描配置") + @Operation(summary = "分页获取项目扫描配置") @GetMapping @LogOperate(type = "PROJECT_SCAN_CONFIG_LIST") fun page(request: ProjectScanConfigurationPageRequest): Response> { @@ -87,7 +87,7 @@ class UserProjectScanConfigurationController( return ResponseBuilder.success(page) } - @ApiOperation("获取项目扫描配置") + @Operation(summary = "获取项目扫描配置") @GetMapping("/{projectId}") fun get(@PathVariable projectId: String): Response { return ResponseBuilder.success(projectScanConfigurationService.get(projectId)) diff --git a/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserScanController.kt b/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserScanController.kt index a6a9db78cb..db92626a94 100644 --- a/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserScanController.kt +++ b/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserScanController.kt @@ -51,9 +51,9 @@ import com.tencent.bkrepo.common.security.permission.Principal import com.tencent.bkrepo.common.security.permission.PrincipalType import com.tencent.bkrepo.common.security.util.SecurityUtils import com.tencent.bkrepo.common.service.util.ResponseBuilder -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.beans.factory.annotation.Autowired import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable @@ -63,7 +63,7 @@ import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam import org.springframework.web.bind.annotation.RestController -@Api("扫描接口") +@Tag(name = "扫描接口") @RestController @RequestMapping("/api/scan") class UserScanController @Autowired constructor( @@ -72,33 +72,33 @@ class UserScanController @Autowired constructor( private val permissionCheckHandler: ScannerPermissionCheckHandler ) { - @ApiOperation("手动创建全局扫描任务") + @Operation(summary = "手动创建全局扫描任务") @PostMapping("/global") @Principal(PrincipalType.ADMIN) fun globalScan(@RequestBody scanRequest: GlobalScanRequest): Response { return ResponseBuilder.success(scanService.globalScan(scanRequest)) } - @ApiOperation("手动创建扫描任务") + @Operation(summary = "手动创建扫描任务") @PostMapping fun scan(@RequestBody scanRequest: ScanRequest): Response { return ResponseBuilder.success(scanService.scan(scanRequest, ScanTriggerType.MANUAL, SecurityUtils.getUserId())) } - @ApiOperation("从流水线触发扫描") + @Operation(summary = "从流水线触发扫描") @PostMapping("/pipeline") fun pipelineScan(@RequestBody request: PipelineScanRequest): Response { return ResponseBuilder.success(scanService.pipelineScan(request)) } - @ApiOperation("中止制品扫描") + @Operation(summary = "中止制品扫描") @PostMapping("/{projectId}/stop") fun stopScan( - @ApiParam(value = "projectId") + @Parameter(name = "projectId") @PathVariable projectId: String, - @ApiParam(value = "记录id") + @Parameter(name = "记录id") @RequestParam("recordId") subtaskId: String?, - @ApiParam(value = "方案id") + @Parameter(name = "方案id") @RequestParam("id") planId: String? ): Response { permissionCheckHandler.checkProjectPermission(projectId, PermissionAction.MANAGE) @@ -115,41 +115,41 @@ class UserScanController @Autowired constructor( } } - @ApiOperation("中止制品扫描") + @Operation(summary = "中止制品扫描") @PostMapping("/{projectId}/tasks/{taskId}/stop") fun stopTask( - @ApiParam(value = "projectId") + @Parameter(name = "projectId") @PathVariable projectId: String, - @ApiParam(value = "任务id") + @Parameter(name = "任务id") @PathVariable("taskId") taskId: String ): Response { permissionCheckHandler.checkProjectPermission(projectId, PermissionAction.MANAGE) return ResponseBuilder.success(scanService.stopTask(projectId, taskId)) } - @ApiOperation("中止制品扫描") + @Operation(summary = "中止制品扫描") @PostMapping("/tasks/{taskId}/stop") @Principal(PrincipalType.ADMIN) fun stopTask( - @ApiParam(value = "任务id") + @Parameter(name = "任务id") @PathVariable("taskId") taskId: String ): Response { return ResponseBuilder.success(scanService.stopTask(null, taskId)) } - @ApiOperation("获取扫描任务信息") + @Operation(summary = "获取扫描任务信息") @GetMapping("/tasks/{taskId}") fun task(@PathVariable("taskId") taskId: String): Response { return ResponseBuilder.success(scanTaskService.task(taskId)) } - @ApiOperation("分页获取扫描任务信息") + @Operation(summary = "分页获取扫描任务信息") @GetMapping("/tasks") fun tasks(scanTaskQuery: ScanTaskQuery, pageLimit: PageLimit): Response> { return ResponseBuilder.success(scanTaskService.tasks(scanTaskQuery, pageLimit)) } - @ApiOperation("获取扫描子任务信息") + @Operation(summary = "获取扫描子任务信息") @GetMapping("/tasks/{taskId}/subtasks/{subtaskId}") fun subtask( @PathVariable("taskId") taskId: String, @@ -158,7 +158,7 @@ class UserScanController @Autowired constructor( return ResponseBuilder.success(scanTaskService.subtaskOverview(subtaskId)) } - @ApiOperation("分页获取扫描子任务信息") + @Operation(summary = "分页获取扫描子任务信息") @GetMapping("/tasks/{taskId}/subtasks") fun subtasks( @PathVariable("taskId") taskId: String, @@ -168,7 +168,7 @@ class UserScanController @Autowired constructor( return ResponseBuilder.success(scanTaskService.subtasks(ScanPlanConverter.convert(subtaskInfoRequest))) } - @ApiOperation("获取许可扫描子任务信息") + @Operation(summary = "获取许可扫描子任务信息") @GetMapping("/license/tasks/{taskId}/subtasks/{subtaskId}") fun licenseSubtask( @PathVariable("taskId") taskId: String, diff --git a/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserScanPlanController.kt b/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserScanPlanController.kt index 2165305358..b7eebb6f70 100644 --- a/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserScanPlanController.kt +++ b/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserScanPlanController.kt @@ -51,8 +51,8 @@ import com.tencent.bkrepo.common.query.model.PageLimit import com.tencent.bkrepo.common.security.permission.Principal import com.tencent.bkrepo.common.security.permission.PrincipalType import com.tencent.bkrepo.common.service.util.ResponseBuilder -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable @@ -71,7 +71,7 @@ class UserScanPlanController( private val permissionCheckHandler: ScannerPermissionCheckHandler ) { - @ApiOperation("创建扫描方案") + @Operation(summary = "创建扫描方案") @PostMapping("/create") fun createScanPlan(@RequestBody request: CreateScanPlanRequest): Response { permissionCheckHandler.checkProjectPermission(request.projectId, PermissionAction.MANAGE) @@ -80,13 +80,13 @@ class UserScanPlanController( return ResponseBuilder.success(true) } - @ApiOperation("查询扫描方案基础信息") + @Operation(summary = "查询扫描方案基础信息") @GetMapping("/detail/{projectId}/{id}") fun getScanPlan( - @ApiParam(value = "projectId") + @Parameter(name = "projectId") @PathVariable projectId: String, - @ApiParam(value = "方案id") + @Parameter(name = "方案id") @PathVariable id: String ): Response { @@ -94,12 +94,12 @@ class UserScanPlanController( return ResponseBuilder.success(scanPlanService.find(projectId, id)) } - @ApiOperation("删除扫描方案") + @Operation(summary = "删除扫描方案") @DeleteMapping("/delete/{projectId}/{id}") fun deleteScanPlan( - @ApiParam(value = "projectId") + @Parameter(name = "projectId") @PathVariable projectId: String, - @ApiParam(value = "方案id") + @Parameter(name = "方案id") @PathVariable id: String ): Response { permissionCheckHandler.checkProjectPermission(projectId, PermissionAction.MANAGE) @@ -107,29 +107,29 @@ class UserScanPlanController( return ResponseBuilder.success(true) } - @ApiOperation("更新扫描方案") + @Operation(summary = "更新扫描方案") @PostMapping("/update") fun updateScanPlan(@RequestBody request: UpdateScanPlanRequest): Response { scanPlanService.update(request) return ResponseBuilder.success(true) } - @ApiOperation("扫描方案列表-分页") + @Operation(summary = "扫描方案列表-分页") @GetMapping("/list/{projectId}") fun scanPlanList( - @ApiParam(value = "projectId", required = true) + @Parameter(name = "projectId", required = true) @PathVariable projectId: String, - @ApiParam(value = "方案类型") + @Parameter(name = "方案类型") @RequestParam type: String?, - @ApiParam(value = "方案名") + @Parameter(name = "方案名") @RequestParam name: String?, - @ApiParam("页数", required = false, defaultValue = "1") + @Parameter(name = "页数", required = false) @RequestParam(required = false, defaultValue = DEFAULT_PAGE_NUMBER.toString()) pageNumber: Int = DEFAULT_PAGE_NUMBER, - @ApiParam("每页数量", required = false, defaultValue = "20") + @Parameter(name = "每页数量", required = false) @RequestParam(required = false, defaultValue = DEFAULT_PAGE_SIZE.toString()) pageSize: Int = DEFAULT_PAGE_SIZE ): Response> { @@ -140,16 +140,16 @@ class UserScanPlanController( return ResponseBuilder.success(page) } - @ApiOperation("所有扫描方案") + @Operation(summary = "所有扫描方案") @GetMapping("/all/{projectId}") fun scanPlanList( - @ApiParam(value = "projectId", required = true) + @Parameter(name = "projectId", required = true) @PathVariable projectId: String, - @ApiParam(value = "方案类型") + @Parameter(name = "方案类型") @RequestParam type: String?, - @ApiParam(value = "待扫描文件名后缀，该参数尽在type为GENERIC时有效") + @Parameter(name = "待扫描文件名后缀，该参数尽在type为GENERIC时有效") @RequestParam(required = false) fileNameExt: String? = null ): Response> { @@ -159,7 +159,7 @@ class UserScanPlanController( return ResponseBuilder.success(planList) } - @ApiOperation("方案详情-统计数据") + @Operation(summary = "方案详情-统计数据") @GetMapping("/count") fun planDetailCount(countRequest: PlanCountRequest): Response { // TODO 等前端流水线扫描报告移除调用该接口后改会项目管理员权限 @@ -167,7 +167,7 @@ class UserScanPlanController( return ResponseBuilder.success(scanPlanService.scanPlanInfo(ScanPlanConverter.convert(countRequest))) } - @ApiOperation("校正扫描方案预览信息数据") + @Operation(summary = "校正扫描方案预览信息数据") @PostMapping("/count/correct") @Principal(type = PrincipalType.ADMIN) fun correctPlanOverview(@RequestParam(required = false) planId: String? = null): Response { @@ -175,7 +175,7 @@ class UserScanPlanController( return ResponseBuilder.success() } - @ApiOperation("方案详情-制品信息") + @Operation(summary = "方案详情-制品信息") @GetMapping("/artifact") fun planArtifactSubtaskList(subtaskInfoRequest: SubtaskInfoRequest): Response> { permissionCheckHandler.checkProjectPermission(subtaskInfoRequest.projectId, PermissionAction.MANAGE) @@ -184,14 +184,14 @@ class UserScanPlanController( ) } - @ApiOperation("扫描方案数据导出") + @Operation(summary = "扫描方案数据导出") @GetMapping("/export") fun planScanRecordExport(subtaskInfoRequest: SubtaskInfoRequest) { permissionCheckHandler.checkProjectPermission(subtaskInfoRequest.projectId, PermissionAction.MANAGE) scanTaskService.exportScanPlanRecords(ScanPlanConverter.convert(subtaskInfoRequest)) } - @ApiOperation("文件/包关联的扫描方案列表") + @Operation(summary = "文件/包关联的扫描方案列表") @GetMapping("/relation/artifact") fun artifactPlanList( artifactRequest: ArtifactPlanRelationRequest @@ -199,7 +199,7 @@ class UserScanPlanController( return ResponseBuilder.success(scanPlanService.artifactPlanList(artifactRequest)) } - @ApiOperation("方案详情-许可-统计数据") + @Operation(summary = "方案详情-许可-统计数据") @GetMapping("/license/count") fun planLicenseDetailCount(countRequest: PlanCountRequest): Response { permissionCheckHandler.checkProjectPermission(countRequest.projectId, PermissionAction.MANAGE) diff --git a/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserScanQualityController.kt b/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserScanQualityController.kt index e36f0fae5e..9721258ef3 100644 --- a/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserScanQualityController.kt +++ b/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserScanQualityController.kt @@ -28,13 +28,13 @@ package com.tencent.bkrepo.analyst.controller.user import com.tencent.bkrepo.analyst.pojo.request.ScanQualityUpdateRequest -import com.tencent.bkrepo.common.api.pojo.Response -import com.tencent.bkrepo.common.service.util.ResponseBuilder import com.tencent.bkrepo.analyst.pojo.response.ScanQuality import com.tencent.bkrepo.analyst.service.ScanQualityService -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import com.tencent.bkrepo.common.api.pojo.Response +import com.tencent.bkrepo.common.service.util.ResponseBuilder +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable import org.springframework.web.bind.annotation.PostMapping @@ -42,27 +42,27 @@ import org.springframework.web.bind.annotation.RequestBody import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RestController -@Api("扫描方案质量规则接口") +@Tag(name = "扫描方案质量规则接口") @RestController @RequestMapping("/api/scan/quality") class UserScanQualityController( private val scanQualityService: ScanQualityService ) { - @ApiOperation("获取扫描方案质量规则") + @Operation(summary = "获取扫描方案质量规则") @GetMapping("/{planId}") fun getScanQuality( - @ApiParam(value = "方案id") + @Parameter(name = "方案id") @PathVariable("planId") planId: String ): Response { return ResponseBuilder.success(scanQualityService.getScanQuality(planId)) } - @ApiOperation("更新扫描方案质量规则") + @Operation(summary = "更新扫描方案质量规则") @PostMapping("/{planId}") fun updateScanQuality( - @ApiParam(value = "方案id") + @Parameter(name = "方案id") @PathVariable("planId") planId: String, @RequestBody request: ScanQualityUpdateRequest diff --git a/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserScanReportController.kt b/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserScanReportController.kt index 1dc39c30f6..1fce3137a7 100644 --- a/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserScanReportController.kt +++ b/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserScanReportController.kt @@ -30,29 +30,29 @@ package com.tencent.bkrepo.analyst.controller.user import com.tencent.bkrepo.analyst.pojo.request.ArtifactVulnerabilityRequest import com.tencent.bkrepo.analyst.pojo.request.FileScanResultDetailRequest import com.tencent.bkrepo.analyst.pojo.request.FileScanResultOverviewRequest +import com.tencent.bkrepo.analyst.pojo.request.scancodetoolkit.ArtifactLicensesDetailRequest +import com.tencent.bkrepo.analyst.pojo.response.ArtifactVulnerabilityInfo +import com.tencent.bkrepo.analyst.pojo.response.FileLicensesResultDetail +import com.tencent.bkrepo.analyst.pojo.response.FileLicensesResultOverview +import com.tencent.bkrepo.analyst.pojo.response.FileScanResultDetail +import com.tencent.bkrepo.analyst.pojo.response.FileScanResultOverview +import com.tencent.bkrepo.analyst.pojo.response.SubtaskResultOverview +import com.tencent.bkrepo.analyst.service.ScanTaskService import com.tencent.bkrepo.auth.pojo.enums.PermissionAction import com.tencent.bkrepo.auth.pojo.enums.ResourceType +import com.tencent.bkrepo.common.analysis.pojo.scanner.utils.normalizedLevel import com.tencent.bkrepo.common.api.pojo.Page import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.common.artifact.api.ArtifactInfo import com.tencent.bkrepo.common.artifact.api.ArtifactPathVariable import com.tencent.bkrepo.common.artifact.api.DefaultArtifactInfo -import com.tencent.bkrepo.common.analysis.pojo.scanner.utils.normalizedLevel import com.tencent.bkrepo.common.security.permission.Permission import com.tencent.bkrepo.common.security.permission.Principal import com.tencent.bkrepo.common.security.permission.PrincipalType import com.tencent.bkrepo.common.service.util.ResponseBuilder -import com.tencent.bkrepo.analyst.pojo.request.scancodetoolkit.ArtifactLicensesDetailRequest -import com.tencent.bkrepo.analyst.pojo.response.SubtaskResultOverview -import com.tencent.bkrepo.analyst.pojo.response.ArtifactVulnerabilityInfo -import com.tencent.bkrepo.analyst.pojo.response.FileLicensesResultDetail -import com.tencent.bkrepo.analyst.pojo.response.FileLicensesResultOverview -import com.tencent.bkrepo.analyst.pojo.response.FileScanResultDetail -import com.tencent.bkrepo.analyst.pojo.response.FileScanResultOverview -import com.tencent.bkrepo.analyst.service.ScanTaskService -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable import org.springframework.web.bind.annotation.PostMapping @@ -60,12 +60,12 @@ import org.springframework.web.bind.annotation.RequestBody import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RestController -@Api("扫描报告") +@Tag(name = "扫描报告") @RestController @RequestMapping("/api/scan") class UserScanReportController(private val scanTaskService: ScanTaskService) { - @ApiOperation("获取文件扫描报告详情") + @Operation(summary = "获取文件扫描报告详情") @Permission(type = ResourceType.NODE, action = PermissionAction.READ) @PostMapping("/reports/detail${DefaultArtifactInfo.DEFAULT_MAPPING_URI}") fun artifactReport( @@ -76,10 +76,10 @@ class UserScanReportController(private val scanTaskService: ScanTaskService) { return ResponseBuilder.success(scanTaskService.resultDetail(request)) } - @ApiOperation("制品详情--漏洞数据") + @Operation(summary = "制品详情--漏洞数据") @GetMapping("/reports/{subScanTaskId}") fun artifactReport( - @ApiParam(value = "扫描记录id") @PathVariable subScanTaskId: String, + @Parameter(name = "扫描记录id") @PathVariable subScanTaskId: String, request: ArtifactVulnerabilityRequest ): Response> { request.subScanTaskId = subScanTaskId @@ -87,7 +87,7 @@ class UserScanReportController(private val scanTaskService: ScanTaskService) { return ResponseBuilder.success(scanTaskService.archiveSubtaskResultDetail(request)) } - @ApiOperation("文件扫描结果预览") + @Operation(summary = "文件扫描结果预览") @Principal(PrincipalType.ADMIN) @PostMapping("/reports/overview") fun artifactReports( @@ -96,11 +96,11 @@ class UserScanReportController(private val scanTaskService: ScanTaskService) { return ResponseBuilder.success(scanTaskService.resultOverview(request)) } - @ApiOperation("制品详情--漏洞数据") + @Operation(summary = "制品详情--漏洞数据") @GetMapping("/artifact/leak/{projectId}/{subScanTaskId}") fun artifactLeak( - @ApiParam(value = "projectId") @PathVariable projectId: String, - @ApiParam(value = "扫描记录id") @PathVariable subScanTaskId: String, + @Parameter(name = "projectId") @PathVariable projectId: String, + @Parameter(name = "扫描记录id") @PathVariable subScanTaskId: String, request: ArtifactVulnerabilityRequest ): Response> { request.projectId = projectId @@ -109,11 +109,11 @@ class UserScanReportController(private val scanTaskService: ScanTaskService) { return ResponseBuilder.success(scanTaskService.resultDetail(request)) } - @ApiOperation("制品详情--漏洞数据--导出") + @Operation(summary = "制品详情--漏洞数据--导出") @GetMapping("/export/artifact/leak/{projectId}/{subScanTaskId}") fun exportLeak( - @ApiParam(value = "projectId") @PathVariable projectId: String, - @ApiParam(value = "扫描记录id") @PathVariable subScanTaskId: String, + @Parameter(name = "projectId") @PathVariable projectId: String, + @Parameter(name = "扫描记录id") @PathVariable subScanTaskId: String, request: ArtifactVulnerabilityRequest ) { request.projectId = projectId @@ -122,20 +122,20 @@ class UserScanReportController(private val scanTaskService: ScanTaskService) { scanTaskService.exportLeakDetail(request) } - @ApiOperation("制品详情--漏洞数据") + @Operation(summary = "制品详情--漏洞数据") @GetMapping("/artifact/count/{projectId}/{subScanTaskId}") fun artifactCount( - @ApiParam(value = "projectId") @PathVariable projectId: String, - @ApiParam(value = "扫描记录id") @PathVariable subScanTaskId: String + @Parameter(name = "projectId") @PathVariable projectId: String, + @Parameter(name = "扫描记录id") @PathVariable subScanTaskId: String ): Response { return ResponseBuilder.success(scanTaskService.planArtifactSubtaskOverview(subScanTaskId)) } - @ApiOperation("制品详情--许可数据") + @Operation(summary = "制品详情--许可数据") @GetMapping("/artifact/license/leak/{projectId}/{subScanTaskId}") fun artifactLicenseLeak( - @ApiParam(value = "projectId", required = true) @PathVariable projectId: String, - @ApiParam(value = "扫描记录id", required = true) @PathVariable subScanTaskId: String, + @Parameter(name = "projectId", required = true) @PathVariable projectId: String, + @Parameter(name = "扫描记录id", required = true) @PathVariable subScanTaskId: String, request: ArtifactLicensesDetailRequest ): Response> { request.projectId = projectId @@ -143,19 +143,19 @@ class UserScanReportController(private val scanTaskService: ScanTaskService) { return ResponseBuilder.success(scanTaskService.resultDetail(request)) } - @ApiOperation("制品详情--许可数据") + @Operation(summary = "制品详情--许可数据") @GetMapping("/artifact/license/count/{projectId}/{subScanTaskId}") fun artifactLicenseCount( - @ApiParam(value = "projectId", required = true) @PathVariable projectId: String, - @ApiParam(value = "扫描记录id", required = true) @PathVariable subScanTaskId: String + @Parameter(name = "projectId", required = true) @PathVariable projectId: String, + @Parameter(name = "扫描记录id", required = true) @PathVariable subScanTaskId: String ): Response { return ResponseBuilder.success(scanTaskService.planLicensesArtifact(projectId, subScanTaskId)) } - @ApiOperation("制品详情--许可数据") + @Operation(summary = "制品详情--许可数据") @GetMapping("/license/reports/{subScanTaskId}") fun artifactLicenseReport( - @ApiParam(value = "扫描记录id") @PathVariable subScanTaskId: String, + @Parameter(name = "扫描记录id") @PathVariable subScanTaskId: String, request: ArtifactLicensesDetailRequest ): Response> { request.subScanTaskId = subScanTaskId diff --git a/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserScannerController.kt b/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserScannerController.kt index bbf2f46d59..dec634a7bf 100644 --- a/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserScannerController.kt +++ b/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserScannerController.kt @@ -27,18 +27,18 @@ package com.tencent.bkrepo.analyst.controller.user +import com.tencent.bkrepo.analyst.pojo.response.ScannerBase +import com.tencent.bkrepo.analyst.service.ScannerService +import com.tencent.bkrepo.common.analysis.pojo.scanner.Scanner import com.tencent.bkrepo.common.api.exception.BadRequestException import com.tencent.bkrepo.common.api.message.CommonMessageCode import com.tencent.bkrepo.common.api.pojo.Response -import com.tencent.bkrepo.common.analysis.pojo.scanner.Scanner +import com.tencent.bkrepo.common.metadata.annotation.LogOperate import com.tencent.bkrepo.common.security.permission.Principal import com.tencent.bkrepo.common.security.permission.PrincipalType import com.tencent.bkrepo.common.service.util.ResponseBuilder -import com.tencent.bkrepo.analyst.pojo.response.ScannerBase -import com.tencent.bkrepo.analyst.service.ScannerService -import com.tencent.bkrepo.common.metadata.annotation.LogOperate -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.beans.factory.annotation.Autowired import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping @@ -50,14 +50,14 @@ import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam import org.springframework.web.bind.annotation.RestController -@Api("扫描器配置接口") +@Tag(name = "扫描器配置接口") @RestController @RequestMapping("/api/scanners") class UserScannerController @Autowired constructor( private val scannerService: ScannerService ) { - @ApiOperation("创建扫描器接口") + @Operation(summary = "创建扫描器接口") @PostMapping @Principal(PrincipalType.ADMIN) @LogOperate(type = "SCANNER_CREATE", desensitize = true) @@ -67,7 +67,7 @@ class UserScannerController @Autowired constructor( return ResponseBuilder.success(scannerService.create(scanner)) } - @ApiOperation("获取扫描器列表") + @Operation(summary = "获取扫描器列表") @GetMapping @Principal(PrincipalType.ADMIN) @LogOperate(type = "SCANNER_LIST") @@ -75,7 +75,7 @@ class UserScannerController @Autowired constructor( return ResponseBuilder.success(scannerService.list()) } - @ApiOperation("获取扫描器基本信息列表") + @Operation(summary = "获取扫描器基本信息列表") @GetMapping("/base") fun listBaseInf( @RequestParam(required = false) packageType: String? = null, @@ -89,19 +89,19 @@ class UserScannerController @Autowired constructor( }) } - @ApiOperation("获取支持扫描的文件名后缀") + @Operation(summary = "获取支持扫描的文件名后缀") @GetMapping("/support/ext") fun supportFileNameExt(): Response> { return ResponseBuilder.success(scannerService.supportFileNameExt()) } - @ApiOperation("获取支持扫描的包类型") + @Operation(summary = "获取支持扫描的包类型") @GetMapping("/support/package") fun supportPackageType(): Response> { return ResponseBuilder.success(scannerService.supportPackageType()) } - @ApiOperation("获取扫描器") + @Operation(summary = "获取扫描器") @GetMapping("/{name}") @Principal(PrincipalType.ADMIN) @LogOperate(type = "SCANNER_GET") @@ -109,7 +109,7 @@ class UserScannerController @Autowired constructor( return ResponseBuilder.success(scannerService.get(name)) } - @ApiOperation("删除扫描器") + @Operation(summary = "删除扫描器") @DeleteMapping("/{name}") @Principal(PrincipalType.ADMIN) @LogOperate(type = "SCANNER_DELETE") @@ -118,7 +118,7 @@ class UserScannerController @Autowired constructor( return ResponseBuilder.success() } - @ApiOperation("更新扫描器") + @Operation(summary = "更新扫描器") @PutMapping("/{name}") @Principal(PrincipalType.ADMIN) @LogOperate(type = "SCANNER_UPDATE", desensitize = true) diff --git a/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserTemporaryScanController.kt b/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserTemporaryScanController.kt index 69ef34ddc2..1a551badf2 100644 --- a/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserTemporaryScanController.kt +++ b/src/backend/analyst/biz-analyst/src/main/kotlin/com/tencent/bkrepo/analyst/controller/user/UserTemporaryScanController.kt @@ -33,8 +33,8 @@ import com.tencent.bkrepo.analyst.service.TemporaryScanTokenService import com.tencent.bkrepo.common.analysis.pojo.scanner.standard.ToolInput import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.common.service.util.ResponseBuilder -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.tags.Tag +import io.swagger.v3.oas.annotations.Operation import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable import org.springframework.web.bind.annotation.PostMapping @@ -44,7 +44,7 @@ import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam import org.springframework.web.bind.annotation.RestController -@Api("使用临时token访问扫描接口") +@Tag(name = "使用临时token访问扫描接口") @RestController @RequestMapping("/api/temporary") class UserTemporaryScanController( @@ -52,7 +52,7 @@ class UserTemporaryScanController( private val scanService: ScanService ) { - @ApiOperation("获取扫描子任务信息") + @Operation(summary = "获取扫描子任务信息") @GetMapping("/scan/subtask/{subtaskId}/input") fun getSubtask( @PathVariable subtaskId: String, @@ -62,7 +62,7 @@ class UserTemporaryScanController( return ResponseBuilder.success(temporaryScanTokenService.getToolInput(subtaskId, token)) } - @ApiOperation("拉取扫描子任务") + @Operation(summary = "拉取扫描子任务") @GetMapping("/scan/subtask/input") fun pullSubtask( @RequestParam executionCluster: String, @@ -74,7 +74,7 @@ class UserTemporaryScanController( return ResponseBuilder.success(toolInput) } - @ApiOperation("扫描结果上报") + @Operation(summary = "扫描结果上报") @PostMapping("/scan/report") fun report(@RequestBody reportResultRequest: ReportResultRequest): Response { temporaryScanTokenService.checkToken(reportResultRequest.subTaskId, reportResultRequest.token) @@ -84,7 +84,7 @@ class UserTemporaryScanController( return ResponseBuilder.success() } - @ApiOperation("扫描任务状态更新") + @Operation(summary = "扫描任务状态更新") @PutMapping("/scan/subtask/{subtaskId}/status") fun updateSubScanTaskStatus( @PathVariable subtaskId: String, @@ -95,7 +95,7 @@ class UserTemporaryScanController( return ResponseBuilder.success(scanService.updateSubScanTaskStatus(subtaskId, status)) } - @ApiOperation("维持任务心跳") + @Operation(summary = "维持任务心跳") @PostMapping("/scan/subtask/{subtaskId}/heartbeat") fun heartbeat( @PathVariable subtaskId: String, diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServiceAccountClient.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServiceAccountClient.kt index b3a7f0c213..4c0d8e1efb 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServiceAccountClient.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServiceAccountClient.kt @@ -35,9 +35,9 @@ import com.tencent.bkrepo.auth.constant.AUTH_SERVICE_ACCOUNT_PREFIX import com.tencent.bkrepo.auth.pojo.oauth.AuthorizationGrantType import com.tencent.bkrepo.common.api.constant.AUTH_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.context.annotation.Primary import org.springframework.web.bind.annotation.GetMapping @@ -46,37 +46,37 @@ import org.springframework.web.bind.annotation.PostMapping import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam -@Api(tags = ["SERVICE_ACCOUNT"], description = "服务-账号接口") +@Tag(name = "SERVICE_ACCOUNT", description = "服务-账号接口") @Primary @FeignClient(AUTH_SERVICE_NAME, contextId = "ServiceAccountResource") @RequestMapping(AUTH_SERVICE_ACCOUNT_PREFIX) interface ServiceAccountClient { - @ApiOperation("校验ak/sk") + @Operation(summary = "校验ak/sk") @GetMapping("/credential/{accesskey}/{secretkey}") @Deprecated("删除get方式校验") fun checkCredential( - @ApiParam(value = "accesskey") + @Parameter(name = "accesskey") @PathVariable accesskey: String, - @ApiParam(value = "secretkey") + @Parameter(name = "secretkey") @PathVariable secretkey: String ): Response - @ApiOperation("校验ak/sk") + @Operation(summary = "校验ak/sk") @PostMapping("/credential") fun checkAccountCredential( - @ApiParam(value = "accesskey") + @Parameter(name = "accesskey") @RequestParam accesskey: String, - @ApiParam(value = "secretkey") + @Parameter(name = "secretkey") @RequestParam secretkey: String, - @ApiParam(value = "authorizationGrantType") + @Parameter(name = "authorizationGrantType") @RequestParam authorizationGrantType: AuthorizationGrantType? = null ): Response - @ApiOperation("查找sk") + @Operation(summary = "查找sk") @GetMapping("/credential/appId/{appId}/accessKey/{accessKey}") fun findSecretKey( - @ApiParam @PathVariable appId: String, - @ApiParam @PathVariable accessKey: String + @Parameter @PathVariable appId: String, + @Parameter @PathVariable accessKey: String ): Response } diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServiceBkiamV3ResourceClient.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServiceBkiamV3ResourceClient.kt index 0a36e5c391..1cb68b4954 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServiceBkiamV3ResourceClient.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServiceBkiamV3ResourceClient.kt @@ -30,9 +30,9 @@ package com.tencent.bkrepo.auth.api import com.tencent.bkrepo.auth.constant.AUTH_SERVICE_BKIAMV3_PREFIX import com.tencent.bkrepo.common.api.constant.AUTH_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.context.annotation.Primary import org.springframework.web.bind.annotation.DeleteMapping @@ -42,47 +42,47 @@ import org.springframework.web.bind.annotation.RequestBody import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam -@Api(tags = ["SERVICE_BKIAMV3"], description = "蓝鲸权限v3接口") +@Tag(name = "SERVICE_BKIAMV3", description = "蓝鲸权限v3接口") @Primary @FeignClient(AUTH_SERVICE_NAME, contextId = "ServiceBkiamV3Resource") @RequestMapping(AUTH_SERVICE_BKIAMV3_PREFIX) interface ServiceBkiamV3ResourceClient { - @ApiOperation("创建项目管理员") + @Operation(summary = "创建项目管理员") @PostMapping("/create/project/manage/{projectId}") fun createProjectManage( - @ApiParam(value = "用户id") + @Parameter(name = "用户id") @RequestParam userId: String, - @ApiParam(value = "项目名称") + @Parameter(name = "项目名称") @PathVariable projectId: String ): Response - @ApiOperation("创建2级仓库管理员") + @Operation(summary = "创建2级仓库管理员") @PostMapping("/create/repo/manage/{projectId}/{repoName}") fun createRepoManage( - @ApiParam(value = "用户id") + @Parameter(name = "用户id") @RequestParam userId: String, - @ApiParam(value = "项目名称") + @Parameter(name = "项目名称") @PathVariable projectId: String, - @ApiParam(value = "仓库名称") + @Parameter(name = "仓库名称") @PathVariable repoName: String ): Response - @ApiOperation("删除仓库相关用户组") + @Operation(summary = "删除仓库相关用户组") @DeleteMapping("/delete/repo/manage/{projectId}/{repoName}") fun deleteRepoManageGroup( - @ApiParam(value = "用户id") + @Parameter(name = "用户id") @RequestParam userId: String, - @ApiParam(value = "项目名称") + @Parameter(name = "项目名称") @PathVariable projectId: String, - @ApiParam(value = "仓库名称") + @Parameter(name = "仓库名称") @PathVariable repoName: String ): Response - @ApiOperation("检查项目默认的rbac项目组是否已经存在") + @Operation(summary = "检查项目默认的rbac项目组是否已经存在") @PostMapping("/rbac/group/check") fun getExistRbacDefaultGroupProjectIds( - @ApiParam(value = "项目ID列表") + @Parameter(name = "项目ID列表") @RequestBody projectIdList: List = emptyList() ): Response> diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServiceExternalPermissionClient.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServiceExternalPermissionClient.kt index 8d426c009e..a91fd6f8b7 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServiceExternalPermissionClient.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServiceExternalPermissionClient.kt @@ -31,12 +31,12 @@ import com.tencent.bkrepo.auth.constant.AUTH_SERVICE_EXT_PERMISSION_PREFIX import com.tencent.bkrepo.auth.pojo.externalPermission.ExternalPermission import com.tencent.bkrepo.common.api.constant.AUTH_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response -import io.swagger.annotations.Api +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.RequestMapping -@Api(tags = ["SERVICE_EXTERNAL_PERMISSION"], description = "服务-外部权限接口") +@Tag(name = "SERVICE_EXTERNAL_PERMISSION", description = "服务-外部权限接口") @FeignClient(AUTH_SERVICE_NAME, contextId = "ServiceExternalPermissionResource") @RequestMapping(AUTH_SERVICE_EXT_PERMISSION_PREFIX) interface ServiceExternalPermissionClient { diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServiceOauthAuthorizationClient.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServiceOauthAuthorizationClient.kt index 476488d233..228d7e8734 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServiceOauthAuthorizationClient.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServiceOauthAuthorizationClient.kt @@ -31,27 +31,27 @@ import com.tencent.bkrepo.auth.constant.AUTH_SERVICE_OAUTH_PREFIX import com.tencent.bkrepo.auth.pojo.oauth.OauthToken import com.tencent.bkrepo.common.api.constant.AUTH_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.context.annotation.Primary import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam -@Api(tags = ["SERVICE_OAUTHAUTHORIZATION"], description = "服务-Oauth授权接口") +@Tag(name = "SERVICE_OAUTHAUTHORIZATION", description = "服务-Oauth授权接口") @Primary @FeignClient(AUTH_SERVICE_NAME, contextId = "ServiceOauthAuthorizationResource") @RequestMapping(AUTH_SERVICE_OAUTH_PREFIX) interface ServiceOauthAuthorizationClient { - @ApiOperation("获取oauth token信息") + @Operation(summary = "获取oauth token信息") @GetMapping("/token") fun getToken( @RequestParam accessToken: String ): Response - @ApiOperation("验证oauth token") + @Operation(summary = "验证oauth token") @GetMapping("/token/validate") fun validateToken( @RequestParam accessToken: String diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServicePermissionClient.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServicePermissionClient.kt index e0c15cdda4..2d85fe8276 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServicePermissionClient.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServicePermissionClient.kt @@ -36,9 +36,9 @@ import com.tencent.bkrepo.auth.pojo.permission.CheckPermissionRequest import com.tencent.bkrepo.auth.pojo.permission.ListPathResult import com.tencent.bkrepo.common.api.constant.AUTH_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.context.annotation.Primary import org.springframework.web.bind.annotation.GetMapping @@ -47,45 +47,45 @@ import org.springframework.web.bind.annotation.RequestBody import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam -@Api(tags = ["SERVICE_PERMISSION"], description = "服务-权限接口") +@Tag(name = "SERVICE_PERMISSION", description = "服务-权限接口") @Primary @FeignClient(AUTH_SERVICE_NAME, contextId = "ServicePermissionResource") @RequestMapping(AUTH_SERVICE_PERMISSION_PREFIX) interface ServicePermissionClient { - @ApiOperation("list有权限仓库仓库") + @Operation(summary = "list有权限仓库仓库") @GetMapping("/repo/list") fun listPermissionRepo( - @ApiParam(value = "项目ID") + @Parameter(name = "项目ID") @RequestParam projectId: String, - @ApiParam(value = "用户ID") + @Parameter(name = "用户ID") @RequestParam userId: String, - @ApiParam(value = "应用ID") + @Parameter(name = "应用ID") @RequestParam appId: String? ): Response> - @ApiOperation("list有权限项目") + @Operation(summary = "list有权限项目") @GetMapping("/project/list") fun listPermissionProject( - @ApiParam(value = "用户ID") + @Parameter(name = "用户ID") @RequestParam userId: String ): Response> - @ApiOperation("list无权限路径") + @Operation(summary = "list无权限路径") @GetMapping("/path/list") fun listPermissionPath( - @ApiParam(value = "用户ID") + @Parameter(name = "用户ID") @RequestParam userId: String, - @ApiParam(value = "项目ID") + @Parameter(name = "项目ID") @RequestParam projectId: String, - @ApiParam(value = "仓库名称") + @Parameter(name = "仓库名称") @RequestParam repoName: String ): Response - @ApiOperation("校验权限") + @Operation(summary = "校验权限") @PostMapping("/check") fun checkPermission( - @ApiParam(value = "校验权限信息") + @Parameter(name = "校验权限信息") @RequestBody request: CheckPermissionRequest, ): Response diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServicePipelineClient.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServicePipelineClient.kt index 64d3be2548..0707a784d5 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServicePipelineClient.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServicePipelineClient.kt @@ -34,38 +34,38 @@ package com.tencent.bkrepo.auth.api import com.tencent.bkrepo.auth.constant.AUTH_SERVICE_PERMISSION_PREFIX import com.tencent.bkrepo.common.api.constant.AUTH_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.context.annotation.Primary import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam -@Api(tags = ["SERVICE_PERMISSION"], description = "服务-权限接口") +@Tag(name = "SERVICE_PERMISSION", description = "服务-权限接口") @Primary @FeignClient(AUTH_SERVICE_NAME, contextId = "ServicePipelineResource") @RequestMapping(AUTH_SERVICE_PERMISSION_PREFIX) interface ServicePipelineClient { - @ApiOperation("获取有权限的流水线") + @Operation(summary = "获取有权限的流水线") @GetMapping("/pipeline/listPermissionedPipelines") fun listPermissionedPipelines( - @ApiParam(value = "用户ID", required = true) + @Parameter(name = "用户ID", required = true) @RequestParam uid: String, - @ApiParam(value = "项目ID", required = true) + @Parameter(name = "项目ID", required = true) @RequestParam projectId: String ): Response> - @ApiOperation("是否有流水线访问权限") + @Operation(summary = "是否有流水线访问权限") @GetMapping("/pipeline/hasPermission") fun hasPermission( - @ApiParam(value = "用户ID", required = true) + @Parameter(name = "用户ID", required = true) @RequestParam uid: String, - @ApiParam(value = "项目ID", required = true) + @Parameter(name = "项目ID", required = true) @RequestParam projectId: String, - @ApiParam(value = "流水线ID", required = true) + @Parameter(name = "流水线ID", required = true) @RequestParam pipelineId: String ): Response } diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServiceProxyClient.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServiceProxyClient.kt index 41ba237375..769ecec332 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServiceProxyClient.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServiceProxyClient.kt @@ -30,19 +30,19 @@ package com.tencent.bkrepo.auth.api import com.tencent.bkrepo.auth.pojo.proxy.ProxyKey import com.tencent.bkrepo.common.api.constant.AUTH_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable import org.springframework.web.bind.annotation.RequestMapping -@Api(tags = ["SERVICE_PROXY"], description = "服务Proxy接口") +@Tag(name = "SERVICE_PROXY", description = "服务Proxy接口") @FeignClient(AUTH_SERVICE_NAME, contextId = "ServiceProxyClient") @RequestMapping("/service/proxy") interface ServiceProxyClient { - @ApiOperation("获取Proxy加密存储的密钥") + @Operation(summary = "获取Proxy加密存储的密钥") @GetMapping("/key/{projectId}/{name}") fun getEncryptedKey( @PathVariable projectId: String, diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServiceRoleClient.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServiceRoleClient.kt index abd8e539da..6ecc61a28c 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServiceRoleClient.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServiceRoleClient.kt @@ -34,34 +34,34 @@ package com.tencent.bkrepo.auth.api import com.tencent.bkrepo.auth.constant.AUTH_SERVICE_ROLE_PREFIX import com.tencent.bkrepo.common.api.constant.AUTH_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.context.annotation.Primary import org.springframework.web.bind.annotation.PathVariable import org.springframework.web.bind.annotation.PostMapping import org.springframework.web.bind.annotation.RequestMapping -@Api(tags = ["SERVICE_ROLE"], description = "服务-角色接口") +@Tag(name = "SERVICE_ROLE", description = "服务-角色接口") @Primary @FeignClient(AUTH_SERVICE_NAME, contextId = "ServiceRoleResource") @RequestMapping(AUTH_SERVICE_ROLE_PREFIX) interface ServiceRoleClient { - @ApiOperation("创建项目管理员") + @Operation(summary = "创建项目管理员") @PostMapping("/create/project/manage/{projectId}") fun createProjectManage( - @ApiParam(value = "仓库名称") + @Parameter(name = "仓库名称") @PathVariable projectId: String ): Response - @ApiOperation("创建仓库管理员") + @Operation(summary = "创建仓库管理员") @PostMapping("/create/repo/manage/{projectId}/{repoName}") fun createRepoManage( - @ApiParam(value = "仓库ID") + @Parameter(name = "仓库ID") @PathVariable projectId: String, - @ApiParam(value = "项目ID") + @Parameter(name = "项目ID") @PathVariable repoName: String ): Response } diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServiceTemporaryTokenClient.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServiceTemporaryTokenClient.kt index 91dd44d19f..cbc2b58d5e 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServiceTemporaryTokenClient.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServiceTemporaryTokenClient.kt @@ -35,8 +35,8 @@ import com.tencent.bkrepo.auth.pojo.token.TemporaryTokenCreateRequest import com.tencent.bkrepo.auth.pojo.token.TemporaryTokenInfo import com.tencent.bkrepo.common.api.constant.AUTH_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.context.annotation.Primary import org.springframework.web.bind.annotation.DeleteMapping @@ -46,31 +46,31 @@ import org.springframework.web.bind.annotation.PostMapping import org.springframework.web.bind.annotation.RequestBody import org.springframework.web.bind.annotation.RequestMapping -@Api("临时token服务接口") +@Tag(name = "临时token服务接口") @Primary @FeignClient(AUTH_SERVICE_NAME, contextId = "ServiceTemporaryTokenResource") @RequestMapping("/service/temporary/token") interface ServiceTemporaryTokenClient { - @ApiOperation("创建临时token") + @Operation(summary = "创建临时token") @PostMapping("/create") fun createToken( @RequestBody request: TemporaryTokenCreateRequest ): Response> - @ApiOperation("查询临时token信息") + @Operation(summary = "查询临时token信息") @GetMapping("/info/{token}") fun getTokenInfo( @PathVariable token: String ): Response - @ApiOperation("删除临时token信息") + @Operation(summary = "删除临时token信息") @DeleteMapping("/delete/{token}") fun deleteToken( @PathVariable token: String ): Response - @ApiOperation("减少token 允许访问次数") + @Operation(summary = "减少token 允许访问次数") @PostMapping("/permits/decrement/{token}") fun decrementPermits( @PathVariable token: String diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServiceUserClient.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServiceUserClient.kt index 58f9a258e6..42fd8e41d6 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServiceUserClient.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/ServiceUserClient.kt @@ -38,9 +38,9 @@ import com.tencent.bkrepo.auth.pojo.user.User import com.tencent.bkrepo.auth.pojo.user.UserInfo import com.tencent.bkrepo.common.api.constant.AUTH_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.context.annotation.Primary import org.springframework.web.bind.annotation.GetMapping @@ -50,67 +50,67 @@ import org.springframework.web.bind.annotation.RequestBody import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam -@Api(tags = ["SERVICE_USER"], description = "服务-用户接口") +@Tag(name = "SERVICE_USER", description = "服务-用户接口") @Primary @FeignClient(AUTH_SERVICE_NAME, contextId = "ServiceUserResource") @RequestMapping(AUTH_SERVICE_USER_PREFIX) interface ServiceUserClient { - @ApiOperation("创建用户") + @Operation(summary = "创建用户") @PostMapping("/create") fun createUser( @RequestBody request: CreateUserRequest ): Response - @ApiOperation("创建项目用户") + @Operation(summary = "创建项目用户") @PostMapping("/create/project") fun createUserToProject(@RequestBody request: CreateUserToProjectRequest): Response - @ApiOperation("用户详情") + @Operation(summary = "用户详情") @GetMapping("/detail/{uid}") @Deprecated("仅用于兼容旧接口", ReplaceWith("userInfoById")) fun detail( - @ApiParam(value = "用户id") + @Parameter(name = "用户id") @PathVariable uid: String ): Response - @ApiOperation("新增用户所属角色") + @Operation(summary = "新增用户所属角色") @PostMapping("/role/{uid}/{rid}") fun addUserRole( - @ApiParam(value = "用户id") + @Parameter(name = "用户id") @PathVariable uid: String, - @ApiParam(value = "用户角色id") + @Parameter(name = "用户角色id") @PathVariable rid: String ): Response - @ApiOperation("校验用户token") + @Operation(summary = "校验用户token") @PostMapping("/token") fun checkToken( - @ApiParam(value = "用户id") + @Parameter(name = "用户id") @RequestParam uid: String, - @ApiParam(value = "用户token") + @Parameter(name = "用户token") @RequestParam token: String ): Response - @ApiOperation("用户info ") + @Operation(summary = "用户info ") @GetMapping("/userinfo/{uid}") fun userInfoById( @PathVariable uid: String ): Response - @ApiOperation("获取用户pwd ") + @Operation(summary = "获取用户pwd ") @GetMapping("/userpwd/{uid}") fun userPwdById( @PathVariable uid: String ): Response - @ApiOperation("获取用户token") + @Operation(summary = "获取用户token") @GetMapping("/usertoken/{uid}") fun userTokenById( @PathVariable uid: String ): Response> - @ApiOperation("获取admin用户") + @Operation(summary = "获取admin用户") @GetMapping("/admin/users") fun listAdminUsers(): Response> } diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/cluster/ClusterPermissionClient.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/cluster/ClusterPermissionClient.kt index fdeab4a21e..79c5e5f233 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/cluster/ClusterPermissionClient.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/cluster/ClusterPermissionClient.kt @@ -31,25 +31,25 @@ import com.tencent.bkrepo.auth.constant.AUTH_CLUSTER_PERMISSION_PREFIX import com.tencent.bkrepo.auth.pojo.permission.CheckPermissionRequest import com.tencent.bkrepo.common.api.constant.AUTH_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.context.annotation.Primary import org.springframework.web.bind.annotation.PostMapping import org.springframework.web.bind.annotation.RequestBody import org.springframework.web.bind.annotation.RequestMapping -@Api("集群间权限服务接口") +@Tag(name = "集群间权限服务接口") @Primary @FeignClient(AUTH_SERVICE_NAME, contextId = "ClusterPermissionResource") @RequestMapping(AUTH_CLUSTER_PERMISSION_PREFIX) interface ClusterPermissionClient { - @ApiOperation("校验权限") + @Operation(summary = "校验权限") @PostMapping("/check") fun checkPermission( - @ApiParam(value = "校验权限信息") + @Parameter(name = "校验权限信息") @RequestBody request: CheckPermissionRequest ): Response } diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/cluster/ClusterTemporaryTokenClient.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/cluster/ClusterTemporaryTokenClient.kt index e6943a8d7d..3319678696 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/cluster/ClusterTemporaryTokenClient.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/cluster/ClusterTemporaryTokenClient.kt @@ -31,8 +31,8 @@ import com.tencent.bkrepo.auth.pojo.token.TemporaryTokenCreateRequest import com.tencent.bkrepo.auth.pojo.token.TemporaryTokenInfo import com.tencent.bkrepo.common.api.constant.AUTH_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.context.annotation.Primary import org.springframework.web.bind.annotation.DeleteMapping @@ -42,31 +42,31 @@ import org.springframework.web.bind.annotation.PostMapping import org.springframework.web.bind.annotation.RequestBody import org.springframework.web.bind.annotation.RequestMapping -@Api("临时token服务接口") +@Tag(name = "临时token服务接口") @Primary @FeignClient(AUTH_SERVICE_NAME, contextId = "ClusterTemporaryTokenResource") @RequestMapping("/cluster/temporary/token") interface ClusterTemporaryTokenClient { - @ApiOperation("创建临时token") + @Operation(summary = "创建临时token") @PostMapping("/create") fun createToken( @RequestBody request: TemporaryTokenCreateRequest ): Response> - @ApiOperation("查询临时token信息") + @Operation(summary = "查询临时token信息") @GetMapping("/info/{token}") fun getTokenInfo( @PathVariable token: String ): Response - @ApiOperation("删除临时token信息") + @Operation(summary = "删除临时token信息") @DeleteMapping("/delete/{token}") fun deleteToken( @PathVariable token: String ): Response - @ApiOperation("减少token 允许访问次数") + @Operation(summary = "减少token 允许访问次数") @PostMapping("/permits/decrement/{token}") fun decrementPermits( @PathVariable token: String diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/cluster/ClusterUserClient.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/cluster/ClusterUserClient.kt index f81f43b881..f89a48a8f9 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/cluster/ClusterUserClient.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/cluster/ClusterUserClient.kt @@ -31,25 +31,25 @@ import com.tencent.bkrepo.auth.constant.AUTH_CLUSTER_PERMISSION_PREFIX import com.tencent.bkrepo.auth.pojo.user.UserInfo import com.tencent.bkrepo.common.api.constant.AUTH_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.context.annotation.Primary import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable import org.springframework.web.bind.annotation.RequestMapping -@Api("集群间用户服务接口") +@Tag(name = "集群间用户服务接口") @Primary @FeignClient(AUTH_SERVICE_NAME, contextId = "ClusterUserResource") @RequestMapping(AUTH_CLUSTER_PERMISSION_PREFIX) interface ClusterUserClient { - @ApiOperation("用户信息") + @Operation(summary = "用户信息") @GetMapping("/info/{uid}") fun info( - @ApiParam(value = "用户id") + @Parameter(name = "用户id") @PathVariable uid: String ): Response } diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/proxy/ProxyAccountClient.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/proxy/ProxyAccountClient.kt index f3e14d7394..463680c230 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/proxy/ProxyAccountClient.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/proxy/ProxyAccountClient.kt @@ -29,9 +29,9 @@ package com.tencent.bkrepo.auth.api.proxy import com.tencent.bkrepo.common.api.constant.AUTH_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable @@ -39,24 +39,24 @@ import org.springframework.web.bind.annotation.PostMapping import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam -@Api(tags = ["PROXY_ACCOUNT"], description = "Proxy账号接口") +@Tag(name = "PROXY_ACCOUNT", description = "Proxy账号接口") @FeignClient(AUTH_SERVICE_NAME, contextId = "ProxyAccountClient") @RequestMapping("/proxy/account") interface ProxyAccountClient { - @ApiOperation("校验ak/sk") + @Operation(summary = "校验ak/sk") @PostMapping("/credential") fun checkAccountCredential( - @ApiParam(value = "accesskey") + @Parameter(name = "accesskey") @RequestParam accesskey: String, - @ApiParam(value = "secretkey") + @Parameter(name = "secretkey") @RequestParam secretkey: String ): Response - @ApiOperation("查找sk") + @Operation(summary = "查找sk") @GetMapping("/credential/appId/{appId}/accessKey/{accessKey}") fun findSecretKey( - @ApiParam @PathVariable appId: String, - @ApiParam @PathVariable accessKey: String + @Parameter @PathVariable appId: String, + @Parameter @PathVariable accessKey: String ): Response } diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/proxy/ProxyAuthClient.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/proxy/ProxyAuthClient.kt index 38ebb08a41..2356153de0 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/proxy/ProxyAuthClient.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/proxy/ProxyAuthClient.kt @@ -30,7 +30,7 @@ package com.tencent.bkrepo.auth.api.proxy import com.tencent.bkrepo.auth.pojo.proxy.ProxyStatusRequest import com.tencent.bkrepo.common.api.constant.AUTH_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response -import io.swagger.annotations.Api +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable @@ -38,7 +38,7 @@ import org.springframework.web.bind.annotation.PostMapping import org.springframework.web.bind.annotation.RequestBody import org.springframework.web.bind.annotation.RequestMapping -@Api(tags = ["PROXY_AUTH"], description = "Proxy认证接口") +@Tag(name = "PROXY_AUTH", description = "Proxy认证接口") @FeignClient(AUTH_SERVICE_NAME, contextId = "ProxyAuthClient") @RequestMapping("/proxy/auth") interface ProxyAuthClient { diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/proxy/ProxyOauthAuthorizationClient.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/proxy/ProxyOauthAuthorizationClient.kt index 83686b9864..39c50e018f 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/proxy/ProxyOauthAuthorizationClient.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/proxy/ProxyOauthAuthorizationClient.kt @@ -30,27 +30,27 @@ package com.tencent.bkrepo.auth.api.proxy import com.tencent.bkrepo.auth.pojo.oauth.OauthToken import com.tencent.bkrepo.common.api.constant.AUTH_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.context.annotation.Primary import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam -@Api(tags = ["PROXY_OAUTHAUTHORIZATION"], description = "Proxy Oauth授权接口") +@Tag(name = "PROXY_OAUTHAUTHORIZATION", description = "Proxy Oauth授权接口") @Primary @FeignClient(AUTH_SERVICE_NAME, contextId = "ProxyOauthAuthorizationClient") @RequestMapping("/proxy/oauth") interface ProxyOauthAuthorizationClient { - @ApiOperation("获取oauth token信息") + @Operation(summary = "获取oauth token信息") @GetMapping("/token") fun getToken( @RequestParam accessToken: String ): Response - @ApiOperation("验证oauth token") + @Operation(summary = "验证oauth token") @GetMapping("/token/validate") fun validateToken( @RequestParam accessToken: String diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/proxy/ProxyPermissionClient.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/proxy/ProxyPermissionClient.kt index e2488c621f..382be24781 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/proxy/ProxyPermissionClient.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/proxy/ProxyPermissionClient.kt @@ -30,19 +30,19 @@ package com.tencent.bkrepo.auth.api.proxy import com.tencent.bkrepo.auth.pojo.permission.CheckPermissionRequest import com.tencent.bkrepo.common.api.constant.AUTH_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.web.bind.annotation.PostMapping import org.springframework.web.bind.annotation.RequestBody import org.springframework.web.bind.annotation.RequestMapping -@Api(tags = ["PROXY_PERMISSION"], description = "Proxy权限接口") +@Tag(name = "PROXY_PERMISSION", description = "Proxy权限接口") @FeignClient(AUTH_SERVICE_NAME, contextId = "ProxyPermissionClient") @RequestMapping("/proxy/permission") interface ProxyPermissionClient { - @ApiOperation("校验权限") + @Operation(summary = "校验权限") @PostMapping("/check") fun checkPermission( @RequestBody request: CheckPermissionRequest diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/proxy/ProxyProxyClient.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/proxy/ProxyProxyClient.kt index 8eecde28c4..2b9b03c22f 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/proxy/ProxyProxyClient.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/proxy/ProxyProxyClient.kt @@ -30,19 +30,19 @@ package com.tencent.bkrepo.auth.api.proxy import com.tencent.bkrepo.auth.pojo.proxy.ProxyInfo import com.tencent.bkrepo.common.api.constant.AUTH_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable import org.springframework.web.bind.annotation.RequestMapping -@Api(tags = ["PROXY_PROXY"], description = "Proxy Proxy接口") +@Tag(name = "PROXY_PROXY", description = "Proxy Proxy接口") @FeignClient(AUTH_SERVICE_NAME, contextId = "ProxyProxyClient") @RequestMapping("/proxy/proxy") interface ProxyProxyClient { - @ApiOperation("查询Proxy信息") + @Operation(summary = "查询Proxy信息") @GetMapping("/info/{projectId}/{name}") fun info( @PathVariable projectId: String, diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/proxy/ProxyTemporaryTokenClient.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/proxy/ProxyTemporaryTokenClient.kt index a1b172fb00..5e1432ac1c 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/proxy/ProxyTemporaryTokenClient.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/proxy/ProxyTemporaryTokenClient.kt @@ -34,21 +34,21 @@ package com.tencent.bkrepo.auth.api.proxy import com.tencent.bkrepo.auth.pojo.token.TemporaryTokenInfo import com.tencent.bkrepo.common.api.constant.AUTH_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.context.annotation.Primary import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable import org.springframework.web.bind.annotation.RequestMapping -@Api("临时token服务接口") +@Tag(name = "临时token服务接口") @Primary @FeignClient(AUTH_SERVICE_NAME, contextId = "ProxyTemporaryTokenClient") @RequestMapping("/proxy/temporary/token") interface ProxyTemporaryTokenClient { - @ApiOperation("查询临时token信息") + @Operation(summary = "查询临时token信息") @GetMapping("/info/{token}") fun getTokenInfo( @PathVariable token: String diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/proxy/ProxyUserClient.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/proxy/ProxyUserClient.kt index 6744840fb0..4a1435bb83 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/proxy/ProxyUserClient.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/api/proxy/ProxyUserClient.kt @@ -31,9 +31,9 @@ import com.tencent.bkrepo.auth.pojo.user.CreateUserRequest import com.tencent.bkrepo.auth.pojo.user.UserInfo import com.tencent.bkrepo.common.api.constant.AUTH_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable @@ -42,27 +42,27 @@ import org.springframework.web.bind.annotation.RequestBody import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam -@Api(tags = ["PROXY_USER"], description = "Proxy用户接口") +@Tag(name = "PROXY_USER", description = "Proxy用户接口") @FeignClient(AUTH_SERVICE_NAME, contextId = "ProxyUserClient") @RequestMapping("/proxy/user") interface ProxyUserClient { - @ApiOperation("用户info") + @Operation(summary = "用户info") @GetMapping("/userinfo/{uid}") fun userInfoById( @PathVariable uid: String ): Response - @ApiOperation("校验用户token") + @Operation(summary = "校验用户token") @PostMapping("/token") fun checkToken( - @ApiParam(value = "用户id") + @Parameter(name = "用户id") @RequestParam uid: String, - @ApiParam(value = "用户token") + @Parameter(name = "用户token") @RequestParam token: String ): Response - @ApiOperation("创建用户") + @Operation(summary = "创建用户") @PostMapping("/create") fun createUser( @RequestBody request: CreateUserRequest diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/Key.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/Key.kt index 683f0e7816..fdbbe88548 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/Key.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/Key.kt @@ -27,18 +27,17 @@ package com.tencent.bkrepo.auth.pojo -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema import java.time.LocalDateTime -@ApiModel("密钥") +@Schema(title = "密钥") data class Key( - @ApiModelProperty("id") + @get:Schema(title = "id") val id: String, - @ApiModelProperty("名称") + @get:Schema(title = "名称") val name: String, - @ApiModelProperty("指纹") + @get:Schema(title = "指纹") val fingerprint: String, - @ApiModelProperty("创建日期") + @get:Schema(title = "创建日期") val createAt: LocalDateTime ) diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/Project.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/Project.kt index ebfeea3349..3e40f349d2 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/Project.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/Project.kt @@ -31,17 +31,17 @@ package com.tencent.bkrepo.auth.pojo -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("项目") + +@Schema(title = "项目") data class Project( - @ApiModelProperty("ID") + @get:Schema(title = "ID") val id: String, - @ApiModelProperty("名称") + @get:Schema(title = "名称") val name: String, - @ApiModelProperty("显示名称") + @get:Schema(title = "显示名称") val displayName: String, - @ApiModelProperty("描述") + @get:Schema(title = "描述") val description: String ) diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/bkiam/BkResult.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/bkiam/BkResult.kt index f009060450..540b97ae90 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/bkiam/BkResult.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/bkiam/BkResult.kt @@ -32,16 +32,16 @@ package com.tencent.bkrepo.auth.pojo.bkiam import com.fasterxml.jackson.annotation.JsonIgnore -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("数据返回包装模型") + +@Schema(title = "数据返回包装模型") data class BkResult( - @ApiModelProperty("状态码", required = true) + @get:Schema(title = "状态码", required = true) val code: Int, - @ApiModelProperty("错误信息", required = false) + @get:Schema(title = "错误信息", required = false) val message: String? = null, - @ApiModelProperty("数据", required = false) + @get:Schema(title = "数据", required = false) val data: T? = null ) { constructor(data: T) : this(0, null, data) diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/externalPermission/CreateExtPermissionRequest.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/externalPermission/CreateExtPermissionRequest.kt index 972beeef30..26530fce49 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/externalPermission/CreateExtPermissionRequest.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/externalPermission/CreateExtPermissionRequest.kt @@ -29,24 +29,24 @@ package com.tencent.bkrepo.auth.pojo.externalPermission import com.tencent.bkrepo.common.metadata.annotation.Sensitive import com.tencent.bkrepo.common.metadata.handler.MaskPartMapValue -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("创建外部权限请求") + +@Schema(title = "创建外部权限请求") data class CreateExtPermissionRequest( - @ApiModelProperty("外部权限回调地址") + @get:Schema(title = "外部权限回调地址") val url: String, - @ApiModelProperty("请求头") + @get:Schema(title = "请求头") @Sensitive(handler = MaskPartMapValue::class) val headers: Map? = emptyMap(), - @ApiModelProperty("项目id") + @get:Schema(title = "项目id") val projectId: String, - @ApiModelProperty("仓库名") + @get:Schema(title = "仓库名") val repoName: String, - @ApiModelProperty("生效接口") + @get:Schema(title = "生效接口") val scope: String, - @ApiModelProperty("平台账号白名单，白名单内不会校验外部权限") + @get:Schema(title = "平台账号白名单，白名单内不会校验外部权限") val platformWhiteList: List? = emptyList(), - @ApiModelProperty("是否启用") + @get:Schema(title = "是否启用") val enabled: Boolean = false ) diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/externalPermission/ExternalPermission.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/externalPermission/ExternalPermission.kt index 33d34cc42f..7f2bc30260 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/externalPermission/ExternalPermission.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/externalPermission/ExternalPermission.kt @@ -27,34 +27,33 @@ package com.tencent.bkrepo.auth.pojo.externalPermission -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema import java.time.LocalDateTime -@ApiModel("外部权限") +@Schema(title = "外部权限") data class ExternalPermission( - @ApiModelProperty("id") + @get:Schema(title = "id") val id: String, - @ApiModelProperty("外部权限回调地址") + @get:Schema(title = "外部权限回调地址") val url: String, - @ApiModelProperty("请求头") + @get:Schema(title = "请求头") val headers: Map? = emptyMap(), - @ApiModelProperty("项目id") + @get:Schema(title = "项目id") val projectId: String, - @ApiModelProperty("仓库名") + @get:Schema(title = "仓库名") val repoName: String, - @ApiModelProperty("生效微服务") + @get:Schema(title = "生效微服务") val scope: String, - @ApiModelProperty("平台账号白名单，白名单内不会校验外部权限") + @get:Schema(title = "平台账号白名单，白名单内不会校验外部权限") val platformWhiteList: List? = emptyList(), - @ApiModelProperty("是否启用") + @get:Schema(title = "是否启用") val enabled: Boolean, - @ApiModelProperty("创建日期") + @get:Schema(title = "创建日期") var createdDate: LocalDateTime, - @ApiModelProperty("创建人") + @get:Schema(title = "创建人") var createdBy: String, - @ApiModelProperty("最后修改日期") + @get:Schema(title = "最后修改日期") var lastModifiedDate: LocalDateTime, - @ApiModelProperty("最后修改人") + @get:Schema(title = "最后修改人") var lastModifiedBy: String ) diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/externalPermission/ListExtPermissionOption.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/externalPermission/ListExtPermissionOption.kt index 401e620ba4..023251ac7a 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/externalPermission/ListExtPermissionOption.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/externalPermission/ListExtPermissionOption.kt @@ -29,23 +29,23 @@ package com.tencent.bkrepo.auth.pojo.externalPermission import com.tencent.bkrepo.common.api.constant.DEFAULT_PAGE_NUMBER import com.tencent.bkrepo.common.api.constant.DEFAULT_PAGE_SIZE -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("外部权限列表选项") + +@Schema(title = "外部权限列表选项") data class ListExtPermissionOption( - @ApiModelProperty("外部权限回调地址") + @get:Schema(title = "外部权限回调地址") val url: String? = null, - @ApiModelProperty("项目id") + @get:Schema(title = "项目id") val projectId: String? = null, - @ApiModelProperty("仓库名") + @get:Schema(title = "仓库名") val repoName: String? = null, - @ApiModelProperty("生效接口范围，支持通配符*") + @get:Schema(title = "生效接口范围，支持通配符*") val scope: String? = null, - @ApiModelProperty("是否启用") + @get:Schema(title = "是否启用") val enabled: Boolean? = null, - @ApiModelProperty("页数") + @get:Schema(title = "页数") val pageNumber: Int = DEFAULT_PAGE_NUMBER, - @ApiModelProperty("页大小") + @get:Schema(title = "页大小") val pageSize: Int = DEFAULT_PAGE_SIZE ) diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/externalPermission/UpdateExtPermissionRequest.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/externalPermission/UpdateExtPermissionRequest.kt index 7875bde5f0..f7fae7a80e 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/externalPermission/UpdateExtPermissionRequest.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/externalPermission/UpdateExtPermissionRequest.kt @@ -29,26 +29,26 @@ package com.tencent.bkrepo.auth.pojo.externalPermission import com.tencent.bkrepo.common.metadata.annotation.Sensitive import com.tencent.bkrepo.common.metadata.handler.MaskPartMapValue -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("更新外部权限请求") + +@Schema(title = "更新外部权限请求") data class UpdateExtPermissionRequest( - @ApiModelProperty("id") + @get:Schema(title = "id") val id: String, - @ApiModelProperty("外部权限回调地址") + @get:Schema(title = "外部权限回调地址") val url: String? = null, - @ApiModelProperty("请求头") + @get:Schema(title = "请求头") @Sensitive(handler = MaskPartMapValue::class) val headers: Map? = null, - @ApiModelProperty("项目id") + @get:Schema(title = "项目id") val projectId: String? = null, - @ApiModelProperty("仓库名") + @get:Schema(title = "仓库名") val repoName: String? = null, - @ApiModelProperty("生效微服务") + @get:Schema(title = "生效微服务") val scope: String? = null, - @ApiModelProperty("平台账号白名单，白名单内不会校验外部权限") + @get:Schema(title = "平台账号白名单，白名单内不会校验外部权限") val platformWhiteList: List? = null, - @ApiModelProperty("是否启用") + @get:Schema(title = "是否启用") val enabled: Boolean? = null ) diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/oauth/IdToken.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/oauth/IdToken.kt index 902267f9ee..bd63179dfe 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/oauth/IdToken.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/oauth/IdToken.kt @@ -28,10 +28,10 @@ package com.tencent.bkrepo.auth.pojo.oauth import com.fasterxml.jackson.annotation.JsonProperty -import io.swagger.annotations.ApiModel +import io.swagger.v3.oas.annotations.media.Schema // https://openid.net/specs/openid-connect-core-1_0.html#IDToken -@ApiModel("OpenId Connect id token") +@Schema(title = "OpenId Connect id token") data class IdToken( val iss: String, val sub: String, diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/permission/CheckPermissionRequest.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/permission/CheckPermissionRequest.kt index a1aabc1545..9273e60b38 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/permission/CheckPermissionRequest.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/permission/CheckPermissionRequest.kt @@ -32,9 +32,9 @@ package com.tencent.bkrepo.auth.pojo.permission import com.tencent.bkrepo.auth.pojo.ResourceBaseRequest -import io.swagger.annotations.ApiModel +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("校验权限请求") +@Schema(title = "校验权限请求") data class CheckPermissionRequest( val uid: String, override var resourceType: String, diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/permission/ListPathResult.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/permission/ListPathResult.kt index 168f8d07dd..9ff4169bc2 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/permission/ListPathResult.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/permission/ListPathResult.kt @@ -31,10 +31,10 @@ package com.tencent.bkrepo.auth.pojo.permission -import io.swagger.annotations.ApiModel import com.tencent.bkrepo.common.query.enums.OperationType +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("校验权限请求") +@Schema(title = "校验权限请求") data class ListPathResult( // when true, need to compare val status: Boolean, diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/proxy/ProxyCreateRequest.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/proxy/ProxyCreateRequest.kt index 116739791e..81c5a19b12 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/proxy/ProxyCreateRequest.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/proxy/ProxyCreateRequest.kt @@ -27,24 +27,23 @@ package com.tencent.bkrepo.auth.pojo.proxy -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema import org.springframework.util.unit.DataSize -@ApiModel("proxy创建请求") +@Schema(title = "proxy创建请求") data class ProxyCreateRequest( - @ApiModelProperty("项目Id") + @get:Schema(title = "项目Id") val projectId: String, - @ApiModelProperty("集群名") + @get:Schema(title = "集群名") val clusterName: String, - @ApiModelProperty("展示名") + @get:Schema(title = "展示名") val displayName: String, - @ApiModelProperty("访问域名") + @get:Schema(title = "访问域名") val domain: String, - @ApiModelProperty("同步限速") + @get:Schema(title = "同步限速") val syncRateLimit: DataSize = DataSize.ofBytes(-1), - @ApiModelProperty("同步时间段") + @get:Schema(title = "同步时间段") val syncTimeRange: String = "0-24", - @ApiModelProperty("缓存过期天数") + @get:Schema(title = "缓存过期天数") val cacheExpireDays: Int = 7, ) diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/proxy/ProxyInfo.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/proxy/ProxyInfo.kt index 6362ade5d3..8f886927ad 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/proxy/ProxyInfo.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/proxy/ProxyInfo.kt @@ -27,29 +27,29 @@ package com.tencent.bkrepo.auth.pojo.proxy -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("Proxy信息") + +@Schema(title = "Proxy信息") data class ProxyInfo( - @ApiModelProperty("名称") + @get:Schema(title = "名称") val name: String, - @ApiModelProperty("展示名") + @get:Schema(title = "展示名") val displayName: String, - @ApiModelProperty("项目Id") + @get:Schema(title = "项目Id") val projectId: String, - @ApiModelProperty("集群名") + @get:Schema(title = "集群名") val clusterName: String, - @ApiModelProperty("访问域名") + @get:Schema(title = "访问域名") val domain: String, - @ApiModelProperty("IP") + @get:Schema(title = "IP") val ip: String, - @ApiModelProperty("状态") + @get:Schema(title = "状态") val status: ProxyStatus, - @ApiModelProperty("同步限速，单位Byte/s") + @get:Schema(title = "同步限速，单位Byte/s") val syncRateLimit: Long, - @ApiModelProperty("同步时间段") + @get:Schema(title = "同步时间段") val syncTimeRange: String, - @ApiModelProperty("缓存过期时间") + @get:Schema(title = "缓存过期时间") val cacheExpireDays: Int ) diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/proxy/ProxyUpdateRequest.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/proxy/ProxyUpdateRequest.kt index 628788c9f2..7e773073eb 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/proxy/ProxyUpdateRequest.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/proxy/ProxyUpdateRequest.kt @@ -27,24 +27,23 @@ package com.tencent.bkrepo.auth.pojo.proxy -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema import org.springframework.util.unit.DataSize -@ApiModel("proxy更新请求") +@Schema(title = "proxy更新请求") data class ProxyUpdateRequest( - @ApiModelProperty("项目Id") + @get:Schema(title = "项目Id") val projectId: String, - @ApiModelProperty("名称") + @get:Schema(title = "名称") val name: String, - @ApiModelProperty("展示名") + @get:Schema(title = "展示名") val displayName: String? = null, - @ApiModelProperty("访问域名") + @get:Schema(title = "访问域名") val domain: String? = null, - @ApiModelProperty("同步限速") + @get:Schema(title = "同步限速") val syncRateLimit: DataSize? = null, - @ApiModelProperty("同步时间段") + @get:Schema(title = "同步时间段") val syncTimeRange: String? = null, - @ApiModelProperty("缓存过期时间") + @get:Schema(title = "缓存过期时间") val cacheExpiredDays: Int? = null, ) diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/token/TemporaryTokenCreateRequest.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/token/TemporaryTokenCreateRequest.kt index 75ecd29abb..7329b2935e 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/token/TemporaryTokenCreateRequest.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/token/TemporaryTokenCreateRequest.kt @@ -31,28 +31,27 @@ package com.tencent.bkrepo.auth.pojo.token -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema import java.time.Duration -@ApiModel("创建临时token请求") +@Schema(title = "创建临时token请求") data class TemporaryTokenCreateRequest( - @ApiModelProperty("项目id") + @get:Schema(title = "项目id") val projectId: String, - @ApiModelProperty("仓库名称") + @get:Schema(title = "仓库名称") val repoName: String, - @ApiModelProperty("授权路径列表") + @get:Schema(title = "授权路径列表") val fullPathSet: Set, - @ApiModelProperty("授权用户") + @get:Schema(title = "授权用户") val authorizedUserSet: Set = emptySet(), - @ApiModelProperty("授权IP") + @get:Schema(title = "授权IP") val authorizedIpSet: Set = emptySet(), - @ApiModelProperty("有效时间，单位秒") + @get:Schema(title = "有效时间，单位秒") val expireSeconds: Long = Duration.ofDays(1).seconds, - @ApiModelProperty("允许访问次数，为空表示无限制") + @get:Schema(title = "允许访问次数，为空表示无限制") val permits: Int? = null, - @ApiModelProperty("token类型") + @get:Schema(title = "token类型") val type: TokenType, - @ApiModelProperty("创建人") + @get:Schema(title = "创建人") val createdBy: String? = null, ) diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/token/TemporaryTokenInfo.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/token/TemporaryTokenInfo.kt index 1bec89a078..cf87d46f12 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/token/TemporaryTokenInfo.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/token/TemporaryTokenInfo.kt @@ -31,29 +31,29 @@ package com.tencent.bkrepo.auth.pojo.token -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("临时token信息") + +@Schema(title = "临时token信息") data class TemporaryTokenInfo( - @ApiModelProperty("项目") + @get:Schema(title = "项目") val projectId: String, - @ApiModelProperty("仓库") + @get:Schema(title = "仓库") val repoName: String, - @ApiModelProperty("授权路径") + @get:Schema(title = "授权路径") val fullPath: String, - @ApiModelProperty("token") + @get:Schema(title = "token") val token: String, - @ApiModelProperty("授权用户") + @get:Schema(title = "授权用户") val authorizedUserList: Set, - @ApiModelProperty("授权IP") + @get:Schema(title = "授权IP") val authorizedIpList: Set, - @ApiModelProperty("过期时间") + @get:Schema(title = "过期时间") val expireDate: String?, - @ApiModelProperty("允许下载次数") + @get:Schema(title = "允许下载次数") val permits: Int?, - @ApiModelProperty("token类型") + @get:Schema(title = "token类型") val type: TokenType, - @ApiModelProperty("创建者") + @get:Schema(title = "创建者") val createdBy: String ) diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/token/Token.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/token/Token.kt index 92b7fb2fcc..6b98ae27fe 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/token/Token.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/token/Token.kt @@ -31,18 +31,17 @@ package com.tencent.bkrepo.auth.pojo.token -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema import java.time.LocalDateTime -@ApiModel("token信息") +@Schema(title = "token信息") data class Token( - @ApiModelProperty("tokenName") + @get:Schema(title = "tokenName") val name: String?, - @ApiModelProperty("tokenID") + @get:Schema(title = "tokenID") val id: String, - @ApiModelProperty("创建时间") + @get:Schema(title = "创建时间") val createdAt: LocalDateTime, - @ApiModelProperty("过期时间") + @get:Schema(title = "过期时间") val expiredAt: LocalDateTime? ) diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/token/TokenResult.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/token/TokenResult.kt index d62a2c82fe..cd736873c6 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/token/TokenResult.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/token/TokenResult.kt @@ -31,16 +31,15 @@ package com.tencent.bkrepo.auth.pojo.token -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema import java.time.LocalDateTime -@ApiModel("token信息") +@Schema(title = "token信息") data class TokenResult( - @ApiModelProperty("tokenName") + @get:Schema(title = "tokenName") val name: String?, - @ApiModelProperty("创建时间") + @get:Schema(title = "创建时间") val createdAt: LocalDateTime, - @ApiModelProperty("过期时间") + @get:Schema(title = "过期时间") val expiredAt: LocalDateTime? ) diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/user/CreateUserRequest.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/user/CreateUserRequest.kt index 338b351d40..76252b1316 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/user/CreateUserRequest.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/user/CreateUserRequest.kt @@ -33,26 +33,26 @@ package com.tencent.bkrepo.auth.pojo.user import com.tencent.bkrepo.common.metadata.annotation.Sensitive import com.tencent.bkrepo.common.metadata.handler.MaskString -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("创建用户请求") + +@Schema(title = "创建用户请求") data class CreateUserRequest( - @ApiModelProperty("用户id") + @get:Schema(title = "用户id") val userId: String, - @ApiModelProperty("用户名") + @get:Schema(title = "用户名") val name: String, - @ApiModelProperty("密码") + @get:Schema(title = "密码") @Sensitive(MaskString::class) var pwd: String? = null, - @ApiModelProperty("管理员") + @get:Schema(title = "管理员") var admin: Boolean = false, - @ApiModelProperty("关联用户") + @get:Schema(title = "关联用户") val asstUsers: List = emptyList(), - @ApiModelProperty("群组账号") + @get:Schema(title = "群组账号") val group: Boolean = false, - @ApiModelProperty("邮箱") + @get:Schema(title = "邮箱") val email: String? = null, - @ApiModelProperty("联系电话") + @get:Schema(title = "联系电话") val phone: String? = null ) diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/user/CreateUserToProjectRequest.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/user/CreateUserToProjectRequest.kt index 9ad57d0bc4..524d00077c 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/user/CreateUserToProjectRequest.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/user/CreateUserToProjectRequest.kt @@ -33,24 +33,24 @@ package com.tencent.bkrepo.auth.pojo.user import com.tencent.bkrepo.common.metadata.annotation.Sensitive import com.tencent.bkrepo.common.metadata.handler.MaskString -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("创建用户到项目管理员请求") + +@Schema(title = "创建用户到项目管理员请求") data class CreateUserToProjectRequest( - @ApiModelProperty("用户id") + @get:Schema(title = "用户id") val userId: String, - @ApiModelProperty("用户名") + @get:Schema(title = "用户名") val name: String, - @ApiModelProperty("密码") + @get:Schema(title = "密码") @Sensitive(MaskString::class) var pwd: String? = null, - @ApiModelProperty("管理员") + @get:Schema(title = "管理员") var admin: Boolean = false, - @ApiModelProperty("关联用户") + @get:Schema(title = "关联用户") val asstUsers: List = emptyList(), - @ApiModelProperty("群组账号") + @get:Schema(title = "群组账号") val group: Boolean = false, - @ApiModelProperty("项目ID") + @get:Schema(title = "项目ID") val projectId: String ) diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/user/User.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/user/User.kt index d556ee506d..d202939369 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/user/User.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/user/User.kt @@ -32,34 +32,33 @@ package com.tencent.bkrepo.auth.pojo.user import com.tencent.bkrepo.auth.pojo.token.Token -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema import java.time.LocalDateTime -@ApiModel("用户信息") +@Schema(title = "用户信息") data class User( - @ApiModelProperty("用户ID") + @get:Schema(title = "用户ID") val userId: String, - @ApiModelProperty("用户名") + @get:Schema(title = "用户名") val name: String, - @ApiModelProperty("用户密码") + @get:Schema(title = "用户密码") var pwd: String? = null, - @ApiModelProperty("是否是管理员") + @get:Schema(title = "是否是管理员") val admin: Boolean = false, - @ApiModelProperty("是否锁定") + @get:Schema(title = "是否锁定") val locked: Boolean = false, - @ApiModelProperty("用户token") + @get:Schema(title = "用户token") val tokens: List = emptyList(), - @ApiModelProperty("所属角色") + @get:Schema(title = "所属角色") val roles: List = emptyList(), - @ApiModelProperty("关联用户") + @get:Schema(title = "关联用户") val asstUsers: List = emptyList(), - @ApiModelProperty("群组账号") + @get:Schema(title = "群组账号") val group: Boolean = false, - @ApiModelProperty("邮箱") + @get:Schema(title = "邮箱") val email: String? = null, - @ApiModelProperty("创建时间") + @get:Schema(title = "创建时间") val createdDate: LocalDateTime? = null, - @ApiModelProperty("最近跟新时间") + @get:Schema(title = "最近跟新时间") val lastModifiedDate: LocalDateTime? = null ) diff --git a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/user/UserInfo.kt b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/user/UserInfo.kt index 2fc6a0f0c3..956e1d7029 100644 --- a/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/user/UserInfo.kt +++ b/src/backend/auth/api-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/user/UserInfo.kt @@ -1,27 +1,26 @@ package com.tencent.bkrepo.auth.pojo.user -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema import java.time.LocalDateTime -@ApiModel("分页用户信息") +@Schema(title = "分页用户信息") data class UserInfo( - @ApiModelProperty("用户ID") + @get:Schema(title = "用户ID") val userId: String, - @ApiModelProperty("用户名") + @get:Schema(title = "用户名") val name: String, - @ApiModelProperty("邮箱") + @get:Schema(title = "邮箱") val email: String?, - @ApiModelProperty("联系电话") + @get:Schema(title = "联系电话") val phone: String?, - @ApiModelProperty("用户名") + @get:Schema(title = "用户名") val createdDate: LocalDateTime?, - @ApiModelProperty("用户名") + @get:Schema(title = "用户名") val locked: Boolean, - @ApiModelProperty("是否管理员") + @get:Schema(title = "是否管理员") val admin: Boolean, - @ApiModelProperty("是否为虚拟用户") + @get:Schema(title = "是否为虚拟用户") val group: Boolean, - @ApiModelProperty("关联用户") + @get:Schema(title = "关联用户") val asstUsers: List = emptyList() ) diff --git a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/UserBkiamv3AuthController.kt b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/UserBkiamv3AuthController.kt index f363385197..9f7ec8ed34 100644 --- a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/UserBkiamv3AuthController.kt +++ b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/UserBkiamv3AuthController.kt @@ -36,7 +36,7 @@ import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.common.security.permission.Principal import com.tencent.bkrepo.common.security.permission.PrincipalType import com.tencent.bkrepo.common.service.util.ResponseBuilder -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation import org.springframework.beans.factory.annotation.Autowired import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping @@ -54,7 +54,7 @@ class UserBkiamv3AuthController { @Autowired private var bkIamV3Service: BkIamV3Service? = null - @ApiOperation("生成无权限申请url") + @Operation(summary = "生成无权限申请url") @PostMapping("/bkiamv3/permission/url") fun queryProject( @RequestBody request: CheckPermissionRequest @@ -69,7 +69,7 @@ class UserBkiamv3AuthController { return ResponseBuilder.success(result) } - @ApiOperation("判断蓝鲸权限是否开启") + @Operation(summary = "判断蓝鲸权限是否开启") @GetMapping("/bkiamv3/status") fun bkiamv3Status(): Response { val result = bkIamV3Service?.let { @@ -78,7 +78,7 @@ class UserBkiamv3AuthController { return ResponseBuilder.success(result) } - @ApiOperation("在权限中心生成对应项目以及其下所有仓库的管理权限") + @Operation(summary = "在权限中心生成对应项目以及其下所有仓库的管理权限") @PostMapping("/bkiamv3/project/refresh/{projectId}") @Principal(PrincipalType.ADMIN) fun refreshProject( @@ -91,7 +91,7 @@ class UserBkiamv3AuthController { return ResponseBuilder.success(result) } - @ApiOperation("删除生成的管理员空间") + @Operation(summary = "删除生成的管理员空间") @DeleteMapping("/bkiamv3/manager/delete") @Principal(PrincipalType.ADMIN) fun deleteProjectManager( diff --git a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/service/ServiceUserController.kt b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/service/ServiceUserController.kt index 1b2fff4ff2..c778daeb95 100644 --- a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/service/ServiceUserController.kt +++ b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/service/ServiceUserController.kt @@ -41,7 +41,7 @@ import com.tencent.bkrepo.auth.service.UserService import com.tencent.bkrepo.auth.util.RequestUtil import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.common.service.util.ResponseBuilder -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation import org.springframework.beans.factory.annotation.Autowired import org.springframework.web.bind.annotation.PostMapping import org.springframework.web.bind.annotation.RestController @@ -57,7 +57,7 @@ class ServiceUserController @Autowired constructor( return ResponseBuilder.success(true) } - @ApiOperation("创建项目用户") + @Operation(summary = "创建项目用户") @PostMapping("/create/project") override fun createUserToProject(request: CreateUserToProjectRequest): Response { userService.createUserToProject(request) diff --git a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/user/AccountController.kt b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/user/AccountController.kt index 5086da0653..5a3ba09855 100644 --- a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/user/AccountController.kt +++ b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/user/AccountController.kt @@ -32,20 +32,20 @@ package com.tencent.bkrepo.auth.controller.user import com.tencent.bkrepo.auth.constant.AUTH_API_ACCOUNT_PREFIX +import com.tencent.bkrepo.auth.controller.OpenResource import com.tencent.bkrepo.auth.pojo.account.Account import com.tencent.bkrepo.auth.pojo.account.CreateAccountRequest import com.tencent.bkrepo.auth.pojo.account.UpdateAccountRequest import com.tencent.bkrepo.auth.pojo.enums.CredentialStatus import com.tencent.bkrepo.auth.pojo.oauth.AuthorizationGrantType import com.tencent.bkrepo.auth.pojo.token.CredentialSet -import com.tencent.bkrepo.auth.controller.OpenResource import com.tencent.bkrepo.auth.service.AccountService import com.tencent.bkrepo.auth.service.PermissionService import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.common.metadata.annotation.LogOperate import com.tencent.bkrepo.common.security.util.SecurityUtils import com.tencent.bkrepo.common.service.util.ResponseBuilder -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation import org.springframework.beans.factory.annotation.Autowired import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping @@ -64,7 +64,7 @@ class AccountController @Autowired constructor( permissionService: PermissionService ) : OpenResource(permissionService) { - @ApiOperation("查询所有账号") + @Operation(summary = "查询所有账号") @GetMapping("/list") @LogOperate(type = "ACCOUNT_LIST") fun listAccount(): Response> { @@ -74,7 +74,7 @@ class AccountController @Autowired constructor( return ResponseBuilder.success(accountList) } - @ApiOperation("查询拥有的账号") + @Operation(summary = "查询拥有的账号") @GetMapping("/own/list") fun listOwnAccount(): Response> { preCheckPlatformPermission() @@ -82,7 +82,7 @@ class AccountController @Autowired constructor( return ResponseBuilder.success(accountService.listOwnAccount(userId)) } - @ApiOperation("查询已授权账号") + @Operation(summary = "查询已授权账号") @GetMapping("/authorized/list") @PutMapping("/update") fun listAuthorizedAccount(): Response> { @@ -91,7 +91,7 @@ class AccountController @Autowired constructor( return ResponseBuilder.success(accountService.listAuthorizedAccount(userId)) } - @ApiOperation("根据appId查询账号") + @Operation(summary = "根据appId查询账号") @GetMapping("/detail/{appId}") fun getAccountDetail(@PathVariable appId: String): Response { preCheckPlatformPermission() @@ -99,7 +99,7 @@ class AccountController @Autowired constructor( return ResponseBuilder.success(accountService.findAccountByAppId(appId, userId)) } - @ApiOperation("创建账号") + @Operation(summary = "创建账号") @PostMapping("/create") @LogOperate(type = "ACCOUNT_CREATE") fun createAccount(@RequestBody request: CreateAccountRequest): Response { @@ -109,7 +109,7 @@ class AccountController @Autowired constructor( return ResponseBuilder.success(accountService.createAccount(request, owner)) } - @ApiOperation("更新账号") + @Operation(summary = "更新账号") @PutMapping("/update") @LogOperate(type = "ACCOUNT_UPDATE") fun updateAccount(@RequestBody request: UpdateAccountRequest): Response { @@ -120,7 +120,7 @@ class AccountController @Autowired constructor( return ResponseBuilder.success(true) } - @ApiOperation("删除账号") + @Operation(summary = "删除账号") @DeleteMapping("/delete/{appId}") @LogOperate(type = "ACCOUNT_DELETE") fun deleteAccount(@PathVariable appId: String): Response { @@ -130,7 +130,7 @@ class AccountController @Autowired constructor( return ResponseBuilder.success(true) } - @ApiOperation("卸载账号") + @Operation(summary = "卸载账号") @DeleteMapping("/uninstall/{appId}") fun uninstallAccount(@PathVariable appId: String): Response { preCheckPlatformPermission() @@ -139,7 +139,7 @@ class AccountController @Autowired constructor( return ResponseBuilder.success(true) } - @ApiOperation("获取账户下的ak/sk对") + @Operation(summary = "获取账户下的ak/sk对") @GetMapping("/credential/list/{appId}") fun getCredential(@PathVariable appId: String): Response> { preCheckPlatformPermission() @@ -148,7 +148,7 @@ class AccountController @Autowired constructor( return ResponseBuilder.success(credential) } - @ApiOperation("创建ak/sk对") + @Operation(summary = "创建ak/sk对") @PostMapping("/credential/{appId}") @LogOperate(type = "KEYS_CREATE") fun createCredential( @@ -161,7 +161,7 @@ class AccountController @Autowired constructor( return ResponseBuilder.success(result) } - @ApiOperation("删除ak/sk对") + @Operation(summary = "删除ak/sk对") @DeleteMapping("/credential/{appId}/{accesskey}") @LogOperate(type = "KEYS_DELETE") fun deleteCredential(@PathVariable appId: String, @PathVariable accesskey: String): Response { @@ -171,7 +171,7 @@ class AccountController @Autowired constructor( return ResponseBuilder.success(result) } - @ApiOperation("更新ak/sk对状态") + @Operation(summary = "更新ak/sk对状态") @PutMapping("/credential/{appId}/{accesskey}/{status}") @LogOperate(type = "KEYS_UPDATE") fun updateCredential( @@ -185,7 +185,7 @@ class AccountController @Autowired constructor( return ResponseBuilder.success(true) } - @ApiOperation("校验ak/sk") + @Operation(summary = "校验ak/sk") @GetMapping("/credential/{accesskey}/{secretkey}") fun checkCredential(@PathVariable accesskey: String, @PathVariable secretkey: String): Response { preCheckPlatformPermission() diff --git a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/user/AuthProxyController.kt b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/user/AuthProxyController.kt index ceaf590ffc..8bf6f8d2c1 100644 --- a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/user/AuthProxyController.kt +++ b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/user/AuthProxyController.kt @@ -35,8 +35,8 @@ import com.tencent.bkrepo.auth.service.ProxyService import com.tencent.bkrepo.common.api.pojo.Page import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.common.service.util.ResponseBuilder -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable @@ -45,20 +45,20 @@ import org.springframework.web.bind.annotation.RequestBody import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RestController -@Api("Proxy管理接口") +@Tag(name = "Proxy管理接口") @RestController @RequestMapping("/api/proxy") class AuthProxyController( private val proxyService: ProxyService ) { - @ApiOperation("创建Proxy") + @Operation(summary = "创建Proxy") @PostMapping("/create") fun create(@RequestBody request: ProxyCreateRequest): Response { return ResponseBuilder.success(proxyService.create(request)) } - @ApiOperation("查询Proxy信息") + @Operation(summary = "查询Proxy信息") @GetMapping("/info/{projectId}/{name}") fun info( @PathVariable projectId: String, @@ -67,7 +67,7 @@ class AuthProxyController( return ResponseBuilder.success(proxyService.getInfo(projectId, name)) } - @ApiOperation("分页查询Proxy信息") + @Operation(summary = "分页查询Proxy信息") @GetMapping("/page/info/{projectId}") fun page( @PathVariable projectId: String, @@ -76,13 +76,13 @@ class AuthProxyController( return ResponseBuilder.success(proxyService.page(projectId, proxyListOption)) } - @ApiOperation("更新Proxy") + @Operation(summary = "更新Proxy") @PostMapping("/update") fun update(@RequestBody request: ProxyUpdateRequest): Response { return ResponseBuilder.success(proxyService.update(request)) } - @ApiOperation("删除Proxy") + @Operation(summary = "删除Proxy") @DeleteMapping("/delete/{projectId}/{name}") fun delete( @PathVariable projectId: String, diff --git a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/user/BkiamCallbackController.kt b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/user/BkiamCallbackController.kt index d878d9c6a6..9fd8a2b7d8 100644 --- a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/user/BkiamCallbackController.kt +++ b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/user/BkiamCallbackController.kt @@ -36,8 +36,8 @@ import com.tencent.bk.sdk.iam.dto.callback.response.CallbackBaseResponseDTO import com.tencent.bkrepo.auth.condition.MultipleAuthCondition import com.tencent.bkrepo.auth.pojo.bkiam.BkResult import com.tencent.bkrepo.auth.service.bkiamv3.callback.BkiamCallbackService -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter import org.springframework.beans.factory.annotation.Autowired import org.springframework.context.annotation.Conditional import org.springframework.web.bind.annotation.GetMapping @@ -52,43 +52,43 @@ import org.springframework.web.bind.annotation.RestController @Conditional(MultipleAuthCondition::class) class BkiamCallbackController @Autowired constructor(private val bkiamCallbackService: BkiamCallbackService) { - @ApiOperation("项目列表") + @Operation(summary = "项目列表") @PostMapping("/project") fun queryProject( @RequestHeader("Authorization") - @ApiParam("token") + @Parameter(name = "token") token: String, - @ApiParam("回调信息") + @Parameter(name = "回调信息") @RequestBody request: CallbackRequestDTO ): CallbackBaseResponseDTO? { return bkiamCallbackService.queryProject(token, request) } - @ApiOperation("仓库列表") + @Operation(summary = "仓库列表") @PostMapping("/repo") fun queryRepo( @RequestHeader("Authorization") - @ApiParam("token") + @Parameter(name = "token") token: String, - @ApiParam("回调信息") + @Parameter(name = "回调信息") @RequestBody request: CallbackRequestDTO ): CallbackBaseResponseDTO? { return bkiamCallbackService.queryRepo(token, request) } - @ApiOperation("节点列表") + @Operation(summary = "节点列表") @PostMapping("/node") fun queryNode( @RequestHeader("Authorization") - @ApiParam("token") + @Parameter(name = "token") token: String, - @ApiParam("回调信息") + @Parameter(name = "回调信息") @RequestBody request: CallbackRequestDTO ): CallbackBaseResponseDTO? { return bkiamCallbackService.queryNode(token, request) } - @ApiOperation("健康检查") + @Operation(summary = "健康检查") @GetMapping("/health") fun health(): BkResult { return BkResult(true) diff --git a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/user/ExternalPermissionController.kt b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/user/ExternalPermissionController.kt index 473889a427..cff2c3f261 100644 --- a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/user/ExternalPermissionController.kt +++ b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/user/ExternalPermissionController.kt @@ -37,8 +37,8 @@ import com.tencent.bkrepo.common.api.pojo.Page import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.common.metadata.annotation.LogOperate import com.tencent.bkrepo.common.service.util.ResponseBuilder -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable @@ -48,14 +48,14 @@ import org.springframework.web.bind.annotation.RequestBody import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RestController -@Api("用户-外部权限接口") +@Tag(name = "用户-外部权限接口") @RestController @RequestMapping(AUTH_API_EXT_PERMISSION_PREFIX) class ExternalPermissionController( private val externalPermissionService: ExternalPermissionService ) { - @ApiOperation("创建外部权限") + @Operation(summary = "创建外部权限") @PostMapping @LogOperate(type = "EXT_PERMISSION_CREAT", desensitize = true) fun createExtPermission( @@ -65,7 +65,7 @@ class ExternalPermissionController( return ResponseBuilder.success() } - @ApiOperation("更新外部权限") + @Operation(summary = "更新外部权限") @PutMapping @LogOperate(type = "EXT_PERMISSION_UPDATE", desensitize = true) fun updateExtPermission( @@ -75,7 +75,7 @@ class ExternalPermissionController( return ResponseBuilder.success() } - @ApiOperation("删除外部权限") + @Operation(summary = "删除外部权限") @DeleteMapping("/{id}") @LogOperate(type = "EXT_PERMISSION_DELETE") fun deleteExtPermission( @@ -85,7 +85,7 @@ class ExternalPermissionController( return ResponseBuilder.success() } - @ApiOperation("分页查询外部权限") + @Operation(summary = "分页查询外部权限") @GetMapping @LogOperate(type = "EXT_PERMISSION_LIST") fun listExtPermissionPage( diff --git a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/user/OauthAuthorizationController.kt b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/user/OauthAuthorizationController.kt index 18c3f5f59c..567a74ff1a 100644 --- a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/user/OauthAuthorizationController.kt +++ b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/user/OauthAuthorizationController.kt @@ -38,7 +38,7 @@ import com.tencent.bkrepo.auth.pojo.oauth.UserInfo import com.tencent.bkrepo.auth.service.OauthAuthorizationService import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.common.service.util.ResponseBuilder -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation import org.springframework.beans.factory.annotation.Autowired import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping @@ -54,7 +54,7 @@ class OauthAuthorizationController @Autowired constructor( private val oauthAuthorizationService: OauthAuthorizationService ) { - @ApiOperation("用户确认Oauth授权") + @Operation(summary = "用户确认Oauth授权") @GetMapping("/authorize") fun authorize( @RequestParam("client_id") clientId: String, @@ -76,13 +76,13 @@ class OauthAuthorizationController @Autowired constructor( return ResponseBuilder.success(authorizedResult) } - @ApiOperation("获取oauth token信息") + @Operation(summary = "获取oauth token信息") @GetMapping("/token") fun getToken(accessToken: String): Response { return ResponseBuilder.success(oauthAuthorizationService.getToken(accessToken)) } - @ApiOperation("创建或刷新oauth token") + @Operation(summary = "创建或刷新oauth token") @PostMapping("/{projectId}/token") fun generateToken( code: String?, @@ -101,32 +101,32 @@ class OauthAuthorizationController @Autowired constructor( } } - @ApiOperation("删除oauth token") + @Operation(summary = "删除oauth token") @DeleteMapping("/token") fun deleteToken(clientId: String, clientSecret: String, accessToken: String): Response { oauthAuthorizationService.deleteToken(clientId, clientSecret, accessToken) return ResponseBuilder.success() } - @ApiOperation("验证oauth token") + @Operation(summary = "验证oauth token") @GetMapping("/token/validate") fun validateToken(accessToken: String): Response { return ResponseBuilder.success(oauthAuthorizationService.validateToken(accessToken)) } - @ApiOperation("用户信息") + @Operation(summary = "用户信息") @GetMapping("/{projectId}/userInfo") fun userInfo(): UserInfo { return oauthAuthorizationService.getUserInfo() } - @ApiOperation("OpenId Connect配置") + @Operation(summary = "OpenId Connect配置") @GetMapping("/{projectId}/.well-known/openid-configuration") fun configuration(@PathVariable projectId: String): OidcConfiguration { return oauthAuthorizationService.getOidcConfiguration(projectId) } - @ApiOperation("Json web key set") + @Operation(summary = "Json web key set") @GetMapping("/{projectId}/.well-known/jwks.json") fun jwks(): JsonWebKeySet { return oauthAuthorizationService.getJwks() diff --git a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/user/PermissionController.kt b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/user/PermissionController.kt index 3cb8e5851c..002e73fe65 100644 --- a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/user/PermissionController.kt +++ b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/user/PermissionController.kt @@ -32,21 +32,21 @@ package com.tencent.bkrepo.auth.controller.user import com.tencent.bkrepo.auth.constant.AUTH_API_PERMISSION_PREFIX +import com.tencent.bkrepo.auth.controller.OpenResource +import com.tencent.bkrepo.auth.pojo.enums.AuthPermissionType import com.tencent.bkrepo.auth.pojo.permission.CheckPermissionRequest import com.tencent.bkrepo.auth.pojo.permission.CreatePermissionRequest import com.tencent.bkrepo.auth.pojo.permission.Permission +import com.tencent.bkrepo.auth.pojo.permission.UpdatePermissionDeployInRepoRequest import com.tencent.bkrepo.auth.pojo.permission.UpdatePermissionRepoRequest import com.tencent.bkrepo.auth.pojo.permission.UpdatePermissionUserRequest -import com.tencent.bkrepo.auth.controller.OpenResource -import com.tencent.bkrepo.auth.pojo.enums.AuthPermissionType -import com.tencent.bkrepo.auth.pojo.permission.UpdatePermissionDeployInRepoRequest import com.tencent.bkrepo.auth.pojo.role.ExternalRoleResult import com.tencent.bkrepo.auth.pojo.role.RoleSource import com.tencent.bkrepo.auth.service.PermissionService import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.common.security.util.SecurityUtils import com.tencent.bkrepo.common.service.util.ResponseBuilder -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation import org.springframework.beans.factory.annotation.Autowired import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping @@ -64,7 +64,7 @@ class PermissionController @Autowired constructor( private val permissionService: PermissionService, ) : OpenResource(permissionService) { - @ApiOperation("创建权限") + @Operation(summary = "创建权限") @PostMapping("/create") fun createPermission(@RequestBody request: CreatePermissionRequest): Response { // todo check request @@ -76,14 +76,14 @@ class PermissionController @Autowired constructor( return ResponseBuilder.success(permissionService.createPermission(request)) } - @ApiOperation("校验权限") + @Operation(summary = "校验权限") @PostMapping("/check") fun checkPermission(@RequestBody request: CheckPermissionRequest): Response { checkRequest(request) return ResponseBuilder.success(permissionService.checkPermission(request)) } - @ApiOperation("list有权限仓库仓库") + @Operation(summary = "list有权限仓库仓库") @GetMapping("/repo/list") fun listPermissionRepo( @RequestParam projectId: String, @@ -94,14 +94,14 @@ class PermissionController @Autowired constructor( return ResponseBuilder.success(permissionService.listPermissionRepo(projectId, userId, appId)) } - @ApiOperation("list有权限项目") + @Operation(summary = "list有权限项目") @GetMapping("/project/list") fun listPermissionProject(@RequestParam userId: String): Response> { preCheckContextUser(userId) return ResponseBuilder.success(permissionService.listPermissionProject(userId)) } - @ApiOperation("权限列表") + @Operation(summary = "权限列表") @GetMapping("/list") fun listPermission( @RequestParam projectId: String, @@ -112,7 +112,7 @@ class PermissionController @Autowired constructor( return ResponseBuilder.success(permissionService.listPermission(projectId, repoName, resourceType)) } - @ApiOperation("获取仓库内置权限列表") + @Operation(summary = "获取仓库内置权限列表") @GetMapping("/list/inrepo") fun listRepoBuiltinPermission( @RequestParam projectId: String, @@ -122,7 +122,7 @@ class PermissionController @Autowired constructor( return ResponseBuilder.success(permissionService.listBuiltinPermission(projectId, repoName)) } - @ApiOperation("删除权限") + @Operation(summary = "删除权限") @DeleteMapping("/delete/{id}") fun deletePermission(@PathVariable id: String): Response { val permission = permissionService.getPermission(id) ?: return ResponseBuilder.success(false) @@ -134,14 +134,14 @@ class PermissionController @Autowired constructor( return ResponseBuilder.success(permissionService.deletePermission(id)) } - @ApiOperation("更新权限权限绑定repo") + @Operation(summary = "更新权限权限绑定repo") @PutMapping("/repo") fun updatePermissionRepo(@RequestBody request: UpdatePermissionRepoRequest): Response { preCheckUserAdmin() return ResponseBuilder.success(permissionService.updateRepoPermission(request)) } - @ApiOperation("更新权限绑定用户") + @Operation(summary = "更新权限绑定用户") @PutMapping("/user") fun updatePermissionUser(@RequestBody request: UpdatePermissionUserRequest): Response { if (request.projectId != null) { @@ -152,7 +152,7 @@ class PermissionController @Autowired constructor( return ResponseBuilder.success(permissionService.updatePermissionUser(request)) } - @ApiOperation("获取项目内置权限列表") + @Operation(summary = "获取项目内置权限列表") @GetMapping("/list/inproject") fun listProjectBuiltinPermission( @RequestParam projectId: String @@ -161,7 +161,7 @@ class PermissionController @Autowired constructor( return ResponseBuilder.success(permissionService.listProjectBuiltinPermission(projectId)) } - @ApiOperation("更新配置权限") + @Operation(summary = "更新配置权限") @PutMapping("/update/config") fun updatePermissionDeployInRepo( @RequestBody request: UpdatePermissionDeployInRepoRequest @@ -170,13 +170,13 @@ class PermissionController @Autowired constructor( return ResponseBuilder.success(permissionService.updatePermissionDeployInRepo(request)) } - @ApiOperation("查询是否限制权限配置页，用于前端展示") + @Operation(summary = "查询是否限制权限配置页，用于前端展示") @GetMapping("/permission/available") fun getRepoPermissionEnabled(): Response { return ResponseBuilder.success(permissionService.getPathCheckConfig()) } - @ApiOperation("创建或查询私有目录") + @Operation(summary = "创建或查询私有目录") @PostMapping("/personal/path") fun getOrCreatePersonalPath( @RequestParam projectId: String, @@ -187,7 +187,7 @@ class PermissionController @Autowired constructor( return ResponseBuilder.success(permissionService.getOrCreatePersonalPath(projectId, repoName, userId)) } - @ApiOperation("查询外部用户组") + @Operation(summary = "查询外部用户组") @GetMapping("/external/group/{projectId}/{source}") fun getExternalRole( @PathVariable projectId: String, @@ -196,4 +196,4 @@ class PermissionController @Autowired constructor( preCheckProjectAdmin(projectId) return ResponseBuilder.success(permissionService.listExternalRoleByProject(projectId, source)) } -} \ No newline at end of file +} diff --git a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/user/RoleController.kt b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/user/RoleController.kt index 60ea7c5f05..ba9b312468 100644 --- a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/user/RoleController.kt +++ b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/user/RoleController.kt @@ -43,7 +43,7 @@ import com.tencent.bkrepo.auth.util.RequestUtil.buildProjectAdminRequest import com.tencent.bkrepo.auth.util.RequestUtil.buildRepoAdminRequest import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.common.service.util.ResponseBuilder -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation import org.springframework.beans.factory.annotation.Autowired import org.springframework.transaction.annotation.Transactional import org.springframework.web.bind.annotation.DeleteMapping @@ -62,7 +62,7 @@ class RoleController @Autowired constructor( permissionService: PermissionService ) : OpenResource(permissionService) { - @ApiOperation("创建角色") + @Operation(summary = "创建角色") @PostMapping("/create") fun createRole(@RequestBody request: CreateRoleRequest): Response { preCheckProjectAdmin(request.projectId) @@ -70,7 +70,7 @@ class RoleController @Autowired constructor( return ResponseBuilder.success(id) } - @ApiOperation("创建项目管理员") + @Operation(summary = "创建项目管理员") @PostMapping("/create/project/manage/{projectId}") fun createProjectManage(@PathVariable projectId: String): Response { preCheckProjectAdmin(projectId) @@ -79,7 +79,7 @@ class RoleController @Autowired constructor( return ResponseBuilder.success(id) } - @ApiOperation("创建仓库管理员") + @Operation(summary = "创建仓库管理员") @PostMapping("/create/repo/manage/{projectId}/{repoName}") fun createRepoManage(@PathVariable projectId: String, @PathVariable repoName: String): Response { preCheckProjectAdmin(projectId) @@ -88,7 +88,7 @@ class RoleController @Autowired constructor( return ResponseBuilder.success(id) } - @ApiOperation("删除角色") + @Operation(summary = "删除角色") @DeleteMapping("/delete/{id}") fun deleteRole(@PathVariable id: String): Response { val role = roleService.detail(id) ?: return ResponseBuilder.success(false) @@ -97,7 +97,7 @@ class RoleController @Autowired constructor( return ResponseBuilder.success(true) } - @ApiOperation("根据主键id查询角色详情") + @Operation(summary = "根据主键id查询角色详情") @GetMapping("/detail/{id}") fun detail(@PathVariable id: String): Response { val role = roleService.detail(id) ?: return ResponseBuilder.success(null) @@ -105,7 +105,7 @@ class RoleController @Autowired constructor( return ResponseBuilder.success(role) } - @ApiOperation("根据角色ID与项目Id查询角色") + @Operation(summary = "根据角色ID与项目Id查询角色") @GetMapping("/detail/{rid}/{projectId}") fun detailByProject(@PathVariable rid: String, @PathVariable projectId: String): Response { preCheckProjectAdmin(projectId) @@ -113,7 +113,7 @@ class RoleController @Autowired constructor( return ResponseBuilder.success(result) } - @ApiOperation("根据角色ID与项目Id,仓库名查询角色") + @Operation(summary = "根据角色ID与项目Id,仓库名查询角色") @GetMapping("/detail/{rid}/{projectId}/{repoName}") fun detailByProjectAndRepo( @PathVariable rid: String, @@ -125,7 +125,7 @@ class RoleController @Autowired constructor( return ResponseBuilder.success(result) } - @ApiOperation("查询用户组下用户列表") + @Operation(summary = "查询用户组下用户列表") @GetMapping("/users/{id}") fun listUserByRole(@PathVariable id: String): Response> { val role = roleService.detail(id) ?: return ResponseBuilder.success(emptySet()) @@ -133,7 +133,7 @@ class RoleController @Autowired constructor( return ResponseBuilder.success(roleService.listUserByRoleId(id)) } - @ApiOperation("编辑用户组信息") + @Operation(summary = "编辑用户组信息") @PutMapping("/update/info/{id}") @Transactional(rollbackFor = [Exception::class]) fun updateRoleInfo( diff --git a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/user/UserController.kt b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/user/UserController.kt index 1cf3636899..7182127764 100644 --- a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/user/UserController.kt +++ b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/controller/user/UserController.kt @@ -33,6 +33,7 @@ package com.tencent.bkrepo.auth.controller.user import com.tencent.bkrepo.auth.constant.AUTH_API_USER_PREFIX import com.tencent.bkrepo.auth.constant.BKREPO_TICKET +import com.tencent.bkrepo.auth.controller.OpenResource import com.tencent.bkrepo.auth.message.AuthMessageCode import com.tencent.bkrepo.auth.pojo.enums.AuthPermissionType import com.tencent.bkrepo.auth.pojo.token.Token @@ -44,7 +45,6 @@ import com.tencent.bkrepo.auth.pojo.user.UpdateUserRequest import com.tencent.bkrepo.auth.pojo.user.User import com.tencent.bkrepo.auth.pojo.user.UserInfo import com.tencent.bkrepo.auth.pojo.user.UserResult -import com.tencent.bkrepo.auth.controller.OpenResource import com.tencent.bkrepo.auth.service.PermissionService import com.tencent.bkrepo.auth.service.RoleService import com.tencent.bkrepo.auth.service.UserService @@ -60,7 +60,7 @@ import com.tencent.bkrepo.common.security.util.RsaUtils import com.tencent.bkrepo.common.security.util.SecurityUtils import com.tencent.bkrepo.common.service.util.HttpContextHolder import com.tencent.bkrepo.common.service.util.ResponseBuilder -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation import org.bouncycastle.crypto.CryptoException import org.slf4j.LoggerFactory import org.springframework.beans.factory.annotation.Autowired @@ -88,7 +88,7 @@ class UserController @Autowired constructor( private val signingKey = JwtUtils.createSigningKey(jwtProperties.secretKey) - @ApiOperation("创建用户") + @Operation(summary = "创建用户") @PostMapping("/create") fun createUser(@RequestBody request: CreateUserRequest): Response { preCheckUserAdmin() @@ -98,7 +98,7 @@ class UserController @Autowired constructor( return ResponseBuilder.success(true) } - @ApiOperation("创建项目用户") + @Operation(summary = "创建项目用户") @PostMapping("/create/project") fun createUserToProject(@RequestBody request: CreateUserToProjectRequest): Response { // 限制创建为admin用户 @@ -111,7 +111,7 @@ class UserController @Autowired constructor( return ResponseBuilder.success(true) } - @ApiOperation("创建仓库用户") + @Operation(summary = "创建仓库用户") @PostMapping("/create/repo") fun createUserToRepo(@RequestBody request: CreateUserToRepoRequest): Response { // 限制创建为admin用户 @@ -124,7 +124,7 @@ class UserController @Autowired constructor( return ResponseBuilder.success(true) } - @ApiOperation("用户列表") + @Operation(summary = "用户列表") @GetMapping("/list") fun listUser(@RequestBody rids: List?): Response> { if (rids != null && rids.isNotEmpty()) { @@ -136,7 +136,7 @@ class UserController @Autowired constructor( return ResponseBuilder.success(result) } - @ApiOperation("删除用户") + @Operation(summary = "删除用户") @DeleteMapping("/delete/{uid}") fun deleteById(@PathVariable uid: String): Response { preCheckUserOrAssetUser(uid, userService.getRelatedUserById(SecurityUtils.getUserId())) @@ -144,14 +144,14 @@ class UserController @Autowired constructor( return ResponseBuilder.success(true) } - @ApiOperation("用户详情") + @Operation(summary = "用户详情") @GetMapping("/detail/{uid}") fun detail(@PathVariable uid: String): Response { preCheckContextUser(uid) return ResponseBuilder.success(userService.getUserById(uid)) } - @ApiOperation("更新用户信息") + @Operation(summary = "更新用户信息") @PutMapping("/update/info/{uid}") fun updateUserInfoById(@PathVariable uid: String, @RequestBody request: UpdateUserRequest): Response { preCheckContextUser(uid) @@ -163,7 +163,7 @@ class UserController @Autowired constructor( return ResponseBuilder.success(true) } - @ApiOperation("新增用户所属角色") + @Operation(summary = "新增用户所属角色") @PostMapping("/role/{uid}/{rid}") fun addUserRole(@PathVariable uid: String, @PathVariable rid: String): Response { preCheckContextUser(uid) @@ -171,7 +171,7 @@ class UserController @Autowired constructor( return ResponseBuilder.success(result) } - @ApiOperation("删除用户所属角色") + @Operation(summary = "删除用户所属角色") @DeleteMapping("/role/{uid}/{rid}") fun removeUserRole(@PathVariable uid: String, @PathVariable rid: String): Response { preCheckContextUser(uid) @@ -179,7 +179,7 @@ class UserController @Autowired constructor( return ResponseBuilder.success(result) } - @ApiOperation("批量新增用户所属角色") + @Operation(summary = "批量新增用户所属角色") @PatchMapping("/role/add/{rid}") fun addUserRoleBatch(@PathVariable rid: String, @RequestBody request: List): Response { preCheckUserAdmin() @@ -187,7 +187,7 @@ class UserController @Autowired constructor( return ResponseBuilder.success(true) } - @ApiOperation("批量删除用户所属角色") + @Operation(summary = "批量删除用户所属角色") @PatchMapping("/role/delete/{rid}") fun deleteUserRoleBatch(@PathVariable rid: String, @RequestBody request: List): Response { preCheckUserAdmin() @@ -195,7 +195,7 @@ class UserController @Autowired constructor( return ResponseBuilder.success(true) } - @ApiOperation("新加用户token") + @Operation(summary = "新加用户token") @PostMapping("/token/{uid}/{name}") fun addUserToken( @PathVariable("uid") uid: String, @@ -209,7 +209,7 @@ class UserController @Autowired constructor( return ResponseBuilder.success(result) } - @ApiOperation("查询用户token列表") + @Operation(summary = "查询用户token列表") @GetMapping("/list/token/{uid}") fun listUserToken(@PathVariable("uid") uid: String): Response> { preCheckContextUser(uid) @@ -217,7 +217,7 @@ class UserController @Autowired constructor( return ResponseBuilder.success(result) } - @ApiOperation("删除用户token") + @Operation(summary = "删除用户token") @DeleteMapping("/token/{uid}/{name}") fun deleteToken(@PathVariable uid: String, @PathVariable name: String): Response { preCheckContextUser(uid) @@ -225,7 +225,7 @@ class UserController @Autowired constructor( return ResponseBuilder.success(result) } - @ApiOperation("校验用户token") + @Operation(summary = "校验用户token") @PostMapping("/token") @Deprecated("no need work") fun checkToken(@RequestParam uid: String, @RequestParam token: String): Response { @@ -234,13 +234,13 @@ class UserController @Autowired constructor( return ResponseBuilder.success(true) } - @ApiOperation("获取公钥") + @Operation(summary = "获取公钥") @GetMapping("/rsa") fun getPublicKey(): Response { return ResponseBuilder.success(RsaUtils.publicKey) } - @ApiOperation("校验登陆会话") + @Operation(summary = "校验登陆会话") @PostMapping("/login") fun loginUser(@RequestParam("uid") uid: String, @RequestParam("token") token: String): Response { val decryptToken: String? @@ -263,7 +263,7 @@ class UserController @Autowired constructor( return ResponseBuilder.success(true) } - @ApiOperation("独立部署模式下，获取用户信息") + @Operation(summary = "独立部署模式下，获取用户信息") @GetMapping("/info") fun userInfo( @RequestHeader("x-bkrepo-uid") bkUserId: String?, @@ -278,7 +278,7 @@ class UserController @Autowired constructor( return ResponseBuilder.success(result) } - @ApiOperation("校验用户ticket") + @Operation(summary = "校验用户ticket") @GetMapping("/verify") fun verify(@RequestParam(value = "bkrepo_ticket") bkrepoToken: String?): Response> { try { @@ -294,7 +294,7 @@ class UserController @Autowired constructor( } } - @ApiOperation("用户分页列表") + @Operation(summary = "用户分页列表") @GetMapping("page/{pageNumber}/{pageSize}") fun userPage( @PathVariable pageNumber: Int, @@ -308,14 +308,14 @@ class UserController @Autowired constructor( return ResponseBuilder.success(result) } - @ApiOperation("用户info") + @Operation(summary = "用户info") @GetMapping("/userinfo/{uid}") fun userInfoById(@PathVariable uid: String): Response { preCheckContextUser(uid) return ResponseBuilder.success(userService.getUserInfoById(uid)) } - @ApiOperation("修改用户密码") + @Operation(summary = "修改用户密码") @PutMapping("/update/password/{uid}") fun updatePassword( @PathVariable uid: String, @@ -328,34 +328,34 @@ class UserController @Autowired constructor( return ResponseBuilder.success(userService.updatePassword(uid, decryptOldPwd, decryptNewPwd)) } - @ApiOperation("用户info ") + @Operation(summary = "用户info ") @PostMapping("/reset/{uid}") fun resetPassword(@PathVariable uid: String): Response { preCheckContextUser(uid) return ResponseBuilder.success(userService.resetPassword(uid)) } - @ApiOperation("检验系统中是否存在同名userId ") + @Operation(summary = "检验系统中是否存在同名userId ") @GetMapping("/repeat/{uid}") fun repeatUid(@PathVariable uid: String): Response { preCheckContextUser(uid) return ResponseBuilder.success(userService.repeatUid(uid)) } - @ApiOperation("判断用户是否为项目管理员") + @Operation(summary = "判断用户是否为项目管理员") @GetMapping("/admin/{projectId}") fun isProjectAdmin(@PathVariable projectId: String): Response { return ResponseBuilder.success(isContextUserProjectAdmin(projectId)) } - @ApiOperation("检验实体用户是否存在此userid") + @Operation(summary = "检验实体用户是否存在此userid") @GetMapping("/validateEntityUser/{uid}") fun validateEntityUser(@PathVariable uid: String): Response { preCheckContextUser(uid) return ResponseBuilder.success(userService.validateEntityUser(uid)) } - @ApiOperation("相关虚拟列表") + @Operation(summary = "相关虚拟列表") @GetMapping("/group") fun userGroup( @RequestParam userName: String? = null, diff --git a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/account/Account.kt b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/account/Account.kt index 6f62af4f4e..36afc3ace8 100644 --- a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/account/Account.kt +++ b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/account/Account.kt @@ -30,38 +30,38 @@ package com.tencent.bkrepo.auth.pojo.account import com.tencent.bkrepo.auth.pojo.enums.ResourceType import com.tencent.bkrepo.auth.pojo.oauth.AuthorizationGrantType import com.tencent.bkrepo.auth.pojo.token.CredentialSet -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + import java.time.LocalDateTime -@ApiModel("账号信息") +@Schema(title = "账号信息") data class Account( - @ApiModelProperty("id") + @get:Schema(title = "id") val id: String, - @ApiModelProperty("appId") + @get:Schema(title = "appId") val appId: String, - @ApiModelProperty("locked状态") + @get:Schema(title = "locked状态") val locked: Boolean, - @ApiModelProperty("认证ak/sk对") + @get:Schema(title = "认证ak/sk对") val credentials: List, - @ApiModelProperty("应用所有人") + @get:Schema(title = "应用所有人") val owner: String?, - @ApiModelProperty("授权方式") + @get:Schema(title = "授权方式") var authorizationGrantTypes: Set, - @ApiModelProperty("主页地址") + @get:Schema(title = "主页地址") var homepageUrl: String?, - @ApiModelProperty("回调地址") + @get:Schema(title = "回调地址") var redirectUri: String?, - @ApiModelProperty("图标地址") + @get:Schema(title = "图标地址") var avatarUrl: String?, - @ApiModelProperty("权限类型") + @get:Schema(title = "权限类型") var scope: Set?, - @ApiModelProperty("权限范围") + @get:Schema(title = "权限范围") var scopeDesc: List?, - @ApiModelProperty("描述信息") + @get:Schema(title = "描述信息") var description: String?, - @ApiModelProperty("创建时间") + @get:Schema(title = "创建时间") var createdDate: LocalDateTime?, - @ApiModelProperty("最后修改时间") + @get:Schema(title = "最后修改时间") var lastModifiedDate: LocalDateTime? ) diff --git a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/account/CreateAccountRequest.kt b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/account/CreateAccountRequest.kt index c54a99b543..3d4b2ef0f2 100644 --- a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/account/CreateAccountRequest.kt +++ b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/account/CreateAccountRequest.kt @@ -29,27 +29,27 @@ package com.tencent.bkrepo.auth.pojo.account import com.tencent.bkrepo.auth.pojo.enums.ResourceType import com.tencent.bkrepo.auth.pojo.oauth.AuthorizationGrantType -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("创建账号请求") + +@Schema(title = "创建账号请求") data class CreateAccountRequest( - @ApiModelProperty("系统Id") + @get:Schema(title = "系统Id") val appId: String, - @ApiModelProperty("是否锁定") + @get:Schema(title = "是否锁定") val locked: Boolean = false, - @ApiModelProperty("授权方式") + @get:Schema(title = "授权方式") val authorizationGrantTypes: Set = setOf(AuthorizationGrantType.PLATFORM), - @ApiModelProperty("应用主页") + @get:Schema(title = "应用主页") val homepageUrl: String?, - @ApiModelProperty("应用回调地址") + @get:Schema(title = "应用回调地址") val redirectUri: String?, - @ApiModelProperty("应用图标地址") + @get:Schema(title = "应用图标地址") val avatarUrl: String?, - @ApiModelProperty("权限类型") + @get:Schema(title = "权限类型") val scopeDesc: List?, - @ApiModelProperty("权限范围") + @get:Schema(title = "权限范围") val scope: Set?, - @ApiModelProperty("简要描述") + @get:Schema(title = "简要描述") val description: String? ) diff --git a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/account/ScopeRule.kt b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/account/ScopeRule.kt index 528b1370f8..4ac8291afa 100644 --- a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/account/ScopeRule.kt +++ b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/account/ScopeRule.kt @@ -28,13 +28,14 @@ package com.tencent.bkrepo.auth.pojo.account import com.tencent.bkrepo.common.query.enums.OperationType -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + data class ScopeRule( - @ApiModelProperty("字段名") + @get:Schema(title = "字段名") val field: String, - @ApiModelProperty("值") + @get:Schema(title = "值") val value: Any, - @ApiModelProperty("操作类型") + @get:Schema(title = "操作类型") val operation: OperationType = OperationType.DEFAULT ) diff --git a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/account/UpdateAccountRequest.kt b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/account/UpdateAccountRequest.kt index 5e26ce2d6d..6563ad9883 100644 --- a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/account/UpdateAccountRequest.kt +++ b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/account/UpdateAccountRequest.kt @@ -29,25 +29,26 @@ package com.tencent.bkrepo.auth.pojo.account import com.tencent.bkrepo.auth.pojo.enums.ResourceType import com.tencent.bkrepo.auth.pojo.oauth.AuthorizationGrantType -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + data class UpdateAccountRequest( - @ApiModelProperty("系统Id") + @get:Schema(title = "系统Id") val appId: String, - @ApiModelProperty("是否锁定") + @get:Schema(title = "是否锁定") val locked: Boolean = false, - @ApiModelProperty("授权方式") + @get:Schema(title = "授权方式") val authorizationGrantTypes: Set, - @ApiModelProperty("应用主页") + @get:Schema(title = "应用主页") val homepageUrl: String? = null, - @ApiModelProperty("应用回调地址") + @get:Schema(title = "应用回调地址") val redirectUri: String? = null, - @ApiModelProperty("应用图标地址") + @get:Schema(title = "应用图标地址") val avatarUrl: String? = null, - @ApiModelProperty("权限类型") + @get:Schema(title = "权限类型") val scope: Set? = null, - @ApiModelProperty("权限范围") + @get:Schema(title = "权限范围") val scopeDesc: List? = null, - @ApiModelProperty("简要描述") + @get:Schema(title = "简要描述") val description: String? = null ) diff --git a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/permission/CreatePermissionRequest.kt b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/permission/CreatePermissionRequest.kt index 0dcaab813a..9efbc0b08e 100644 --- a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/permission/CreatePermissionRequest.kt +++ b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/permission/CreatePermissionRequest.kt @@ -33,33 +33,33 @@ package com.tencent.bkrepo.auth.pojo.permission import com.tencent.bkrepo.auth.pojo.enums.PermissionAction import com.tencent.bkrepo.auth.pojo.enums.ResourceType -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("创建权限请求") + +@Schema(title = "创建权限请求") data class CreatePermissionRequest( - @ApiModelProperty("资源类型") + @get:Schema(title = "资源类型") val resourceType: ResourceType = ResourceType.REPO, - @ApiModelProperty("项目ID") + @get:Schema(title = "项目ID") val projectId: String? = null, - @ApiModelProperty("权限名") + @get:Schema(title = "权限名") val permName: String, - @ApiModelProperty("关联仓库名") + @get:Schema(title = "关联仓库名") val repos: List = emptyList(), - @ApiModelProperty("匹配路径") + @get:Schema(title = "匹配路径") val includePattern: List = emptyList(), - @ApiModelProperty("不匹配路径") + @get:Schema(title = "不匹配路径") val excludePattern: List = emptyList(), - @ApiModelProperty("绑定用户") + @get:Schema(title = "绑定用户") val users: List = emptyList(), - @ApiModelProperty("绑定角色") + @get:Schema(title = "绑定角色") val roles: List = emptyList(), - @ApiModelProperty("绑定部门") + @get:Schema(title = "绑定部门") val departments: List = emptyList(), - @ApiModelProperty("权限动作") + @get:Schema(title = "权限动作") val actions: List = emptyList(), - @ApiModelProperty("创建人") + @get:Schema(title = "创建人") val createBy: String, - @ApiModelProperty("修改人") + @get:Schema(title = "修改人") val updatedBy: String ) diff --git a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/permission/Permission.kt b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/permission/Permission.kt index d24c1b0d27..700794891a 100644 --- a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/permission/Permission.kt +++ b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/permission/Permission.kt @@ -31,10 +31,10 @@ package com.tencent.bkrepo.auth.pojo.permission -import io.swagger.annotations.ApiModel +import io.swagger.v3.oas.annotations.media.Schema import java.time.LocalDateTime -@ApiModel("权限") +@Schema(title = "权限") data class Permission( val id: String? = null, val resourceType: String, diff --git a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/role/CreateRoleRequest.kt b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/role/CreateRoleRequest.kt index d78e14f467..cf7d4b2037 100644 --- a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/role/CreateRoleRequest.kt +++ b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/role/CreateRoleRequest.kt @@ -28,25 +28,25 @@ package com.tencent.bkrepo.auth.pojo.role import com.tencent.bkrepo.auth.pojo.enums.RoleType -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("创建角色请求") + +@Schema(title = "创建角色请求") data class CreateRoleRequest( - @ApiModelProperty("角色id") + @get:Schema(title = "角色id") val roleId: String?, - @ApiModelProperty("角色名称") + @get:Schema(title = "角色名称") val name: String, - @ApiModelProperty("角色类型") + @get:Schema(title = "角色类型") val type: RoleType = RoleType.PROJECT, - @ApiModelProperty("项目ID") + @get:Schema(title = "项目ID") val projectId: String, - @ApiModelProperty("仓库名称") + @get:Schema(title = "仓库名称") val repoName: String? = null, - @ApiModelProperty("管理员") + @get:Schema(title = "管理员") val admin: Boolean = false, - @ApiModelProperty("描述信息") + @get:Schema(title = "描述信息") val description: String? = null, - @ApiModelProperty("角色来源") + @get:Schema(title = "角色来源") val source: RoleSource? = null ) diff --git a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/role/Role.kt b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/role/Role.kt index 647c38f9d4..43dd6481ff 100644 --- a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/role/Role.kt +++ b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/role/Role.kt @@ -28,28 +28,28 @@ package com.tencent.bkrepo.auth.pojo.role import com.tencent.bkrepo.auth.pojo.enums.RoleType -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("角色") + +@Schema(title = "角色") data class Role( val id: String? = null, - @ApiModelProperty("角色ID") + @get:Schema(title = "角色ID") val roleId: String, - @ApiModelProperty("角色类型") + @get:Schema(title = "角色类型") val type: RoleType, - @ApiModelProperty("角色名") + @get:Schema(title = "角色名") val name: String, - @ApiModelProperty("项目ID") + @get:Schema(title = "项目ID") val projectId: String, - @ApiModelProperty("仓库名称") + @get:Schema(title = "仓库名称") val repoName: String? = null, - @ApiModelProperty("管理员") + @get:Schema(title = "管理员") val admin: Boolean = false, - @ApiModelProperty("绑定的用户") + @get:Schema(title = "绑定的用户") val users: List = listOf(), - @ApiModelProperty("描述信息") + @get:Schema(title = "描述信息") val description: String? = null, - @ApiModelProperty("角色来源") + @get:Schema(title = "角色来源") val source: RoleSource? = null ) diff --git a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/role/RoleSource.kt b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/role/RoleSource.kt index 56cccd85a5..a2e157d099 100644 --- a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/role/RoleSource.kt +++ b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/role/RoleSource.kt @@ -27,9 +27,9 @@ package com.tencent.bkrepo.auth.pojo.role -import io.swagger.annotations.ApiModel +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("角色来源") +@Schema(title = "角色来源") enum class RoleSource { DEVOPS, TAI diff --git a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/token/CredentialSet.kt b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/token/CredentialSet.kt index 7c155353d8..1a1944b281 100644 --- a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/token/CredentialSet.kt +++ b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/token/CredentialSet.kt @@ -29,20 +29,19 @@ package com.tencent.bkrepo.auth.pojo.token import com.tencent.bkrepo.auth.pojo.enums.CredentialStatus import com.tencent.bkrepo.auth.pojo.oauth.AuthorizationGrantType -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema import java.time.LocalDateTime -@ApiModel("账户认证信息") +@Schema(title = "账户认证信息") data class CredentialSet( - @ApiModelProperty("accessKey") + @get:Schema(title = "accessKey") val accessKey: String, - @ApiModelProperty("secretKey") + @get:Schema(title = "secretKey") var secretKey: String, - @ApiModelProperty("创建时间") + @get:Schema(title = "创建时间") val createdAt: LocalDateTime, - @ApiModelProperty("状态") + @get:Schema(title = "状态") val status: CredentialStatus, - @ApiModelProperty("认证授权方式") + @get:Schema(title = "认证授权方式") val authorizationGrantType: AuthorizationGrantType? = AuthorizationGrantType.PLATFORM ) diff --git a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/user/CreateUserToRepoRequest.kt b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/user/CreateUserToRepoRequest.kt index f5fa2d27b9..3dd9eed0df 100644 --- a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/user/CreateUserToRepoRequest.kt +++ b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/user/CreateUserToRepoRequest.kt @@ -33,26 +33,26 @@ package com.tencent.bkrepo.auth.pojo.user import com.tencent.bkrepo.common.metadata.annotation.Sensitive import com.tencent.bkrepo.common.metadata.handler.MaskString -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("创建用户到仓库管理员请求") + +@Schema(title = "创建用户到仓库管理员请求") data class CreateUserToRepoRequest( - @ApiModelProperty("用户id") + @get:Schema(title = "用户id") val userId: String, - @ApiModelProperty("用户名") + @get:Schema(title = "用户名") val name: String, - @ApiModelProperty("密码") + @get:Schema(title = "密码") @Sensitive(MaskString::class) var pwd: String? = null, - @ApiModelProperty("管理员") + @get:Schema(title = "管理员") var admin: Boolean = false, - @ApiModelProperty("关联用户") + @get:Schema(title = "关联用户") val asstUsers: List = emptyList(), - @ApiModelProperty("群组账号") + @get:Schema(title = "群组账号") val group: Boolean = false, - @ApiModelProperty("项目ID") + @get:Schema(title = "项目ID") val projectId: String, - @ApiModelProperty("仓库名称") + @get:Schema(title = "仓库名称") val repoName: String ) diff --git a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/user/UpdateUserRequest.kt b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/user/UpdateUserRequest.kt index e0c9ad91ba..e69f3cfdb0 100644 --- a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/user/UpdateUserRequest.kt +++ b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/user/UpdateUserRequest.kt @@ -27,21 +27,21 @@ package com.tencent.bkrepo.auth.pojo.user -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema data class UpdateUserRequest( - @ApiModelProperty("用户名") + @get:Schema(title = "用户名") val name: String? = null, - @ApiModelProperty("密码") + @get:Schema(title = "密码") val pwd: String? = null, - @ApiModelProperty("绑定用户") + @get:Schema(title = "绑定用户") val asstUsers: List = emptyList(), - @ApiModelProperty("lock状态") + @get:Schema(title = "lock状态") val locked: Boolean? = null, - @ApiModelProperty("email") + @get:Schema(title = "email") val email: String? = null, - @ApiModelProperty("联系电话") + @get:Schema(title = "联系电话") val phone: String? = null, - @ApiModelProperty("是否管理员") + @get:Schema(title = "是否管理员") val admin: Boolean? = null ) diff --git a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/user/UserResult.kt b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/user/UserResult.kt index dd2769fd9f..34c066eed8 100644 --- a/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/user/UserResult.kt +++ b/src/backend/auth/biz-auth/src/main/kotlin/com/tencent/bkrepo/auth/pojo/user/UserResult.kt @@ -31,13 +31,13 @@ package com.tencent.bkrepo.auth.pojo.user -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("用户信息") + +@Schema(title = "用户信息") data class UserResult( - @ApiModelProperty("用户ID") + @get:Schema(title = "用户ID") val userId: String, - @ApiModelProperty("用户名") + @get:Schema(title = "用户名") val name: String ) diff --git a/src/backend/build.gradle.kts b/src/backend/build.gradle.kts index 0bd3c7fc73..08dc1cdf74 100644 --- a/src/backend/build.gradle.kts +++ b/src/backend/build.gradle.kts @@ -67,7 +67,7 @@ allprojects { dependency("org.apache.commons:commons-text:${Versions.CommonsText}") dependency("org.mockito.kotlin:mockito-kotlin:${Versions.MockitoKotlin}") dependency("io.mockk:mockk:${Versions.Mockk}") - dependencySet("io.swagger:${Versions.Swagger}") { + dependencySet("io.swagger.core.v3:${Versions.Swagger}") { entry("swagger-annotations") entry("swagger-models") } diff --git a/src/backend/buildSrc/src/main/kotlin/Versions.kt b/src/backend/buildSrc/src/main/kotlin/Versions.kt index 459a0d6829..a35a9deba9 100644 --- a/src/backend/buildSrc/src/main/kotlin/Versions.kt +++ b/src/backend/buildSrc/src/main/kotlin/Versions.kt @@ -58,7 +58,7 @@ object Versions { const val XStream = "1.4.19" const val DockerJava = "3.2.13" const val Mockk = "1.12.2" - const val Swagger = "1.6.2" + const val Swagger = "2.2.28" const val SleuthOtel = "1.1.4" const val KubernetesClient = "11.0.2" const val ReactiveFeign = "3.2.6" diff --git a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/ScanExecutorResult.kt b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/ScanExecutorResult.kt index 925e929b61..10bbb54b0a 100644 --- a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/ScanExecutorResult.kt +++ b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/ScanExecutorResult.kt @@ -40,9 +40,9 @@ import com.tencent.bkrepo.common.analysis.pojo.scanner.standard.StandardScanExec import com.tencent.bkrepo.common.analysis.pojo.scanner.standard.StandardScanner import com.tencent.bkrepo.common.analysis.pojo.scanner.trivy.TrivyScanExecutorResult import com.tencent.bkrepo.common.analysis.pojo.scanner.trivy.TrivyScanner -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty -@ApiModel("扫描结果") +import io.swagger.v3.oas.annotations.media.Schema + +@Schema(title = "扫描结果") @JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.EXISTING_PROPERTY, property = "type") @JsonSubTypes( JsonSubTypes.Type(value = ArrowheadScanExecutorResult::class, name = ArrowheadScanner.TYPE), @@ -52,9 +52,9 @@ import io.swagger.annotations.ApiModelProperty JsonSubTypes.Type(value = StandardScanExecutorResult::class, name = StandardScanner.TYPE) ) open class ScanExecutorResult( - @ApiModelProperty("扫描执行状态") + @get:Schema(title = "扫描执行状态") open val scanStatus: String, - @ApiModelProperty("扫描器类型") + @get:Schema(title = "扫描器类型") val type: String ) { /** diff --git a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/Scanner.kt b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/Scanner.kt index 951e5dc8dd..6827944bd6 100644 --- a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/Scanner.kt +++ b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/Scanner.kt @@ -36,12 +36,11 @@ import com.tencent.bkrepo.common.analysis.pojo.scanner.standard.StandardScanner import com.tencent.bkrepo.common.analysis.pojo.scanner.trivy.TrivyScanner import com.tencent.bkrepo.common.api.exception.ErrorCodeException import com.tencent.bkrepo.common.api.message.CommonMessageCode -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema import org.slf4j.LoggerFactory import kotlin.math.max -@ApiModel("扫描器配置") +@Schema(title = "扫描器配置") @JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.EXISTING_PROPERTY, property = "type") @JsonSubTypes( JsonSubTypes.Type(value = ArrowheadScanner::class, name = ArrowheadScanner.TYPE), @@ -51,44 +50,44 @@ import kotlin.math.max JsonSubTypes.Type(value = StandardScanner::class, name = StandardScanner.TYPE) ) open class Scanner( - @ApiModelProperty("扫描器名") + @get:Schema(title = "扫描器名") open val name: String, - @ApiModelProperty("扫描器类型") + @get:Schema(title = "扫描器类型") val type: String, - @ApiModelProperty("扫描器版本") + @get:Schema(title = "扫描器版本") open val version: String, - @ApiModelProperty("扫描器描述信息") + @get:Schema(title = "扫描器描述信息") val description: String = "", - @ApiModelProperty("扫描器根目录") + @get:Schema(title = "扫描器根目录") val rootPath: String = type, - @ApiModelProperty("扫描结束后是否清理工作目录") + @get:Schema(title = "扫描结束后是否清理工作目录") val cleanWorkDir: Boolean = true, - @ApiModelProperty("最大允许的1MB文件扫描时间") + @get:Schema(title = "最大允许的1MB文件扫描时间") val maxScanDurationPerMb: Long = DEFAULT_MAX_SCAN_DURATION, - @ApiModelProperty("支持扫描的文件类型") + @get:Schema(title = "支持扫描的文件类型") val supportFileNameExt: List = DEFAULT_SUPPORT_FILE_NAME_EXTENSION, - @ApiModelProperty("支持扫描的包类型") + @get:Schema(title = "支持扫描的包类型") val supportPackageTypes: List = emptyList(), - @ApiModelProperty("支持扫描的类型") + @get:Schema(title = "支持扫描的类型") val supportScanTypes: List = emptyList(), - @ApiModelProperty("支持的分发器") + @get:Schema(title = "支持的分发器") val supportDispatchers: List = emptyList(), - @ApiModelProperty("执行扫描所需要的内存大小") + @get:Schema(title = "执行扫描所需要的内存大小") @Deprecated("使用limitMem替代") val memory: Long = DEFAULT_MEM, - @ApiModelProperty("容器limit mem") + @get:Schema(title = "容器limit mem") val limitMem: Long = 32 * GB, - @ApiModelProperty("容器 request mem") + @get:Schema(title = "容器 request mem") val requestMem: Long = 16 * GB, - @ApiModelProperty("容器request ephemeralStorage") + @get:Schema(title = "容器request ephemeralStorage") val requestStorage: Long = 16 * GB, - @ApiModelProperty("容器limit ephemeralStorage") + @get:Schema(title = "容器limit ephemeralStorage") val limitStorage: Long = 128 * GB, - @ApiModelProperty("容器request cpu") + @get:Schema(title = "容器request cpu") val requestCpu: Double = 4.0, - @ApiModelProperty("容器limit cpu") + @get:Schema(title = "容器limit cpu") val limitCpu: Double = 16.0, - @ApiModelProperty("不支持的制品名称正则列表") + @get:Schema(title = "不支持的制品名称正则列表") val unsupportedArtifactNameRegex: Set = emptySet(), ) { /** diff --git a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/arrowhead/ApplicationItem.kt b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/arrowhead/ApplicationItem.kt index 9dce15d368..1ac9c0faa8 100644 --- a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/arrowhead/ApplicationItem.kt +++ b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/arrowhead/ApplicationItem.kt @@ -31,25 +31,25 @@ import com.fasterxml.jackson.annotation.JsonAlias import com.fasterxml.jackson.annotation.JsonIgnoreProperties import com.tencent.bkrepo.common.analysis.pojo.scanner.utils.normalizedLevel import com.tencent.bkrepo.common.analysis.pojo.scanner.utils.removeRootDirPath -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("应用依赖组件信息") + +@Schema(title = "应用依赖组件信息") @JsonIgnoreProperties(ignoreUnknown = true) data class ApplicationItem( - @ApiModelProperty("组件路径") + @get:Schema(title = "组件路径") @JsonAlias("FilePath") val path: String, - @ApiModelProperty("组件名") + @get:Schema(title = "组件名") @JsonAlias("LibraryName") val component: String, - @ApiModelProperty("组件版本") + @get:Schema(title = "组件版本") @JsonAlias("LibraryVersion") val version: String, - @ApiModelProperty("证书详情") + @get:Schema(title = "证书详情") @JsonAlias("license") val license: License? = null ) { diff --git a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/arrowhead/ArrowheadScanExecutorResult.kt b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/arrowhead/ArrowheadScanExecutorResult.kt index b25ead75ca..289cfbd9ab 100644 --- a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/arrowhead/ArrowheadScanExecutorResult.kt +++ b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/arrowhead/ArrowheadScanExecutorResult.kt @@ -28,19 +28,19 @@ package com.tencent.bkrepo.common.analysis.pojo.scanner.arrowhead import com.tencent.bkrepo.common.analysis.pojo.scanner.ScanExecutorResult -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("arrowhead扫描器扫描结果") + +@Schema(title = "arrowhead扫描器扫描结果") data class ArrowheadScanExecutorResult( override val scanStatus: String, - @ApiModelProperty("安全审计结果") + @get:Schema(title = "安全审计结果") val checkSecItems: List, - @ApiModelProperty("License审计结果") + @get:Schema(title = "License审计结果") val applicationItems: List, - @ApiModelProperty("敏感信息审计结果") + @get:Schema(title = "敏感信息审计结果") val sensitiveItems: List, - @ApiModelProperty("cve审计结果") + @get:Schema(title = "cve审计结果") val cveSecItems: List ) : ScanExecutorResult(scanStatus, ArrowheadScanner.TYPE) { companion object { diff --git a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/arrowhead/ArrowheadScanner.kt b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/arrowhead/ArrowheadScanner.kt index ef41eee021..67331c31f8 100644 --- a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/arrowhead/ArrowheadScanner.kt +++ b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/arrowhead/ArrowheadScanner.kt @@ -30,23 +30,23 @@ package com.tencent.bkrepo.common.analysis.pojo.scanner.arrowhead import com.tencent.bkrepo.common.analysis.pojo.scanner.Scanner import com.tencent.bkrepo.common.metadata.annotation.Sensitive import com.tencent.bkrepo.common.metadata.handler.MaskPartString -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("Arrowhead扫描器配置") + +@Schema(title = "Arrowhead扫描器配置") class ArrowheadScanner( override val name: String, /** * 格式为ArrowheadImageVersion::KnowledgeBaseVervion::StandaloneConfigTemplateVersion * 或者ArrowheadImageVersion::KnowledgeBaseVervion */ - @ApiModelProperty("扫描器版本") + @get:Schema(title = "扫描器版本") override val version: String, - @ApiModelProperty("扫描器配置文件路径，相对于工作目录") + @get:Schema(title = "扫描器配置文件路径，相对于工作目录") val configFilePath: String = DEFAULT_CONFIG_FILE_PATH, - @ApiModelProperty("漏洞知识库配置") + @get:Schema(title = "漏洞知识库配置") val knowledgeBase: KnowledgeBase, - @ApiModelProperty("使用的容器镜像") + @get:Schema(title = "使用的容器镜像") val container: ArrowheadDockerImage ) : Scanner(name, TYPE, version) { companion object { @@ -59,32 +59,32 @@ class ArrowheadScanner( } } -@ApiModel("arrowhead容器镜像配置") +@Schema(title = "arrowhead容器镜像配置") data class ArrowheadDockerImage( - @ApiModelProperty("使用的镜像名和版本") + @get:Schema(title = "使用的镜像名和版本") val image: String, - @ApiModelProperty("docker仓库用户") + @get:Schema(title = "docker仓库用户") val dockerRegistryUsername: String?, - @ApiModelProperty("docker仓库密码") + @get:Schema(title = "docker仓库密码") val dockerRegistryPassword: String?, - @ApiModelProperty("容器启动参数") + @get:Schema(title = "容器启动参数") val args: String = "/data/standalone.toml", - @ApiModelProperty("容器内的工作目录") + @get:Schema(title = "容器内的工作目录") val workDir: String = "/data", - @ApiModelProperty("输入目录，相对于workDir的路径") + @get:Schema(title = "输入目录，相对于workDir的路径") val inputDir: String = "/package", - @ApiModelProperty("输出目录，相对于workDir的路径") + @get:Schema(title = "输出目录，相对于workDir的路径") val outputDir: String = "/output" ) -@ApiModel("v2 arrowhead漏洞知识库配置") +@Schema(title = "v2 arrowhead漏洞知识库配置") data class KnowledgeBase( - @ApiModelProperty("漏洞知识库地址，例如http://127.0.0.1:1234") + @get:Schema(title = "漏洞知识库地址，例如http://127.0.0.1:1234") val endpoint: String, - @ApiModelProperty("漏洞知识库认证id") + @get:Schema(title = "漏洞知识库认证id") @Sensitive(handler = MaskPartString::class) val secretId: String = "", - @ApiModelProperty("漏洞知识库认证密钥") + @get:Schema(title = "漏洞知识库认证密钥") @Sensitive(handler = MaskPartString::class) val secretKey: String = "" ) diff --git a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/arrowhead/CveSecItem.kt b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/arrowhead/CveSecItem.kt index f58b17f0d4..0239ee9543 100644 --- a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/arrowhead/CveSecItem.kt +++ b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/arrowhead/CveSecItem.kt @@ -30,102 +30,102 @@ package com.tencent.bkrepo.common.analysis.pojo.scanner.arrowhead import com.fasterxml.jackson.annotation.JsonAlias import com.tencent.bkrepo.common.analysis.pojo.scanner.utils.normalizedLevel import com.tencent.bkrepo.common.analysis.pojo.scanner.utils.removeRootDirPath -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("CVE信息") + +@Schema(title = "CVE信息") data class CveSecItem( - @ApiModelProperty("文件路径") + @get:Schema(title = "文件路径") @JsonAlias("path") val path: String, - @ApiModelProperty("组件名") + @get:Schema(title = "组件名") @JsonAlias("lib_name") var component: String, - @ApiModelProperty("库版本") + @get:Schema(title = "库版本") @JsonAlias("version") val version: String, - @ApiModelProperty("库版本列表") + @get:Schema(title = "库版本列表") val versions: MutableSet = HashSet(), - @ApiModelProperty("漏洞影响版本") + @get:Schema(title = "漏洞影响版本") @JsonAlias("version_effected") val versionEffected: String, - @ApiModelProperty("漏洞修复版本") + @get:Schema(title = "漏洞修复版本") @JsonAlias("version_fixed") val versionFixed: String, - @ApiModelProperty("漏洞名") + @get:Schema(title = "漏洞名") @JsonAlias("name") val name: String, - @ApiModelProperty("漏洞利用类型") + @get:Schema(title = "漏洞利用类型") @JsonAlias("category") val category: String, - @ApiModelProperty("漏洞类型") + @get:Schema(title = "漏洞类型") @JsonAlias("category_type") val categoryType: String, - @ApiModelProperty("漏洞描述") + @get:Schema(title = "漏洞描述") @JsonAlias("description") val description: String, - @ApiModelProperty("官方解决方案") + @get:Schema(title = "官方解决方案") @JsonAlias("official_solution") val officialSolution: String, - @ApiModelProperty("解决方案") + @get:Schema(title = "解决方案") @JsonAlias("defense_solution") val defenseSolution: String, - @ApiModelProperty("相关链接") + @get:Schema(title = "相关链接") @JsonAlias("reference") val references: List, - @ApiModelProperty("漏洞年份") + @get:Schema(title = "漏洞年份") @JsonAlias("cve_year") val cveYear: String, - @ApiModelProperty("poc id") + @get:Schema(title = "poc id") @JsonAlias("poc_id") val pocId: String, - @ApiModelProperty("cve id") + @get:Schema(title = "cve id") @JsonAlias("cve_id") val cveId: String, - @ApiModelProperty("cnvd id") + @get:Schema(title = "cnvd id") @JsonAlias("cnvd_id") val cnvdId: String, - @ApiModelProperty("cnnvd id") + @get:Schema(title = "cnnvd id") @JsonAlias("cnnvd_id") val cnnvdId: String, - @ApiModelProperty("cwe id") + @get:Schema(title = "cwe id") @JsonAlias("cwe_id") val cweId: String, /** * CRITICAL,HIGH,MEDIUM,LOW */ - @ApiModelProperty("cvss等级") + @get:Schema(title = "cvss等级") @JsonAlias("cvss_rank") val cvssRank: String, - @ApiModelProperty("cvss 评分") + @get:Schema(title = "cvss 评分") @JsonAlias("cvss") val cvss: Double, - @ApiModelProperty("cvss V3 漏洞影响评价") + @get:Schema(title = "cvss V3 漏洞影响评价") @JsonAlias("cvss_v3") val cvssV3: CvssV3?, - @ApiModelProperty("cvss V2 漏洞影响评价") + @get:Schema(title = "cvss V2 漏洞影响评价") @JsonAlias("cvss_v2") val cvssV2: CvssV2? ) { diff --git a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/arrowhead/License.kt b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/arrowhead/License.kt index 93b7e43577..1dace0115d 100644 --- a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/arrowhead/License.kt +++ b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/arrowhead/License.kt @@ -29,22 +29,23 @@ package com.tencent.bkrepo.common.analysis.pojo.scanner.arrowhead import com.fasterxml.jackson.annotation.JsonAlias -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 许可证 */ data class License( - @ApiModelProperty("证书名字") + @get:Schema(title = "证书名字") @JsonAlias("Name") val name: String, - @ApiModelProperty("许可证内容") + @get:Schema(title = "许可证内容") @JsonAlias("Content") val content: String, - @ApiModelProperty("许可证链接") + @get:Schema(title = "许可证链接") @JsonAlias("Source") val source: String, - @ApiModelProperty("证书风险等级， LOW, MEDIUM, HIGH") + @get:Schema(title = "证书风险等级， LOW, MEDIUM, HIGH") @JsonAlias("Risk") val risk: String ) diff --git a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/arrowhead/SensitiveItem.kt b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/arrowhead/SensitiveItem.kt index 74443b7888..a592aefa14 100644 --- a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/arrowhead/SensitiveItem.kt +++ b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/arrowhead/SensitiveItem.kt @@ -27,41 +27,41 @@ package com.tencent.bkrepo.common.analysis.pojo.scanner.arrowhead -import com.fasterxml.jackson.annotation.JsonIgnoreProperties import com.fasterxml.jackson.annotation.JsonAlias -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import com.fasterxml.jackson.annotation.JsonIgnoreProperties +import io.swagger.v3.oas.annotations.media.Schema + -@ApiModel("敏感信息数据") +@Schema(title = "敏感信息数据") @JsonIgnoreProperties(ignoreUnknown = true) data class SensitiveItem( - @ApiModelProperty("存在敏感信息的文件路径") + @get:Schema(title = "存在敏感信息的文件路径") @JsonAlias("Source") val path: String, /** * uri, ipv4, ipv6, email, secret */ - @ApiModelProperty("敏感信息类型,") + @get:Schema(title = "敏感信息类型,") @JsonAlias("Class") val type: String, /** * uri, ipv4, ipv6, email, common_key */ - @ApiModelProperty("敏感信息子类型") + @get:Schema(title = "敏感信息子类型") @JsonAlias("SubClass") val subtype: String, - @ApiModelProperty("敏感信息内容") + @get:Schema(title = "敏感信息内容") @JsonAlias("Content") val content: String, - @ApiModelProperty("敏感信息为uri或者email时生效") + @get:Schema(title = "敏感信息为uri或者email时生效") @JsonAlias("Domain") val domain: String, - @ApiModelProperty("敏感信息属性，存放文件类型，uri协议等信息") + @get:Schema(title = "敏感信息属性，存放文件类型，uri协议等信息") @JsonAlias("Attr") val attr: Map ) { diff --git a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/dependencycheck/result/DependencyItem.kt b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/dependencycheck/result/DependencyItem.kt index 981ebd2ebd..15b2c4664f 100644 --- a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/dependencycheck/result/DependencyItem.kt +++ b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/dependencycheck/result/DependencyItem.kt @@ -30,56 +30,56 @@ package com.tencent.bkrepo.common.analysis.pojo.scanner.dependencycheck.result import com.fasterxml.jackson.annotation.JsonAlias import com.tencent.bkrepo.common.checker.pojo.Cvssv2 import com.tencent.bkrepo.common.checker.pojo.Cvssv3 -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("DependencyCheck漏洞信息") + +@Schema(title = "DependencyCheck漏洞信息") data class DependencyItem( /** * CVE-2017-18349 */ - @ApiModelProperty("cve id") + @get:Schema(title = "cve id") val cveId: String, /** * CVE-2017-18349 */ - @ApiModelProperty("漏洞名/漏洞标题") + @get:Schema(title = "漏洞名/漏洞标题") val name: String, - @ApiModelProperty("所属依赖") + @get:Schema(title = "所属依赖") val dependency: String, - @ApiModelProperty("引入版本") + @get:Schema(title = "引入版本") val version: String, /** * CRITICAL,HIGH,MEDIUM,LOW */ - @ApiModelProperty("等级") + @get:Schema(title = "等级") val severity: String, - @ApiModelProperty("漏洞描述") + @get:Schema(title = "漏洞描述") @JsonAlias("description") val description: String, - @ApiModelProperty("官方解决方案") + @get:Schema(title = "官方解决方案") @JsonAlias("official_solution") val officialSolution: String?, - @ApiModelProperty("解决方案") + @get:Schema(title = "解决方案") @JsonAlias("defense_solution") val defenseSolution: String?, - @ApiModelProperty("相关链接") + @get:Schema(title = "相关链接") val references: List?, - @ApiModelProperty("cvss V2 漏洞影响评价") + @get:Schema(title = "cvss V2 漏洞影响评价") val cvssV2Vector: Cvssv2?, - @ApiModelProperty("cvss V3 漏洞影响评价") + @get:Schema(title = "cvss V3 漏洞影响评价") val cvssV3: Cvssv3?, - @ApiModelProperty("漏洞文件路径") + @get:Schema(title = "漏洞文件路径") val path: String? = null ) diff --git a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/dependencycheck/result/DependencyScanExecutorResult.kt b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/dependencycheck/result/DependencyScanExecutorResult.kt index 738ff3a2bb..93242bc5cb 100644 --- a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/dependencycheck/result/DependencyScanExecutorResult.kt +++ b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/dependencycheck/result/DependencyScanExecutorResult.kt @@ -29,12 +29,12 @@ package com.tencent.bkrepo.common.analysis.pojo.scanner.dependencycheck.result import com.tencent.bkrepo.common.analysis.pojo.scanner.ScanExecutorResult import com.tencent.bkrepo.common.analysis.pojo.scanner.dependencycheck.scanner.DependencyScanner -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("DependencyCheck扫描器扫描结果") + +@Schema(title = "DependencyCheck扫描器扫描结果") data class DependencyScanExecutorResult( override val scanStatus: String, - @ApiModelProperty("结果") + @get:Schema(title = "结果") val dependencyItems: List ) : ScanExecutorResult(scanStatus, DependencyScanner.TYPE) diff --git a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/dependencycheck/scanner/DependencyScanner.kt b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/dependencycheck/scanner/DependencyScanner.kt index 4e7e08cd30..844fdabbbd 100644 --- a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/dependencycheck/scanner/DependencyScanner.kt +++ b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/dependencycheck/scanner/DependencyScanner.kt @@ -28,13 +28,13 @@ package com.tencent.bkrepo.common.analysis.pojo.scanner.dependencycheck.scanner import com.tencent.bkrepo.common.analysis.pojo.scanner.Scanner -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("DependencyCheck扫描器配置") + +@Schema(title = "DependencyCheck扫描器配置") class DependencyScanner( override val name: String, - @ApiModelProperty("扫描器版本") + @get:Schema(title = "扫描器版本") override val version: String ) : Scanner(name, TYPE, version) { companion object { diff --git a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/scanCodeCheck/result/ScanCodeToolkitScanExecutorResult.kt b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/scanCodeCheck/result/ScanCodeToolkitScanExecutorResult.kt index 148426cb1a..6e54dd56ce 100644 --- a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/scanCodeCheck/result/ScanCodeToolkitScanExecutorResult.kt +++ b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/scanCodeCheck/result/ScanCodeToolkitScanExecutorResult.kt @@ -29,12 +29,12 @@ package com.tencent.bkrepo.common.analysis.pojo.scanner.scanCodeCheck.result import com.tencent.bkrepo.common.analysis.pojo.scanner.ScanExecutorResult import com.tencent.bkrepo.common.analysis.pojo.scanner.scanCodeCheck.scanner.ScancodeToolkitScanner -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("scancode_toolkit扫描器扫描结果") + +@Schema(title = "scancode_toolkit扫描器扫描结果") data class ScanCodeToolkitScanExecutorResult( override val scanStatus: String, - @ApiModelProperty("结果") + @get:Schema(title = "结果") val scancodeItem: Set ) : ScanExecutorResult(scanStatus, ScancodeToolkitScanner.TYPE) diff --git a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/scanCodeCheck/result/ScancodeItem.kt b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/scanCodeCheck/result/ScancodeItem.kt index b0ebcb86bf..1936ef4e0c 100644 --- a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/scanCodeCheck/result/ScancodeItem.kt +++ b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/scanCodeCheck/result/ScancodeItem.kt @@ -27,17 +27,17 @@ package com.tencent.bkrepo.common.analysis.pojo.scanner.scanCodeCheck.result -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("ScancodeItem许可信息") + +@Schema(title = "ScancodeItem许可信息") data class ScancodeItem( - @ApiModelProperty("许可简称") + @get:Schema(title = "许可简称") val licenseId: String, - @ApiModelProperty("依赖路径") + @get:Schema(title = "依赖路径") val dependentPath: String, // 风险等级暂时没有 - @ApiModelProperty("风险等级") + @get:Schema(title = "风险等级") var riskLevel: String? = null, ) { companion object { diff --git a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/scanCodeCheck/result/ScancodeToolkitItem.kt b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/scanCodeCheck/result/ScancodeToolkitItem.kt index 3f921798d6..19f9706c51 100644 --- a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/scanCodeCheck/result/ScancodeToolkitItem.kt +++ b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/scanCodeCheck/result/ScancodeToolkitItem.kt @@ -28,15 +28,15 @@ package com.tencent.bkrepo.common.analysis.pojo.scanner.scanCodeCheck.result import com.fasterxml.jackson.annotation.JsonProperty -import io.swagger.annotations.ApiModel +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("scancode扫描结果") +@Schema(title = "scancode扫描结果") data class ScancodeToolItem( val headers: List, val files: List ) -@ApiModel("scancode_toolkit扫描结果映射") +@Schema(title = "scancode_toolkit扫描结果映射") data class ScancodeToolkitItem( val path: String, val type: String, diff --git a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/scanCodeCheck/result/SubLicenseItem.kt b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/scanCodeCheck/result/SubLicenseItem.kt index d1000d21a9..db72f35d34 100644 --- a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/scanCodeCheck/result/SubLicenseItem.kt +++ b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/scanCodeCheck/result/SubLicenseItem.kt @@ -28,9 +28,9 @@ package com.tencent.bkrepo.common.analysis.pojo.scanner.scanCodeCheck.result import com.fasterxml.jackson.annotation.JsonProperty -import io.swagger.annotations.ApiModel +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("scancode_toolkit扫描结果许可信息部分") +@Schema(title = "scancode_toolkit扫描结果许可信息部分") data class SubLicenseItem( val key: String, val score: Float, diff --git a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/scanCodeCheck/scanner/ScancodeToolkitScanner.kt b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/scanCodeCheck/scanner/ScancodeToolkitScanner.kt index 16e3155944..80ffd67802 100644 --- a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/scanCodeCheck/scanner/ScancodeToolkitScanner.kt +++ b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/scanCodeCheck/scanner/ScancodeToolkitScanner.kt @@ -28,34 +28,34 @@ package com.tencent.bkrepo.common.analysis.pojo.scanner.scanCodeCheck.scanner import com.tencent.bkrepo.common.analysis.pojo.scanner.Scanner -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("scancode_toolkit(licenses扫描)扫描器配置") + +@Schema(title = "scancode_toolkit(licenses扫描)扫描器配置") class ScancodeToolkitScanner( override val name: String, - @ApiModelProperty("扫描器版本") + @get:Schema(title = "扫描器版本") override val version: String, - @ApiModelProperty("使用的容器镜像") + @get:Schema(title = "使用的容器镜像") val container: ScancodeToolkitDockerImage ) : Scanner(name, TYPE, version) { companion object { const val TYPE = "scancodeToolkit" } - @ApiModel("容器镜像配置") + @Schema(title = "容器镜像配置") data class ScancodeToolkitDockerImage( - @ApiModelProperty("使用的镜像名和版本") + @get:Schema(title = "使用的镜像名和版本") val image: String, - @ApiModelProperty("docker仓库用户") + @get:Schema(title = "docker仓库用户") val dockerRegistryUsername: String?, - @ApiModelProperty("docker仓库密码") + @get:Schema(title = "docker仓库密码") val dockerRegistryPassword: String?, - @ApiModelProperty("容器内的工作目录") + @get:Schema(title = "容器内的工作目录") val workDir: String = "/data", - @ApiModelProperty("输入目录，相对于workDir的路径") + @get:Schema(title = "输入目录，相对于workDir的路径") val inputDir: String = "/package", - @ApiModelProperty("输出目录，相对于workDir的路径") + @get:Schema(title = "输出目录，相对于workDir的路径") val outputDir: String = "/output" ) } diff --git a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/standard/StandardScanExecutorResult.kt b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/standard/StandardScanExecutorResult.kt index 0fe735a9cb..6523014fc3 100644 --- a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/standard/StandardScanExecutorResult.kt +++ b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/standard/StandardScanExecutorResult.kt @@ -30,10 +30,11 @@ package com.tencent.bkrepo.common.analysis.pojo.scanner.standard import com.tencent.bkrepo.common.analysis.pojo.scanner.ScanExecutorResult import com.tencent.bkrepo.common.analysis.pojo.scanner.SubScanTaskStatus import com.tencent.bkrepo.common.analysis.pojo.scanner.utils.normalizedLevel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + data class StandardScanExecutorResult( - @ApiModelProperty("工具分析结果") + @get:Schema(title = "工具分析结果") val output: ToolOutput? = null, override val scanStatus: String = output?.status ?: SubScanTaskStatus.FAILED.name ) : ScanExecutorResult(scanStatus, StandardScanner.TYPE) { diff --git a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/standard/StandardScanner.kt b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/standard/StandardScanner.kt index fcc9d2fea1..24b8ec2155 100644 --- a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/standard/StandardScanner.kt +++ b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/standard/StandardScanner.kt @@ -31,25 +31,25 @@ import com.tencent.bkrepo.common.analysis.pojo.scanner.Scanner import com.tencent.bkrepo.common.api.constant.CharPool.COLON import com.tencent.bkrepo.common.metadata.annotation.Sensitive import com.tencent.bkrepo.common.metadata.handler.MaskPartString -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 标准扫描器，后续可逐步替换掉其他扫描器实现，移除其余扫描器代码 */ -@ApiModel("标准扫描器配置") +@Schema(title = "标准扫描器配置") class StandardScanner( override val name: String, - @ApiModelProperty("扫描器镜像") + @get:Schema(title = "扫描器镜像") val image: String, - @ApiModelProperty("docker仓库用户") + @get:Schema(title = "docker仓库用户") val dockerRegistryUsername: String?, - @ApiModelProperty("docker仓库密码") + @get:Schema(title = "docker仓库密码") val dockerRegistryPassword: String?, - @ApiModelProperty("扫描器容器启动CMD") + @get:Schema(title = "扫描器容器启动CMD") val cmd: String, override val version: String = image.substring(image.lastIndexOf(COLON) + 1, image.length), - @ApiModelProperty("扫描器参数") + @get:Schema(title = "扫描器参数") val args: List = emptyList(), ) : Scanner(name, TYPE, version) { companion object { @@ -60,16 +60,16 @@ class StandardScanner( const val ARG_KEY_MAX_TIME = "maxTime" } - @ApiModel("扫描器参数") + @Schema(title = "扫描器参数") data class Argument( - @ApiModelProperty("参数类型") + @get:Schema(title = "参数类型") val type: String, - @ApiModelProperty("参数名") + @get:Schema(title = "参数名") val key: String, - @ApiModelProperty("参数值") + @get:Schema(title = "参数值") @Sensitive(handler = MaskPartString::class) val value: String? = null, - @ApiModelProperty("描述") + @get:Schema(title = "描述") val des: String = "" ) { companion object { diff --git a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/trivy/TrivyScanExecutorResult.kt b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/trivy/TrivyScanExecutorResult.kt index ec9d439119..a8632e084c 100644 --- a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/trivy/TrivyScanExecutorResult.kt +++ b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/trivy/TrivyScanExecutorResult.kt @@ -29,13 +29,13 @@ package com.tencent.bkrepo.common.analysis.pojo.scanner.trivy import com.tencent.bkrepo.common.analysis.pojo.scanner.ScanExecutorResult import com.tencent.bkrepo.common.analysis.pojo.scanner.utils.normalizedLevel -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("trivy扫描器扫描结果") + +@Schema(title = "trivy扫描器扫描结果") data class TrivyScanExecutorResult( override val scanStatus: String, - @ApiModelProperty("cve审计结果") + @get:Schema(title = "cve审计结果") val vulnerabilityItems: List ) : ScanExecutorResult(scanStatus, TrivyScanner.TYPE) { override fun normalizeResult() { diff --git a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/trivy/TrivyScanResult.kt b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/trivy/TrivyScanResult.kt index 90ad1b0eca..8b7d4b0e37 100644 --- a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/trivy/TrivyScanResult.kt +++ b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/trivy/TrivyScanResult.kt @@ -28,28 +28,28 @@ package com.tencent.bkrepo.common.analysis.pojo.scanner.trivy import com.fasterxml.jackson.annotation.JsonAlias -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("扫描结果") + +@Schema(title = "扫描结果") data class TrivyScanResults( - @ApiModelProperty("扫描结果") + @get:Schema(title = "扫描结果") @JsonAlias("Results") val results: List = emptyList() ) -@ApiModel("制品漏洞信息") +@Schema(title = "制品漏洞信息") data class TrivyScanResult( - @ApiModelProperty("目标") + @get:Schema(title = "目标") @JsonAlias("Target") val target: String, - @ApiModelProperty("类") + @get:Schema(title = "类") @JsonAlias("Class") val clazz: String, - @ApiModelProperty("类型") + @get:Schema(title = "类型") @JsonAlias("Type") val type: String, - @ApiModelProperty("Results") + @get:Schema(title = "Results") @JsonAlias("Vulnerabilities") val vulnerabilities: List? = emptyList() ) diff --git a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/trivy/TrivyScanner.kt b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/trivy/TrivyScanner.kt index 73ce853f69..ab3bf11657 100644 --- a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/trivy/TrivyScanner.kt +++ b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/trivy/TrivyScanner.kt @@ -27,21 +27,21 @@ package com.tencent.bkrepo.common.analysis.pojo.scanner.trivy +import com.tencent.bkrepo.common.analysis.pojo.scanner.Scanner import com.tencent.bkrepo.common.artifact.constant.PUBLIC_GLOBAL_PROJECT import com.tencent.bkrepo.common.artifact.constant.PUBLIC_VULDB_REPO -import com.tencent.bkrepo.common.analysis.pojo.scanner.Scanner -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + -@ApiModel("trivy扫描器配置") +@Schema(title = "trivy扫描器配置") class TrivyScanner( override val name: String, override val version: String, - @ApiModelProperty("扫描器缓存目录，会在rootPath下创建，存放漏洞数据库文件目录，需要以.开头，否则会被定时任务清理") + @get:Schema(title = "扫描器缓存目录，会在rootPath下创建，存放漏洞数据库文件目录，需要以.开头，否则会被定时任务清理") val cacheDir: String = ".cache", - @ApiModelProperty("使用的容器镜像") + @get:Schema(title = "使用的容器镜像") val container: TrivyDockerImage, - @ApiModelProperty("漏洞库配置") + @get:Schema(title = "漏洞库配置") val vulDbConfig: VulDbConfig = VulDbConfig() ) : Scanner(name, TYPE, version) { companion object { @@ -49,29 +49,29 @@ class TrivyScanner( } } -@ApiModel("漏洞数据库配置") +@Schema(title = "漏洞数据库配置") data class VulDbConfig( - @ApiModelProperty("从制品库下载使用的projectId，仅dbSource为[DbSource.REPO]时有有效") + @get:Schema(title = "从制品库下载使用的projectId，仅dbSource为[DbSource.REPO]时有有效") val projectId: String = PUBLIC_GLOBAL_PROJECT, - @ApiModelProperty("从制品库下载使用的repo，会从该repo的trivy目录中下载最新的文件，仅dbSource为[DbSource.REPO]时有有效") + @get:Schema(title = "从制品库下载使用的repo，会从该repo的trivy目录中下载最新的文件，仅dbSource为[DbSource.REPO]时有有效") val repo: String = PUBLIC_VULDB_REPO, - @ApiModelProperty("漏洞库来源") + @get:Schema(title = "漏洞库来源") val dbSource: Int = DbSource.REPO.code, ) -@ApiModel("Trivy容器镜像配置") +@Schema(title = "Trivy容器镜像配置") data class TrivyDockerImage( - @ApiModelProperty("使用的镜像名和版本") + @get:Schema(title = "使用的镜像名和版本") val image: String, - @ApiModelProperty("docker仓库用户") + @get:Schema(title = "docker仓库用户") val dockerRegistryUsername: String?, - @ApiModelProperty("docker仓库密码") + @get:Schema(title = "docker仓库密码") val dockerRegistryPassword: String?, - @ApiModelProperty("容器内的工作目录") + @get:Schema(title = "容器内的工作目录") val workDir: String = "/data", - @ApiModelProperty("输入目录，相对于workDir的路径") + @get:Schema(title = "输入目录，相对于workDir的路径") val inputDir: String = "/package", - @ApiModelProperty("输出目录，相对于workDir的路径") + @get:Schema(title = "输出目录，相对于workDir的路径") val outputDir: String = "/output" ) diff --git a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/trivy/VulnerabilityItem.kt b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/trivy/VulnerabilityItem.kt index 9f242427e4..0f18bb4964 100644 --- a/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/trivy/VulnerabilityItem.kt +++ b/src/backend/common/common-analysis/src/main/kotlin/com/tencent/bkrepo/common/analysis/pojo/scanner/trivy/VulnerabilityItem.kt @@ -28,57 +28,57 @@ package com.tencent.bkrepo.common.analysis.pojo.scanner.trivy import com.fasterxml.jackson.annotation.JsonAlias -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("漏洞信息") + +@Schema(title = "漏洞信息") data class VulnerabilityItem( - @ApiModelProperty("漏洞编号") + @get:Schema(title = "漏洞编号") @JsonAlias("VulnerabilityID") val vulnerabilityId: String, - @ApiModelProperty("PkgName") + @get:Schema(title = "PkgName") @JsonAlias("PkgName") val pkgName: String = "", - @ApiModelProperty("安装版本") + @get:Schema(title = "安装版本") @JsonAlias("InstalledVersion") val installedVersion: String = "", - @ApiModelProperty("修复版本") + @get:Schema(title = "修复版本") @JsonAlias("FixedVersion") val fixedVersion: String = "", - @ApiModelProperty("Layer") + @get:Schema(title = "Layer") @JsonAlias("Layer") val layer: Layer? = null, - @ApiModelProperty("严重来源") + @get:Schema(title = "严重来源") @JsonAlias("SeveritySource") val severitySource: String = "", - @ApiModelProperty("PrimaryURL") + @get:Schema(title = "PrimaryURL") @JsonAlias("PrimaryURL") val primaryUrl: String = "", - @ApiModelProperty("PkgName") + @get:Schema(title = "PkgName") @JsonAlias("DataSource") val dataSource: DataSource? = null, - @ApiModelProperty("Title") + @get:Schema(title = "Title") @JsonAlias("Title") val title: String = "", - @ApiModelProperty("Description") + @get:Schema(title = "Description") @JsonAlias("Description") val description: String = "", - @ApiModelProperty("Severity") + @get:Schema(title = "Severity") @JsonAlias("Severity") var severity: String = "", - @ApiModelProperty("CweIDs") + @get:Schema(title = "CweIDs") @JsonAlias("CweIDs") val cweIds: List? = null, - @ApiModelProperty("CVSS") + @get:Schema(title = "CVSS") @JsonAlias("CVSS") val cvss: Map? = null, - @ApiModelProperty("References") + @get:Schema(title = "References") @JsonAlias("References") val references: List? = null, - @ApiModelProperty("PublishedDate") + @get:Schema(title = "PublishedDate") @JsonAlias("PublishedDate") val publishedDate: String = "", - @ApiModelProperty("LastModifiedDate") + @get:Schema(title = "LastModifiedDate") @JsonAlias("LastModifiedDate") val lastModifiedDate: String = "" ) { @@ -87,41 +87,41 @@ data class VulnerabilityItem( } } -@ApiModel("Layer") +@Schema(title = "Layer") data class Layer( - @ApiModelProperty("Digest") + @get:Schema(title = "Digest") @JsonAlias("Digest") val digest: String = "", - @ApiModelProperty("DiffID") + @get:Schema(title = "DiffID") @JsonAlias("DiffID") val diffId: String = "" ) -@ApiModel("DataSource") +@Schema(title = "DataSource") data class DataSource( - @ApiModelProperty("ID") + @get:Schema(title = "ID") @JsonAlias("ID") val id: String = "", - @ApiModelProperty("Name") + @get:Schema(title = "Name") @JsonAlias("Name") val name: String = "", - @ApiModelProperty("URL") + @get:Schema(title = "URL") @JsonAlias("URL") val url: String = "" ) -@ApiModel("CVSS") +@Schema(title = "CVSS") data class CVSS( - @ApiModelProperty("V2Vector") + @get:Schema(title = "V2Vector") @JsonAlias("V2Vector") val v2Vector: String = "", - @ApiModelProperty("V3Vector") + @get:Schema(title = "V3Vector") @JsonAlias("V3Vector") val v3Vector: String = "", - @ApiModelProperty("V2Score") + @get:Schema(title = "V2Score") @JsonAlias("V2Score") val v2Score: String = "", - @ApiModelProperty("V3Score") + @get:Schema(title = "V3Score") @JsonAlias("V3Score") val v3Score: String = "" ) diff --git a/src/backend/common/common-api/build.gradle.kts b/src/backend/common/common-api/build.gradle.kts index 6efd36aa42..3aeb19f1ce 100644 --- a/src/backend/common/common-api/build.gradle.kts +++ b/src/backend/common/common-api/build.gradle.kts @@ -30,8 +30,8 @@ */ dependencies { - api("io.swagger:swagger-annotations") - api("io.swagger:swagger-models") + api("io.swagger.core.v3:swagger-annotations") + api("io.swagger.core.v3:swagger-models") api("com.fasterxml.jackson.module:jackson-module-kotlin") api("com.fasterxml.jackson.datatype:jackson-datatype-jdk8") api("com.fasterxml.jackson.datatype:jackson-datatype-jsr310") diff --git a/src/backend/common/common-api/src/main/kotlin/com/tencent/bkrepo/common/api/pojo/Page.kt b/src/backend/common/common-api/src/main/kotlin/com/tencent/bkrepo/common/api/pojo/Page.kt index ab213939a4..6ded61feda 100644 --- a/src/backend/common/common-api/src/main/kotlin/com/tencent/bkrepo/common/api/pojo/Page.kt +++ b/src/backend/common/common-api/src/main/kotlin/com/tencent/bkrepo/common/api/pojo/Page.kt @@ -31,21 +31,21 @@ package com.tencent.bkrepo.common.api.pojo -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + import kotlin.math.ceil -@ApiModel("分页数据包装模型") +@Schema(title = "分页数据包装模型") data class Page( - @ApiModelProperty("页码(从1页开始)") + @get:Schema(title = "页码(从1页开始)") val pageNumber: Int, - @ApiModelProperty("每页多少条") + @get:Schema(title = "每页多少条") val pageSize: Int, - @ApiModelProperty("总记录条数") + @get:Schema(title = "总记录条数") val totalRecords: Long, - @ApiModelProperty("总页数") + @get:Schema(title = "总页数") val totalPages: Long, - @ApiModelProperty("数据列表") + @get:Schema(title = "数据列表") val records: List ) { constructor(pageNumber: Int, pageSize: Int, totalRecords: Long, records: List) : this( diff --git a/src/backend/common/common-api/src/main/kotlin/com/tencent/bkrepo/common/api/pojo/Response.kt b/src/backend/common/common-api/src/main/kotlin/com/tencent/bkrepo/common/api/pojo/Response.kt index 33aa85a7c2..b8a0914e3c 100644 --- a/src/backend/common/common-api/src/main/kotlin/com/tencent/bkrepo/common/api/pojo/Response.kt +++ b/src/backend/common/common-api/src/main/kotlin/com/tencent/bkrepo/common/api/pojo/Response.kt @@ -33,18 +33,18 @@ package com.tencent.bkrepo.common.api.pojo import com.fasterxml.jackson.annotation.JsonIgnore import com.tencent.bkrepo.common.api.message.CommonMessageCode -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("数据返回包装模型") + +@Schema(title = "数据返回包装模型") open class Response( - @ApiModelProperty("返回码") + @get:Schema(title = "返回码") val code: Int, - @ApiModelProperty("错误信息") + @get:Schema(title = "错误信息") val message: String? = null, - @ApiModelProperty("数据") + @get:Schema(title = "数据") val data: T? = null, - @ApiModelProperty("链路追踪id") + @get:Schema(title = "链路追踪id") val traceId: String? = null ) { @JsonIgnore diff --git a/src/backend/common/common-artifact/artifact-api/src/main/kotlin/com/tencent/bkrepo/common/artifact/pojo/configuration/RepositoryConfiguration.kt b/src/backend/common/common-artifact/artifact-api/src/main/kotlin/com/tencent/bkrepo/common/artifact/pojo/configuration/RepositoryConfiguration.kt index 7f2e2de6df..86f34162cf 100644 --- a/src/backend/common/common-artifact/artifact-api/src/main/kotlin/com/tencent/bkrepo/common/artifact/pojo/configuration/RepositoryConfiguration.kt +++ b/src/backend/common/common-artifact/artifact-api/src/main/kotlin/com/tencent/bkrepo/common/artifact/pojo/configuration/RepositoryConfiguration.kt @@ -39,7 +39,8 @@ import com.tencent.bkrepo.common.artifact.pojo.configuration.local.LocalConfigur import com.tencent.bkrepo.common.artifact.pojo.configuration.proxy.ProxyConfiguration import com.tencent.bkrepo.common.artifact.pojo.configuration.remote.RemoteConfiguration import com.tencent.bkrepo.common.artifact.pojo.configuration.virtual.VirtualConfiguration -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + @JsonTypeInfo( use = JsonTypeInfo.Id.NAME, @@ -60,7 +61,7 @@ open class RepositoryConfiguration { * 设置项 * 不同类型仓库可以通过该字段进行差异化配置 */ - @ApiModelProperty("设置项", required = false) + @get:Schema(title = "设置项", required = false) val settings: MutableMap = mutableMapOf() /** diff --git a/src/backend/common/common-artifact/artifact-api/src/main/kotlin/com/tencent/bkrepo/common/artifact/pojo/configuration/composite/CompositeConfiguration.kt b/src/backend/common/common-artifact/artifact-api/src/main/kotlin/com/tencent/bkrepo/common/artifact/pojo/configuration/composite/CompositeConfiguration.kt index 6f8e9b0611..aaa95051f8 100644 --- a/src/backend/common/common-artifact/artifact-api/src/main/kotlin/com/tencent/bkrepo/common/artifact/pojo/configuration/composite/CompositeConfiguration.kt +++ b/src/backend/common/common-artifact/artifact-api/src/main/kotlin/com/tencent/bkrepo/common/artifact/pojo/configuration/composite/CompositeConfiguration.kt @@ -32,12 +32,12 @@ package com.tencent.bkrepo.common.artifact.pojo.configuration.composite import com.tencent.bkrepo.common.artifact.pojo.configuration.local.LocalConfiguration -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("组合类型仓库配置") + +@Schema(title = "组合类型仓库配置") data class CompositeConfiguration( - @ApiModelProperty("代理配置", required = false) + @get:Schema(title = "代理配置", required = false) val proxy: ProxyConfiguration = ProxyConfiguration() ) : LocalConfiguration() { diff --git a/src/backend/common/common-artifact/artifact-api/src/main/kotlin/com/tencent/bkrepo/common/artifact/pojo/configuration/composite/ProxyChannelSetting.kt b/src/backend/common/common-artifact/artifact-api/src/main/kotlin/com/tencent/bkrepo/common/artifact/pojo/configuration/composite/ProxyChannelSetting.kt index d0553fd0f6..6d9288e85f 100644 --- a/src/backend/common/common-artifact/artifact-api/src/main/kotlin/com/tencent/bkrepo/common/artifact/pojo/configuration/composite/ProxyChannelSetting.kt +++ b/src/backend/common/common-artifact/artifact-api/src/main/kotlin/com/tencent/bkrepo/common/artifact/pojo/configuration/composite/ProxyChannelSetting.kt @@ -31,24 +31,24 @@ package com.tencent.bkrepo.common.artifact.pojo.configuration.composite -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 代理源 */ -@ApiModel("代理源设置") +@Schema(title = "代理源设置") data class ProxyChannelSetting( - @ApiModelProperty("是否为公有源", required = true) + @get:Schema(title = "是否为公有源", required = true) val public: Boolean, - @ApiModelProperty("名称", required = true) + @get:Schema(title = "名称", required = true) val name: String, - @ApiModelProperty("地址", required = true) + @get:Schema(title = "地址", required = true) val url: String, - @ApiModelProperty("鉴权凭据key", required = false) + @get:Schema(title = "鉴权凭据key", required = false) val credentialKey: String? = null, - @ApiModelProperty("代理源认证用户名", required = false) + @get:Schema(title = "代理源认证用户名", required = false) val username: String? = null, - @ApiModelProperty("代理源认证密码", required = false) + @get:Schema(title = "代理源认证密码", required = false) var password: String? = null ) diff --git a/src/backend/common/common-artifact/artifact-api/src/main/kotlin/com/tencent/bkrepo/common/artifact/pojo/configuration/composite/ProxyConfiguration.kt b/src/backend/common/common-artifact/artifact-api/src/main/kotlin/com/tencent/bkrepo/common/artifact/pojo/configuration/composite/ProxyConfiguration.kt index df02c2ff72..a81f8ff4ca 100644 --- a/src/backend/common/common-artifact/artifact-api/src/main/kotlin/com/tencent/bkrepo/common/artifact/pojo/configuration/composite/ProxyConfiguration.kt +++ b/src/backend/common/common-artifact/artifact-api/src/main/kotlin/com/tencent/bkrepo/common/artifact/pojo/configuration/composite/ProxyConfiguration.kt @@ -31,14 +31,14 @@ package com.tencent.bkrepo.common.artifact.pojo.configuration.composite -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 代理配置 */ -@ApiModel("代理配置") +@Schema(title = "代理配置") data class ProxyConfiguration( - @ApiModelProperty("代理源列表", required = false) + @get:Schema(title = "代理源列表", required = false) val channelList: List = emptyList() ) diff --git a/src/backend/common/common-artifact/artifact-api/src/main/kotlin/com/tencent/bkrepo/common/artifact/pojo/configuration/local/LocalConfiguration.kt b/src/backend/common/common-artifact/artifact-api/src/main/kotlin/com/tencent/bkrepo/common/artifact/pojo/configuration/local/LocalConfiguration.kt index c50db596bd..27bd917dc7 100644 --- a/src/backend/common/common-artifact/artifact-api/src/main/kotlin/com/tencent/bkrepo/common/artifact/pojo/configuration/local/LocalConfiguration.kt +++ b/src/backend/common/common-artifact/artifact-api/src/main/kotlin/com/tencent/bkrepo/common/artifact/pojo/configuration/local/LocalConfiguration.kt @@ -33,7 +33,8 @@ package com.tencent.bkrepo.common.artifact.pojo.configuration.local import com.tencent.bkrepo.common.artifact.pojo.configuration.RepositoryConfiguration import com.tencent.bkrepo.common.artifact.pojo.configuration.local.webhook.WebHookConfiguration -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 本地仓库配置 @@ -42,7 +43,7 @@ open class LocalConfiguration( /** * webHook配置 */ - @ApiModelProperty("WebHook配置", required = false) + @get:Schema(title = "WebHook配置", required = false) var webHook: WebHookConfiguration = WebHookConfiguration() ) : RepositoryConfiguration() { diff --git a/src/backend/common/common-artifact/artifact-api/src/main/kotlin/com/tencent/bkrepo/common/artifact/pojo/configuration/local/webhook/WebHookConfiguration.kt b/src/backend/common/common-artifact/artifact-api/src/main/kotlin/com/tencent/bkrepo/common/artifact/pojo/configuration/local/webhook/WebHookConfiguration.kt index 04de1621f2..f13bdd4c8a 100644 --- a/src/backend/common/common-artifact/artifact-api/src/main/kotlin/com/tencent/bkrepo/common/artifact/pojo/configuration/local/webhook/WebHookConfiguration.kt +++ b/src/backend/common/common-artifact/artifact-api/src/main/kotlin/com/tencent/bkrepo/common/artifact/pojo/configuration/local/webhook/WebHookConfiguration.kt @@ -31,11 +31,11 @@ package com.tencent.bkrepo.common.artifact.pojo.configuration.local.webhook -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("WebHook配置") + +@Schema(title = "WebHook配置") data class WebHookConfiguration( - @ApiModelProperty("WebHook配置列表", required = false) + @get:Schema(title = "WebHook配置列表", required = false) val webHookList: List = emptyList() ) diff --git a/src/backend/common/common-artifact/artifact-api/src/main/kotlin/com/tencent/bkrepo/common/artifact/pojo/configuration/local/webhook/WebHookSetting.kt b/src/backend/common/common-artifact/artifact-api/src/main/kotlin/com/tencent/bkrepo/common/artifact/pojo/configuration/local/webhook/WebHookSetting.kt index 0cf31382fd..4863017a81 100644 --- a/src/backend/common/common-artifact/artifact-api/src/main/kotlin/com/tencent/bkrepo/common/artifact/pojo/configuration/local/webhook/WebHookSetting.kt +++ b/src/backend/common/common-artifact/artifact-api/src/main/kotlin/com/tencent/bkrepo/common/artifact/pojo/configuration/local/webhook/WebHookSetting.kt @@ -31,13 +31,13 @@ package com.tencent.bkrepo.common.artifact.pojo.configuration.local.webhook -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("WebHook设置") + +@Schema(title = "WebHook设置") data class WebHookSetting( - @ApiModelProperty("远程地址", required = true) + @get:Schema(title = "远程地址", required = true) val url: String, - @ApiModelProperty("请求头", required = true) + @get:Schema(title = "请求头", required = true) val headers: Map? = null ) diff --git a/src/backend/common/common-artifact/artifact-api/src/main/kotlin/com/tencent/bkrepo/common/artifact/pojo/configuration/proxy/ProxyConfiguration.kt b/src/backend/common/common-artifact/artifact-api/src/main/kotlin/com/tencent/bkrepo/common/artifact/pojo/configuration/proxy/ProxyConfiguration.kt index 75f900722f..bc9873c5b8 100644 --- a/src/backend/common/common-artifact/artifact-api/src/main/kotlin/com/tencent/bkrepo/common/artifact/pojo/configuration/proxy/ProxyConfiguration.kt +++ b/src/backend/common/common-artifact/artifact-api/src/main/kotlin/com/tencent/bkrepo/common/artifact/pojo/configuration/proxy/ProxyConfiguration.kt @@ -2,23 +2,23 @@ package com.tencent.bkrepo.common.artifact.pojo.configuration.proxy import com.tencent.bkrepo.common.artifact.pojo.configuration.composite.ProxyChannelSetting import com.tencent.bkrepo.common.artifact.pojo.configuration.local.LocalConfiguration -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 代理仓库配置 * */ -@ApiModel("代理仓库配置") +@Schema(title = "代理仓库配置") class ProxyConfiguration( /** * 代理服务器配置 * */ - @ApiModelProperty("代理服务器配置") + @get:Schema(title = "代理服务器配置") val proxy: ProxyChannelSetting = ProxyChannelSetting(false, "", ""), /** * 客户端访问的代理地址 * */ - @ApiModelProperty("访问url", required = false) + @get:Schema(title = "访问url", required = false) var url: String? = null, ) : LocalConfiguration() { diff --git a/src/backend/common/common-artifact/artifact-cache/src/main/kotlin/com/tencent/bkrepo/common/artifact/cache/pojo/ArtifactPreloadPlan.kt b/src/backend/common/common-artifact/artifact-cache/src/main/kotlin/com/tencent/bkrepo/common/artifact/cache/pojo/ArtifactPreloadPlan.kt index 65948f931d..639629328e 100644 --- a/src/backend/common/common-artifact/artifact-cache/src/main/kotlin/com/tencent/bkrepo/common/artifact/cache/pojo/ArtifactPreloadPlan.kt +++ b/src/backend/common/common-artifact/artifact-cache/src/main/kotlin/com/tencent/bkrepo/common/artifact/cache/pojo/ArtifactPreloadPlan.kt @@ -28,32 +28,31 @@ package com.tencent.bkrepo.common.artifact.cache.pojo import com.tencent.bkrepo.common.artifact.cache.model.TArtifactPreloadPlan -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema import java.time.LocalDateTime -@ApiModel("预加载执行计划") +@Schema(title = "预加载执行计划") data class ArtifactPreloadPlan( val id: String? = null, val createdDate: LocalDateTime, val lastModifiedDate: LocalDateTime, - @ApiModelProperty("所属策略ID，仅用于记录执行计划来源") + @get:Schema(title = "所属策略ID，仅用于记录执行计划来源") val strategyId: String? = null, - @ApiModelProperty("所属项目ID，仅用于记录执行计划来源") + @get:Schema(title = "所属项目ID，仅用于记录执行计划来源") val projectId: String? = null, - @ApiModelProperty("所属仓库，仅用于记录执行计划来源") + @get:Schema(title = "所属仓库，仅用于记录执行计划来源") val repoName: String? = null, - @ApiModelProperty("待加载制品的完整路径，仅用于记录执行计划来源") + @get:Schema(title = "待加载制品的完整路径，仅用于记录执行计划来源") val fullPath: String? = null, - @ApiModelProperty("待加载制品sha256") + @get:Schema(title = "待加载制品sha256") val sha256: String, - @ApiModelProperty("待加载制品大小") + @get:Schema(title = "待加载制品大小") val size: Long, - @ApiModelProperty("待加载制品所在存储，为null时表示默认存储") + @get:Schema(title = "待加载制品所在存储，为null时表示默认存储") val credentialsKey: String? = null, - @ApiModelProperty("预加载计划执行毫秒时间戳") + @get:Schema(title = "预加载计划执行毫秒时间戳") val executeTime: Long, - @ApiModelProperty("预加载计划执行状态") + @get:Schema(title = "预加载计划执行状态") val status: String = STATUS_PENDING ) { fun toPo() = TArtifactPreloadPlan( diff --git a/src/backend/common/common-artifact/artifact-cache/src/main/kotlin/com/tencent/bkrepo/common/artifact/cache/pojo/ArtifactPreloadPlanCreateRequest.kt b/src/backend/common/common-artifact/artifact-cache/src/main/kotlin/com/tencent/bkrepo/common/artifact/cache/pojo/ArtifactPreloadPlanCreateRequest.kt index 399ca831a2..6b197d1bff 100644 --- a/src/backend/common/common-artifact/artifact-cache/src/main/kotlin/com/tencent/bkrepo/common/artifact/cache/pojo/ArtifactPreloadPlanCreateRequest.kt +++ b/src/backend/common/common-artifact/artifact-cache/src/main/kotlin/com/tencent/bkrepo/common/artifact/cache/pojo/ArtifactPreloadPlanCreateRequest.kt @@ -1,16 +1,16 @@ package com.tencent.bkrepo.common.artifact.cache.pojo -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("预加载执行计划创建清理") + +@Schema(title = "预加载执行计划创建清理") data class ArtifactPreloadPlanCreateRequest( - @ApiModelProperty("所属项目ID") + @get:Schema(title = "所属项目ID") val projectId: String, - @ApiModelProperty("所属仓库") + @get:Schema(title = "所属仓库") val repoName: String, - @ApiModelProperty("待加载制品的完整路径") + @get:Schema(title = "待加载制品的完整路径") val fullPath: String, - @ApiModelProperty("预加载计划执行毫秒时间戳") + @get:Schema(title = "预加载计划执行毫秒时间戳") val executeTime: Long, ) diff --git a/src/backend/common/common-artifact/artifact-cache/src/main/kotlin/com/tencent/bkrepo/common/artifact/cache/pojo/ArtifactPreloadStrategy.kt b/src/backend/common/common-artifact/artifact-cache/src/main/kotlin/com/tencent/bkrepo/common/artifact/cache/pojo/ArtifactPreloadStrategy.kt index a61c236d49..4fed10a2a6 100644 --- a/src/backend/common/common-artifact/artifact-cache/src/main/kotlin/com/tencent/bkrepo/common/artifact/cache/pojo/ArtifactPreloadStrategy.kt +++ b/src/backend/common/common-artifact/artifact-cache/src/main/kotlin/com/tencent/bkrepo/common/artifact/cache/pojo/ArtifactPreloadStrategy.kt @@ -28,35 +28,34 @@ package com.tencent.bkrepo.common.artifact.cache.pojo import com.tencent.bkrepo.common.artifact.cache.model.TArtifactPreloadStrategy -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema import java.time.LocalDateTime -@ApiModel("预加载策略") +@Schema(title = "预加载策略") data class ArtifactPreloadStrategy( - @ApiModelProperty("id") + @get:Schema(title = "id") val id: String? = null, - @ApiModelProperty("创建人") + @get:Schema(title = "创建人") val createdBy: String, - @ApiModelProperty("创建时间") + @get:Schema(title = "创建时间") val createdDate: LocalDateTime, - @ApiModelProperty("修改人") + @get:Schema(title = "修改人") val lastModifiedBy: String, - @ApiModelProperty("修改时间") + @get:Schema(title = "修改时间") val lastModifiedDate: LocalDateTime, - @ApiModelProperty("策略所属项目") + @get:Schema(title = "策略所属项目") val projectId: String, - @ApiModelProperty("策略所属仓库") + @get:Schema(title = "策略所属仓库") val repoName: String, - @ApiModelProperty("文件路径正则，匹配成功才会执行预加载") + @get:Schema(title = "文件路径正则，匹配成功才会执行预加载") val fullPathRegex: String, - @ApiModelProperty("仅加载大于指定大小的文件") + @get:Schema(title = "仅加载大于指定大小的文件") val minSize: Long, - @ApiModelProperty("限制只对最近一段时间内创建的制品执行预加载") + @get:Schema(title = "限制只对最近一段时间内创建的制品执行预加载") val recentSeconds: Long, - @ApiModelProperty("预加载执行时间") + @get:Schema(title = "预加载执行时间") val preloadCron: String? = null, - @ApiModelProperty("策略类型") + @get:Schema(title = "策略类型") val type: String, ) { fun toPo() = TArtifactPreloadStrategy( diff --git a/src/backend/common/common-artifact/artifact-cache/src/main/kotlin/com/tencent/bkrepo/common/artifact/cache/pojo/ArtifactPreloadStrategyCreateRequest.kt b/src/backend/common/common-artifact/artifact-cache/src/main/kotlin/com/tencent/bkrepo/common/artifact/cache/pojo/ArtifactPreloadStrategyCreateRequest.kt index ff08aae5e6..3372282221 100644 --- a/src/backend/common/common-artifact/artifact-cache/src/main/kotlin/com/tencent/bkrepo/common/artifact/cache/pojo/ArtifactPreloadStrategyCreateRequest.kt +++ b/src/backend/common/common-artifact/artifact-cache/src/main/kotlin/com/tencent/bkrepo/common/artifact/cache/pojo/ArtifactPreloadStrategyCreateRequest.kt @@ -28,25 +28,25 @@ package com.tencent.bkrepo.common.artifact.cache.pojo import com.tencent.bkrepo.repository.constant.SYSTEM_USER -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("预加载策略创建请求") + +@Schema(title = "预加载策略创建请求") data class ArtifactPreloadStrategyCreateRequest( - @ApiModelProperty("策略所属项目") + @get:Schema(title = "策略所属项目") val projectId: String, - @ApiModelProperty("策略所属仓库") + @get:Schema(title = "策略所属仓库") val repoName: String, - @ApiModelProperty("文件路径正则，匹配成功才会执行预加载") + @get:Schema(title = "文件路径正则，匹配成功才会执行预加载") val fullPathRegex: String, - @ApiModelProperty("仅加载大于指定大小的文件") + @get:Schema(title = "仅加载大于指定大小的文件") val minSize: Long, - @ApiModelProperty("限制只对最近一段时间内创建的制品执行预加载") + @get:Schema(title = "限制只对最近一段时间内创建的制品执行预加载") val recentSeconds: Long, - @ApiModelProperty("预加载执行时间") + @get:Schema(title = "预加载执行时间") val preloadCron: String? = null, - @ApiModelProperty("策略类型") + @get:Schema(title = "策略类型") val type: String = PreloadStrategyType.CUSTOM.name, - @ApiModelProperty("操作人") + @get:Schema(title = "操作人") val operator: String = SYSTEM_USER, ) diff --git a/src/backend/common/common-artifact/artifact-cache/src/main/kotlin/com/tencent/bkrepo/common/artifact/cache/pojo/ArtifactPreloadStrategyUpdateRequest.kt b/src/backend/common/common-artifact/artifact-cache/src/main/kotlin/com/tencent/bkrepo/common/artifact/cache/pojo/ArtifactPreloadStrategyUpdateRequest.kt index e6af29230d..3ff32c9802 100644 --- a/src/backend/common/common-artifact/artifact-cache/src/main/kotlin/com/tencent/bkrepo/common/artifact/cache/pojo/ArtifactPreloadStrategyUpdateRequest.kt +++ b/src/backend/common/common-artifact/artifact-cache/src/main/kotlin/com/tencent/bkrepo/common/artifact/cache/pojo/ArtifactPreloadStrategyUpdateRequest.kt @@ -28,25 +28,25 @@ package com.tencent.bkrepo.common.artifact.cache.pojo import com.tencent.bkrepo.repository.constant.SYSTEM_USER -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("预加载策略更新请求") + +@Schema(title = "预加载策略更新请求") data class ArtifactPreloadStrategyUpdateRequest( - @ApiModelProperty("策略ID") + @get:Schema(title = "策略ID") val id: String, - @ApiModelProperty("策略所属项目") + @get:Schema(title = "策略所属项目") val projectId: String, - @ApiModelProperty("策略所属仓库") + @get:Schema(title = "策略所属仓库") val repoName: String, - @ApiModelProperty("文件路径正则，匹配成功才会执行预加载") + @get:Schema(title = "文件路径正则，匹配成功才会执行预加载") val fullPathRegex: String? = null, - @ApiModelProperty("仅加载大于指定大小的文件") + @get:Schema(title = "仅加载大于指定大小的文件") val minSize: Long? = null, - @ApiModelProperty("限制只对最近一段时间内创建的制品执行预加载") + @get:Schema(title = "限制只对最近一段时间内创建的制品执行预加载") val recentSeconds: Long? = null, - @ApiModelProperty("预加载执行时间") + @get:Schema(title = "预加载执行时间") val preloadCron: String? = null, - @ApiModelProperty("操作人") + @get:Schema(title = "操作人") val operator: String = SYSTEM_USER, ) diff --git a/src/backend/common/common-bksync/src/main/kotlin/com/tencent/bkrepo/common/bksync/transfer/http/HttpBkSyncCall.kt b/src/backend/common/common-bksync/src/main/kotlin/com/tencent/bkrepo/common/bksync/transfer/http/HttpBkSyncCall.kt index 7335be4a26..330afdff52 100644 --- a/src/backend/common/common-bksync/src/main/kotlin/com/tencent/bkrepo/common/bksync/transfer/http/HttpBkSyncCall.kt +++ b/src/backend/common/common-bksync/src/main/kotlin/com/tencent/bkrepo/common/bksync/transfer/http/HttpBkSyncCall.kt @@ -22,7 +22,7 @@ import okhttp3.MediaType.Companion.toMediaType import okhttp3.MediaType.Companion.toMediaTypeOrNull import okhttp3.OkHttpClient import okhttp3.Request -import okhttp3.RequestBody +import okhttp3.RequestBody.Companion.asRequestBody import okhttp3.RequestBody.Companion.toRequestBody import okhttp3.Response import okhttp3.internal.sse.RealEventSource @@ -170,7 +170,7 @@ open class HttpBkSyncCall( .addQueryParameter("action", UPLOAD_ACTION).build() val request = Request.Builder() .url(reportUrl) - .put(RequestBody.create(null, ByteArray(0))) + .put(ByteArray(0).toRequestBody(null)) .build() val response = client.newCall(request).execute() response.use { @@ -229,7 +229,7 @@ open class HttpBkSyncCall( private fun uploadNewSignFile(request: UploadRequest, signData: ByteArray) { with(request) { logger.info("Start upload sign file.") - val signFileBody = RequestBody.create(APPLICATION_OCTET_STREAM.toMediaType(), signData) + val signFileBody = signData.toRequestBody(APPLICATION_OCTET_STREAM.toMediaType()) val uploadUrl = newFileSignUrl.toHttpUrlOrNull()!!.newBuilder().addQueryParameter( QUERY_PARAM_MD5, headers[HEADER_MD5] ).build() @@ -308,7 +308,7 @@ open class HttpBkSyncCall( } } logger.info("Start upload delta file.") - val body = RequestBody.create(APPLICATION_OCTET_STREAM.toMediaType(), deltaFile) + val body = deltaFile.asRequestBody(APPLICATION_OCTET_STREAM.toMediaType()) val patchRequest = Request.Builder() .url(deltaUrl) .headers(headers) @@ -370,7 +370,7 @@ open class HttpBkSyncCall( val request = context.request with(request) { logger.info("Start use generic upload.") - val body = RequestBody.create(APPLICATION_OCTET_STREAM.toMediaType(), file) + val body = file.asRequestBody(APPLICATION_OCTET_STREAM.toMediaType()) val commonRequest = Request.Builder() .url(genericUrl) .put(body) diff --git a/src/backend/common/common-metadata/metadata-api/src/main/kotlin/com/tencent/bkrepo/common/metadata/pojo/file/FileReference.kt b/src/backend/common/common-metadata/metadata-api/src/main/kotlin/com/tencent/bkrepo/common/metadata/pojo/file/FileReference.kt index e60a534134..3181092e21 100644 --- a/src/backend/common/common-metadata/metadata-api/src/main/kotlin/com/tencent/bkrepo/common/metadata/pojo/file/FileReference.kt +++ b/src/backend/common/common-metadata/metadata-api/src/main/kotlin/com/tencent/bkrepo/common/metadata/pojo/file/FileReference.kt @@ -27,15 +27,15 @@ package com.tencent.bkrepo.common.metadata.pojo.file -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("文件引用信息") + +@Schema(title = "文件引用信息") data class FileReference( - @ApiModelProperty("所引用文件的sha256") + @get:Schema(title = "所引用文件的sha256") val sha256: String, - @ApiModelProperty("文件实际存储所在存储") + @get:Schema(title = "文件实际存储所在存储") val credentialsKey: String? = null, - @ApiModelProperty("当前记录文件被引用次数") + @get:Schema(title = "当前记录文件被引用次数") val count: Long ) diff --git a/src/backend/common/common-metadata/metadata-api/src/main/kotlin/com/tencent/bkrepo/common/metadata/pojo/log/OpLogListOption.kt b/src/backend/common/common-metadata/metadata-api/src/main/kotlin/com/tencent/bkrepo/common/metadata/pojo/log/OpLogListOption.kt index 5b5bc3fc3d..dd2608d312 100644 --- a/src/backend/common/common-metadata/metadata-api/src/main/kotlin/com/tencent/bkrepo/common/metadata/pojo/log/OpLogListOption.kt +++ b/src/backend/common/common-metadata/metadata-api/src/main/kotlin/com/tencent/bkrepo/common/metadata/pojo/log/OpLogListOption.kt @@ -31,36 +31,35 @@ import com.tencent.bkrepo.common.api.constant.DEFAULT_PAGE_NUMBER import com.tencent.bkrepo.common.api.constant.DEFAULT_PAGE_SIZE import com.tencent.bkrepo.common.artifact.event.base.EventType import com.tencent.bkrepo.common.query.model.Sort -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema import java.time.LocalDateTime -@ApiModel("操作日志列表选项") +@Schema(title = "操作日志列表选项") data class OpLogListOption( - @ApiModelProperty("分页数") + @get:Schema(title = "分页数") val pageNumber: Int = DEFAULT_PAGE_NUMBER, - @ApiModelProperty("分页大小") + @get:Schema(title = "分页大小") val pageSize: Int = DEFAULT_PAGE_SIZE, - @ApiModelProperty("所属项目Id") + @get:Schema(title = "所属项目Id") val projectId: String, - @ApiModelProperty("所属仓库名称") + @get:Schema(title = "所属仓库名称") val repoName: String, - @ApiModelProperty("节点完整路径") + @get:Schema(title = "节点完整路径") val resourceKey: String, - @ApiModelProperty("事件类型") + @get:Schema(title = "事件类型") val eventType: EventType, - @ApiModelProperty("sha256校验值") + @get:Schema(title = "sha256校验值") val sha256: String?, - @ApiModelProperty("流水线Id") + @get:Schema(title = "流水线Id") val pipelineId: String?, - @ApiModelProperty("流水线构建Id") + @get:Schema(title = "流水线构建Id") val buildId: String?, - @ApiModelProperty("下载用户Id") + @get:Schema(title = "下载用户Id") val userId: String?, - @ApiModelProperty("查询起始时间") + @get:Schema(title = "查询起始时间") val startTime: LocalDateTime = LocalDateTime.now().minusMonths(3L), - @ApiModelProperty("查询截至时间") + @get:Schema(title = "查询截至时间") val endTime: LocalDateTime = LocalDateTime.now(), - @ApiModelProperty("时间排序方向") + @get:Schema(title = "时间排序方向") val direction: Sort.Direction = Sort.Direction.DESC ) diff --git a/src/backend/common/common-metadata/metadata-api/src/main/kotlin/com/tencent/bkrepo/common/metadata/pojo/log/OperateLogResponse.kt b/src/backend/common/common-metadata/metadata-api/src/main/kotlin/com/tencent/bkrepo/common/metadata/pojo/log/OperateLogResponse.kt index 58b12f3e70..447cfc4e58 100644 --- a/src/backend/common/common-metadata/metadata-api/src/main/kotlin/com/tencent/bkrepo/common/metadata/pojo/log/OperateLogResponse.kt +++ b/src/backend/common/common-metadata/metadata-api/src/main/kotlin/com/tencent/bkrepo/common/metadata/pojo/log/OperateLogResponse.kt @@ -27,10 +27,10 @@ package com.tencent.bkrepo.common.metadata.pojo.log -import io.swagger.annotations.Api +import io.swagger.v3.oas.annotations.media.Schema import java.time.LocalDateTime -@Api("操作日志") +@Schema(name = "操作日志") data class OperateLogResponse( val createdDate: LocalDateTime, val operate: String, diff --git a/src/backend/common/common-metadata/metadata-api/src/main/kotlin/com/tencent/bkrepo/common/metadata/pojo/node/NodeRestoreOption.kt b/src/backend/common/common-metadata/metadata-api/src/main/kotlin/com/tencent/bkrepo/common/metadata/pojo/node/NodeRestoreOption.kt index a4ee23d4c7..ec47d2b2bc 100644 --- a/src/backend/common/common-metadata/metadata-api/src/main/kotlin/com/tencent/bkrepo/common/metadata/pojo/node/NodeRestoreOption.kt +++ b/src/backend/common/common-metadata/metadata-api/src/main/kotlin/com/tencent/bkrepo/common/metadata/pojo/node/NodeRestoreOption.kt @@ -31,17 +31,17 @@ package com.tencent.bkrepo.common.metadata.pojo.node -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 节点恢复选项 */ -@ApiModel("节点恢复选项") +@Schema(title = "节点恢复选项") data class NodeRestoreOption( - @ApiModelProperty("删除时间") + @get:Schema(title = "删除时间") val deletedId: Long, - @ApiModelProperty("冲突处理策略") + @get:Schema(title = "冲突处理策略") val conflictStrategy: ConflictStrategy = ConflictStrategy.SKIP ) diff --git a/src/backend/common/common-metadata/metadata-api/src/main/kotlin/com/tencent/bkrepo/common/metadata/pojo/project/ProjectUsageStatistics.kt b/src/backend/common/common-metadata/metadata-api/src/main/kotlin/com/tencent/bkrepo/common/metadata/pojo/project/ProjectUsageStatistics.kt index fdf579f61f..84358bca7a 100644 --- a/src/backend/common/common-metadata/metadata-api/src/main/kotlin/com/tencent/bkrepo/common/metadata/pojo/project/ProjectUsageStatistics.kt +++ b/src/backend/common/common-metadata/metadata-api/src/main/kotlin/com/tencent/bkrepo/common/metadata/pojo/project/ProjectUsageStatistics.kt @@ -27,17 +27,17 @@ package com.tencent.bkrepo.common.metadata.pojo.project -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("项目使用情况统计数据") + +@Schema(title = "项目使用情况统计数据") data class ProjectUsageStatistics( - @ApiModelProperty("项目ID") + @get:Schema(title = "项目ID") val projectId: String, - @ApiModelProperty("请求次数") + @get:Schema(title = "请求次数") val reqCount: Long = 0L, - @ApiModelProperty("项目上传流量") + @get:Schema(title = "项目上传流量") var receiveBytes: Long = 0L, - @ApiModelProperty("项目下载流量") + @get:Schema(title = "项目下载流量") var responseBytes: Long = 0L, ) diff --git a/src/backend/common/common-metadata/metadata-api/src/main/kotlin/com/tencent/bkrepo/common/metadata/pojo/project/ProjectUsageStatisticsListOption.kt b/src/backend/common/common-metadata/metadata-api/src/main/kotlin/com/tencent/bkrepo/common/metadata/pojo/project/ProjectUsageStatisticsListOption.kt index 9e04ed61eb..2ad9a4c313 100644 --- a/src/backend/common/common-metadata/metadata-api/src/main/kotlin/com/tencent/bkrepo/common/metadata/pojo/project/ProjectUsageStatisticsListOption.kt +++ b/src/backend/common/common-metadata/metadata-api/src/main/kotlin/com/tencent/bkrepo/common/metadata/pojo/project/ProjectUsageStatisticsListOption.kt @@ -29,17 +29,18 @@ package com.tencent.bkrepo.common.metadata.pojo.project import com.tencent.bkrepo.common.api.constant.DEFAULT_PAGE_NUMBER import com.tencent.bkrepo.common.api.constant.DEFAULT_PAGE_SIZE -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + data class ProjectUsageStatisticsListOption( - @ApiModelProperty("项目ID") + @get:Schema(title = "项目ID") val projectId: String? = null, - @ApiModelProperty("开始时间，包含") + @get:Schema(title = "开始时间，包含") val start: Long? = null, - @ApiModelProperty("结束时间，不包含") + @get:Schema(title = "结束时间，不包含") val end: Long? = null, - @ApiModelProperty("分页数") + @get:Schema(title = "分页数") val pageNumber: Int = DEFAULT_PAGE_NUMBER, - @ApiModelProperty("分页大小") + @get:Schema(title = "分页大小") val pageSize: Int = DEFAULT_PAGE_SIZE, ) diff --git a/src/backend/common/common-metadata/metadata-service/src/main/kotlin/com/tencent/bkrepo/common/metadata/client/RAuthClient.kt b/src/backend/common/common-metadata/metadata-service/src/main/kotlin/com/tencent/bkrepo/common/metadata/client/RAuthClient.kt index c58e70fffc..75feb800b1 100644 --- a/src/backend/common/common-metadata/metadata-service/src/main/kotlin/com/tencent/bkrepo/common/metadata/client/RAuthClient.kt +++ b/src/backend/common/common-metadata/metadata-service/src/main/kotlin/com/tencent/bkrepo/common/metadata/client/RAuthClient.kt @@ -35,7 +35,7 @@ import com.tencent.bkrepo.auth.pojo.user.CreateUserToProjectRequest import com.tencent.bkrepo.auth.pojo.user.User import com.tencent.bkrepo.common.api.constant.AUTH_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Parameter import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable @@ -70,11 +70,11 @@ interface RAuthClient { @GetMapping("/permission/repo/list") fun listPermissionRepo( - @ApiParam(value = "项目ID") + @Parameter(name = "项目ID") @RequestParam projectId: String, - @ApiParam(value = "用户ID") + @Parameter(name = "用户ID") @RequestParam userId: String, - @ApiParam(value = "应用ID") + @Parameter(name = "应用ID") @RequestParam appId: String? ): Mono>> @@ -95,9 +95,9 @@ interface RAuthClient { @PostMapping("/user/role/{uid}/{rid}") fun addUserRole( - @ApiParam(value = "用户id") + @Parameter(name = "用户id") @PathVariable uid: String, - @ApiParam(value = "用户角色id") + @Parameter(name = "用户角色id") @PathVariable rid: String ): Mono> @@ -110,65 +110,65 @@ interface RAuthClient { @GetMapping("/permission/project/list") fun listPermissionProject( - @ApiParam(value = "用户ID") + @Parameter(name = "用户ID") @RequestParam userId: String ): Mono>> @GetMapping("/permission/path/list") fun listPermissionPath( - @ApiParam(value = "用户ID") + @Parameter(name = "用户ID") @RequestParam userId: String, - @ApiParam(value = "项目ID") + @Parameter(name = "项目ID") @RequestParam projectId: String, - @ApiParam(value = "仓库名称") + @Parameter(name = "仓库名称") @RequestParam repoName: String ): Mono> @PostMapping("/bkiamv3/rbac/group/check") fun getExistRbacDefaultGroupProjectIds( - @ApiParam(value = "项目ID列表") + @Parameter(name = "项目ID列表") @RequestBody projectIdList: List = emptyList() ): Mono>> @PostMapping("/bkiamv3/create/project/manage/{projectId}") fun createProjectManage( - @ApiParam(value = "用户id") + @Parameter(name = "用户id") @RequestParam userId: String, - @ApiParam(value = "项目名称") + @Parameter(name = "项目名称") @PathVariable projectId: String ): Mono> @PostMapping("/bkiamv3/create/repo/manage/{projectId}/{repoName}") fun createRepoManage( - @ApiParam(value = "用户id") + @Parameter(name = "用户id") @RequestParam userId: String, - @ApiParam(value = "项目名称") + @Parameter(name = "项目名称") @PathVariable projectId: String, - @ApiParam(value = "仓库名称") + @Parameter(name = "仓库名称") @PathVariable repoName: String ): Mono> @DeleteMapping("/bkiamv3/delete/repo/manage/{projectId}/{repoName}") fun deleteRepoManageGroup( - @ApiParam(value = "用户id") + @Parameter(name = "用户id") @RequestParam userId: String, - @ApiParam(value = "项目名称") + @Parameter(name = "项目名称") @PathVariable projectId: String, - @ApiParam(value = "仓库名称") + @Parameter(name = "仓库名称") @PathVariable repoName: String ): Mono> @PostMapping("/role/create/project/manage/{projectId}") fun createProjectManage( - @ApiParam(value = "仓库名称") + @Parameter(name = "仓库名称") @PathVariable projectId: String ): Mono> @PostMapping("/role/create/repo/manage/{projectId}/{repoName}") fun createRepoManage( - @ApiParam(value = "仓库ID") + @Parameter(name = "仓库ID") @PathVariable projectId: String, - @ApiParam(value = "项目ID") + @Parameter(name = "项目ID") @PathVariable repoName: String ): Mono> } diff --git a/src/backend/common/common-notify/notify-api/src/main/kotlin/com/tencent/bkrepo/common/notify/api/NotifyChannelCredential.kt b/src/backend/common/common-notify/notify-api/src/main/kotlin/com/tencent/bkrepo/common/notify/api/NotifyChannelCredential.kt index 2687d384a2..653cf2a94a 100644 --- a/src/backend/common/common-notify/notify-api/src/main/kotlin/com/tencent/bkrepo/common/notify/api/NotifyChannelCredential.kt +++ b/src/backend/common/common-notify/notify-api/src/main/kotlin/com/tencent/bkrepo/common/notify/api/NotifyChannelCredential.kt @@ -30,8 +30,8 @@ package com.tencent.bkrepo.common.notify.api import com.fasterxml.jackson.annotation.JsonSubTypes import com.fasterxml.jackson.annotation.JsonTypeInfo import com.tencent.bkrepo.common.notify.api.weworkbot.WeworkBotChannelCredential -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 通知通道凭据 @@ -40,12 +40,12 @@ import io.swagger.annotations.ApiModelProperty @JsonSubTypes( JsonSubTypes.Type(value = WeworkBotChannelCredential::class, name = WeworkBotChannelCredential.type), ) -@ApiModel("消息通知渠道") +@Schema(title = "消息通知渠道") open class NotifyChannelCredential( - @ApiModelProperty("通知通道名") + @get:Schema(title = "通知通道名") open var name: String, - @ApiModelProperty("通知通道类型") + @get:Schema(title = "通知通道类型") var type: String, - @ApiModelProperty("是否为默认通知渠道，默认通知渠道可以有多个") + @get:Schema(title = "是否为默认通知渠道，默认通知渠道可以有多个") open var default: Boolean = false ) diff --git a/src/backend/common/common-notify/notify-api/src/main/kotlin/com/tencent/bkrepo/common/notify/api/weworkbot/WeworkBotChannelCredential.kt b/src/backend/common/common-notify/notify-api/src/main/kotlin/com/tencent/bkrepo/common/notify/api/weworkbot/WeworkBotChannelCredential.kt index 4368873cca..0da28e5e41 100644 --- a/src/backend/common/common-notify/notify-api/src/main/kotlin/com/tencent/bkrepo/common/notify/api/weworkbot/WeworkBotChannelCredential.kt +++ b/src/backend/common/common-notify/notify-api/src/main/kotlin/com/tencent/bkrepo/common/notify/api/weworkbot/WeworkBotChannelCredential.kt @@ -30,14 +30,14 @@ package com.tencent.bkrepo.common.notify.api.weworkbot import com.tencent.bkrepo.common.notify.api.NotifyChannelCredential import com.tencent.bkrepo.common.metadata.annotation.Sensitive import com.tencent.bkrepo.common.metadata.handler.MaskPartString -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("企业微信机器人") + +@Schema(title = "企业微信机器人") data class WeworkBotChannelCredential( override var name: String = "", override var default: Boolean = false, - @ApiModelProperty("企业微信机器人Key，可以从企业微信机器人的Webhook中获取") + @get:Schema(title = "企业微信机器人Key，可以从企业微信机器人的Webhook中获取") @Sensitive(handler = MaskPartString::class) var key: String ) : NotifyChannelCredential(name, type, default) { diff --git a/src/backend/common/common-notify/notify-service/src/main/kotlin/com/tencent/bkrepo/common/notify/pojo/BaseMessage.kt b/src/backend/common/common-notify/notify-service/src/main/kotlin/com/tencent/bkrepo/common/notify/pojo/BaseMessage.kt index 6d7e3d4f7f..cf62462cc0 100644 --- a/src/backend/common/common-notify/notify-service/src/main/kotlin/com/tencent/bkrepo/common/notify/pojo/BaseMessage.kt +++ b/src/backend/common/common-notify/notify-service/src/main/kotlin/com/tencent/bkrepo/common/notify/pojo/BaseMessage.kt @@ -31,17 +31,17 @@ package com.tencent.bkrepo.common.notify.pojo -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("基础消息类型") + +@Schema(title = "基础消息类型") open class BaseMessage { - @ApiModelProperty("频率限制，单位分钟，即 frequencyLimit 分钟内限制不重发相同内容的消息") + @get:Schema(title = "频率限制，单位分钟，即 frequencyLimit 分钟内限制不重发相同内容的消息") var frequencyLimit: Int = 0 - @ApiModelProperty("源系统id") + @get:Schema(title = "源系统id") var fromSysId: String = "" - @ApiModelProperty("tof系统id") + @get:Schema(title = "tof系统id") var tofSysId: String = "" } diff --git a/src/backend/common/common-notify/notify-service/src/main/kotlin/com/tencent/bkrepo/common/notify/pojo/DevopsResult.kt b/src/backend/common/common-notify/notify-service/src/main/kotlin/com/tencent/bkrepo/common/notify/pojo/DevopsResult.kt index 2b824bbd00..e18ded3bbe 100644 --- a/src/backend/common/common-notify/notify-service/src/main/kotlin/com/tencent/bkrepo/common/notify/pojo/DevopsResult.kt +++ b/src/backend/common/common-notify/notify-service/src/main/kotlin/com/tencent/bkrepo/common/notify/pojo/DevopsResult.kt @@ -32,16 +32,16 @@ package com.tencent.bkrepo.common.notify.pojo import com.fasterxml.jackson.annotation.JsonIgnore -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("蓝盾api调用结果") + +@Schema(title = "蓝盾api调用结果") data class DevopsResult( - @ApiModelProperty("返回码") + @get:Schema(title = "返回码") val status: Int, - @ApiModelProperty("错误信息") + @get:Schema(title = "错误信息") val message: String? = null, - @ApiModelProperty("数据") + @get:Schema(title = "数据") val data: T? = null ) { @JsonIgnore diff --git a/src/backend/common/common-notify/notify-service/src/main/kotlin/com/tencent/bkrepo/common/notify/pojo/EmailNotifyMessage.kt b/src/backend/common/common-notify/notify-service/src/main/kotlin/com/tencent/bkrepo/common/notify/pojo/EmailNotifyMessage.kt index aab71d98d9..9b303f703d 100644 --- a/src/backend/common/common-notify/notify-service/src/main/kotlin/com/tencent/bkrepo/common/notify/pojo/EmailNotifyMessage.kt +++ b/src/backend/common/common-notify/notify-service/src/main/kotlin/com/tencent/bkrepo/common/notify/pojo/EmailNotifyMessage.kt @@ -35,9 +35,9 @@ import com.tencent.bkrepo.common.notify.pojo.enums.EnumEmailFormat import com.tencent.bkrepo.common.notify.pojo.enums.EnumEmailType import com.tencent.bkrepo.common.notify.pojo.enums.EnumNotifyPriority import com.tencent.bkrepo.common.notify.pojo.enums.EnumNotifySource -import io.swagger.annotations.ApiModel +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("邮件") +@Schema(title = "邮件") open class EmailNotifyMessage( var format: EnumEmailFormat = EnumEmailFormat.PLAIN_TEXT, var type: EnumEmailType = EnumEmailType.OUTER_MAIL, diff --git a/src/backend/common/common-notify/notify-service/src/main/kotlin/com/tencent/bkrepo/common/notify/pojo/RtxNotifyMessage.kt b/src/backend/common/common-notify/notify-service/src/main/kotlin/com/tencent/bkrepo/common/notify/pojo/RtxNotifyMessage.kt index fc00da7eb4..4b3aeee012 100644 --- a/src/backend/common/common-notify/notify-service/src/main/kotlin/com/tencent/bkrepo/common/notify/pojo/RtxNotifyMessage.kt +++ b/src/backend/common/common-notify/notify-service/src/main/kotlin/com/tencent/bkrepo/common/notify/pojo/RtxNotifyMessage.kt @@ -33,9 +33,9 @@ package com.tencent.bkrepo.common.notify.pojo import com.tencent.bkrepo.common.notify.pojo.enums.EnumNotifyPriority import com.tencent.bkrepo.common.notify.pojo.enums.EnumNotifySource -import io.swagger.annotations.ApiModel +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("rtx消息/企业微信") +@Schema(title = "rtx消息/企业微信") open class RtxNotifyMessage( var receivers: Set = setOf(), var body: String = "", diff --git a/src/backend/common/common-notify/notify-service/src/main/kotlin/com/tencent/bkrepo/common/notify/pojo/SmsNotifyMessage.kt b/src/backend/common/common-notify/notify-service/src/main/kotlin/com/tencent/bkrepo/common/notify/pojo/SmsNotifyMessage.kt index b9437eca00..e72f9f1533 100644 --- a/src/backend/common/common-notify/notify-service/src/main/kotlin/com/tencent/bkrepo/common/notify/pojo/SmsNotifyMessage.kt +++ b/src/backend/common/common-notify/notify-service/src/main/kotlin/com/tencent/bkrepo/common/notify/pojo/SmsNotifyMessage.kt @@ -33,9 +33,9 @@ package com.tencent.bkrepo.common.notify.pojo import com.tencent.bkrepo.common.notify.pojo.enums.EnumNotifyPriority import com.tencent.bkrepo.common.notify.pojo.enums.EnumNotifySource -import io.swagger.annotations.ApiModel +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("短信消息") +@Schema(title = "短信消息") open class SmsNotifyMessage( var receivers: MutableSet = mutableSetOf(), var body: String = "", diff --git a/src/backend/common/common-notify/notify-service/src/main/kotlin/com/tencent/bkrepo/common/notify/pojo/WechatNotifyMessage.kt b/src/backend/common/common-notify/notify-service/src/main/kotlin/com/tencent/bkrepo/common/notify/pojo/WechatNotifyMessage.kt index 493e8682c3..369ec06204 100644 --- a/src/backend/common/common-notify/notify-service/src/main/kotlin/com/tencent/bkrepo/common/notify/pojo/WechatNotifyMessage.kt +++ b/src/backend/common/common-notify/notify-service/src/main/kotlin/com/tencent/bkrepo/common/notify/pojo/WechatNotifyMessage.kt @@ -33,9 +33,9 @@ package com.tencent.bkrepo.common.notify.pojo import com.tencent.bkrepo.common.notify.pojo.enums.EnumNotifyPriority import com.tencent.bkrepo.common.notify.pojo.enums.EnumNotifySource -import io.swagger.annotations.ApiModel +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("微信消息") +@Schema(title = "微信消息") open class WechatNotifyMessage( var receivers: MutableSet = mutableSetOf(), var body: String = "", diff --git a/src/backend/common/common-notify/notify-service/src/main/kotlin/com/tencent/bkrepo/common/notify/service/DevopsNotify.kt b/src/backend/common/common-notify/notify-service/src/main/kotlin/com/tencent/bkrepo/common/notify/service/DevopsNotify.kt index d783f7d974..e3e994d447 100644 --- a/src/backend/common/common-notify/notify-service/src/main/kotlin/com/tencent/bkrepo/common/notify/service/DevopsNotify.kt +++ b/src/backend/common/common-notify/notify-service/src/main/kotlin/com/tencent/bkrepo/common/notify/service/DevopsNotify.kt @@ -47,7 +47,7 @@ import com.tencent.bkrepo.common.notify.pojo.WechatNotifyMessage import okhttp3.MediaType.Companion.toMediaTypeOrNull import okhttp3.OkHttpClient import okhttp3.Request -import okhttp3.RequestBody +import okhttp3.RequestBody.Companion.toRequestBody import org.slf4j.LoggerFactory import org.springframework.stereotype.Service import java.util.concurrent.TimeUnit @@ -118,7 +118,7 @@ class DevopsNotify constructor( private fun postMessage(url: String, message: BaseMessage) { val requestContent = JsonUtils.objectMapper.writeValueAsString(message) - val requestBody = RequestBody.create("application/json; charset=utf-8".toMediaTypeOrNull(), requestContent) + val requestBody = requestContent.toRequestBody("application/json; charset=utf-8".toMediaTypeOrNull()) val request = Request.Builder().url(url).post(requestBody).build() okHttpClient.newCall(request).execute().use { response -> val responseContent = response.body!!.string() diff --git a/src/backend/common/common-query/query-api/src/main/kotlin/com/tencent/bkrepo/common/query/model/PageLimit.kt b/src/backend/common/common-query/query-api/src/main/kotlin/com/tencent/bkrepo/common/query/model/PageLimit.kt index e77eaefbb7..7b0c9ccd14 100644 --- a/src/backend/common/common-query/query-api/src/main/kotlin/com/tencent/bkrepo/common/query/model/PageLimit.kt +++ b/src/backend/common/common-query/query-api/src/main/kotlin/com/tencent/bkrepo/common/query/model/PageLimit.kt @@ -35,21 +35,21 @@ import com.fasterxml.jackson.annotation.JsonIgnore import com.tencent.bkrepo.common.api.constant.DEFAULT_PAGE_NUMBER import com.tencent.bkrepo.common.api.constant.DEFAULT_PAGE_SIZE import com.tencent.bkrepo.common.api.util.CompatibleUtils -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("分页参数") + +@Schema(title = "分页参数") data class PageLimit( - @ApiModelProperty("当前页") + @get:Schema(title = "当前页") val pageNumber: Int = DEFAULT_PAGE_NUMBER, - @ApiModelProperty("每页数量") + @get:Schema(title = "每页数量") val pageSize: Int = DEFAULT_PAGE_SIZE, @Deprecated("Replace with pageNumber", replaceWith = ReplaceWith("pageNumber")) - @ApiModelProperty("当前页") + @get:Schema(title = "当前页") val current: Int? = null, @Deprecated("Replace with pageSize", replaceWith = ReplaceWith("pageSize")) - @ApiModelProperty("每页数量") + @get:Schema(title = "每页数量") val size: Int? = null ) { @JsonIgnore diff --git a/src/backend/common/common-query/query-api/src/main/kotlin/com/tencent/bkrepo/common/query/model/QueryModel.kt b/src/backend/common/common-query/query-api/src/main/kotlin/com/tencent/bkrepo/common/query/model/QueryModel.kt index 6f0569ceac..328d2af333 100644 --- a/src/backend/common/common-query/query-api/src/main/kotlin/com/tencent/bkrepo/common/query/model/QueryModel.kt +++ b/src/backend/common/common-query/query-api/src/main/kotlin/com/tencent/bkrepo/common/query/model/QueryModel.kt @@ -31,14 +31,14 @@ package com.tencent.bkrepo.common.query.model -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("自定义查询模型") + +@Schema(title = "自定义查询模型") data class QueryModel( var page: PageLimit = PageLimit(), var sort: Sort?, - @ApiModelProperty("筛选字段列表") + @get:Schema(title = "筛选字段列表") var select: List?, var rule: Rule ) { diff --git a/src/backend/common/common-query/query-api/src/main/kotlin/com/tencent/bkrepo/common/query/model/Rule.kt b/src/backend/common/common-query/query-api/src/main/kotlin/com/tencent/bkrepo/common/query/model/Rule.kt index d0f81ac5b9..6e1c19ee0d 100644 --- a/src/backend/common/common-query/query-api/src/main/kotlin/com/tencent/bkrepo/common/query/model/Rule.kt +++ b/src/backend/common/common-query/query-api/src/main/kotlin/com/tencent/bkrepo/common/query/model/Rule.kt @@ -34,18 +34,18 @@ package com.tencent.bkrepo.common.query.model import com.fasterxml.jackson.databind.annotation.JsonDeserialize import com.tencent.bkrepo.common.query.enums.OperationType import com.tencent.bkrepo.common.query.serializer.RuleDeserializer -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("查询规则") + +@Schema(title = "查询规则") @JsonDeserialize(using = RuleDeserializer::class) sealed class Rule { - @ApiModel("嵌套查询规则") + @Schema(title = "嵌套查询规则") data class NestedRule( - @ApiModelProperty("规则集") + @get:Schema(title = "规则集") val rules: MutableList, - @ApiModelProperty("组合条件类型") + @get:Schema(title = "组合条件类型") val relation: RelationType = RelationType.DEFAULT ) : Rule() { @@ -65,13 +65,13 @@ sealed class Rule { } } - @ApiModel("条件查询规则") + @Schema(title = "条件查询规则") data class QueryRule( - @ApiModelProperty("字段") + @get:Schema(title = "字段") val field: String, - @ApiModelProperty("值") + @get:Schema(title = "值") val value: Any, - @ApiModelProperty("操作类型") + @get:Schema(title = "操作类型") val operation: OperationType = OperationType.DEFAULT ) : Rule() { fun toFixed(): FixedRule { @@ -79,6 +79,6 @@ sealed class Rule { } } - @ApiModel("固定查询规则") + @Schema(title = "固定查询规则") data class FixedRule(val wrapperRule: QueryRule) : Rule() } diff --git a/src/backend/common/common-query/query-api/src/main/kotlin/com/tencent/bkrepo/common/query/model/Sort.kt b/src/backend/common/common-query/query-api/src/main/kotlin/com/tencent/bkrepo/common/query/model/Sort.kt index 94322f2c86..cafc599b89 100644 --- a/src/backend/common/common-query/query-api/src/main/kotlin/com/tencent/bkrepo/common/query/model/Sort.kt +++ b/src/backend/common/common-query/query-api/src/main/kotlin/com/tencent/bkrepo/common/query/model/Sort.kt @@ -31,14 +31,14 @@ package com.tencent.bkrepo.common.query.model -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("排序规则") + +@Schema(title = "排序规则") data class Sort( - @ApiModelProperty("排序字段") + @get:Schema(title = "排序字段") val properties: List, - @ApiModelProperty("排序方式") + @get:Schema(title = "排序方式") val direction: Direction = Direction.DEFAULT ) { enum class Direction { diff --git a/src/backend/common/common-security/src/main/kotlin/com/tencent/bkrepo/common/security/interceptor/devx/PageResponse.kt b/src/backend/common/common-security/src/main/kotlin/com/tencent/bkrepo/common/security/interceptor/devx/PageResponse.kt index 0434876c77..21118aff1f 100644 --- a/src/backend/common/common-security/src/main/kotlin/com/tencent/bkrepo/common/security/interceptor/devx/PageResponse.kt +++ b/src/backend/common/common-security/src/main/kotlin/com/tencent/bkrepo/common/security/interceptor/devx/PageResponse.kt @@ -27,17 +27,18 @@ package com.tencent.bkrepo.common.security.interceptor.devx -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + data class PageResponse( - @ApiModelProperty("记录条数") + @get:Schema(title = "记录条数") val count: Long, - @ApiModelProperty("页码(从1页开始)") + @get:Schema(title = "页码(从1页开始)") val page: Int, - @ApiModelProperty("每页多少条") + @get:Schema(title = "每页多少条") val pageSize: Int, - @ApiModelProperty("总页数") + @get:Schema(title = "总页数") val totalPages: Long, - @ApiModelProperty("数据列表") + @get:Schema(title = "数据列表") val records: List ) diff --git a/src/backend/common/common-stream/src/main/kotlin/com/tencent/bkrepo/common/stream/binder/file/StreamFileUtils.kt b/src/backend/common/common-stream/src/main/kotlin/com/tencent/bkrepo/common/stream/binder/file/StreamFileUtils.kt index a9bc37c0b3..89b2075d94 100644 --- a/src/backend/common/common-stream/src/main/kotlin/com/tencent/bkrepo/common/stream/binder/file/StreamFileUtils.kt +++ b/src/backend/common/common-stream/src/main/kotlin/com/tencent/bkrepo/common/stream/binder/file/StreamFileUtils.kt @@ -38,7 +38,7 @@ internal object StreamFileUtils { private val fileSync = ConcurrentHashMap() fun getDestinationFile(folder: String, destination: String): String { - val fileName = destination.toLowerCase() + ".stream" + val fileName = destination.lowercase() + ".stream" return Paths.get(folder, fileName).toString() } diff --git a/src/backend/composer/api-composer/src/main/kotlin/com/tencent/bkrepo/composer/api/ComposerResource.kt b/src/backend/composer/api-composer/src/main/kotlin/com/tencent/bkrepo/composer/api/ComposerResource.kt index ce494732c3..7520e95f01 100644 --- a/src/backend/composer/api-composer/src/main/kotlin/com/tencent/bkrepo/composer/api/ComposerResource.kt +++ b/src/backend/composer/api-composer/src/main/kotlin/com/tencent/bkrepo/composer/api/ComposerResource.kt @@ -38,30 +38,30 @@ import com.tencent.bkrepo.composer.artifact.ComposerArtifactInfo.Companion.COMPO import com.tencent.bkrepo.composer.artifact.ComposerArtifactInfo.Companion.COMPOSER_INSTALL import com.tencent.bkrepo.composer.artifact.ComposerArtifactInfo.Companion.COMPOSER_JSON import com.tencent.bkrepo.composer.artifact.ComposerArtifactInfo.Companion.COMPOSER_PACKAGES -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.http.MediaType import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PutMapping -@Api("composer http协议接口") +@Tag(name = "composer http协议接口") interface ComposerResource { - @ApiOperation("install") + @Operation(summary = "install") @GetMapping(COMPOSER_INSTALL) fun installRequire( @ArtifactPathVariable composerArtifactInfo: ComposerArtifactInfo ) - @ApiOperation("packages.json") + @Operation(summary = "packages.json") @GetMapping(COMPOSER_PACKAGES, produces = [MediaType.APPLICATION_JSON_VALUE]) fun packages(@ArtifactPathVariable composerArtifactInfo: ComposerArtifactInfo) - @ApiOperation("%package%.json") + @Operation(summary = "%package%.json") @GetMapping(COMPOSER_JSON, produces = [MediaType.APPLICATION_JSON_VALUE]) fun getJson(@ArtifactPathVariable composerArtifactInfo: ComposerArtifactInfo) - @ApiOperation("deploy") + @Operation(summary = "deploy") @PutMapping(COMPOSER_DEPLOY, produces = [MediaType.APPLICATION_JSON_VALUE]) fun deploy(@ArtifactPathVariable composerArtifactInfo: ComposerArtifactInfo, file: ArtifactFile) } diff --git a/src/backend/composer/api-composer/src/main/kotlin/com/tencent/bkrepo/composer/api/ComposerWebResource.kt b/src/backend/composer/api-composer/src/main/kotlin/com/tencent/bkrepo/composer/api/ComposerWebResource.kt index 01da05323d..89e7d66354 100644 --- a/src/backend/composer/api-composer/src/main/kotlin/com/tencent/bkrepo/composer/api/ComposerWebResource.kt +++ b/src/backend/composer/api-composer/src/main/kotlin/com/tencent/bkrepo/composer/api/ComposerWebResource.kt @@ -34,25 +34,25 @@ package com.tencent.bkrepo.composer.api import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.common.artifact.api.ArtifactPathVariable import com.tencent.bkrepo.composer.artifact.ComposerArtifactInfo -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam -@Api("Composer 产品-web接口") +@Tag(name = "Composer 产品-web接口") @RequestMapping("/ext") interface ComposerWebResource { - @ApiOperation("composer 包删除接口") + @Operation(summary = "composer 包删除接口") @DeleteMapping(ComposerArtifactInfo.COMPOSER_EXT_PACKAGE_DELETE) fun deletePackage( @ArtifactPathVariable composerArtifactInfo: ComposerArtifactInfo, @RequestParam packageKey: String ): Response - @ApiOperation("composer 版本删除接口") + @Operation(summary = "composer 版本删除接口") @DeleteMapping(ComposerArtifactInfo.COMPOSER_EXT_VERSION_DELETE) fun deleteVersion( @ArtifactPathVariable composerArtifactInfo: ComposerArtifactInfo, @@ -60,7 +60,7 @@ interface ComposerWebResource { @RequestParam version: String? ): Response - @ApiOperation("composer 版本详情接口") + @Operation(summary = "composer 版本详情接口") @GetMapping(ComposerArtifactInfo.COMPOSER_EXT_DETAIL) fun artifactDetail( @ArtifactPathVariable composerArtifactInfo: ComposerArtifactInfo, diff --git a/src/backend/composer/biz-composer/src/main/kotlin/com/tencent/bkrepo/composer/pojo/ArtifactUploadResponse.kt b/src/backend/composer/biz-composer/src/main/kotlin/com/tencent/bkrepo/composer/pojo/ArtifactUploadResponse.kt index 11369951e9..9e8a1b7a10 100644 --- a/src/backend/composer/biz-composer/src/main/kotlin/com/tencent/bkrepo/composer/pojo/ArtifactUploadResponse.kt +++ b/src/backend/composer/biz-composer/src/main/kotlin/com/tencent/bkrepo/composer/pojo/ArtifactUploadResponse.kt @@ -31,21 +31,21 @@ package com.tencent.bkrepo.composer.pojo -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("构件 upload成功时返回信息") + +@Schema(title = "构件 upload成功时返回信息") data class ArtifactUploadResponse( - @ApiModelProperty("项目") + @get:Schema(title = "项目") val projectId: String, - @ApiModelProperty("仓库") + @get:Schema(title = "仓库") val repoName: String, - @ApiModelProperty("构件uri") + @get:Schema(title = "构件uri") val artifactUri: String, - @ApiModelProperty("构件sha256") + @get:Schema(title = "构件sha256") val sha256: String, - @ApiModelProperty("构件md5") + @get:Schema(title = "构件md5") val md5: String, - @ApiModelProperty("上传结果描述") + @get:Schema(title = "上传结果描述") val description: String ) diff --git a/src/backend/composer/biz-composer/src/main/kotlin/com/tencent/bkrepo/composer/util/pojo/ComposerArtifact.kt b/src/backend/composer/biz-composer/src/main/kotlin/com/tencent/bkrepo/composer/util/pojo/ComposerArtifact.kt index 4cf9cc2cb9..b9f11af08c 100644 --- a/src/backend/composer/biz-composer/src/main/kotlin/com/tencent/bkrepo/composer/util/pojo/ComposerArtifact.kt +++ b/src/backend/composer/biz-composer/src/main/kotlin/com/tencent/bkrepo/composer/util/pojo/ComposerArtifact.kt @@ -31,16 +31,16 @@ package com.tencent.bkrepo.composer.util.pojo -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("composer 'package.json'文件中节点") + +@Schema(title = "composer 'package.json'文件中节点") data class ComposerArtifact( - @ApiModelProperty("composer package name") + @get:Schema(title = "composer package name") val name: String, - @ApiModelProperty("composer package version") + @get:Schema(title = "composer package version") val version: String, - @ApiModelProperty("composer package content") + @get:Schema(title = "composer package content") // 保存到 package.json 索引中的内容 val json: String ) diff --git a/src/backend/composer/biz-composer/src/main/kotlin/com/tencent/bkrepo/composer/util/pojo/UriArgs.kt b/src/backend/composer/biz-composer/src/main/kotlin/com/tencent/bkrepo/composer/util/pojo/UriArgs.kt index ca69a99df1..cbfec7fa76 100644 --- a/src/backend/composer/biz-composer/src/main/kotlin/com/tencent/bkrepo/composer/util/pojo/UriArgs.kt +++ b/src/backend/composer/biz-composer/src/main/kotlin/com/tencent/bkrepo/composer/util/pojo/UriArgs.kt @@ -31,11 +31,11 @@ package com.tencent.bkrepo.composer.util.pojo -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("composer 构件") + +@Schema(title = "composer 构件") data class UriArgs( - @ApiModelProperty("构件打包格式") + @get:Schema(title = "构件打包格式") val format: String ) diff --git a/src/backend/conan/api-conan/src/main/kotlin/com/tencent/bkrepo/conan/api/ConanMetadataClient.kt b/src/backend/conan/api-conan/src/main/kotlin/com/tencent/bkrepo/conan/api/ConanMetadataClient.kt index a1c8da395c..ad3d554d2f 100644 --- a/src/backend/conan/api-conan/src/main/kotlin/com/tencent/bkrepo/conan/api/ConanMetadataClient.kt +++ b/src/backend/conan/api-conan/src/main/kotlin/com/tencent/bkrepo/conan/api/ConanMetadataClient.kt @@ -30,7 +30,7 @@ package com.tencent.bkrepo.conan.api import com.tencent.bkrepo.common.api.constant.MAVEN_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.conan.pojo.metadata.ConanMetadataRequest -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation import org.springframework.cloud.openfeign.FeignClient import org.springframework.web.bind.annotation.PostMapping import org.springframework.web.bind.annotation.RequestBody @@ -40,11 +40,11 @@ import org.springframework.web.bind.annotation.RequestParam @FeignClient(MAVEN_SERVICE_NAME, contextId = "ConanMetadataClient") @RequestMapping("/cluster/metadata") interface ConanMetadataClient { - @ApiOperation("存储conan版本元数据") + @Operation(summary = "存储conan版本元数据") @PostMapping("/update") fun storeMetadata(@RequestBody request: ConanMetadataRequest): Response - @ApiOperation("删除conan版本元数据") + @Operation(summary = "删除conan版本元数据") @PostMapping("/delete") fun delete( @RequestParam projectId: String, diff --git a/src/backend/conan/api-conan/src/main/kotlin/com/tencent/bkrepo/conan/pojo/PackageVersionInfo.kt b/src/backend/conan/api-conan/src/main/kotlin/com/tencent/bkrepo/conan/pojo/PackageVersionInfo.kt index 576dd1226b..ea8d450c81 100644 --- a/src/backend/conan/api-conan/src/main/kotlin/com/tencent/bkrepo/conan/pojo/PackageVersionInfo.kt +++ b/src/backend/conan/api-conan/src/main/kotlin/com/tencent/bkrepo/conan/pojo/PackageVersionInfo.kt @@ -32,43 +32,42 @@ package com.tencent.bkrepo.conan.pojo import com.tencent.bkrepo.repository.pojo.metadata.MetadataModel -import io.swagger.annotations.Api -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@Api("conan版本详情页返回包装模型") +@Schema(title = "conan版本详情页返回包装模型") data class PackageVersionInfo( - @ApiModelProperty("基础信息") + @get:Schema(title = "基础信息") val basic: BasicInfo, - @ApiModelProperty("元数据信息") + @get:Schema(title = "元数据信息") val metadata: List ) -@Api("基础信息") +@Schema(title = "基础信息") data class BasicInfo( - @ApiModelProperty("版本字段") + @get:Schema(title = "版本字段") val version: String, - @ApiModelProperty("完整路径") + @get:Schema(title = "完整路径") val fullPath: String, - @ApiModelProperty("文件大小，单位byte") + @get:Schema(title = "文件大小，单位byte") val size: Long, - @ApiModelProperty("文件sha256") + @get:Schema(title = "文件sha256") val sha256: String, - @ApiModelProperty("文件md5") + @get:Schema(title = "文件md5") val md5: String, - @ApiModelProperty("晋级状态标签") + @get:Schema(title = "晋级状态标签") val stageTag: List, - @ApiModelProperty("所属项目id") + @get:Schema(title = "所属项目id") val projectId: String, - @ApiModelProperty("所属仓库名称") + @get:Schema(title = "所属仓库名称") val repoName: String, - @ApiModelProperty("下载次数") + @get:Schema(title = "下载次数") val downloadCount: Long, - @ApiModelProperty("创建者") + @get:Schema(title = "创建者") val createdBy: String, - @ApiModelProperty("创建时间") + @get:Schema(title = "创建时间") val createdDate: String, - @ApiModelProperty("修改者") + @get:Schema(title = "修改者") val lastModifiedBy: String, - @ApiModelProperty("修改时间") + @get:Schema(title = "修改时间") val lastModifiedDate: String ) diff --git a/src/backend/conan/biz-conan/src/main/kotlin/com/tencent/bkrepo/conan/controller/UserConanController.kt b/src/backend/conan/biz-conan/src/main/kotlin/com/tencent/bkrepo/conan/controller/UserConanController.kt index 569587a8cc..429193a158 100644 --- a/src/backend/conan/biz-conan/src/main/kotlin/com/tencent/bkrepo/conan/controller/UserConanController.kt +++ b/src/backend/conan/biz-conan/src/main/kotlin/com/tencent/bkrepo/conan/controller/UserConanController.kt @@ -49,9 +49,9 @@ import com.tencent.bkrepo.conan.pojo.artifact.ConanArtifactInfo.Companion.CONAN_ import com.tencent.bkrepo.conan.pojo.request.IndexRefreshRequest import com.tencent.bkrepo.conan.service.ConanDeleteService import com.tencent.bkrepo.conan.service.ConanExtService -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PostMapping @@ -62,7 +62,7 @@ import org.springframework.web.bind.annotation.RequestParam import org.springframework.web.bind.annotation.RestController @Suppress("MVCPathVariableInspection") -@Api("conan产品接口") +@Tag(name = "conan产品接口") @RestController @RequestMapping("/ext") class UserConanController( @@ -70,16 +70,16 @@ class UserConanController( private val conanExtService: ConanExtService ) { - @ApiOperation("查询包的版本详情") + @Operation(summary = "查询包的版本详情") @GetMapping(CONAN_VERSION_DETAIL) @Permission(type = ResourceType.REPO, action = PermissionAction.READ) fun detailVersion( @RequestAttribute userId: String, @ArtifactPathVariable artifactInfo: ConanArtifactInfo, - @ApiParam(value = "包唯一Key", required = true) + @Parameter(name = "包唯一Key", required = true) @RequestParam packageKey: String, - @ApiParam(value = "包版本", required = true) + @Parameter(name = "包版本", required = true) @RequestParam version: String ): Response { return ResponseBuilder.success(conanDeleteService.detailVersion(artifactInfo, packageKey, version)) @@ -102,13 +102,13 @@ class UserConanController( scopeId = "#artifactInfo?.projectId", content = ActionAuditContent.REPO_PACKAGE_DELETE_CONTENT ) - @ApiOperation("删除仓库下的包") + @Operation(summary = "删除仓库下的包") @DeleteMapping(CONAN_PACKAGE_DELETE_URL) @Permission(type = ResourceType.REPO, action = PermissionAction.DELETE) fun deletePackage( @RequestAttribute userId: String, artifactInfo: ConanArtifactInfo, - @ApiParam(value = "包唯一key", required = true) + @Parameter(name = "包唯一key", required = true) @RequestParam packageKey: String ): Response { conanDeleteService.removePackageByKey(artifactInfo, packageKey) @@ -134,28 +134,28 @@ class UserConanController( scopeId = "#artifactInfo?.projectId", content = ActionAuditContent.REPO_PACKAGE_VERSION_DELETE_CONTENT ) - @ApiOperation("删除仓库下的包版本") + @Operation(summary = "删除仓库下的包版本") @DeleteMapping(CONAN_VERSION_DELETE_URL) @Permission(type = ResourceType.REPO, action = PermissionAction.DELETE) fun deleteVersion( @RequestAttribute userId: String, artifactInfo: ConanArtifactInfo, - @ApiParam(value = "包唯一key", required = true) + @Parameter(name = "包唯一key", required = true) @RequestParam packageKey: String, - @ApiParam(value = "包版本", required = true) + @Parameter(name = "包版本", required = true) @RequestParam version: String ): Response { conanDeleteService.removePackageVersion(artifactInfo, packageKey, version) return ResponseBuilder.success() } - @ApiOperation("获取conan域名地址") + @Operation(summary = "获取conan域名地址") @GetMapping("/address") fun getRegistryDomain(): Response { return ResponseBuilder.success(conanDeleteService.getDomain()) } - @ApiOperation("仓库索引修正") + @Operation(summary = "仓库索引修正") @PostMapping("/repo/index/refresh/{projectId}/{repoName}") @Permission(type = ResourceType.REPO, action = PermissionAction.WRITE) fun repoIndexRefresh( @@ -165,7 +165,7 @@ class UserConanController( return ResponseBuilder.success() } - @ApiOperation("recipe索引修正") + @Operation(summary = "recipe索引修正") @PostMapping("/recipe/index/refresh/{projectId}/{repoName}") @Permission(type = ResourceType.REPO, action = PermissionAction.WRITE) fun recipeIndexRefresh( @@ -177,7 +177,7 @@ class UserConanController( } - @ApiOperation("packagekey下索引修正") + @Operation(summary = "packagekey下索引修正") @PostMapping("/packagekey/index/refresh/{projectId}/{repoName}") @Permission(type = ResourceType.REPO, action = PermissionAction.WRITE) fun packageKeyIndexRefresh( @@ -188,7 +188,7 @@ class UserConanController( return ResponseBuilder.success() } - @ApiOperation("重新生成仓库元数据信息") + @Operation(summary = "重新生成仓库元数据信息") @PostMapping("/metadata/refresh/{projectId}/{repoName}") @Permission(type = ResourceType.REPO, action = PermissionAction.WRITE) fun metadataRefresh( @@ -198,7 +198,7 @@ class UserConanController( return ResponseBuilder.success() } - @ApiOperation("重新生成包元数据信息") + @Operation(summary = "重新生成包元数据信息") @PostMapping("/metadata/package/refresh/{projectId}/{repoName}") @Permission(type = ResourceType.REPO, action = PermissionAction.WRITE) fun packageMetadataRefresh( @@ -209,7 +209,7 @@ class UserConanController( return ResponseBuilder.success() } - @ApiOperation("重新生成版本元数据信息") + @Operation(summary = "重新生成版本元数据信息") @PostMapping("/metadata/version/refresh/{projectId}/{repoName}") @Permission(type = ResourceType.REPO, action = PermissionAction.WRITE) fun versionMetadataRefresh( @@ -220,4 +220,4 @@ class UserConanController( conanExtService.versionMetadataRefresh(artifactInfo.projectId, artifactInfo.repoName, packageKey, version) return ResponseBuilder.success() } -} \ No newline at end of file +} diff --git a/src/backend/ddc/biz-ddc/src/main/kotlin/com/tencent/bkrepo/ddc/controller/CompressedBlobController.kt b/src/backend/ddc/biz-ddc/src/main/kotlin/com/tencent/bkrepo/ddc/controller/CompressedBlobController.kt index 0f32f45b70..9f6d5015da 100644 --- a/src/backend/ddc/biz-ddc/src/main/kotlin/com/tencent/bkrepo/ddc/controller/CompressedBlobController.kt +++ b/src/backend/ddc/biz-ddc/src/main/kotlin/com/tencent/bkrepo/ddc/controller/CompressedBlobController.kt @@ -42,8 +42,8 @@ import com.tencent.bkrepo.ddc.artifact.CompressedBlobArtifactInfo import com.tencent.bkrepo.ddc.component.PermissionHelper import com.tencent.bkrepo.ddc.service.CompressedBlobService import com.tencent.bkrepo.ddc.utils.MEDIA_TYPE_UNREAL_UNREAL_COMPRESSED_BUFFER -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter import org.slf4j.LoggerFactory import org.springframework.http.MediaType import org.springframework.web.bind.annotation.GetMapping @@ -75,13 +75,13 @@ class CompressedBlobController( scopeId = "#artifactInfo?.projectId", content = ActionAuditContent.NODE_DOWNLOAD_CONTENT ) - @ApiOperation("获取压缩后的缓存") + @Operation(summary = "获取压缩后的缓存") @GetMapping( "/{repoName}/{$PATH_VARIABLE_CONTENT_ID}", produces = [MEDIA_TYPE_UNREAL_UNREAL_COMPRESSED_BUFFER, MediaType.APPLICATION_OCTET_STREAM_VALUE] ) fun get( - @ApiParam(value = "ddc compressed blob", required = true) + @Parameter(name = "ddc compressed blob", required = true) @ArtifactPathVariable artifactInfo: CompressedBlobArtifactInfo, ) { @@ -106,10 +106,10 @@ class CompressedBlobController( scopeId = "#artifactInfo?.projectId", content = ActionAuditContent.NODE_UPLOAD_CONTENT ) - @ApiOperation("上传压缩后的缓存") + @Operation(summary = "上传压缩后的缓存") @PutMapping("/{repoName}/{$PATH_VARIABLE_CONTENT_ID}", consumes = [MEDIA_TYPE_UNREAL_UNREAL_COMPRESSED_BUFFER]) fun put( - @ApiParam(value = "ddc compressed blob", required = true) + @Parameter(name = "ddc compressed blob", required = true) @ArtifactPathVariable artifactInfo: CompressedBlobArtifactInfo, artifactFile: ArtifactFile diff --git a/src/backend/ddc/biz-ddc/src/main/kotlin/com/tencent/bkrepo/ddc/controller/LegacyReferencesController.kt b/src/backend/ddc/biz-ddc/src/main/kotlin/com/tencent/bkrepo/ddc/controller/LegacyReferencesController.kt index 1f460a4b48..232fbcf76f 100644 --- a/src/backend/ddc/biz-ddc/src/main/kotlin/com/tencent/bkrepo/ddc/controller/LegacyReferencesController.kt +++ b/src/backend/ddc/biz-ddc/src/main/kotlin/com/tencent/bkrepo/ddc/controller/LegacyReferencesController.kt @@ -35,10 +35,10 @@ import com.tencent.bkrepo.auth.pojo.enums.PermissionAction import com.tencent.bkrepo.common.artifact.api.ArtifactFile import com.tencent.bkrepo.common.artifact.api.ArtifactPathVariable import com.tencent.bkrepo.common.artifact.audit.ActionAuditContent +import com.tencent.bkrepo.common.artifact.audit.NODE_CREATE_ACTION import com.tencent.bkrepo.common.artifact.audit.NODE_DELETE_ACTION import com.tencent.bkrepo.common.artifact.audit.NODE_DOWNLOAD_ACTION import com.tencent.bkrepo.common.artifact.audit.NODE_RESOURCE -import com.tencent.bkrepo.common.artifact.audit.NODE_CREATE_ACTION import com.tencent.bkrepo.ddc.artifact.ReferenceArtifactInfo import com.tencent.bkrepo.ddc.artifact.ReferenceArtifactInfo.Companion.PATH_VARIABLE_BUCKET import com.tencent.bkrepo.ddc.artifact.ReferenceArtifactInfo.Companion.PATH_VARIABLE_REF_ID @@ -46,8 +46,8 @@ import com.tencent.bkrepo.ddc.component.PermissionHelper import com.tencent.bkrepo.ddc.controller.LegacyReferencesController.Companion.LEGACY_PREFIX import com.tencent.bkrepo.ddc.service.ReferenceArtifactService import com.tencent.bkrepo.ddc.utils.MEDIA_TYPE_UNREAL_COMPACT_BINARY -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter import org.springframework.http.MediaType import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping @@ -79,7 +79,7 @@ class LegacyReferencesController( scopeId = "#artifactInfo?.projectId", content = ActionAuditContent.NODE_DOWNLOAD_CONTENT ) - @ApiOperation("获取ref") + @Operation(summary = "获取ref") @GetMapping( "/ddc/{repoName}/{${PATH_VARIABLE_BUCKET}}/{${PATH_VARIABLE_REF_ID}}.raw", "/ddc/{repoName}/{${PATH_VARIABLE_BUCKET}}/{${PATH_VARIABLE_REF_ID}}", @@ -90,7 +90,7 @@ class LegacyReferencesController( ] ) fun get( - @ApiParam(value = "ddc ref", required = true) + @Parameter(name = "ddc ref", required = true) @ArtifactPathVariable artifactInfo: ReferenceArtifactInfo ) { @@ -120,7 +120,7 @@ class LegacyReferencesController( consumes = [MediaType.APPLICATION_OCTET_STREAM_VALUE] ) fun put( - @ApiParam(value = "ddc ref", required = true) + @Parameter(name = "ddc ref", required = true) @ArtifactPathVariable artifactInfo: ReferenceArtifactInfo, file: ArtifactFile @@ -148,7 +148,7 @@ class LegacyReferencesController( ) @DeleteMapping("/ddc/{repoName}/{${PATH_VARIABLE_BUCKET}}/{${PATH_VARIABLE_REF_ID}}") fun delete( - @ApiParam(value = "ddc ref", required = true) + @Parameter(name = "ddc ref", required = true) @ArtifactPathVariable artifactInfo: ReferenceArtifactInfo ) { diff --git a/src/backend/ddc/biz-ddc/src/main/kotlin/com/tencent/bkrepo/ddc/controller/ReferencesController.kt b/src/backend/ddc/biz-ddc/src/main/kotlin/com/tencent/bkrepo/ddc/controller/ReferencesController.kt index e492000e4d..daf0a6f285 100644 --- a/src/backend/ddc/biz-ddc/src/main/kotlin/com/tencent/bkrepo/ddc/controller/ReferencesController.kt +++ b/src/backend/ddc/biz-ddc/src/main/kotlin/com/tencent/bkrepo/ddc/controller/ReferencesController.kt @@ -45,13 +45,13 @@ import com.tencent.bkrepo.ddc.artifact.ReferenceArtifactInfo import com.tencent.bkrepo.ddc.artifact.repository.DdcLocalRepository.Companion.HEADER_NAME_HASH import com.tencent.bkrepo.ddc.component.PermissionHelper import com.tencent.bkrepo.ddc.pojo.BatchOps -import com.tencent.bkrepo.ddc.pojo.Operation +import com.tencent.bkrepo.ddc.pojo.OperationType import com.tencent.bkrepo.ddc.service.ReferenceArtifactService import com.tencent.bkrepo.ddc.utils.MEDIA_TYPE_JUPITER_INLINED_PAYLOAD import com.tencent.bkrepo.ddc.utils.MEDIA_TYPE_UNREAL_COMPACT_BINARY import com.tencent.bkrepo.ddc.utils.MEDIA_TYPE_UNREAL_COMPACT_BINARY_PACKAGE -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter import org.slf4j.LoggerFactory import org.springframework.http.MediaType import org.springframework.web.bind.annotation.GetMapping @@ -86,7 +86,7 @@ class ReferencesController( scopeId = "#artifactInfo?.projectId", content = ActionAuditContent.NODE_DOWNLOAD_CONTENT ) - @ApiOperation("获取ref") + @Operation(summary = "获取ref") @GetMapping( "/{repoName}/{$PATH_VARIABLE_BUCKET}/{$PATH_VARIABLE_REF_ID}", produces = [ @@ -98,7 +98,7 @@ class ReferencesController( ] ) fun getRef( - @ApiParam(value = "ddc ref", required = true) + @Parameter(name = "ddc ref", required = true) @ArtifactPathVariable artifactInfo: ReferenceArtifactInfo, ) { @@ -124,12 +124,12 @@ class ReferencesController( scopeId = "#artifactInfo?.projectId", content = ActionAuditContent.NODE_UPLOAD_CONTENT ) - @ApiOperation("开始创建ref") + @Operation(summary = "开始创建ref") @PutMapping( "/{repoName}/{$PATH_VARIABLE_BUCKET}/{$PATH_VARIABLE_REF_ID}", ) fun putObject( - @ApiParam(value = "ddc ref", required = true) + @Parameter(name = "ddc ref", required = true) @ArtifactPathVariable artifactInfo: ReferenceArtifactInfo, file: ArtifactFile @@ -140,15 +140,15 @@ class ReferencesController( referenceArtifactService.createRef(artifactInfo, file) } - @ApiOperation("结束ref创建") + @Operation(summary = "结束ref创建") @PostMapping( "/{repoName}/{$PATH_VARIABLE_BUCKET}/{$PATH_VARIABLE_REF_ID}/finalize/{hash}", ) fun finalizeObject( - @ApiParam(value = "ddc ref", required = true) + @Parameter(name = "ddc ref", required = true) @ArtifactPathVariable artifactInfo: ReferenceArtifactInfo, - @ApiParam("blob hash", required = true) + @Parameter(name = "blob hash", required = true) @PathVariable hash: String, ) { permissionHelper.checkPathPermission(PermissionAction.WRITE) @@ -156,7 +156,7 @@ class ReferencesController( referenceArtifactService.finalize(artifactInfo) } - @ApiOperation("批量读写") + @Operation(summary = "批量读写") @PostMapping( "/{repoName}", consumes = [MEDIA_TYPE_UNREAL_COMPACT_BINARY], @@ -170,7 +170,7 @@ class ReferencesController( val ops = BatchOps.deserialize(HttpContextHolder.getRequest().inputStream.use { it.readBytes() }) var requiredPermissionAction = PermissionAction.READ for (op in ops.ops) { - if (op.op == Operation.PUT.name) { + if (op.op == OperationType.PUT.name) { requiredPermissionAction = PermissionAction.WRITE break } diff --git a/src/backend/ddc/biz-ddc/src/main/kotlin/com/tencent/bkrepo/ddc/pojo/BatchOps.kt b/src/backend/ddc/biz-ddc/src/main/kotlin/com/tencent/bkrepo/ddc/pojo/BatchOps.kt index 9b01254fa5..c06375c3fe 100644 --- a/src/backend/ddc/biz-ddc/src/main/kotlin/com/tencent/bkrepo/ddc/pojo/BatchOps.kt +++ b/src/backend/ddc/biz-ddc/src/main/kotlin/com/tencent/bkrepo/ddc/pojo/BatchOps.kt @@ -107,7 +107,7 @@ data class BatchOp( val opId: Int = 0, val bucket: String = "", val key: String = "", - val op: String = Operation.INVALID.toString(), + val op: String = OperationType.INVALID.toString(), /** * 是否检查ref引用的所有blob是否存在 */ @@ -125,7 +125,7 @@ data class BatchOp( /** * 操作类型 */ -enum class Operation { +enum class OperationType { INVALID, GET, PUT, diff --git a/src/backend/ddc/biz-ddc/src/main/kotlin/com/tencent/bkrepo/ddc/service/ReferenceArtifactService.kt b/src/backend/ddc/biz-ddc/src/main/kotlin/com/tencent/bkrepo/ddc/service/ReferenceArtifactService.kt index 0224f68149..7ac0f155ee 100644 --- a/src/backend/ddc/biz-ddc/src/main/kotlin/com/tencent/bkrepo/ddc/service/ReferenceArtifactService.kt +++ b/src/backend/ddc/biz-ddc/src/main/kotlin/com/tencent/bkrepo/ddc/service/ReferenceArtifactService.kt @@ -55,7 +55,7 @@ import com.tencent.bkrepo.ddc.pojo.BatchOp import com.tencent.bkrepo.ddc.pojo.BatchOps import com.tencent.bkrepo.ddc.pojo.BatchOpsResponse import com.tencent.bkrepo.ddc.pojo.OpResponse -import com.tencent.bkrepo.ddc.pojo.Operation +import com.tencent.bkrepo.ddc.pojo.OperationType import com.tencent.bkrepo.ddc.pojo.RefKey import com.tencent.bkrepo.ddc.serialization.CbObject import com.tencent.bkrepo.ddc.utils.BlakeUtils @@ -118,9 +118,12 @@ class ReferenceArtifactService( val userId = SecurityUtils.getUserId() for (op in ops.ops) { results[op.opId] = when (op.op) { - Operation.GET.name -> executor.submit> { getRef(projectId, repoName, op, userId) } - Operation.HEAD.name -> executor.submit> { headRef(projectId, repoName, op, userId) } - Operation.PUT.name -> executor.submit> { putRef(repo, op, userId) } + OperationType.GET.name -> + executor.submit> { getRef(projectId, repoName, op, userId) } + OperationType.HEAD.name -> + executor.submit> { headRef(projectId, repoName, op, userId) } + OperationType.PUT.name -> + executor.submit> { putRef(repo, op, userId) } else -> throw UnsupportedOperationException("unsupported op: ${op.op}") } } diff --git a/src/backend/ddc/biz-ddc/src/test/kotlin/com/tencent/bkrepo/ddc/pojo/SerializationTest.kt b/src/backend/ddc/biz-ddc/src/test/kotlin/com/tencent/bkrepo/ddc/pojo/SerializationTest.kt index 9c69b00c16..3ba5912323 100644 --- a/src/backend/ddc/biz-ddc/src/test/kotlin/com/tencent/bkrepo/ddc/pojo/SerializationTest.kt +++ b/src/backend/ddc/biz-ddc/src/test/kotlin/com/tencent/bkrepo/ddc/pojo/SerializationTest.kt @@ -79,7 +79,7 @@ class SerializationTest { writer.writeInteger(BatchOp::opId.name, 0) writer.writeString(BatchOp::bucket.name, "bucket") writer.writeString(BatchOp::key.name, "key") - writer.writeString(BatchOp::op.name, Operation.GET.name) + writer.writeString(BatchOp::op.name, OperationType.GET.name) writer.writeBool(BatchOp::resolveAttachments.name, true) writer.endObject() @@ -87,7 +87,7 @@ class SerializationTest { writer.writeInteger(BatchOp::opId.name, 0) writer.writeString(BatchOp::bucket.name, "bucket") writer.writeString(BatchOp::key.name, "key") - writer.writeString(BatchOp::op.name, Operation.HEAD.name) + writer.writeString(BatchOp::op.name, OperationType.HEAD.name) writer.endObject() val payload = CbObject.build { innerWriter -> innerWriter.writeString("test", "test value") } @@ -95,7 +95,7 @@ class SerializationTest { writer.writeInteger(BatchOp::opId.name, 0) writer.writeString(BatchOp::bucket.name, "bucket") writer.writeString(BatchOp::key.name, "key") - writer.writeString(BatchOp::op.name, Operation.PUT.name) + writer.writeString(BatchOp::op.name, OperationType.PUT.name) writer.writerObject(BatchOp::payload.name, payload) writer.writeString(BatchOp::payloadHash.name, "test hash") writer.endObject() @@ -135,14 +135,14 @@ class SerializationTest { opId = 1, bucket = "testbucket", key = "testtkeyyytesttkeyyytesttkeyyytesttkeyyy", - op = Operation.GET.name, + op = OperationType.GET.name, resolveAttachments = true ) val headOp = BatchOp( opId = 2, bucket = "testbucket", key = "testtkeyyytesttkeyyytesttkeyyytesttkeyyy", - op = Operation.HEAD.name, + op = OperationType.HEAD.name, resolveAttachments = false ) val payload = CbObject.build { @@ -158,7 +158,7 @@ class SerializationTest { opId = 3, bucket = "testbucket", key = "testtkeyyytesttkeyyytesttkeyyytesttkeyyy", - op = Operation.PUT.name, + op = OperationType.PUT.name, payload = payload, payloadHash = payloadHash, ) diff --git a/src/backend/generic/api-generic/src/main/kotlin/com/tencent/bkrepo/generic/api/OperateResource.kt b/src/backend/generic/api-generic/src/main/kotlin/com/tencent/bkrepo/generic/api/OperateResource.kt index fa48a47f61..10618644ab 100644 --- a/src/backend/generic/api-generic/src/main/kotlin/com/tencent/bkrepo/generic/api/OperateResource.kt +++ b/src/backend/generic/api-generic/src/main/kotlin/com/tencent/bkrepo/generic/api/OperateResource.kt @@ -36,9 +36,9 @@ import com.tencent.bkrepo.common.artifact.api.ArtifactInfo import com.tencent.bkrepo.common.artifact.api.ArtifactPathVariable import com.tencent.bkrepo.common.artifact.api.DefaultArtifactInfo.Companion.DEFAULT_MAPPING_URI import com.tencent.bkrepo.generic.pojo.FileInfo -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.RequestAttribute import org.springframework.web.bind.annotation.RequestParam @@ -47,19 +47,19 @@ import org.springframework.web.bind.annotation.RequestParam * 文件操作接口 */ @Deprecated("OperateResource is deprecated!", ReplaceWith("UserNodeResource")) -@Api("文件操作接口") +@Tag(name = "文件操作接口") interface OperateResource { - @ApiOperation("列出目录下的文件") + @Operation(summary = "列出目录下的文件") @GetMapping("/list/$DEFAULT_MAPPING_URI") fun listFile( @RequestAttribute userId: String, @ArtifactPathVariable artifactInfo: ArtifactInfo, - @ApiParam("是否包含目录", required = false, defaultValue = "false") + @Parameter(name = "是否包含目录", required = false) @RequestParam includeFolder: Boolean = true, - @ApiParam("是否深度查询文件", required = false, defaultValue = "false") + @Parameter(name = "是否深度查询文件", required = false) @RequestParam deep: Boolean = false, - @ApiParam("是否包含元数据", required = false, defaultValue = "false") + @Parameter(name = "是否包含元数据", required = false) @RequestParam includeMetadata: Boolean = false, ): Response> } diff --git a/src/backend/generic/api-generic/src/main/kotlin/com/tencent/bkrepo/generic/api/ProxyTemporaryAccessClient.kt b/src/backend/generic/api-generic/src/main/kotlin/com/tencent/bkrepo/generic/api/ProxyTemporaryAccessClient.kt index ebddf17ba2..9a07810052 100644 --- a/src/backend/generic/api-generic/src/main/kotlin/com/tencent/bkrepo/generic/api/ProxyTemporaryAccessClient.kt +++ b/src/backend/generic/api-generic/src/main/kotlin/com/tencent/bkrepo/generic/api/ProxyTemporaryAccessClient.kt @@ -31,7 +31,7 @@ import com.tencent.bkrepo.auth.pojo.token.TemporaryTokenInfo import com.tencent.bkrepo.auth.pojo.token.TokenType import com.tencent.bkrepo.common.api.constant.GENERIC_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response -import io.swagger.annotations.Api +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.web.bind.annotation.PathVariable import org.springframework.web.bind.annotation.PostMapping @@ -40,7 +40,7 @@ import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam -@Api("节点服务接口") +@Tag(name = "节点服务接口") @FeignClient(GENERIC_SERVICE_NAME, contextId = "ProxyTemporaryAccessClient", primary = false) @RequestMapping("/proxy/temporary") interface ProxyTemporaryAccessClient { diff --git a/src/backend/generic/api-generic/src/main/kotlin/com/tencent/bkrepo/generic/pojo/BlockInfo.kt b/src/backend/generic/api-generic/src/main/kotlin/com/tencent/bkrepo/generic/pojo/BlockInfo.kt index 921ec1aa5e..d2a41dd415 100644 --- a/src/backend/generic/api-generic/src/main/kotlin/com/tencent/bkrepo/generic/pojo/BlockInfo.kt +++ b/src/backend/generic/api-generic/src/main/kotlin/com/tencent/bkrepo/generic/pojo/BlockInfo.kt @@ -31,18 +31,18 @@ package com.tencent.bkrepo.generic.pojo -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 分块信息 */ -@ApiModel("分块信息") +@Schema(title = "分块信息") data class BlockInfo( - @ApiModelProperty("分块大小") + @get:Schema(title = "分块大小") val size: Long, - @ApiModelProperty("分块sha256") + @get:Schema(title = "分块sha256") val sha256: String, - @ApiModelProperty("分块序号") + @get:Schema(title = "分块序号") val sequence: Int ) diff --git a/src/backend/generic/api-generic/src/main/kotlin/com/tencent/bkrepo/generic/pojo/FileInfo.kt b/src/backend/generic/api-generic/src/main/kotlin/com/tencent/bkrepo/generic/pojo/FileInfo.kt index b7ce124403..367008e299 100644 --- a/src/backend/generic/api-generic/src/main/kotlin/com/tencent/bkrepo/generic/pojo/FileInfo.kt +++ b/src/backend/generic/api-generic/src/main/kotlin/com/tencent/bkrepo/generic/pojo/FileInfo.kt @@ -31,41 +31,41 @@ package com.tencent.bkrepo.generic.pojo -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 文件信息 */ -@ApiModel("文件信息") +@Schema(title = "文件信息") data class FileInfo( - @ApiModelProperty("创建者") + @get:Schema(title = "创建者") val createdBy: String, - @ApiModelProperty("创建时间") + @get:Schema(title = "创建时间") val createdDate: String, - @ApiModelProperty("修改者") + @get:Schema(title = "修改者") val lastModifiedBy: String, - @ApiModelProperty("修改时间") + @get:Schema(title = "修改时间") val lastModifiedDate: String, - @ApiModelProperty("是否为文件夹") + @get:Schema(title = "是否为文件夹") val folder: Boolean, - @ApiModelProperty("路径") + @get:Schema(title = "路径") val path: String, - @ApiModelProperty("资源名称") + @get:Schema(title = "资源名称") val name: String, - @ApiModelProperty("完整路径") + @get:Schema(title = "完整路径") val fullPath: String, - @ApiModelProperty("文件大小，单位byte") + @get:Schema(title = "文件大小，单位byte") val size: Long, - @ApiModelProperty("文件sha256") + @get:Schema(title = "文件sha256") val sha256: String? = null, - @ApiModelProperty("文件md5") + @get:Schema(title = "文件md5") val md5: String? = null, - @ApiModelProperty("项目ID") + @get:Schema(title = "项目ID") val projectId: String, - @ApiModelProperty("仓库名称") + @get:Schema(title = "仓库名称") val repoName: String, - @ApiModelProperty("元数据") + @get:Schema(title = "元数据") val metadata: Map? = null, ) diff --git a/src/backend/generic/api-generic/src/main/kotlin/com/tencent/bkrepo/generic/pojo/SeparateBlockInfo.kt b/src/backend/generic/api-generic/src/main/kotlin/com/tencent/bkrepo/generic/pojo/SeparateBlockInfo.kt index 020a75aaf9..acc73af0da 100644 --- a/src/backend/generic/api-generic/src/main/kotlin/com/tencent/bkrepo/generic/pojo/SeparateBlockInfo.kt +++ b/src/backend/generic/api-generic/src/main/kotlin/com/tencent/bkrepo/generic/pojo/SeparateBlockInfo.kt @@ -1,17 +1,17 @@ package com.tencent.bkrepo.generic.pojo -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("新分块信息") + +@Schema(title = "新分块信息") data class SeparateBlockInfo( - @ApiModelProperty("分块大小") + @get:Schema(title = "分块大小") val size: Long, - @ApiModelProperty("分块sha256") + @get:Schema(title = "分块sha256") val sha256: String, - @ApiModelProperty("分块起始位置") + @get:Schema(title = "分块起始位置") val startPos: Long, - @ApiModelProperty("分块uploadID") + @get:Schema(title = "分块uploadID") val uploadId: String? -) \ No newline at end of file +) diff --git a/src/backend/generic/api-generic/src/main/kotlin/com/tencent/bkrepo/generic/pojo/TemporaryAccessToken.kt b/src/backend/generic/api-generic/src/main/kotlin/com/tencent/bkrepo/generic/pojo/TemporaryAccessToken.kt index 559e5ead2a..65009ca20d 100644 --- a/src/backend/generic/api-generic/src/main/kotlin/com/tencent/bkrepo/generic/pojo/TemporaryAccessToken.kt +++ b/src/backend/generic/api-generic/src/main/kotlin/com/tencent/bkrepo/generic/pojo/TemporaryAccessToken.kt @@ -31,27 +31,27 @@ package com.tencent.bkrepo.generic.pojo -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("临时访问token") + +@Schema(title = "临时访问token") data class TemporaryAccessToken( - @ApiModelProperty("项目") + @get:Schema(title = "项目") val projectId: String, - @ApiModelProperty("仓库") + @get:Schema(title = "仓库") val repoName: String, - @ApiModelProperty("授权路径") + @get:Schema(title = "授权路径") val fullPath: String, - @ApiModelProperty("token") + @get:Schema(title = "token") val token: String, - @ApiModelProperty("授权用户") + @get:Schema(title = "授权用户") val authorizedUserList: Set, - @ApiModelProperty("授权IP") + @get:Schema(title = "授权IP") val authorizedIpList: Set, - @ApiModelProperty("过期时间") + @get:Schema(title = "过期时间") val expireDate: String?, - @ApiModelProperty("允许下载次数") + @get:Schema(title = "允许下载次数") var permits: Int?, - @ApiModelProperty("token类型") + @get:Schema(title = "token类型") val type: String ) diff --git a/src/backend/generic/api-generic/src/main/kotlin/com/tencent/bkrepo/generic/pojo/TemporaryAccessUrl.kt b/src/backend/generic/api-generic/src/main/kotlin/com/tencent/bkrepo/generic/pojo/TemporaryAccessUrl.kt index c075aa6c40..fdfa2ebae0 100644 --- a/src/backend/generic/api-generic/src/main/kotlin/com/tencent/bkrepo/generic/pojo/TemporaryAccessUrl.kt +++ b/src/backend/generic/api-generic/src/main/kotlin/com/tencent/bkrepo/generic/pojo/TemporaryAccessUrl.kt @@ -31,27 +31,27 @@ package com.tencent.bkrepo.generic.pojo -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("临时访问url") + +@Schema(title = "临时访问url") data class TemporaryAccessUrl( - @ApiModelProperty("项目") + @get:Schema(title = "项目") val projectId: String, - @ApiModelProperty("仓库") + @get:Schema(title = "仓库") val repoName: String, - @ApiModelProperty("授权路径") + @get:Schema(title = "授权路径") val fullPath: String, - @ApiModelProperty("url") + @get:Schema(title = "url") val url: String, - @ApiModelProperty("授权用户") + @get:Schema(title = "授权用户") val authorizedUserList: Set, - @ApiModelProperty("授权IP") + @get:Schema(title = "授权IP") val authorizedIpList: Set, - @ApiModelProperty("过期时间") + @get:Schema(title = "过期时间") val expireDate: String?, - @ApiModelProperty("允许下载次数") + @get:Schema(title = "允许下载次数") var permits: Int?, - @ApiModelProperty("token类型") + @get:Schema(title = "token类型") val type: String ) diff --git a/src/backend/generic/api-generic/src/main/kotlin/com/tencent/bkrepo/generic/pojo/TemporaryUrlCreateRequest.kt b/src/backend/generic/api-generic/src/main/kotlin/com/tencent/bkrepo/generic/pojo/TemporaryUrlCreateRequest.kt index f504b026f4..17812217dc 100644 --- a/src/backend/generic/api-generic/src/main/kotlin/com/tencent/bkrepo/generic/pojo/TemporaryUrlCreateRequest.kt +++ b/src/backend/generic/api-generic/src/main/kotlin/com/tencent/bkrepo/generic/pojo/TemporaryUrlCreateRequest.kt @@ -28,30 +28,29 @@ package com.tencent.bkrepo.generic.pojo import com.tencent.bkrepo.auth.pojo.token.TokenType -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema import java.time.Duration -@ApiModel("创建临时访问url请求") +@Schema(title = "创建临时访问url请求") data class TemporaryUrlCreateRequest( - @ApiModelProperty("项目id") + @get:Schema(title = "项目id") val projectId: String, - @ApiModelProperty("仓库名称") + @get:Schema(title = "仓库名称") val repoName: String, - @ApiModelProperty("授权路径列表") + @get:Schema(title = "授权路径列表") val fullPathSet: Set, - @ApiModelProperty("授权用户") + @get:Schema(title = "授权用户") val authorizedUserSet: Set = emptySet(), - @ApiModelProperty("授权IP") + @get:Schema(title = "授权IP") val authorizedIpSet: Set = emptySet(), - @ApiModelProperty("有效时间，单位秒") + @get:Schema(title = "有效时间，单位秒") val expireSeconds: Long = Duration.ofDays(1).seconds, - @ApiModelProperty("允许访问次数，为空表示无限制") + @get:Schema(title = "允许访问次数，为空表示无限制") val permits: Int? = null, - @ApiModelProperty("token类型") + @get:Schema(title = "token类型") val type: TokenType, - @ApiModelProperty("指定临时访问链接host") + @get:Schema(title = "指定临时访问链接host") val host: String? = null, - @ApiModelProperty("是否通知用户") + @get:Schema(title = "是否通知用户") val needsNotify: Boolean = false ) diff --git a/src/backend/generic/api-generic/src/main/kotlin/com/tencent/bkrepo/generic/pojo/UploadTransactionInfo.kt b/src/backend/generic/api-generic/src/main/kotlin/com/tencent/bkrepo/generic/pojo/UploadTransactionInfo.kt index 6953da2936..b4cffdce80 100644 --- a/src/backend/generic/api-generic/src/main/kotlin/com/tencent/bkrepo/generic/pojo/UploadTransactionInfo.kt +++ b/src/backend/generic/api-generic/src/main/kotlin/com/tencent/bkrepo/generic/pojo/UploadTransactionInfo.kt @@ -31,16 +31,16 @@ package com.tencent.bkrepo.generic.pojo -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 分块上传预检结果 */ -@ApiModel("分块上传事物信息") +@Schema(title = "分块上传事物信息") data class UploadTransactionInfo( - @ApiModelProperty("分块上传id") + @get:Schema(title = "分块上传id") val uploadId: String, - @ApiModelProperty("上传有效期") + @get:Schema(title = "上传有效期") val expireSeconds: Long ) diff --git a/src/backend/generic/biz-generic/src/main/kotlin/com/tencent/bkrepo/generic/controller/GenericController.kt b/src/backend/generic/biz-generic/src/main/kotlin/com/tencent/bkrepo/generic/controller/GenericController.kt index 6fce444949..93f805a330 100644 --- a/src/backend/generic/biz-generic/src/main/kotlin/com/tencent/bkrepo/generic/controller/GenericController.kt +++ b/src/backend/generic/biz-generic/src/main/kotlin/com/tencent/bkrepo/generic/controller/GenericController.kt @@ -45,16 +45,16 @@ import com.tencent.bkrepo.common.artifact.api.ArtifactFile import com.tencent.bkrepo.common.artifact.api.ArtifactInfo import com.tencent.bkrepo.common.artifact.api.ArtifactPathVariable import com.tencent.bkrepo.common.artifact.api.DefaultArtifactInfo +import com.tencent.bkrepo.common.artifact.audit.ActionAuditContent +import com.tencent.bkrepo.common.artifact.audit.NODE_CREATE_ACTION +import com.tencent.bkrepo.common.artifact.audit.NODE_DELETE_ACTION +import com.tencent.bkrepo.common.artifact.audit.NODE_DOWNLOAD_ACTION +import com.tencent.bkrepo.common.artifact.audit.NODE_RESOURCE import com.tencent.bkrepo.common.artifact.constant.ARTIFACT_INFO_KEY import com.tencent.bkrepo.common.artifact.message.ArtifactMessageCode import com.tencent.bkrepo.common.artifact.router.Router import com.tencent.bkrepo.common.artifact.util.PipelineRepoUtils import com.tencent.bkrepo.common.metadata.permission.PermissionManager -import com.tencent.bkrepo.common.artifact.audit.ActionAuditContent -import com.tencent.bkrepo.common.artifact.audit.NODE_DELETE_ACTION -import com.tencent.bkrepo.common.artifact.audit.NODE_DOWNLOAD_ACTION -import com.tencent.bkrepo.common.artifact.audit.NODE_RESOURCE -import com.tencent.bkrepo.common.artifact.audit.NODE_CREATE_ACTION import com.tencent.bkrepo.common.mongo.dao.util.Pages import com.tencent.bkrepo.common.query.model.QueryModel import com.tencent.bkrepo.common.security.permission.Permission @@ -72,7 +72,7 @@ import com.tencent.bkrepo.generic.pojo.UploadTransactionInfo import com.tencent.bkrepo.generic.service.CompressedFileService import com.tencent.bkrepo.generic.service.DownloadService import com.tencent.bkrepo.generic.service.UploadService -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable @@ -290,7 +290,7 @@ class GenericController( return ResponseBuilder.success(downloadService.allowDownload(artifactInfo, ip, fromApp)) } - @ApiOperation("根据路径查看节点详情") + @Operation(summary = "根据路径查看节点详情") @Permission(type = ResourceType.NODE, action = PermissionAction.READ) @GetMapping("/detail/${DefaultArtifactInfo.DEFAULT_MAPPING_URI}") fun query(@ArtifactPathVariable artifactInfo: GenericArtifactInfo): Response { @@ -300,7 +300,7 @@ class GenericController( } - @ApiOperation("自定义查询节点") + @Operation(summary = "自定义查询节点") @PostMapping("/{projectId}/{repoName}/search") @Permission(ResourceType.REPO, PermissionAction.READ) fun search( diff --git a/src/backend/generic/biz-generic/src/main/kotlin/com/tencent/bkrepo/generic/controller/TemporaryAccessController.kt b/src/backend/generic/biz-generic/src/main/kotlin/com/tencent/bkrepo/generic/controller/TemporaryAccessController.kt index 7e6f9fcbd6..45391a6c77 100644 --- a/src/backend/generic/biz-generic/src/main/kotlin/com/tencent/bkrepo/generic/controller/TemporaryAccessController.kt +++ b/src/backend/generic/biz-generic/src/main/kotlin/com/tencent/bkrepo/generic/controller/TemporaryAccessController.kt @@ -70,7 +70,7 @@ import com.tencent.bkrepo.generic.pojo.TemporaryUrlCreateRequest import com.tencent.bkrepo.generic.pojo.UploadTransactionInfo import com.tencent.bkrepo.generic.service.TemporaryAccessService import com.tencent.bkrepo.generic.service.UploadService -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation import org.springframework.http.HttpMethod import org.springframework.web.bind.annotation.CrossOrigin import org.springframework.web.bind.annotation.DeleteMapping @@ -135,7 +135,7 @@ class TemporaryAccessController( scopeId = "#artifactInfo?.projectId", content = ActionAuditContent.NODE_SHARE_DOWNLOAD_CONTENT ) - @ApiOperation("下载分享文件") + @Operation(summary = "下载分享文件") @Router @CrossOrigin @GetMapping("/share/$GENERIC_MAPPING_URI") diff --git a/src/backend/helm/api-helm/src/main/kotlin/com/tencent/bkrepo/helm/api/HelmClient.kt b/src/backend/helm/api-helm/src/main/kotlin/com/tencent/bkrepo/helm/api/HelmClient.kt index 73166e1959..d76afbab68 100644 --- a/src/backend/helm/api-helm/src/main/kotlin/com/tencent/bkrepo/helm/api/HelmClient.kt +++ b/src/backend/helm/api-helm/src/main/kotlin/com/tencent/bkrepo/helm/api/HelmClient.kt @@ -33,8 +33,8 @@ package com.tencent.bkrepo.helm.api import com.tencent.bkrepo.common.api.constant.HELM_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.context.annotation.Primary import org.springframework.web.bind.annotation.DeleteMapping @@ -46,27 +46,27 @@ import org.springframework.web.bind.annotation.RequestParam /** * helm代理仓库刷新接口 */ -@Api("helm代理仓库刷新接口") +@Tag(name = "helm代理仓库刷新接口") @Primary @FeignClient(HELM_SERVICE_NAME, contextId = "HelmClient") @RequestMapping("/service/index") interface HelmClient { - @ApiOperation("刷新对应代理仓库的index文件以及package信息") + @Operation(summary = "刷新对应代理仓库的index文件以及package信息") @PostMapping("/{projectId}/{repoName}/refresh") fun refreshIndexYamlAndPackage( @PathVariable projectId: String, @PathVariable repoName: String ): Response - @ApiOperation("初始化代理仓库的index文件以及package信息") + @Operation(summary = "初始化代理仓库的index文件以及package信息") @PostMapping("/{projectId}/{repoName}/init") fun initIndexAndPackage( @PathVariable projectId: String, @PathVariable repoName: String ): Response - @ApiOperation("当仓库有版本replication时，刷新index文件") + @Operation(summary = "当仓库有版本replication时，刷新index文件") @PostMapping("/{projectId}/{repoName}/replication") fun refreshIndexForReplication( @PathVariable projectId: String, @@ -76,7 +76,7 @@ interface HelmClient { @RequestParam packageVersion: String, ): Response - @ApiOperation("删除仓库下的包版本") + @Operation(summary = "删除仓库下的包版本") @DeleteMapping("version/delete/{projectId}/{repoName}") fun deleteVersion( @PathVariable projectId: String, @@ -85,7 +85,7 @@ interface HelmClient { @RequestParam version: String ): Response - @ApiOperation("更新对应节点元数据") + @Operation(summary = "更新对应节点元数据") @PostMapping("/{projectId}/{repoName}/metaDate/regenerate") fun metadataRefresh( @PathVariable projectId: String, diff --git a/src/backend/helm/api-helm/src/main/kotlin/com/tencent/bkrepo/helm/pojo/HelmErrorResponse.kt b/src/backend/helm/api-helm/src/main/kotlin/com/tencent/bkrepo/helm/pojo/HelmErrorResponse.kt index f0edf229dc..f92166ec0d 100644 --- a/src/backend/helm/api-helm/src/main/kotlin/com/tencent/bkrepo/helm/pojo/HelmErrorResponse.kt +++ b/src/backend/helm/api-helm/src/main/kotlin/com/tencent/bkrepo/helm/pojo/HelmErrorResponse.kt @@ -31,11 +31,11 @@ package com.tencent.bkrepo.helm.pojo -import io.swagger.annotations.Api -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@Api("helm error 包装返回模型") + +@Schema(title = "helm error 包装返回模型") data class HelmErrorResponse( - @ApiModelProperty("错误信息") + @get:Schema(title = "错误信息") val error: String? ) diff --git a/src/backend/helm/api-helm/src/main/kotlin/com/tencent/bkrepo/helm/pojo/HelmSuccessResponse.kt b/src/backend/helm/api-helm/src/main/kotlin/com/tencent/bkrepo/helm/pojo/HelmSuccessResponse.kt index fe20af0fec..35ead072f4 100644 --- a/src/backend/helm/api-helm/src/main/kotlin/com/tencent/bkrepo/helm/pojo/HelmSuccessResponse.kt +++ b/src/backend/helm/api-helm/src/main/kotlin/com/tencent/bkrepo/helm/pojo/HelmSuccessResponse.kt @@ -32,12 +32,12 @@ package com.tencent.bkrepo.helm.pojo import com.fasterxml.jackson.annotation.JsonInclude -import io.swagger.annotations.Api -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@Api("helm success 包装模型") + +@Schema(title = "helm success 包装模型") data class HelmSuccessResponse( - @ApiModelProperty("是否成功") + @get:Schema(title = "是否成功") @JsonInclude(JsonInclude.Include.NON_NULL) val saved: Boolean?, @JsonInclude(JsonInclude.Include.NON_NULL) diff --git a/src/backend/helm/api-helm/src/main/kotlin/com/tencent/bkrepo/helm/pojo/chart/ChartPackageDeleteRequest.kt b/src/backend/helm/api-helm/src/main/kotlin/com/tencent/bkrepo/helm/pojo/chart/ChartPackageDeleteRequest.kt index e8b7a9031c..25713afe69 100644 --- a/src/backend/helm/api-helm/src/main/kotlin/com/tencent/bkrepo/helm/pojo/chart/ChartPackageDeleteRequest.kt +++ b/src/backend/helm/api-helm/src/main/kotlin/com/tencent/bkrepo/helm/pojo/chart/ChartPackageDeleteRequest.kt @@ -31,17 +31,17 @@ package com.tencent.bkrepo.helm.pojo.chart -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("chart包删除请求") + +@Schema(title = "chart包删除请求") data class ChartPackageDeleteRequest( - @ApiModelProperty("所属项目id", required = true) + @get:Schema(title = "所属项目id", required = true) override val projectId: String, - @ApiModelProperty("所属仓库id", required = true) + @get:Schema(title = "所属仓库id", required = true) override val repoName: String, - @ApiModelProperty("chart名称", required = true) + @get:Schema(title = "chart名称", required = true) val name: String, - @ApiModelProperty("操作用户id", required = true) + @get:Schema(title = "操作用户id", required = true) override val operator: String ) : ChartOperationRequest diff --git a/src/backend/helm/api-helm/src/main/kotlin/com/tencent/bkrepo/helm/pojo/chart/ChartUploadRequest.kt b/src/backend/helm/api-helm/src/main/kotlin/com/tencent/bkrepo/helm/pojo/chart/ChartUploadRequest.kt index df44d5ade4..9735661acc 100644 --- a/src/backend/helm/api-helm/src/main/kotlin/com/tencent/bkrepo/helm/pojo/chart/ChartUploadRequest.kt +++ b/src/backend/helm/api-helm/src/main/kotlin/com/tencent/bkrepo/helm/pojo/chart/ChartUploadRequest.kt @@ -28,25 +28,25 @@ package com.tencent.bkrepo.helm.pojo.chart import com.tencent.bkrepo.common.artifact.api.ArtifactInfo -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("chart包上传请求") + +@Schema(title = "chart包上传请求") data class ChartUploadRequest( - @ApiModelProperty("所属项目id", required = true) + @get:Schema(title = "所属项目id", required = true) override val projectId: String, - @ApiModelProperty("所属仓库id", required = true) + @get:Schema(title = "所属仓库id", required = true) override val repoName: String, - @ApiModelProperty("chart名称", required = true) + @get:Schema(title = "chart名称", required = true) val name: String, - @ApiModelProperty("chart版本", required = true) + @get:Schema(title = "chart版本", required = true) val version: String, - @ApiModelProperty("操作用户id", required = true) + @get:Schema(title = "操作用户id", required = true) override val operator: String, - @ApiModelProperty("chart路径", required = true) + @get:Schema(title = "chart路径", required = true) val fullPath: String, - @ApiModelProperty("chart元属性信息", required = false) + @get:Schema(title = "chart元属性信息", required = false) val metadataMap: Map?, - @ApiModelProperty("chart包相关信息", required = false) + @get:Schema(title = "chart包相关信息", required = false) val artifactInfo: ArtifactInfo ) : ChartOperationRequest diff --git a/src/backend/helm/api-helm/src/main/kotlin/com/tencent/bkrepo/helm/pojo/chart/ChartVersionDeleteRequest.kt b/src/backend/helm/api-helm/src/main/kotlin/com/tencent/bkrepo/helm/pojo/chart/ChartVersionDeleteRequest.kt index 8f59d5942c..3b8f7ec1a6 100644 --- a/src/backend/helm/api-helm/src/main/kotlin/com/tencent/bkrepo/helm/pojo/chart/ChartVersionDeleteRequest.kt +++ b/src/backend/helm/api-helm/src/main/kotlin/com/tencent/bkrepo/helm/pojo/chart/ChartVersionDeleteRequest.kt @@ -31,19 +31,19 @@ package com.tencent.bkrepo.helm.pojo.chart -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("chart删除请求") + +@Schema(title = "chart删除请求") data class ChartVersionDeleteRequest( - @ApiModelProperty("所属项目id", required = true) + @get:Schema(title = "所属项目id", required = true) override val projectId: String, - @ApiModelProperty("所属仓库id", required = true) + @get:Schema(title = "所属仓库id", required = true) override val repoName: String, - @ApiModelProperty("chart名称", required = true) + @get:Schema(title = "chart名称", required = true) val name: String, - @ApiModelProperty("chart版本", required = true) + @get:Schema(title = "chart版本", required = true) val version: String, - @ApiModelProperty("操作用户id", required = true) + @get:Schema(title = "操作用户id", required = true) override val operator: String ) : ChartOperationRequest diff --git a/src/backend/helm/api-helm/src/main/kotlin/com/tencent/bkrepo/helm/pojo/user/PackageVersionInfo.kt b/src/backend/helm/api-helm/src/main/kotlin/com/tencent/bkrepo/helm/pojo/user/PackageVersionInfo.kt index 0c712735e5..2a15b1785a 100644 --- a/src/backend/helm/api-helm/src/main/kotlin/com/tencent/bkrepo/helm/pojo/user/PackageVersionInfo.kt +++ b/src/backend/helm/api-helm/src/main/kotlin/com/tencent/bkrepo/helm/pojo/user/PackageVersionInfo.kt @@ -32,43 +32,43 @@ package com.tencent.bkrepo.helm.pojo.user import com.tencent.bkrepo.repository.pojo.metadata.MetadataModel -import io.swagger.annotations.Api -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@Api("npm版本详情页返回包装模型") + +@Schema(title = "npm版本详情页返回包装模型") data class PackageVersionInfo( - @ApiModelProperty("基础信息") + @get:Schema(title = "基础信息") val basic: BasicInfo, - @ApiModelProperty("元数据信息") + @get:Schema(title = "元数据信息") val metadata: List ) -@Api("基础信息") +@Schema(title = "基础信息") data class BasicInfo( - @ApiModelProperty("版本字段") + @get:Schema(title = "版本字段") val version: String, - @ApiModelProperty("完整路径") + @get:Schema(title = "完整路径") val fullPath: String, - @ApiModelProperty("文件大小，单位byte") + @get:Schema(title = "文件大小，单位byte") val size: Long, - @ApiModelProperty("文件sha256") + @get:Schema(title = "文件sha256") val sha256: String, - @ApiModelProperty("文件md5") + @get:Schema(title = "文件md5") val md5: String, - @ApiModelProperty("晋级状态标签") + @get:Schema(title = "晋级状态标签") val stageTag: List, - @ApiModelProperty("所属项目id") + @get:Schema(title = "所属项目id") val projectId: String, - @ApiModelProperty("所属仓库名称") + @get:Schema(title = "所属仓库名称") val repoName: String, - @ApiModelProperty("下载次数") + @get:Schema(title = "下载次数") val downloadCount: Long, - @ApiModelProperty("创建者") + @get:Schema(title = "创建者") val createdBy: String, - @ApiModelProperty("创建时间") + @get:Schema(title = "创建时间") val createdDate: String, - @ApiModelProperty("修改者") + @get:Schema(title = "修改者") val lastModifiedBy: String, - @ApiModelProperty("修改时间") + @get:Schema(title = "修改时间") val lastModifiedDate: String ) diff --git a/src/backend/helm/biz-helm/src/main/kotlin/com/tencent/bkrepo/helm/controller/api/HelmFixToolController.kt b/src/backend/helm/biz-helm/src/main/kotlin/com/tencent/bkrepo/helm/controller/api/HelmFixToolController.kt index ddc947a371..23571b5ea1 100644 --- a/src/backend/helm/biz-helm/src/main/kotlin/com/tencent/bkrepo/helm/controller/api/HelmFixToolController.kt +++ b/src/backend/helm/biz-helm/src/main/kotlin/com/tencent/bkrepo/helm/controller/api/HelmFixToolController.kt @@ -38,7 +38,7 @@ import com.tencent.bkrepo.helm.pojo.artifact.HelmArtifactInfo import com.tencent.bkrepo.helm.pojo.fixtool.DateTimeRepairResponse import com.tencent.bkrepo.helm.pojo.fixtool.PackageManagerResponse import com.tencent.bkrepo.helm.service.FixToolService -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PostMapping import org.springframework.web.bind.annotation.RequestAttribute @@ -48,13 +48,13 @@ import org.springframework.web.bind.annotation.RestController class HelmFixToolController( private val fixToolService: FixToolService ) { - @ApiOperation("修复package管理功能") + @Operation(summary = "修复package管理功能") @GetMapping("/ext/package/populate") fun fixPackageVersion(): List { return fixToolService.fixPackageVersion() } - @ApiOperation("修复index.yaml文件中的制品包创建时间问题") + @Operation(summary = "修复index.yaml文件中的制品包创建时间问题") @GetMapping("/ext/repairDateFormat") fun repairPackageCreatedDate(): Response> { return ResponseBuilder.success(fixToolService.repairPackageCreatedDate()) diff --git a/src/backend/helm/biz-helm/src/main/kotlin/com/tencent/bkrepo/helm/controller/api/UserHelmController.kt b/src/backend/helm/biz-helm/src/main/kotlin/com/tencent/bkrepo/helm/controller/api/UserHelmController.kt index 18f209a39c..961a668481 100644 --- a/src/backend/helm/biz-helm/src/main/kotlin/com/tencent/bkrepo/helm/controller/api/UserHelmController.kt +++ b/src/backend/helm/biz-helm/src/main/kotlin/com/tencent/bkrepo/helm/controller/api/UserHelmController.kt @@ -50,9 +50,9 @@ import com.tencent.bkrepo.helm.pojo.artifact.HelmDeleteArtifactInfo import com.tencent.bkrepo.helm.pojo.user.PackageVersionInfo import com.tencent.bkrepo.helm.service.ChartManipulationService import com.tencent.bkrepo.helm.service.ChartRepositoryService -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.RequestAttribute @@ -61,7 +61,7 @@ import org.springframework.web.bind.annotation.RequestParam import org.springframework.web.bind.annotation.RestController @Suppress("MVCPathVariableInspection") -@Api("helm产品接口") +@Tag(name = "helm产品接口") @RestController @RequestMapping("/ext") class UserHelmController( @@ -69,15 +69,15 @@ class UserHelmController( private val chartRepositoryService: ChartRepositoryService, ) { - @ApiOperation("查询包的版本详情") + @Operation(summary = "查询包的版本详情") @GetMapping(HELM_VERSION_DETAIL) fun detailVersion( @RequestAttribute userId: String, @ArtifactPathVariable artifactInfo: HelmArtifactInfo, - @ApiParam(value = "包唯一Key", required = true) + @Parameter(name = "包唯一Key", required = true) @RequestParam packageKey: String, - @ApiParam(value = "包版本", required = true) + @Parameter(name = "包版本", required = true) @RequestParam version: String ): Response { return ResponseBuilder.success(chartRepositoryService.detailVersion(userId, artifactInfo, packageKey, version)) @@ -100,12 +100,12 @@ class UserHelmController( scopeId = "#artifactInfo?.projectId", content = ActionAuditContent.REPO_PACKAGE_DELETE_CONTENT ) - @ApiOperation("删除仓库下的包") + @Operation(summary = "删除仓库下的包") @DeleteMapping(CHART_PACKAGE_DELETE_URL) fun deletePackage( @RequestAttribute userId: String, artifactInfo: HelmDeleteArtifactInfo, - @ApiParam(value = "包唯一key", required = true) + @Parameter(name = "包唯一key", required = true) @RequestParam packageKey: String ): Response { chartManipulationService.deletePackage(userId, artifactInfo) @@ -131,21 +131,21 @@ class UserHelmController( scopeId = "#artifactInfo?.projectId", content = ActionAuditContent.REPO_PACKAGE_VERSION_DELETE_CONTENT ) - @ApiOperation("删除仓库下的包版本") + @Operation(summary = "删除仓库下的包版本") @DeleteMapping(CHART_VERSION_DELETE_URL) fun deleteVersion( @RequestAttribute userId: String, artifactInfo: HelmDeleteArtifactInfo, - @ApiParam(value = "包唯一key", required = true) + @Parameter(name = "包唯一key", required = true) @RequestParam packageKey: String, - @ApiParam(value = "包版本", required = true) + @Parameter(name = "包版本", required = true) @RequestParam version: String ): Response { chartManipulationService.deleteVersion(userId, artifactInfo) return ResponseBuilder.success() } - @ApiOperation("获取helm域名地址") + @Operation(summary = "获取helm域名地址") @GetMapping("/address") fun getRegistryDomain(): Response { return ResponseBuilder.success(chartRepositoryService.getRegistryDomain()) diff --git a/src/backend/job/biz-job/src/main/kotlin/com/tencent/bkrepo/job/backup/pojo/query/common/BackupCredentialSet.kt b/src/backend/job/biz-job/src/main/kotlin/com/tencent/bkrepo/job/backup/pojo/query/common/BackupCredentialSet.kt index c4815cd9b8..7394889545 100644 --- a/src/backend/job/biz-job/src/main/kotlin/com/tencent/bkrepo/job/backup/pojo/query/common/BackupCredentialSet.kt +++ b/src/backend/job/biz-job/src/main/kotlin/com/tencent/bkrepo/job/backup/pojo/query/common/BackupCredentialSet.kt @@ -29,20 +29,19 @@ package com.tencent.bkrepo.job.backup.pojo.query.common import com.tencent.bkrepo.auth.pojo.oauth.AuthorizationGrantType import com.tencent.bkrepo.job.backup.pojo.query.enums.BackupCredentialStatus -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema import java.time.LocalDateTime -@ApiModel("账户认证信息") +@Schema(title = "账户认证信息") data class BackupCredentialSet( - @ApiModelProperty("accessKey") + @get:Schema(title = "accessKey") val accessKey: String, - @ApiModelProperty("secretKey") + @get:Schema(title = "secretKey") var secretKey: String, - @ApiModelProperty("创建时间") + @get:Schema(title = "创建时间") val createdAt: LocalDateTime, - @ApiModelProperty("状态") + @get:Schema(title = "状态") val status: BackupCredentialStatus, - @ApiModelProperty("认证授权方式") + @get:Schema(title = "认证授权方式") val authorizationGrantType: AuthorizationGrantType? = AuthorizationGrantType.PLATFORM ) diff --git a/src/backend/job/biz-job/src/main/kotlin/com/tencent/bkrepo/job/backup/pojo/query/common/BackupScopeRule.kt b/src/backend/job/biz-job/src/main/kotlin/com/tencent/bkrepo/job/backup/pojo/query/common/BackupScopeRule.kt index 6f43af1b63..08fe5c6f29 100644 --- a/src/backend/job/biz-job/src/main/kotlin/com/tencent/bkrepo/job/backup/pojo/query/common/BackupScopeRule.kt +++ b/src/backend/job/biz-job/src/main/kotlin/com/tencent/bkrepo/job/backup/pojo/query/common/BackupScopeRule.kt @@ -28,13 +28,14 @@ package com.tencent.bkrepo.job.backup.pojo.query.common import com.tencent.bkrepo.common.query.enums.OperationType -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + data class BackupScopeRule( - @ApiModelProperty("字段名") + @get:Schema(title = "字段名") val field: String, - @ApiModelProperty("值") + @get:Schema(title = "值") val value: Any, - @ApiModelProperty("操作类型") + @get:Schema(title = "操作类型") val operation: OperationType = OperationType.DEFAULT ) diff --git a/src/backend/job/biz-job/src/main/kotlin/com/tencent/bkrepo/job/backup/pojo/query/enums/BackupRoleSource.kt b/src/backend/job/biz-job/src/main/kotlin/com/tencent/bkrepo/job/backup/pojo/query/enums/BackupRoleSource.kt index 7b99694300..f235ddaa24 100644 --- a/src/backend/job/biz-job/src/main/kotlin/com/tencent/bkrepo/job/backup/pojo/query/enums/BackupRoleSource.kt +++ b/src/backend/job/biz-job/src/main/kotlin/com/tencent/bkrepo/job/backup/pojo/query/enums/BackupRoleSource.kt @@ -27,9 +27,9 @@ package com.tencent.bkrepo.job.backup.pojo.query.enums -import io.swagger.annotations.ApiModel +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("角色来源") +@Schema(title = "角色来源") enum class BackupRoleSource { DEVOPS, TAI diff --git a/src/backend/job/biz-job/src/main/kotlin/com/tencent/bkrepo/job/backup/pojo/task/BackupTask.kt b/src/backend/job/biz-job/src/main/kotlin/com/tencent/bkrepo/job/backup/pojo/task/BackupTask.kt index 180917a76e..32b0fd4c47 100644 --- a/src/backend/job/biz-job/src/main/kotlin/com/tencent/bkrepo/job/backup/pojo/task/BackupTask.kt +++ b/src/backend/job/biz-job/src/main/kotlin/com/tencent/bkrepo/job/backup/pojo/task/BackupTask.kt @@ -29,35 +29,34 @@ package com.tencent.bkrepo.job.backup.pojo.task import com.tencent.bkrepo.job.backup.model.TBackupTask import com.tencent.bkrepo.job.backup.pojo.setting.BackupSetting -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema import java.time.LocalDateTime -@ApiModel("数据备份任务") +@Schema(title = "数据备份任务") data class BackupTask( - @ApiModelProperty("ID") + @get:Schema(title = "ID") val id: String? = null, - @ApiModelProperty("创建人") + @get:Schema(title = "创建人") val createdBy: String, - @ApiModelProperty("创建时间") + @get:Schema(title = "创建时间") val createdDate: LocalDateTime, - @ApiModelProperty("最后修改人") + @get:Schema(title = "最后修改人") val lastModifiedBy: String, - @ApiModelProperty("最后修改时间") + @get:Schema(title = "最后修改时间") val lastModifiedDate: LocalDateTime, - @ApiModelProperty("任务开始执行的时间") + @get:Schema(title = "任务开始执行的时间") val startDate: LocalDateTime? = null, - @ApiModelProperty("任务结束执行的时间") + @get:Schema(title = "任务结束执行的时间") val endDate: LocalDateTime? = null, - @ApiModelProperty("任务状态") + @get:Schema(title = "任务状态") val state: String, - @ApiModelProperty("任务内容") + @get:Schema(title = "任务内容") val content: BackupContent?, - @ApiModelProperty("存储路径") + @get:Schema(title = "存储路径") val storeLocation: String, - @ApiModelProperty("任务配置") + @get:Schema(title = "任务配置") val backupSetting: BackupSetting, - @ApiModelProperty("任务类型") + @get:Schema(title = "任务类型") val type: String, ) { companion object { diff --git a/src/backend/job/biz-job/src/main/kotlin/com/tencent/bkrepo/job/controller/user/UserSeparationController.kt b/src/backend/job/biz-job/src/main/kotlin/com/tencent/bkrepo/job/controller/user/UserSeparationController.kt index 4355ae3cca..8d585cd86f 100644 --- a/src/backend/job/biz-job/src/main/kotlin/com/tencent/bkrepo/job/controller/user/UserSeparationController.kt +++ b/src/backend/job/biz-job/src/main/kotlin/com/tencent/bkrepo/job/controller/user/UserSeparationController.kt @@ -47,7 +47,7 @@ import com.tencent.bkrepo.repository.pojo.packages.PackageListOption import com.tencent.bkrepo.repository.pojo.packages.PackageSummary import com.tencent.bkrepo.repository.pojo.packages.PackageVersion import com.tencent.bkrepo.repository.pojo.packages.VersionListOption -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable import org.springframework.web.bind.annotation.PostMapping @@ -88,7 +88,7 @@ class UserSeparationController( return ResponseBuilder.success() } - @ApiOperation("查询冷表中节点信息") + @Operation(summary = "查询冷表中节点信息") @GetMapping("/node/{projectId}/{repoName}") fun getNodeInfo( @PathVariable projectId: String, @@ -98,7 +98,7 @@ class UserSeparationController( return ResponseBuilder.success(separationDataService.findNodeInfo(projectId, repoName, fullPath)) } - @ApiOperation("查询冷表中版本信息") + @Operation(summary = "查询冷表中版本信息") @GetMapping("/version/{projectId}/{repoName}") fun getVersionInfo( @PathVariable projectId: String, @@ -111,7 +111,7 @@ class UserSeparationController( ) } - @ApiOperation("分页查询包") + @Operation(summary = "分页查询包") @GetMapping("/package/page/{projectId}/{repoName}") fun listPackagePage( @PathVariable projectId: String, @@ -122,7 +122,7 @@ class UserSeparationController( return ResponseBuilder.success(pageResult) } - @ApiOperation("分页查询版本") + @Operation(summary = "分页查询版本") @GetMapping("/version/page/{projectId}/{repoName}") fun listVersionPage( @PathVariable projectId: String, @@ -137,7 +137,7 @@ class UserSeparationController( } - @ApiOperation("分页查询节点") + @Operation(summary = "分页查询节点") @GetMapping("/node/page/{projectId}/{repoName}") fun listPageNode( @PathVariable projectId: String, diff --git a/src/backend/job/biz-job/src/main/kotlin/com/tencent/bkrepo/job/migrate/pojo/CreateMigrateRepoStorageTaskRequest.kt b/src/backend/job/biz-job/src/main/kotlin/com/tencent/bkrepo/job/migrate/pojo/CreateMigrateRepoStorageTaskRequest.kt index f502d863da..faad1b6e44 100644 --- a/src/backend/job/biz-job/src/main/kotlin/com/tencent/bkrepo/job/migrate/pojo/CreateMigrateRepoStorageTaskRequest.kt +++ b/src/backend/job/biz-job/src/main/kotlin/com/tencent/bkrepo/job/migrate/pojo/CreateMigrateRepoStorageTaskRequest.kt @@ -28,17 +28,17 @@ package com.tencent.bkrepo.job.migrate.pojo import com.tencent.bkrepo.repository.constant.SYSTEM_USER -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("迁移仓库存储请求") + +@Schema(title = "迁移仓库存储请求") data class CreateMigrateRepoStorageTaskRequest( - @ApiModelProperty("待迁移项目") + @get:Schema(title = "待迁移项目") val projectId: String, - @ApiModelProperty("待迁移仓库") + @get:Schema(title = "待迁移仓库") val repoName: String, - @ApiModelProperty("目标存储key，为null时表示默认存储") + @get:Schema(title = "目标存储key，为null时表示默认存储") val dstCredentialsKey: String?, - @ApiModelProperty("操作用户") + @get:Schema(title = "操作用户") val operator: String = SYSTEM_USER, ) diff --git a/src/backend/job/biz-job/src/main/kotlin/com/tencent/bkrepo/job/migrate/pojo/MigrateRepoStorageTask.kt b/src/backend/job/biz-job/src/main/kotlin/com/tencent/bkrepo/job/migrate/pojo/MigrateRepoStorageTask.kt index a172087890..2fb6f20a97 100644 --- a/src/backend/job/biz-job/src/main/kotlin/com/tencent/bkrepo/job/migrate/pojo/MigrateRepoStorageTask.kt +++ b/src/backend/job/biz-job/src/main/kotlin/com/tencent/bkrepo/job/migrate/pojo/MigrateRepoStorageTask.kt @@ -29,42 +29,42 @@ package com.tencent.bkrepo.job.migrate.pojo import com.tencent.bkrepo.common.mongo.constant.MIN_OBJECT_ID import com.tencent.bkrepo.job.migrate.model.TMigrateRepoStorageTask -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + import java.time.LocalDateTime -@ApiModel("数据迁移任务") +@Schema(title = "数据迁移任务") data class MigrateRepoStorageTask( - @ApiModelProperty("ID") + @get:Schema(title = "ID") val id: String? = null, - @ApiModelProperty("创建人") + @get:Schema(title = "创建人") val createdBy: String, - @ApiModelProperty("创建时间") + @get:Schema(title = "创建时间") val createdDate: LocalDateTime, - @ApiModelProperty("最后修改人") + @get:Schema(title = "最后修改人") val lastModifiedBy: String, - @ApiModelProperty("最后修改时间") + @get:Schema(title = "最后修改时间") val lastModifiedDate: LocalDateTime, - @ApiModelProperty("任务开始执行的时间") + @get:Schema(title = "任务开始执行的时间") val startDate: LocalDateTime? = null, - @ApiModelProperty("需要迁移的制品总数") + @get:Schema(title = "需要迁移的制品总数") val totalCount: Long? = null, - @ApiModelProperty("已迁移的制品数") + @get:Schema(title = "已迁移的制品数") val migratedCount: Long = 0, - @ApiModelProperty("已迁移的最后一个Node ID") + @get:Schema(title = "已迁移的最后一个Node ID") val lastMigratedNodeId: String = MIN_OBJECT_ID, - @ApiModelProperty("迁移任务所属项目") + @get:Schema(title = "迁移任务所属项目") val projectId: String, - @ApiModelProperty("迁移项目所属仓库") + @get:Schema(title = "迁移项目所属仓库") val repoName: String, - @ApiModelProperty("源存储，为null时表示默认存储") + @get:Schema(title = "源存储，为null时表示默认存储") val srcStorageKey: String? = null, - @ApiModelProperty("目标存储，为null时表示默认存储") + @get:Schema(title = "目标存储，为null时表示默认存储") val dstStorageKey: String? = null, - @ApiModelProperty("迁移状态") + @get:Schema(title = "迁移状态") val state: String, - @ApiModelProperty("当前正在执行该任务的实例instanceId") + @get:Schema(title = "当前正在执行该任务的实例instanceId") val executingOn: String? = null, ) { companion object { diff --git a/src/backend/job/biz-job/src/main/kotlin/com/tencent/bkrepo/job/separation/pojo/task/SeparationTask.kt b/src/backend/job/biz-job/src/main/kotlin/com/tencent/bkrepo/job/separation/pojo/task/SeparationTask.kt index 624ae3a782..2dab23b52c 100644 --- a/src/backend/job/biz-job/src/main/kotlin/com/tencent/bkrepo/job/separation/pojo/task/SeparationTask.kt +++ b/src/backend/job/biz-job/src/main/kotlin/com/tencent/bkrepo/job/separation/pojo/task/SeparationTask.kt @@ -29,41 +29,40 @@ package com.tencent.bkrepo.job.separation.pojo.task import com.tencent.bkrepo.job.separation.model.TSeparationTask import com.tencent.bkrepo.job.separation.pojo.SeparationContent -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema import java.time.LocalDateTime -@ApiModel("数据降冷任务") +@Schema(title = "数据降冷任务") data class SeparationTask( - @ApiModelProperty("ID") + @get:Schema(title = "ID") val id: String? = null, - @ApiModelProperty("创建人") + @get:Schema(title = "创建人") val createdBy: String, - @ApiModelProperty("创建时间") + @get:Schema(title = "创建时间") val createdDate: LocalDateTime, - @ApiModelProperty("最后修改人") + @get:Schema(title = "最后修改人") val lastModifiedBy: String, - @ApiModelProperty("最后修改时间") + @get:Schema(title = "最后修改时间") val lastModifiedDate: LocalDateTime, - @ApiModelProperty("降冷临界时间") + @get:Schema(title = "降冷临界时间") val separationDate: LocalDateTime, - @ApiModelProperty("任务开始执行的时间") + @get:Schema(title = "任务开始执行的时间") val startDate: LocalDateTime? = null, - @ApiModelProperty("任务结束执行的时间") + @get:Schema(title = "任务结束执行的时间") val endDate: LocalDateTime? = null, - @ApiModelProperty("已降冷成功的制品数") + @get:Schema(title = "已降冷成功的制品数") val successCount: Long = 0, - @ApiModelProperty("降冷失败的制品数") + @get:Schema(title = "降冷失败的制品数") val failedCount: Long = 0, - @ApiModelProperty("跳过的制品数") + @get:Schema(title = "跳过的制品数") val skippedCount: Long = 0, - @ApiModelProperty("降冷任务所属项目") + @get:Schema(title = "降冷任务所属项目") val projectId: String, - @ApiModelProperty("降冷项目所属仓库") + @get:Schema(title = "降冷项目所属仓库") val repoName: String, - @ApiModelProperty("任务状态") + @get:Schema(title = "任务状态") val state: String, - @ApiModelProperty("任务内容") + @get:Schema(title = "任务内容") val content: SeparationContent, ) { companion object { diff --git a/src/backend/maven/api-maven/src/main/kotlin/com/tencent/bkrepo/maven/api/MavenMetadataClient.kt b/src/backend/maven/api-maven/src/main/kotlin/com/tencent/bkrepo/maven/api/MavenMetadataClient.kt index a3b1dbd210..187dd52b47 100644 --- a/src/backend/maven/api-maven/src/main/kotlin/com/tencent/bkrepo/maven/api/MavenMetadataClient.kt +++ b/src/backend/maven/api-maven/src/main/kotlin/com/tencent/bkrepo/maven/api/MavenMetadataClient.kt @@ -30,7 +30,7 @@ package com.tencent.bkrepo.maven.api import com.tencent.bkrepo.common.api.constant.MAVEN_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.maven.pojo.metadata.MavenMetadataRequest -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation import org.springframework.cloud.openfeign.FeignClient import org.springframework.web.bind.annotation.PostMapping import org.springframework.web.bind.annotation.RequestBody @@ -39,11 +39,11 @@ import org.springframework.web.bind.annotation.RequestMapping @FeignClient(MAVEN_SERVICE_NAME, contextId = "MavenMetadataClient") @RequestMapping("/service/metadata") interface MavenMetadataClient { - @ApiOperation("更新maven版本元数据") + @Operation(summary = "更新maven版本元数据") @PostMapping("/update") fun update(@RequestBody request: MavenMetadataRequest): Response - @ApiOperation("删除maven版本元数据") + @Operation(summary = "删除maven版本元数据") @PostMapping("/delete") fun delete(@RequestBody request: MavenMetadataRequest): Response } diff --git a/src/backend/maven/api-maven/src/main/kotlin/com/tencent/bkrepo/maven/api/MavenWebResource.kt b/src/backend/maven/api-maven/src/main/kotlin/com/tencent/bkrepo/maven/api/MavenWebResource.kt index 9bdb840615..33664eec8b 100644 --- a/src/backend/maven/api-maven/src/main/kotlin/com/tencent/bkrepo/maven/api/MavenWebResource.kt +++ b/src/backend/maven/api-maven/src/main/kotlin/com/tencent/bkrepo/maven/api/MavenWebResource.kt @@ -37,25 +37,25 @@ import com.tencent.bkrepo.common.artifact.api.ArtifactPathVariable import com.tencent.bkrepo.maven.artifact.MavenArtifactInfo import com.tencent.bkrepo.maven.artifact.MavenDeleteArtifactInfo import com.tencent.bkrepo.maven.pojo.response.MavenGAVCResponse -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam -@Api("Maven 产品接口") +@Tag(name = "Maven 产品接口") @RequestMapping("/ext") interface MavenWebResource { - @ApiOperation("maven jar 包删除接口") + @Operation(summary = "maven jar 包删除接口") @DeleteMapping(MavenArtifactInfo.MAVEN_EXT_PACKAGE_DELETE) fun deletePackage( @ArtifactPathVariable mavenArtifactInfo: MavenDeleteArtifactInfo, @RequestParam packageKey: String ): Response - @ApiOperation("maven jar 包版本删除接口") + @Operation(summary = "maven jar 包版本删除接口") @DeleteMapping(MavenArtifactInfo.MAVEN_EXT_VERSION_DELETE) fun deleteVersion( @ArtifactPathVariable mavenArtifactInfo: MavenDeleteArtifactInfo, @@ -63,7 +63,7 @@ interface MavenWebResource { @RequestParam version: String? ): Response - @ApiOperation("maven jar 版本详情接口") + @Operation(summary = "maven jar 版本详情接口") @GetMapping(MavenArtifactInfo.MAVEN_EXT_DETAIL) fun artifactDetail( @ArtifactPathVariable mavenArtifactInfo: MavenArtifactInfo, @@ -71,7 +71,7 @@ interface MavenWebResource { @RequestParam version: String? ): Response - @ApiOperation("maven gavc 搜索接口") + @Operation(summary = "maven gavc 搜索接口") @GetMapping("/search/gavc/{projectId}/{pageNumber}/{pageSize}") fun gavc( @PathVariable projectId: String, diff --git a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/api/AuthResource.kt b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/api/AuthResource.kt index 84f226deeb..e486f379a1 100644 --- a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/api/AuthResource.kt +++ b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/api/AuthResource.kt @@ -34,19 +34,19 @@ package com.tencent.bkrepo.npm.api import com.tencent.bkrepo.npm.artifact.NpmArtifactInfo.Companion.NPM_USER_LOGOUT_MAPPING_URI import com.tencent.bkrepo.npm.artifact.NpmArtifactInfo.Companion.NPM_WHOAMI_MAPPING_URI import com.tencent.bkrepo.npm.pojo.auth.NpmAuthResponse -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.RequestAttribute -@Api("npm用户认证接口定义") +@Tag(name = "npm用户认证接口定义") interface AuthResource { - @ApiOperation("user logout") + @Operation(summary = "user logout") @DeleteMapping(NPM_USER_LOGOUT_MAPPING_URI) fun logout(@RequestAttribute userId: String): NpmAuthResponse - @ApiOperation("npm whoami") + @Operation(summary = "npm whoami") @GetMapping(NPM_WHOAMI_MAPPING_URI) fun whoami(@RequestAttribute userId: String): Map } diff --git a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/api/ModuleDepsResource.kt b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/api/ModuleDepsResource.kt index e9f04f5fce..47ff302f7f 100644 --- a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/api/ModuleDepsResource.kt +++ b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/api/ModuleDepsResource.kt @@ -33,12 +33,12 @@ package com.tencent.bkrepo.npm.api import com.tencent.bkrepo.common.api.pojo.Page import com.tencent.bkrepo.common.api.pojo.Response +import com.tencent.bkrepo.npm.pojo.module.des.ModuleDepsInfo import com.tencent.bkrepo.npm.pojo.module.des.service.DepsCreateRequest import com.tencent.bkrepo.npm.pojo.module.des.service.DepsDeleteRequest -import com.tencent.bkrepo.npm.pojo.module.des.ModuleDepsInfo -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable @@ -47,69 +47,69 @@ import org.springframework.web.bind.annotation.RequestBody import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam -@Api("包依赖信息接口") +@Tag(name = "包依赖信息接口") @RequestMapping("/service/module/deps") interface ModuleDepsResource { - @ApiOperation("创建资源依赖关系") + @Operation(summary = "创建资源依赖关系") @PostMapping("/create") fun create( @RequestBody depsCreateRequest: DepsCreateRequest ): Response - @ApiOperation("批量创建资源依赖关系") + @Operation(summary = "批量创建资源依赖关系") @PostMapping("/batch/create") fun batchCreate( @RequestBody depsCreateRequest: List ): Response - @ApiOperation("删除单个资源的单个依赖关系") + @Operation(summary = "删除单个资源的单个依赖关系") @DeleteMapping("/delete") fun delete( @RequestBody depsDeleteRequest: DepsDeleteRequest ): Response - @ApiOperation("删除单个资源的所有资源依赖关系") + @Operation(summary = "删除单个资源的所有资源依赖关系") @DeleteMapping("/delete/all") fun deleteAllByName( @RequestBody depsDeleteRequest: DepsDeleteRequest ): Response - @ApiOperation("查询某个资源节点被依赖的单个资源名称") + @Operation(summary = "查询某个资源节点被依赖的单个资源名称") @GetMapping("/find/{projectId}/{repoName}") fun find( - @ApiParam(value = "所属项目", required = true) + @Parameter(name = "所属项目", required = true) @PathVariable projectId: String, - @ApiParam(value = "仓库名称", required = true) + @Parameter(name = "仓库名称", required = true) @PathVariable repoName: String, - @ApiParam(value = "资源名称", required = true) + @Parameter(name = "资源名称", required = true) @RequestParam name: String, - @ApiParam(value = "被依赖资源名称", required = true) + @Parameter(name = "被依赖资源名称", required = true) @RequestParam deps: String ): Response - @ApiOperation("列表查询某个资源节点被依赖的所有资源名称") + @Operation(summary = "列表查询某个资源节点被依赖的所有资源名称") @GetMapping("/list/{projectId}/{repoName}") fun list( - @ApiParam(value = "所属项目", required = true) + @Parameter(name = "所属项目", required = true) @PathVariable projectId: String, - @ApiParam(value = "仓库名称", required = true) + @Parameter(name = "仓库名称", required = true) @PathVariable repoName: String, - @ApiParam(value = "资源名称", required = true) + @Parameter(name = "资源名称", required = true) @RequestParam name: String ): Response> - @ApiOperation("分页查询某个资源节点被依赖的所有资源名称") + @Operation(summary = "分页查询某个资源节点被依赖的所有资源名称") @GetMapping("/page/{projectId}/{repoName}/{page}/{size}") fun page( - @ApiParam(value = "所属项目", required = true) + @Parameter(name = "所属项目", required = true) @PathVariable projectId: String, - @ApiParam(value = "仓库名称", required = true) + @Parameter(name = "仓库名称", required = true) @PathVariable repoName: String, - @ApiParam(value = "当前页", required = true, example = "0") + @Parameter(name = "当前页", required = true, example = "0") @PathVariable page: Int, - @ApiParam(value = "分页大小", required = true, example = "20") + @Parameter(name = "分页大小", required = true, example = "20") @PathVariable size: Int, - @ApiParam(value = "资源名称", required = true) + @Parameter(name = "资源名称", required = true) @RequestParam name: String ): Response> } diff --git a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/api/NpmFixToolResource.kt b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/api/NpmFixToolResource.kt index b3e56317c8..dae6c6612e 100644 --- a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/api/NpmFixToolResource.kt +++ b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/api/NpmFixToolResource.kt @@ -35,35 +35,35 @@ import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.common.artifact.api.ArtifactPathVariable import com.tencent.bkrepo.npm.artifact.NpmArtifactInfo import com.tencent.bkrepo.npm.pojo.fixtool.DateTimeFormatResponse -import com.tencent.bkrepo.npm.pojo.fixtool.PackageMetadataFixResponse import com.tencent.bkrepo.npm.pojo.fixtool.PackageManagerResponse -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import com.tencent.bkrepo.npm.pojo.fixtool.PackageMetadataFixResponse +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 import org.springframework.web.bind.annotation.PostMapping -@Api("npm修复工具") +@Tag(name = "npm修复工具") interface NpmFixToolResource { - @ApiOperation("修复时间格式工具") + @Operation(summary = "修复时间格式工具") @GetMapping("/{projectId}/{repoName}/fixDateFormat") fun fixDateFormat( @ArtifactPathVariable artifactInfo: NpmArtifactInfo, pkgName: String ): DateTimeFormatResponse - @ApiOperation("修复package管理功能") + @Operation(summary = "修复package管理功能") @GetMapping("/ext/package/populate") fun fixPackageManager(): List - @ApiOperation("修复历史数据dist对象中增加packageSize字段") + @Operation(summary = "修复历史数据dist对象中增加packageSize字段") @GetMapping("/{projectId}/{repoName}/fixPackageSizeField") fun fixPackageSizeField( @ArtifactPathVariable artifactInfo: NpmArtifactInfo ): PackageMetadataFixResponse - @ApiOperation("修复package.json文件内容与包版本列表不一致的问题") + @Operation(summary = "修复package.json文件内容与包版本列表不一致的问题") @PostMapping("/{projectId}/{repoName}/{name}/correction") fun inconsistentCorrectionData( artifactInfo: NpmArtifactInfo, diff --git a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/api/PackageDependentResource.kt b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/api/PackageDependentResource.kt index bdde151965..5d77f19591 100644 --- a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/api/PackageDependentResource.kt +++ b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/api/PackageDependentResource.kt @@ -34,17 +34,17 @@ package com.tencent.bkrepo.npm.api import com.tencent.bkrepo.common.artifact.api.ArtifactPathVariable import com.tencent.bkrepo.npm.artifact.NpmArtifactInfo import com.tencent.bkrepo.npm.pojo.migration.NpmPackageDependentMigrationResponse -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation import org.springframework.web.bind.annotation.GetMapping interface PackageDependentResource { - @ApiOperation("package dependent migration by url") + @Operation(summary = "package dependent migration by url") @GetMapping("/{projectId}/{repoName}/dependentMigrationByUrl") fun dependentMigrationByUrl( @ArtifactPathVariable artifactInfo: NpmArtifactInfo ): NpmPackageDependentMigrationResponse - @ApiOperation("package dependent migration by file") + @Operation(summary = "package dependent migration by file") @GetMapping("/{projectId}/{repoName}/dependentMigrationByFile") fun dependentMigrationByFile( @ArtifactPathVariable artifactInfo: NpmArtifactInfo diff --git a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/NpmDeleteResponse.kt b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/NpmDeleteResponse.kt index 007d443061..c2ff896023 100644 --- a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/NpmDeleteResponse.kt +++ b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/NpmDeleteResponse.kt @@ -31,15 +31,15 @@ package com.tencent.bkrepo.npm.pojo -import io.swagger.annotations.Api -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@Api("npm delete返回包装模型") + +@Schema(title = "npm delete返回包装模型") data class NpmDeleteResponse( - @ApiModelProperty("返回状态") + @get:Schema(title = "返回状态") val ok: Boolean, - @ApiModelProperty("包名称") + @get:Schema(title = "包名称") val id: String, - @ApiModelProperty("rev") + @get:Schema(title = "rev") val rev: String ) diff --git a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/NpmErrorResponse.kt b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/NpmErrorResponse.kt index 8529346b84..46a63a7845 100644 --- a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/NpmErrorResponse.kt +++ b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/NpmErrorResponse.kt @@ -31,14 +31,14 @@ package com.tencent.bkrepo.npm.pojo -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("npm error返回包装模型") + +@Schema(title = "npm error返回包装模型") data class NpmErrorResponse( - @ApiModelProperty("返回状态") + @get:Schema(title = "返回状态") val error: String, - @ApiModelProperty("错误信息") + @get:Schema(title = "错误信息") val reason: String ) { companion object { diff --git a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/NpmSearchResponse.kt b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/NpmSearchResponse.kt index 8d0b16954f..2ef4f48e3c 100644 --- a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/NpmSearchResponse.kt +++ b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/NpmSearchResponse.kt @@ -34,14 +34,15 @@ package com.tencent.bkrepo.npm.pojo import com.fasterxml.jackson.annotation.JsonAlias import com.fasterxml.jackson.annotation.JsonIgnoreProperties import com.fasterxml.jackson.databind.annotation.JsonSerialize -import io.swagger.annotations.Api -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema +import io.swagger.v3.oas.annotations.tags.Tag -@Api("npm search 返回格式封装") + +@Tag(name = "npm search 返回格式封装") @JsonSerialize @JsonIgnoreProperties(ignoreUnknown = true) data class NpmSearchResponse( - @ApiModelProperty("对应数据") + @get:Schema(title = "对应数据") var objects: List = emptyList() ) diff --git a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/NpmSuccessResponse.kt b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/NpmSuccessResponse.kt index 365d2f8705..c81fcd9d51 100644 --- a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/NpmSuccessResponse.kt +++ b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/NpmSuccessResponse.kt @@ -31,9 +31,9 @@ package com.tencent.bkrepo.npm.pojo -import io.swagger.annotations.Api +import io.swagger.v3.oas.annotations.media.Schema -@Api("npm success返回包装模型") +@Schema(name = "npm success返回包装模型") data class NpmSuccessResponse( val ok: String ) { diff --git a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/auth/NpmAuthFailResponse.kt b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/auth/NpmAuthFailResponse.kt index d04eedcdfa..7fd73777a5 100644 --- a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/auth/NpmAuthFailResponse.kt +++ b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/auth/NpmAuthFailResponse.kt @@ -31,12 +31,12 @@ package com.tencent.bkrepo.npm.pojo.auth -import io.swagger.annotations.Api -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@Api("npm auth 返回包装模型") + +@Schema(title = "npm auth 返回包装模型") data class NpmAuthFailResponse( - @ApiModelProperty("错误信息") + @get:Schema(title = "错误信息") val errors: List ) diff --git a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/auth/NpmAuthResponse.kt b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/auth/NpmAuthResponse.kt index 1a4d459e2f..b82508c5ba 100644 --- a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/auth/NpmAuthResponse.kt +++ b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/auth/NpmAuthResponse.kt @@ -32,16 +32,16 @@ package com.tencent.bkrepo.npm.pojo.auth import com.fasterxml.jackson.annotation.JsonInclude -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("npm auth返回包装模型") + +@Schema(title = "npm auth返回包装模型") data class NpmAuthResponse( - @ApiModelProperty("返回状态") + @get:Schema(title = "返回状态") val ok: Boolean, - @ApiModelProperty("用户ID") + @get:Schema(title = "用户ID") val id: String? = null, - @ApiModelProperty("数据") + @get:Schema(title = "数据") @JsonInclude(JsonInclude.Include.NON_NULL) val token: T? = null ) { diff --git a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/metadata/MetadataSearchRequest.kt b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/metadata/MetadataSearchRequest.kt index d84cd80274..5b25353921 100644 --- a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/metadata/MetadataSearchRequest.kt +++ b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/metadata/MetadataSearchRequest.kt @@ -31,21 +31,21 @@ package com.tencent.bkrepo.npm.pojo.metadata -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("npm search 查询条件") + +@Schema(title = "npm search 查询条件") data class MetadataSearchRequest( - @ApiModelProperty("查询内容", required = true) + @get:Schema(title = "查询内容", required = true) val text: String, - @ApiModelProperty("查询包的个数", required = false) + @get:Schema(title = "查询包的个数", required = false) val size: Int = 10, - @ApiModelProperty("起始页", required = false) + @get:Schema(title = "起始页", required = false) val from: Int = 0, - @ApiModelProperty("质量") + @get:Schema(title = "质量") val quality: Double = 0.0, - @ApiModelProperty("受欢迎程度") + @get:Schema(title = "受欢迎程度") val popularity: Double = 0.0, - @ApiModelProperty("贡献度") + @get:Schema(title = "贡献度") val maintenance: Double = 0.0 ) diff --git a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/migration/MigrationErrorDataInfo.kt b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/migration/MigrationErrorDataInfo.kt index 67fc95c574..0e4df9aaf9 100644 --- a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/migration/MigrationErrorDataInfo.kt +++ b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/migration/MigrationErrorDataInfo.kt @@ -31,21 +31,21 @@ package com.tencent.bkrepo.npm.pojo.migration -import io.swagger.annotations.Api -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@Api("迁移错误数据信息") + +@Schema(title = "迁移错误数据信息") data class MigrationErrorDataInfo( - @ApiModelProperty("创建者") + @get:Schema(title = "创建者") val createdBy: String, - @ApiModelProperty("创建时间") + @get:Schema(title = "创建时间") val createdDate: String, - @ApiModelProperty("迁移次数计数器") + @get:Schema(title = "迁移次数计数器") val counter: Int, - @ApiModelProperty("错误数据") + @get:Schema(title = "错误数据") val errorData: MutableSet, - @ApiModelProperty("所属项目id") + @get:Schema(title = "所属项目id") val projectId: String, - @ApiModelProperty("所属仓库名称") + @get:Schema(title = "所属仓库名称") val repoName: String ) diff --git a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/migration/NpmDataMigrationResponse.kt b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/migration/NpmDataMigrationResponse.kt index 8a17828c8f..b6e687efe6 100644 --- a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/migration/NpmDataMigrationResponse.kt +++ b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/migration/NpmDataMigrationResponse.kt @@ -31,19 +31,20 @@ package com.tencent.bkrepo.npm.pojo.migration -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + data class NpmDataMigrationResponse( - @ApiModelProperty("描述") + @get:Schema(title = "描述") val description: String, - @ApiModelProperty("总的包数量") + @get:Schema(title = "总的包数量") val totalCount: Int = 0, - @ApiModelProperty("迁移成功数量") + @get:Schema(title = "迁移成功数量") val successCount: Int = 0, - @ApiModelProperty("迁移失败数量") + @get:Schema(title = "迁移失败数量") val failCount: Int = 0, - @ApiModelProperty("耗时 单位s") + @get:Schema(title = "耗时 单位s") val elapseTimeSeconds: Long = 0L, - @ApiModelProperty("迁移失败数据") + @get:Schema(title = "迁移失败数据") val failSet: Set = emptySet() ) diff --git a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/migration/NpmPackageDependentMigrationResponse.kt b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/migration/NpmPackageDependentMigrationResponse.kt index aedc12b4cb..55286c43c8 100644 --- a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/migration/NpmPackageDependentMigrationResponse.kt +++ b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/migration/NpmPackageDependentMigrationResponse.kt @@ -31,19 +31,20 @@ package com.tencent.bkrepo.npm.pojo.migration -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + data class NpmPackageDependentMigrationResponse( - @ApiModelProperty("描述") + @get:Schema(title = "描述") val description: String, - @ApiModelProperty("总的包数量") + @get:Schema(title = "总的包数量") val totalCount: Int = 0, - @ApiModelProperty("迁移成功数量") + @get:Schema(title = "迁移成功数量") val successCount: Int = 0, - @ApiModelProperty("迁移失败数量") + @get:Schema(title = "迁移失败数量") val failCount: Int = 0, - @ApiModelProperty("耗时 单位s") + @get:Schema(title = "耗时 单位s") val elapseTimeSeconds: Long = 0L, - @ApiModelProperty("迁移失败数据") + @get:Schema(title = "迁移失败数据") val failSet: Set = emptySet() ) diff --git a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/migration/service/MigrationErrorDataCreateRequest.kt b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/migration/service/MigrationErrorDataCreateRequest.kt index e89d0ad825..9e3424c02f 100644 --- a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/migration/service/MigrationErrorDataCreateRequest.kt +++ b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/migration/service/MigrationErrorDataCreateRequest.kt @@ -31,19 +31,19 @@ package com.tencent.bkrepo.npm.pojo.migration.service -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("创建错误数据请求") + +@Schema(title = "创建错误数据请求") data class MigrationErrorDataCreateRequest( - @ApiModelProperty("所属项目", required = true) + @get:Schema(title = "所属项目", required = true) val projectId: String, - @ApiModelProperty("仓库名称", required = true) + @get:Schema(title = "仓库名称", required = true) val repoName: String, - @ApiModelProperty("计数器", required = true) + @get:Schema(title = "计数器", required = true) val counter: Int, - @ApiModelProperty("错误数据集合", required = true) + @get:Schema(title = "错误数据集合", required = true) val errorData: String, - @ApiModelProperty("操作用户", required = false) + @get:Schema(title = "操作用户", required = false) val operator: String = "system" ) diff --git a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/module/des/ModuleDepsInfo.kt b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/module/des/ModuleDepsInfo.kt index 0da44ed26c..5bbe3e7006 100644 --- a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/module/des/ModuleDepsInfo.kt +++ b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/module/des/ModuleDepsInfo.kt @@ -31,21 +31,21 @@ package com.tencent.bkrepo.npm.pojo.module.des -import io.swagger.annotations.Api -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@Api("节点依赖信息") + +@Schema(title = "节点依赖信息") data class ModuleDepsInfo( - @ApiModelProperty("创建者") + @get:Schema(title = "创建者") val createdBy: String, - @ApiModelProperty("创建时间") + @get:Schema(title = "创建时间") val createdDate: String, - @ApiModelProperty("资源名称") + @get:Schema(title = "资源名称") val name: String, - @ApiModelProperty("被依赖的资源名称") + @get:Schema(title = "被依赖的资源名称") val deps: String, - @ApiModelProperty("所属项目id") + @get:Schema(title = "所属项目id") val projectId: String, - @ApiModelProperty("所属仓库名称") + @get:Schema(title = "所属仓库名称") val repoName: String ) diff --git a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/module/des/service/DepsCreateRequest.kt b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/module/des/service/DepsCreateRequest.kt index f07c521699..c202fb421b 100644 --- a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/module/des/service/DepsCreateRequest.kt +++ b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/module/des/service/DepsCreateRequest.kt @@ -31,21 +31,21 @@ package com.tencent.bkrepo.npm.pojo.module.des.service -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("创建依赖关系请求") + +@Schema(title = "创建依赖关系请求") data class DepsCreateRequest( - @ApiModelProperty("所属项目", required = true) + @get:Schema(title = "所属项目", required = true) val projectId: String, - @ApiModelProperty("仓库名称", required = true) + @get:Schema(title = "仓库名称", required = true) val repoName: String, - @ApiModelProperty("资源名称", required = true) + @get:Schema(title = "资源名称", required = true) val name: String, - @ApiModelProperty("被依赖资源名称", required = true) + @get:Schema(title = "被依赖资源名称", required = true) val deps: String, - @ApiModelProperty("操作用户", required = false) + @get:Schema(title = "操作用户", required = false) val operator: String = "system", - @ApiModelProperty("是否覆盖", required = false) + @get:Schema(title = "是否覆盖", required = false) val overwrite: Boolean = false ) diff --git a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/module/des/service/DepsDeleteRequest.kt b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/module/des/service/DepsDeleteRequest.kt index 9e9088f2d1..e746c94ece 100644 --- a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/module/des/service/DepsDeleteRequest.kt +++ b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/module/des/service/DepsDeleteRequest.kt @@ -31,19 +31,19 @@ package com.tencent.bkrepo.npm.pojo.module.des.service -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("删除依赖关系请求") + +@Schema(title = "删除依赖关系请求") data class DepsDeleteRequest( - @ApiModelProperty("所属项目", required = true) + @get:Schema(title = "所属项目", required = true) val projectId: String, - @ApiModelProperty("仓库名称", required = true) + @get:Schema(title = "仓库名称", required = true) val repoName: String, - @ApiModelProperty("资源名称", required = true) + @get:Schema(title = "资源名称", required = true) val name: String? = null, - @ApiModelProperty("被依赖资源名称", required = true) + @get:Schema(title = "被依赖资源名称", required = true) val deps: String, - @ApiModelProperty("操作用户", required = true) + @get:Schema(title = "操作用户", required = true) val operator: String ) diff --git a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/user/NpmPackageInfo.kt b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/user/NpmPackageInfo.kt index d7aa0d4d10..24354e8bfc 100644 --- a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/user/NpmPackageInfo.kt +++ b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/user/NpmPackageInfo.kt @@ -31,13 +31,13 @@ package com.tencent.bkrepo.npm.pojo.user -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("包的基本信息") + +@Schema(title = "包的基本信息") data class NpmPackageInfo( - @ApiModelProperty("包名称") + @get:Schema(title = "包名称") val name: String, - @ApiModelProperty("最新版本信息") + @get:Schema(title = "最新版本信息") val latest: NpmPackageLatestVersionInfo ) diff --git a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/user/NpmPackageLatestVersionInfo.kt b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/user/NpmPackageLatestVersionInfo.kt index 9293164d2a..be832a5f54 100644 --- a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/user/NpmPackageLatestVersionInfo.kt +++ b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/user/NpmPackageLatestVersionInfo.kt @@ -31,35 +31,35 @@ package com.tencent.bkrepo.npm.pojo.user -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("包的最新版本的信息") + +@Schema(title = "包的最新版本的信息") data class NpmPackageLatestVersionInfo( - @ApiModelProperty("创建者") + @get:Schema(title = "创建者") val createdBy: String, - @ApiModelProperty("创建时间") + @get:Schema(title = "创建时间") val createdDate: String, - @ApiModelProperty("修改者") + @get:Schema(title = "修改者") val lastModifiedBy: String, - @ApiModelProperty("修改时间") + @get:Schema(title = "修改时间") val lastModifiedDate: String, - @ApiModelProperty("资源名称") + @get:Schema(title = "资源名称") val name: String, - @ApiModelProperty("文件大小，单位byte") + @get:Schema(title = "文件大小，单位byte") val size: Long, - @ApiModelProperty("最新版本") + @get:Schema(title = "最新版本") val version: String? = null, - // @ApiModelProperty("文件sha256") + // @get:Schema(title = "文件sha256") // val sha256: String? = null, - // @ApiModelProperty("文件md5") + // @get:Schema(title = "文件md5") // val md5: String? = null, - @ApiModelProperty("制品晋级阶段") + @get:Schema(title = "制品晋级阶段") val stageTag: String? = null, - // @ApiModelProperty("元数据") + // @get:Schema(title = "元数据") // val metadata: Map ? = null, - @ApiModelProperty("所属项目id") + @get:Schema(title = "所属项目id") val projectId: String, - @ApiModelProperty("所属仓库名称") + @get:Schema(title = "所属仓库名称") val repoName: String ) diff --git a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/user/NpmPackageVersionInfo.kt b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/user/NpmPackageVersionInfo.kt index 48df0b0546..d09a64fae4 100644 --- a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/user/NpmPackageVersionInfo.kt +++ b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/user/NpmPackageVersionInfo.kt @@ -31,25 +31,25 @@ package com.tencent.bkrepo.npm.pojo.user -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("包的版本信息") + +@Schema(title = "包的版本信息") data class NpmPackageVersionInfo( - @ApiModelProperty("资源名称") + @get:Schema(title = "资源名称") val name: String, - @ApiModelProperty("文件大小，单位byte") + @get:Schema(title = "文件大小，单位byte") val size: Long, - @ApiModelProperty("当前版本") + @get:Schema(title = "当前版本") val version: String, - @ApiModelProperty("制品晋级阶段") + @get:Schema(title = "制品晋级阶段") val stageTag: String? = null, - @ApiModelProperty("修改者") + @get:Schema(title = "修改者") val lastModifiedBy: String, - @ApiModelProperty("修改时间") + @get:Schema(title = "修改时间") val lastModifiedDate: String, - @ApiModelProperty("所属项目id") + @get:Schema(title = "所属项目id") val projectId: String, - @ApiModelProperty("所属仓库名称") + @get:Schema(title = "所属仓库名称") val repoName: String ) diff --git a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/user/PackageInfo.kt b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/user/PackageInfo.kt index 73eddbb57d..fbe9fee288 100644 --- a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/user/PackageInfo.kt +++ b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/user/PackageInfo.kt @@ -33,60 +33,60 @@ package com.tencent.bkrepo.npm.pojo.user import com.fasterxml.jackson.annotation.JsonInclude import com.tencent.bkrepo.npm.pojo.module.des.ModuleDepsInfo -import io.swagger.annotations.Api -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@Api("npm页面返回包装模型") + +@Schema(title = "npm页面返回包装模型") data class PackageInfo( - @ApiModelProperty("包名称") + @get:Schema(title = "包名称") val name: String, - @ApiModelProperty("包描述信息") + @get:Schema(title = "包描述信息") val description: String, - @ApiModelProperty("包的readme信息") + @get:Schema(title = "包的readme信息") val readme: String, - @ApiModelProperty("包的tag信息") + @get:Schema(title = "包的tag信息") val currentTags: List, - @ApiModelProperty("包的版本信息") + @get:Schema(title = "包的版本信息") val versions: List, - @ApiModelProperty("包的主要贡献者信息") + @get:Schema(title = "包的主要贡献者信息") val maintainers: List, - @ApiModelProperty("包的下载量信息") + @get:Schema(title = "包的下载量信息") val downloadCount: List, - @ApiModelProperty("包的依赖信息") + @get:Schema(title = "包的依赖信息") val dependencies: List, - @ApiModelProperty("包的开发依赖信息") + @get:Schema(title = "包的开发依赖信息") val devDependencies: List, - @ApiModelProperty("包的被依赖信息") + @get:Schema(title = "包的被依赖信息") val dependents: List ) data class TagsInfo( - @ApiModelProperty("tag") + @get:Schema(title = "tag") @JsonInclude(JsonInclude.Include.NON_NULL) val tags: String? = null, - @ApiModelProperty("版本") + @get:Schema(title = "版本") val version: String, - @ApiModelProperty("时间") + @get:Schema(title = "时间") val time: String ) data class MaintainerInfo( - @ApiModelProperty("贡献者名称") + @get:Schema(title = "贡献者名称") val name: String, - @ApiModelProperty("邮箱") + @get:Schema(title = "邮箱") val email: String ) data class DependenciesInfo( - @ApiModelProperty("包的名称") + @get:Schema(title = "包的名称") val name: String, - @ApiModelProperty("版本") + @get:Schema(title = "版本") val version: String ) data class DownloadCount( - @ApiModelProperty("时间段") + @get:Schema(title = "时间段") val description: String, - @ApiModelProperty("下载量") + @get:Schema(title = "下载量") val count: Long ) diff --git a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/user/PackageVersionInfo.kt b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/user/PackageVersionInfo.kt index 89d8b95960..e59ffde7bc 100644 --- a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/user/PackageVersionInfo.kt +++ b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/user/PackageVersionInfo.kt @@ -32,55 +32,56 @@ package com.tencent.bkrepo.npm.pojo.user import com.tencent.bkrepo.repository.pojo.metadata.MetadataModel -import io.swagger.annotations.Api -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema +import io.swagger.v3.oas.annotations.tags.Tag -@Api("npm版本详情页返回包装模型") + +@Schema(title = "npm版本详情页返回包装模型") data class PackageVersionInfo( - @ApiModelProperty("基础信息") + @get:Schema(title = "基础信息") val basic: BasicInfo, - @ApiModelProperty("元数据信息") + @get:Schema(title = "元数据信息") val metadata: List, - @ApiModelProperty("依赖信息") + @get:Schema(title = "依赖信息") val dependencyInfo: VersionDependenciesInfo ) -@Api("基础信息") +@Tag(name = "基础信息") data class BasicInfo( - @ApiModelProperty("版本字段") + @get:Schema(title = "版本字段") val version: String, - @ApiModelProperty("完整路径") + @get:Schema(title = "完整路径") val fullPath: String, - @ApiModelProperty("文件大小，单位byte") + @get:Schema(title = "文件大小，单位byte") val size: Long, - @ApiModelProperty("文件sha256") + @get:Schema(title = "文件sha256") val sha256: String, - @ApiModelProperty("文件md5") + @get:Schema(title = "文件md5") val md5: String, - @ApiModelProperty("晋级状态标签") + @get:Schema(title = "晋级状态标签") val stageTag: List, - @ApiModelProperty("所属项目id") + @get:Schema(title = "所属项目id") val projectId: String, - @ApiModelProperty("所属仓库名称") + @get:Schema(title = "所属仓库名称") val repoName: String, - @ApiModelProperty("下载次数") + @get:Schema(title = "下载次数") val downloadCount: Long, - @ApiModelProperty("创建者") + @get:Schema(title = "创建者") val createdBy: String, - @ApiModelProperty("创建时间") + @get:Schema(title = "创建时间") val createdDate: String, - @ApiModelProperty("修改者") + @get:Schema(title = "修改者") val lastModifiedBy: String, - @ApiModelProperty("修改时间") + @get:Schema(title = "修改时间") val lastModifiedDate: String ) -@Api("版本的依赖信息") +@Tag(name = "版本的依赖信息") data class VersionDependenciesInfo( - @ApiModelProperty("包的依赖信息") + @get:Schema(title = "包的依赖信息") val dependencies: List, - @ApiModelProperty("包的开发依赖信息") + @get:Schema(title = "包的开发依赖信息") val devDependencies: List, - @ApiModelProperty("包的被依赖信息") + @get:Schema(title = "包的被依赖信息") val dependents: Set ) diff --git a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/user/request/PackageDeleteRequest.kt b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/user/request/PackageDeleteRequest.kt index 3b7c591191..2ea69de602 100644 --- a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/user/request/PackageDeleteRequest.kt +++ b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/user/request/PackageDeleteRequest.kt @@ -31,17 +31,17 @@ package com.tencent.bkrepo.npm.pojo.user.request -import io.swagger.annotations.ApiModelProperty -import io.swagger.annotations.ApiOperation -@ApiOperation("删除包请求") +import io.swagger.v3.oas.annotations.media.Schema + +@Schema(title = "删除包请求") data class PackageDeleteRequest( - @ApiModelProperty("所属项目", required = true) + @get:Schema(title = "所属项目", required = true) val projectId: String, - @ApiModelProperty("仓库名称", required = true) + @get:Schema(title = "仓库名称", required = true) val repoName: String, - @ApiModelProperty("包名称", required = true) + @get:Schema(title = "包名称", required = true) val name: String, - @ApiModelProperty("操作用户", required = true) + @get:Schema(title = "操作用户", required = true) val operator: String ) diff --git a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/user/request/PackageVersionDeleteRequest.kt b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/user/request/PackageVersionDeleteRequest.kt index 590114effa..f1dc0f9efd 100644 --- a/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/user/request/PackageVersionDeleteRequest.kt +++ b/src/backend/npm/api-npm/src/main/kotlin/com/tencent/bkrepo/npm/pojo/user/request/PackageVersionDeleteRequest.kt @@ -31,19 +31,19 @@ package com.tencent.bkrepo.npm.pojo.user.request -import io.swagger.annotations.ApiModelProperty -import io.swagger.annotations.ApiOperation -@ApiOperation("删除包版本请求") +import io.swagger.v3.oas.annotations.media.Schema + +@Schema(title = "删除包版本请求") data class PackageVersionDeleteRequest( - @ApiModelProperty("所属项目", required = true) + @get:Schema(title = "所属项目", required = true) val projectId: String, - @ApiModelProperty("仓库名称", required = true) + @get:Schema(title = "仓库名称", required = true) val repoName: String, - @ApiModelProperty("包名称", required = true) + @get:Schema(title = "包名称", required = true) val name: String, - @ApiModelProperty("包的版本", required = true) + @get:Schema(title = "包的版本", required = true) val version: String, - @ApiModelProperty("操作用户", required = true) + @get:Schema(title = "操作用户", required = true) val operator: String ) diff --git a/src/backend/npm/biz-npm/src/main/kotlin/com/tencent/bkrepo/npm/controller/UserModuleDependentsController.kt b/src/backend/npm/biz-npm/src/main/kotlin/com/tencent/bkrepo/npm/controller/UserModuleDependentsController.kt index 04ba05f2de..3b9c672d4b 100644 --- a/src/backend/npm/biz-npm/src/main/kotlin/com/tencent/bkrepo/npm/controller/UserModuleDependentsController.kt +++ b/src/backend/npm/biz-npm/src/main/kotlin/com/tencent/bkrepo/npm/controller/UserModuleDependentsController.kt @@ -39,33 +39,33 @@ import com.tencent.bkrepo.common.service.util.ResponseBuilder import com.tencent.bkrepo.npm.pojo.module.des.ModuleDepsInfo import com.tencent.bkrepo.npm.service.ModuleDepsService import com.tencent.bkrepo.npm.utils.NpmUtils -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam import org.springframework.web.bind.annotation.RestController -@Api("npm 依赖查询接口") +@Tag(name = "npm 依赖查询接口") @RequestMapping("/ext") @RestController class UserModuleDependentsController( private val moduleDepsService: ModuleDepsService ) { - @ApiOperation("分页查询某个资源节点被依赖的所有资源名称") + @Operation(summary = "分页查询某个资源节点被依赖的所有资源名称") @GetMapping("/dependent/page/{projectId}/{repoName}") fun page( - @ApiParam(value = "所属项目", required = true) + @Parameter(name = "所属项目", required = true) @PathVariable projectId: String, - @ApiParam(value = "仓库名称", required = true) + @Parameter(name = "仓库名称", required = true) @PathVariable repoName: String, - @ApiParam(value = "当前页", required = true, example = "1") + @Parameter(name = "当前页", required = true, example = "1") @RequestParam pageNumber: Int = DEFAULT_PAGE_NUMBER, - @ApiParam(value = "分页大小", required = true, example = "20") + @Parameter(name = "分页大小", required = true, example = "20") @RequestParam pageSize: Int = DEFAULT_PAGE_SIZE, - @ApiParam(value = "资源名称", required = true) + @Parameter(name = "资源名称", required = true) @RequestParam packageKey: String ): Response> { val name = NpmUtils.resolveNameByRepoType(packageKey) diff --git a/src/backend/npm/biz-npm/src/main/kotlin/com/tencent/bkrepo/npm/controller/UserNpmController.kt b/src/backend/npm/biz-npm/src/main/kotlin/com/tencent/bkrepo/npm/controller/UserNpmController.kt index 889753f506..0e121d7551 100644 --- a/src/backend/npm/biz-npm/src/main/kotlin/com/tencent/bkrepo/npm/controller/UserNpmController.kt +++ b/src/backend/npm/biz-npm/src/main/kotlin/com/tencent/bkrepo/npm/controller/UserNpmController.kt @@ -51,9 +51,9 @@ import com.tencent.bkrepo.npm.pojo.user.request.PackageDeleteRequest import com.tencent.bkrepo.npm.pojo.user.request.PackageVersionDeleteRequest import com.tencent.bkrepo.npm.service.NpmWebService import com.tencent.bkrepo.npm.utils.NpmUtils -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.RequestAttribute @@ -61,7 +61,7 @@ import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam import org.springframework.web.bind.annotation.RestController -@Api("npm 用户接口") +@Tag(name = "npm 用户接口") @RequestMapping("/ext") @Suppress("MVCPathVariableInspection") @RestController @@ -71,15 +71,15 @@ class UserNpmController( @Permission(ResourceType.REPO, PermissionAction.READ) - @ApiOperation("查询包的版本详情") + @Operation(summary = "查询包的版本详情") @GetMapping("/version/detail/{projectId}/{repoName}") fun detailVersion( @RequestAttribute userId: String, @ArtifactPathVariable artifactInfo: NpmArtifactInfo, - @ApiParam(value = "包唯一Key", required = true) + @Parameter(name = "包唯一Key", required = true) @RequestParam packageKey: String, - @ApiParam(value = "包版本", required = true) + @Parameter(name = "包版本", required = true) @RequestParam version: String ): Response { return ResponseBuilder.success(npmWebService.detailVersion(artifactInfo, packageKey, version)) @@ -103,13 +103,13 @@ class UserNpmController( content = ActionAuditContent.REPO_PACKAGE_DELETE_CONTENT ) @Permission(ResourceType.REPO, PermissionAction.DELETE) - @ApiOperation("删除仓库下的包") + @Operation(summary = "删除仓库下的包") @DeleteMapping("/package/delete/{projectId}/{repoName}") fun deletePackage( @RequestAttribute userId: String, @ArtifactPathVariable artifactInfo: NpmArtifactInfo, - @ApiParam(value = "包名称", required = true) + @Parameter(name = "包名称", required = true) @RequestParam packageKey: String ): Response { with(artifactInfo) { @@ -142,15 +142,15 @@ class UserNpmController( content = ActionAuditContent.REPO_PACKAGE_VERSION_DELETE_CONTENT ) @Permission(ResourceType.REPO, PermissionAction.DELETE) - @ApiOperation("删除仓库下的包版本") + @Operation(summary = "删除仓库下的包版本") @DeleteMapping("/version/delete/{projectId}/{repoName}") fun deleteVersion( @RequestAttribute userId: String, @ArtifactPathVariable artifactInfo: NpmArtifactInfo, - @ApiParam(value = "包名称", required = true) + @Parameter(name = "包名称", required = true) @RequestParam packageKey: String, - @ApiParam(value = "包版本", required = true) + @Parameter(name = "包版本", required = true) @RequestParam version: String ): Response { with(artifactInfo) { @@ -163,7 +163,7 @@ class UserNpmController( } } - @ApiOperation("获取npm域名地址") + @Operation(summary = "获取npm域名地址") @GetMapping("/address") fun getRegistryDomain(): Response { return ResponseBuilder.success(npmWebService.getRegistryDomain()) diff --git a/src/backend/npm/biz-npm/src/main/kotlin/com/tencent/bkrepo/npm/controller/UserPackageMigrationController.kt b/src/backend/npm/biz-npm/src/main/kotlin/com/tencent/bkrepo/npm/controller/UserPackageMigrationController.kt index fa3c6606d6..80848e780f 100644 --- a/src/backend/npm/biz-npm/src/main/kotlin/com/tencent/bkrepo/npm/controller/UserPackageMigrationController.kt +++ b/src/backend/npm/biz-npm/src/main/kotlin/com/tencent/bkrepo/npm/controller/UserPackageMigrationController.kt @@ -35,21 +35,21 @@ import com.tencent.bkrepo.common.artifact.api.ArtifactPathVariable import com.tencent.bkrepo.common.artifact.repository.migration.MigrateDetail import com.tencent.bkrepo.npm.artifact.NpmArtifactInfo import com.tencent.bkrepo.npm.service.DataMigrationService -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +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.RequestMapping import org.springframework.web.bind.annotation.RequestParam import org.springframework.web.bind.annotation.RestController -@Api("npm 用户接口") +@Tag(name = "npm 用户接口") @RequestMapping("/ext") @RestController class UserPackageMigrationController( private val dataMigrationService: DataMigrationService ) { - @ApiOperation("data migration by file") + @Operation(summary = "data migration by file") @GetMapping("/{projectId}/{repoName}/dataMigrationByFile") fun dataMigrationByFile( @ArtifactPathVariable artifactInfo: NpmArtifactInfo, @@ -58,7 +58,7 @@ class UserPackageMigrationController( return dataMigrationService.dataMigrationByFile(artifactInfo, useErrorData) } - @ApiOperation("data migration by url") + @Operation(summary = "data migration by url") @GetMapping("/{projectId}/{repoName}/dataMigrationByUrl") fun dataMigrationByUrl( @ArtifactPathVariable artifactInfo: NpmArtifactInfo, @@ -67,7 +67,7 @@ class UserPackageMigrationController( return dataMigrationService.dataMigrationByUrl(artifactInfo, useErrorData) } - @ApiOperation("data migration by PkgName") + @Operation(summary = "data migration by PkgName") @GetMapping("/{projectId}/{repoName}/dataMigrationByPkgName") fun dataMigrationByPkgName( @ArtifactPathVariable artifactInfo: NpmArtifactInfo, diff --git a/src/backend/nuget/biz-nuget/src/main/kotlin/com/tencent/bkrepo/nuget/controller/NugetWebController.kt b/src/backend/nuget/biz-nuget/src/main/kotlin/com/tencent/bkrepo/nuget/controller/NugetWebController.kt index 859ff34d4e..8bda05bbfc 100644 --- a/src/backend/nuget/biz-nuget/src/main/kotlin/com/tencent/bkrepo/nuget/controller/NugetWebController.kt +++ b/src/backend/nuget/biz-nuget/src/main/kotlin/com/tencent/bkrepo/nuget/controller/NugetWebController.kt @@ -21,9 +21,9 @@ import com.tencent.bkrepo.nuget.pojo.artifact.NugetDeleteArtifactInfo import com.tencent.bkrepo.nuget.pojo.domain.NugetDomainInfo import com.tencent.bkrepo.nuget.pojo.user.PackageVersionInfo import com.tencent.bkrepo.nuget.service.NugetWebService -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.RequestAttribute @@ -31,7 +31,7 @@ import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam import org.springframework.web.bind.annotation.RestController -@Api("NUGET web页面操作接口") +@Tag(name = "NUGET web页面操作接口") @RestController @RequestMapping("/ext") class NugetWebController( @@ -56,12 +56,12 @@ class NugetWebController( content = ActionAuditContent.REPO_PACKAGE_DELETE_CONTENT ) @Permission(ResourceType.REPO, PermissionAction.DELETE) - @ApiOperation("删除仓库下的包") + @Operation(summary = "删除仓库下的包") @DeleteMapping(NUGET_EXT_DELETE_PACKAGE) fun deletePackage( @RequestAttribute userId: String, artifactInfo: NugetDeleteArtifactInfo, - @ApiParam(value = "包名称", required = true) + @Parameter(name = "包名称", required = true) @RequestParam packageKey: String ): Response { nugetWebService.deletePackage(userId, artifactInfo) @@ -88,14 +88,14 @@ class NugetWebController( content = ActionAuditContent.REPO_PACKAGE_VERSION_DELETE_CONTENT ) @Permission(ResourceType.REPO, PermissionAction.DELETE) - @ApiOperation("删除仓库下的包版本") + @Operation(summary = "删除仓库下的包版本") @DeleteMapping(NUGET_EXT_DELETE_VERSION) fun deleteVersion( @RequestAttribute userId: String, artifactInfo: NugetDeleteArtifactInfo, - @ApiParam(value = "包名称", required = true) + @Parameter(name = "包名称", required = true) @RequestParam packageKey: String, - @ApiParam(value = "包版本", required = true) + @Parameter(name = "包版本", required = true) @RequestParam version: String ): Response { nugetWebService.deleteVersion(userId, artifactInfo) @@ -103,21 +103,21 @@ class NugetWebController( } @Permission(ResourceType.REPO, PermissionAction.READ) - @ApiOperation("查询包的版本详情") + @Operation(summary = "查询包的版本详情") @GetMapping(NUGET_EXT_VERSION_DETAIL) fun detailVersion( @RequestAttribute userId: String, artifactInfo: NugetArtifactInfo, - @ApiParam(value = "包唯一Key", required = true) + @Parameter(name = "包唯一Key", required = true) @RequestParam packageKey: String, - @ApiParam(value = "包版本", required = true) + @Parameter(name = "包版本", required = true) @RequestParam version: String ): Response { return ResponseBuilder.success(nugetWebService.detailVersion(artifactInfo, packageKey, version)) } - @ApiOperation("获取nuget域名地址") + @Operation(summary = "获取nuget域名地址") @GetMapping(NUGET_EXT_DOMAIN) fun getRegistryDomain(): Response { return ResponseBuilder.success(nugetWebService.getRegistryDomain()) diff --git a/src/backend/nuget/biz-nuget/src/main/kotlin/com/tencent/bkrepo/nuget/pojo/request/PackageDeleteRequest.kt b/src/backend/nuget/biz-nuget/src/main/kotlin/com/tencent/bkrepo/nuget/pojo/request/PackageDeleteRequest.kt index cd3f5db496..624232e6a1 100644 --- a/src/backend/nuget/biz-nuget/src/main/kotlin/com/tencent/bkrepo/nuget/pojo/request/PackageDeleteRequest.kt +++ b/src/backend/nuget/biz-nuget/src/main/kotlin/com/tencent/bkrepo/nuget/pojo/request/PackageDeleteRequest.kt @@ -1,16 +1,16 @@ package com.tencent.bkrepo.nuget.pojo.request -import io.swagger.annotations.ApiModelProperty -import io.swagger.annotations.ApiOperation -@ApiOperation("删除包请求") +import io.swagger.v3.oas.annotations.media.Schema + +@Schema(title = "删除包请求") data class PackageDeleteRequest( - @ApiModelProperty("所属项目", required = true) + @get:Schema(title = "所属项目", required = true) val projectId: String, - @ApiModelProperty("仓库名称", required = true) + @get:Schema(title = "仓库名称", required = true) val repoName: String, - @ApiModelProperty("包名称", required = true) + @get:Schema(title = "包名称", required = true) val name: String, - @ApiModelProperty("操作用户", required = true) + @get:Schema(title = "操作用户", required = true) val operator: String ) diff --git a/src/backend/nuget/biz-nuget/src/main/kotlin/com/tencent/bkrepo/nuget/pojo/request/PackageVersionDeleteRequest.kt b/src/backend/nuget/biz-nuget/src/main/kotlin/com/tencent/bkrepo/nuget/pojo/request/PackageVersionDeleteRequest.kt index a98763e5a9..eca0bc6369 100644 --- a/src/backend/nuget/biz-nuget/src/main/kotlin/com/tencent/bkrepo/nuget/pojo/request/PackageVersionDeleteRequest.kt +++ b/src/backend/nuget/biz-nuget/src/main/kotlin/com/tencent/bkrepo/nuget/pojo/request/PackageVersionDeleteRequest.kt @@ -1,18 +1,18 @@ package com.tencent.bkrepo.nuget.pojo.request -import io.swagger.annotations.ApiModelProperty -import io.swagger.annotations.ApiOperation -@ApiOperation("删除包版本请求") +import io.swagger.v3.oas.annotations.media.Schema + +@Schema(title = "删除包版本请求") data class PackageVersionDeleteRequest( - @ApiModelProperty("所属项目", required = true) + @get:Schema(title = "所属项目", required = true) val projectId: String, - @ApiModelProperty("仓库名称", required = true) + @get:Schema(title = "仓库名称", required = true) val repoName: String, - @ApiModelProperty("包名称", required = true) + @get:Schema(title = "包名称", required = true) val name: String, - @ApiModelProperty("包的版本", required = true) + @get:Schema(title = "包的版本", required = true) val version: String, - @ApiModelProperty("操作用户", required = true) + @get:Schema(title = "操作用户", required = true) val operator: String ) diff --git a/src/backend/nuget/biz-nuget/src/main/kotlin/com/tencent/bkrepo/nuget/pojo/user/PackageVersionInfo.kt b/src/backend/nuget/biz-nuget/src/main/kotlin/com/tencent/bkrepo/nuget/pojo/user/PackageVersionInfo.kt index 4d070f531b..80a0d161a5 100644 --- a/src/backend/nuget/biz-nuget/src/main/kotlin/com/tencent/bkrepo/nuget/pojo/user/PackageVersionInfo.kt +++ b/src/backend/nuget/biz-nuget/src/main/kotlin/com/tencent/bkrepo/nuget/pojo/user/PackageVersionInfo.kt @@ -1,43 +1,44 @@ package com.tencent.bkrepo.nuget.pojo.user import com.tencent.bkrepo.repository.pojo.metadata.MetadataModel -import io.swagger.annotations.Api -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema +import io.swagger.v3.oas.annotations.tags.Tag -@Api("nuget版本详情页") + +@Schema(title = "nuget版本详情页") data class PackageVersionInfo( - @ApiModelProperty("基础信息") + @get:Schema(title = "基础信息") val basic: BasicInfo, - @ApiModelProperty("元数据信息") + @get:Schema(title = "元数据信息") val metadata: List ) -@Api("基础信息") +@Tag(name = "基础信息") data class BasicInfo( - @ApiModelProperty("版本字段") + @get:Schema(title = "版本字段") val version: String, - @ApiModelProperty("完整路径") + @get:Schema(title = "完整路径") val fullPath: String, - @ApiModelProperty("文件大小，单位byte") + @get:Schema(title = "文件大小，单位byte") val size: Long, - @ApiModelProperty("文件sha256") + @get:Schema(title = "文件sha256") val sha256: String, - @ApiModelProperty("文件md5") + @get:Schema(title = "文件md5") val md5: String, - @ApiModelProperty("晋级状态标签") + @get:Schema(title = "晋级状态标签") val stageTag: List, - @ApiModelProperty("所属项目id") + @get:Schema(title = "所属项目id") val projectId: String, - @ApiModelProperty("所属仓库名称") + @get:Schema(title = "所属仓库名称") val repoName: String, - @ApiModelProperty("下载次数") + @get:Schema(title = "下载次数") val downloadCount: Long, - @ApiModelProperty("创建者") + @get:Schema(title = "创建者") val createdBy: String, - @ApiModelProperty("创建时间") + @get:Schema(title = "创建时间") val createdDate: String, - @ApiModelProperty("修改者") + @get:Schema(title = "修改者") val lastModifiedBy: String, - @ApiModelProperty("修改时间") + @get:Schema(title = "修改时间") val lastModifiedDate: String ) diff --git a/src/backend/oci/api-oci/src/main/kotlin/com/tencent/bkrepo/oci/api/OciClient.kt b/src/backend/oci/api-oci/src/main/kotlin/com/tencent/bkrepo/oci/api/OciClient.kt index a04271a647..559560a637 100644 --- a/src/backend/oci/api-oci/src/main/kotlin/com/tencent/bkrepo/oci/api/OciClient.kt +++ b/src/backend/oci/api-oci/src/main/kotlin/com/tencent/bkrepo/oci/api/OciClient.kt @@ -30,8 +30,8 @@ package com.tencent.bkrepo.oci.api import com.tencent.bkrepo.common.api.constant.OCI_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.oci.pojo.third.OciReplicationRecordInfo -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.context.annotation.Primary import org.springframework.web.bind.annotation.DeleteMapping @@ -42,26 +42,26 @@ import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam -@Api("oci") +@Tag(name = "oci") @Primary @FeignClient(OCI_SERVICE_NAME, contextId = "OciClient") @RequestMapping("/service/third") interface OciClient { - @ApiOperation("更新第三方同步时，先传manifest文件，再传其他文件") + @Operation(summary = "更新第三方同步时，先传manifest文件，再传其他文件") @PostMapping("/packageCreate") fun packageCreate( @RequestBody record: OciReplicationRecordInfo ): Response - @ApiOperation("定时从第三方仓库拉取对应的package信息") + @Operation(summary = "定时从第三方仓库拉取对应的package信息") @PostMapping("/pull/package/{projectId}/{repoName}") fun getPackagesFromThirdPartyRepo( @PathVariable projectId: String, @PathVariable repoName: String ): Response - @ApiOperation("刷新对应版本镜像的blob节点路径") + @Operation(summary = "刷新对应版本镜像的blob节点路径") @PostMapping("/blob/path/refresh/{projectId}/{repoName}") fun blobPathRefresh( @PathVariable projectId: String, @@ -70,7 +70,7 @@ interface OciClient { @RequestParam version: String, ): Response - @ApiOperation("当历史数据刷新完成后，删除blobs路径下的公共blob节点") + @Operation(summary = "当历史数据刷新完成后，删除blobs路径下的公共blob节点") @DeleteMapping("/blobs/delete/{projectId}/{repoName}") fun deleteBlobsFolderAfterRefreshed( @PathVariable projectId: String, @@ -78,7 +78,7 @@ interface OciClient { @RequestParam packageName: String ): Response - @ApiOperation("删除仓库下的包版本") + @Operation(summary = "删除仓库下的包版本") @DeleteMapping("version/delete/{projectId}/{repoName}") fun deleteVersion( @PathVariable projectId: String, diff --git a/src/backend/oci/api-oci/src/main/kotlin/com/tencent/bkrepo/oci/pojo/user/BasicInfo.kt b/src/backend/oci/api-oci/src/main/kotlin/com/tencent/bkrepo/oci/pojo/user/BasicInfo.kt index cc4849fca2..90ecf4ef94 100644 --- a/src/backend/oci/api-oci/src/main/kotlin/com/tencent/bkrepo/oci/pojo/user/BasicInfo.kt +++ b/src/backend/oci/api-oci/src/main/kotlin/com/tencent/bkrepo/oci/pojo/user/BasicInfo.kt @@ -27,36 +27,35 @@ package com.tencent.bkrepo.oci.pojo.user -import io.swagger.annotations.Api -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@Api("基础信息") +@Schema(title = "基础信息") data class BasicInfo( - @ApiModelProperty("版本字段") + @get:Schema(title = "版本字段") val version: String, - @ApiModelProperty("完整路径") + @get:Schema(title = "完整路径") val fullPath: String, - @ApiModelProperty("文件大小，单位byte") + @get:Schema(title = "文件大小，单位byte") val size: Long, - @ApiModelProperty("文件sha256") + @get:Schema(title = "文件sha256") val sha256: String, - @ApiModelProperty("文件md5") + @get:Schema(title = "文件md5") val md5: String, - @ApiModelProperty("晋级状态标签") + @get:Schema(title = "晋级状态标签") val stageTag: List, - @ApiModelProperty("所属项目id") + @get:Schema(title = "所属项目id") val projectId: String, - @ApiModelProperty("所属仓库名称") + @get:Schema(title = "所属仓库名称") val repoName: String, - @ApiModelProperty("下载次数") + @get:Schema(title = "下载次数") val downloadCount: Long, - @ApiModelProperty("创建者") + @get:Schema(title = "创建者") val createdBy: String, - @ApiModelProperty("创建时间") + @get:Schema(title = "创建时间") val createdDate: String, - @ApiModelProperty("修改者") + @get:Schema(title = "修改者") val lastModifiedBy: String, - @ApiModelProperty("修改时间") + @get:Schema(title = "修改时间") val lastModifiedDate: String ) diff --git a/src/backend/oci/api-oci/src/main/kotlin/com/tencent/bkrepo/oci/pojo/user/PackageVersionInfo.kt b/src/backend/oci/api-oci/src/main/kotlin/com/tencent/bkrepo/oci/pojo/user/PackageVersionInfo.kt index 698937409f..95f8099d51 100644 --- a/src/backend/oci/api-oci/src/main/kotlin/com/tencent/bkrepo/oci/pojo/user/PackageVersionInfo.kt +++ b/src/backend/oci/api-oci/src/main/kotlin/com/tencent/bkrepo/oci/pojo/user/PackageVersionInfo.kt @@ -32,14 +32,13 @@ package com.tencent.bkrepo.oci.pojo.user import com.tencent.bkrepo.repository.pojo.metadata.MetadataModel -import io.swagger.annotations.Api -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@Api("oci版本详情页返回包装模型") +@Schema(title = "oci版本详情页返回包装模型") data class PackageVersionInfo( - @ApiModelProperty("基础信息") + @get:Schema(title = "基础信息") val basic: BasicInfo, - @ApiModelProperty("元数据信息") + @get:Schema(title = "元数据信息") val metadata: List ) diff --git a/src/backend/oci/biz-oci/src/main/kotlin/com/tencent/bkrepo/oci/controller/user/CatalogController.kt b/src/backend/oci/biz-oci/src/main/kotlin/com/tencent/bkrepo/oci/controller/user/CatalogController.kt index d70aa77742..ab2223b85a 100644 --- a/src/backend/oci/biz-oci/src/main/kotlin/com/tencent/bkrepo/oci/controller/user/CatalogController.kt +++ b/src/backend/oci/biz-oci/src/main/kotlin/com/tencent/bkrepo/oci/controller/user/CatalogController.kt @@ -42,7 +42,7 @@ import com.tencent.bkrepo.oci.constant.OCI_REPO_NAME import com.tencent.bkrepo.oci.pojo.artifact.OciArtifactInfo.Companion.DOCKER_CATALOG_SUFFIX import com.tencent.bkrepo.oci.pojo.artifact.OciTagArtifactInfo import com.tencent.bkrepo.oci.service.OciCatalogService -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Parameter import org.springframework.http.HttpHeaders import org.springframework.http.HttpStatus import org.springframework.http.ResponseEntity @@ -62,16 +62,16 @@ class CatalogController(private val catalogService: OciCatalogService) { fun list( artifactInfo: OciTagArtifactInfo, @PathVariable - @ApiParam(value = OCI_PROJECT_ID, required = true) + @Parameter(name = OCI_PROJECT_ID, required = true) projectId: String, @PathVariable - @ApiParam(value = OCI_REPO_NAME, required = true) + @Parameter(name = OCI_REPO_NAME, required = true) repoName: String, @RequestParam(required = false) - @ApiParam(value = "n", required = false) + @Parameter(name = "n", required = false) n: Int?, @RequestParam(required = false) - @ApiParam(value = "last", required = false) + @Parameter(name = "last", required = false) last: String? ): ResponseEntity { diff --git a/src/backend/oci/biz-oci/src/main/kotlin/com/tencent/bkrepo/oci/controller/user/UserOciController.kt b/src/backend/oci/biz-oci/src/main/kotlin/com/tencent/bkrepo/oci/controller/user/UserOciController.kt index a8982cfd93..1b2e0b4d81 100644 --- a/src/backend/oci/biz-oci/src/main/kotlin/com/tencent/bkrepo/oci/controller/user/UserOciController.kt +++ b/src/backend/oci/biz-oci/src/main/kotlin/com/tencent/bkrepo/oci/controller/user/UserOciController.kt @@ -60,9 +60,9 @@ import com.tencent.bkrepo.oci.pojo.response.OciImageResult import com.tencent.bkrepo.oci.pojo.response.OciTagResult import com.tencent.bkrepo.oci.pojo.user.PackageVersionInfo import com.tencent.bkrepo.oci.service.OciOperationService -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable @@ -74,23 +74,23 @@ import org.springframework.web.servlet.HandlerMapping import javax.servlet.http.HttpServletRequest @Suppress("MVCPathVariableInspection") -@Api("oci产品接口") +@Tag(name = "oci产品接口") @RestController @RequestMapping("/ext") class UserOciController( private val operationService: OciOperationService ) { - @ApiOperation("查询包的版本详情") + @Operation(summary = "查询包的版本详情") @GetMapping(OCI_VERSION_DETAIL) @Permission(type = ResourceType.REPO, action = PermissionAction.READ) fun detailVersion( @RequestAttribute userId: String, @ArtifactPathVariable artifactInfo: OciArtifactInfo, - @ApiParam(value = "包唯一Key", required = true) + @Parameter(name = "包唯一Key", required = true) @RequestParam packageKey: String, - @ApiParam(value = "包版本", required = true) + @Parameter(name = "包版本", required = true) @RequestParam version: String ): Response { return ResponseBuilder.success( @@ -115,13 +115,13 @@ class UserOciController( scopeId = "#artifactInfo?.projectId", content = ActionAuditContent.REPO_PACKAGE_DELETE_CONTENT ) - @ApiOperation("删除仓库下的包") + @Operation(summary = "删除仓库下的包") @DeleteMapping(OCI_PACKAGE_DELETE_URL) @Permission(type = ResourceType.REPO, action = PermissionAction.WRITE) fun deletePackage( @RequestAttribute userId: String, artifactInfo: OciDeleteArtifactInfo, - @ApiParam(value = "包唯一key", required = true) + @Parameter(name = "包唯一key", required = true) @RequestParam packageKey: String ): Response { operationService.deletePackage(userId, artifactInfo) @@ -147,28 +147,28 @@ class UserOciController( scopeId = "#artifactInfo?.projectId", content = ActionAuditContent.REPO_PACKAGE_VERSION_DELETE_CONTENT ) - @ApiOperation("删除仓库下的包版本") + @Operation(summary = "删除仓库下的包版本") @DeleteMapping(OCI_VERSION_DELETE_URL) @Permission(type = ResourceType.REPO, action = PermissionAction.WRITE) fun deleteVersion( @RequestAttribute userId: String, artifactInfo: OciDeleteArtifactInfo, - @ApiParam(value = "包唯一key", required = true) + @Parameter(name = "包唯一key", required = true) @RequestParam packageKey: String, - @ApiParam(value = "包版本", required = true) + @Parameter(name = "包版本", required = true) @RequestParam version: String ): Response { operationService.deleteVersion(userId, artifactInfo) return ResponseBuilder.success() } - @ApiOperation("获取Oci域名地址") + @Operation(summary = "获取Oci域名地址") @GetMapping("/addr") fun getRegistryDomain(): Response { return ResponseBuilder.success(operationService.getRegistryDomain()) } - @ApiOperation("获取manifest文件") + @Operation(summary = "获取manifest文件") @GetMapping(OCI_USER_MANIFEST_SUFFIX) @Permission(type = ResourceType.REPO, action = PermissionAction.READ) fun getManifest( @@ -179,25 +179,25 @@ class UserOciController( ) } - @ApiOperation("获取所有image") + @Operation(summary = "获取所有image") @GetMapping(OCI_USER_REPO_SUFFIX) @Permission(type = ResourceType.REPO, action = PermissionAction.READ) fun getRepo( request: HttpServletRequest, @PathVariable - @ApiParam(value = OCI_PROJECT_ID, required = true) + @Parameter(name = OCI_PROJECT_ID, required = true) projectId: String, @PathVariable - @ApiParam(value = OCI_REPO_NAME, required = true) + @Parameter(name = OCI_REPO_NAME, required = true) repoName: String, @RequestParam(required = true) - @ApiParam(value = PAGE_NUMBER, required = true) + @Parameter(name = PAGE_NUMBER, required = true) pageNumber: Int, @RequestParam(required = true) - @ApiParam(value = PAGE_SIZE, required = true) + @Parameter(name = PAGE_SIZE, required = true) pageSize: Int, @RequestParam(required = false) - @ApiParam(value = OCI_PACKAGE_NAME, required = true) + @Parameter(name = OCI_PACKAGE_NAME, required = true) name: String? ): Response { return ResponseBuilder.success( @@ -211,24 +211,24 @@ class UserOciController( ) } - @ApiOperation("获取repo所有的tag") + @Operation(summary = "获取repo所有的tag") @GetMapping(OCI_USER_TAG_SUFFIX) @Permission(type = ResourceType.REPO, action = PermissionAction.READ) fun getRepoTag( request: HttpServletRequest, @PathVariable - @ApiParam(value = OCI_PROJECT_ID, required = true) + @Parameter(name = OCI_PROJECT_ID, required = true) projectId: String, @PathVariable - @ApiParam(value = OCI_REPO_NAME, required = true) + @Parameter(name = OCI_REPO_NAME, required = true) repoName: String, - @ApiParam(value = PAGE_NUMBER, required = true) + @Parameter(name = PAGE_NUMBER, required = true) pageNumber: Int, @RequestParam(required = true) - @ApiParam(value = PAGE_SIZE, required = true) + @Parameter(name = PAGE_SIZE, required = true) pageSize: Int, @RequestParam(required = false) - @ApiParam(value = OCI_TAG, required = true) + @Parameter(name = OCI_TAG, required = true) tag: String? ): Response { val requestUrl = request.getAttribute(HandlerMapping.PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE).toString() diff --git a/src/backend/oci/biz-oci/src/main/kotlin/com/tencent/bkrepo/oci/pojo/response/OciErrorResponse.kt b/src/backend/oci/biz-oci/src/main/kotlin/com/tencent/bkrepo/oci/pojo/response/OciErrorResponse.kt index 29f884b717..cee3fcb6eb 100644 --- a/src/backend/oci/biz-oci/src/main/kotlin/com/tencent/bkrepo/oci/pojo/response/OciErrorResponse.kt +++ b/src/backend/oci/biz-oci/src/main/kotlin/com/tencent/bkrepo/oci/pojo/response/OciErrorResponse.kt @@ -31,15 +31,15 @@ package com.tencent.bkrepo.oci.pojo.response -import io.swagger.annotations.Api -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@Api("Oci error 包装返回模型") + +@Schema(title = "Oci error 包装返回模型") data class OciErrorResponse( - @ApiModelProperty("错误提示") + @get:Schema(title = "错误提示") val message: String?, - @ApiModelProperty("编码") + @get:Schema(title = "编码") val code: Any?, - @ApiModelProperty("详情") + @get:Schema(title = "详情") val detail: String? ) diff --git a/src/backend/oci/biz-oci/src/main/kotlin/com/tencent/bkrepo/oci/pojo/response/OciImage.kt b/src/backend/oci/biz-oci/src/main/kotlin/com/tencent/bkrepo/oci/pojo/response/OciImage.kt index 49ddf30355..2468bc3fae 100644 --- a/src/backend/oci/biz-oci/src/main/kotlin/com/tencent/bkrepo/oci/pojo/response/OciImage.kt +++ b/src/backend/oci/biz-oci/src/main/kotlin/com/tencent/bkrepo/oci/pojo/response/OciImage.kt @@ -31,21 +31,21 @@ package com.tencent.bkrepo.oci.pojo.response -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("oci镜像信息") + +@Schema(title = "oci镜像信息") data class OciImage( - @ApiModelProperty("name") + @get:Schema(title = "name") val name: String, - @ApiModelProperty("最后修改人") + @get:Schema(title = "最后修改人") val lastModifiedBy: String, - @ApiModelProperty("最后修改时间") + @get:Schema(title = "最后修改时间") val lastModifiedDate: String, - @ApiModelProperty("下载次数") + @get:Schema(title = "下载次数") val downloadCount: Long, - @ApiModelProperty("镜像logo地址") + @get:Schema(title = "镜像logo地址") val logoUrl: String, - @ApiModelProperty("镜像描述") + @get:Schema(title = "镜像描述") val description: String ) diff --git a/src/backend/oci/biz-oci/src/main/kotlin/com/tencent/bkrepo/oci/pojo/response/OciImageResult.kt b/src/backend/oci/biz-oci/src/main/kotlin/com/tencent/bkrepo/oci/pojo/response/OciImageResult.kt index 2365d0723e..982e2b6407 100644 --- a/src/backend/oci/biz-oci/src/main/kotlin/com/tencent/bkrepo/oci/pojo/response/OciImageResult.kt +++ b/src/backend/oci/biz-oci/src/main/kotlin/com/tencent/bkrepo/oci/pojo/response/OciImageResult.kt @@ -31,13 +31,13 @@ package com.tencent.bkrepo.oci.pojo.response -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("oci镜像信息查询结果信息") + +@Schema(title = "oci镜像信息查询结果信息") data class OciImageResult( - @ApiModelProperty("totalRecords") + @get:Schema(title = "totalRecords") var totalRecords: Long, - @ApiModelProperty("records") + @get:Schema(title = "records") var records: List ) diff --git a/src/backend/oci/biz-oci/src/main/kotlin/com/tencent/bkrepo/oci/pojo/response/OciTag.kt b/src/backend/oci/biz-oci/src/main/kotlin/com/tencent/bkrepo/oci/pojo/response/OciTag.kt index 4a7d985276..c5707441cb 100644 --- a/src/backend/oci/biz-oci/src/main/kotlin/com/tencent/bkrepo/oci/pojo/response/OciTag.kt +++ b/src/backend/oci/biz-oci/src/main/kotlin/com/tencent/bkrepo/oci/pojo/response/OciTag.kt @@ -31,23 +31,23 @@ package com.tencent.bkrepo.oci.pojo.response -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("oci镜像tag信息") + +@Schema(title = "oci镜像tag信息") data class OciTag( - @ApiModelProperty("tag") + @get:Schema(title = "tag") val tag: String, - @ApiModelProperty("stageTag") + @get:Schema(title = "stageTag") val stageTag: String, - @ApiModelProperty("大小") + @get:Schema(title = "大小") val size: Long, - @ApiModelProperty("最后修改人") + @get:Schema(title = "最后修改人") val lastModifiedBy: String, - @ApiModelProperty("最后修改时间") + @get:Schema(title = "最后修改时间") val lastModifiedDate: String, - @ApiModelProperty("下载次数") + @get:Schema(title = "下载次数") val downloadCount: Long, - @ApiModelProperty("镜像地址") + @get:Schema(title = "镜像地址") val registryUrl: String ) diff --git a/src/backend/oci/biz-oci/src/main/kotlin/com/tencent/bkrepo/oci/pojo/response/OciTagResult.kt b/src/backend/oci/biz-oci/src/main/kotlin/com/tencent/bkrepo/oci/pojo/response/OciTagResult.kt index 3990edec77..d2a17e7bf3 100644 --- a/src/backend/oci/biz-oci/src/main/kotlin/com/tencent/bkrepo/oci/pojo/response/OciTagResult.kt +++ b/src/backend/oci/biz-oci/src/main/kotlin/com/tencent/bkrepo/oci/pojo/response/OciTagResult.kt @@ -31,11 +31,12 @@ package com.tencent.bkrepo.oci.pojo.response -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + data class OciTagResult( - @ApiModelProperty("totalRecords") + @get:Schema(title = "totalRecords") val totalRecords: Long, - @ApiModelProperty("records") + @get:Schema(title = "records") val records: List ) diff --git a/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/AnnotationsRequest.kt b/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/AnnotationsRequest.kt index 6c132ea259..a49985556e 100644 --- a/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/AnnotationsRequest.kt +++ b/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/AnnotationsRequest.kt @@ -31,13 +31,13 @@ package com.tencent.bkrepo.opdata.pojo -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("annotation查询") + +@Schema(title = "annotation查询") data class AnnotationsRequest( - @ApiModelProperty("appId") + @get:Schema(title = "appId") val appId: String, - @ApiModelProperty("locked状态") + @get:Schema(title = "locked状态") val locked: Boolean ) diff --git a/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/Columns.kt b/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/Columns.kt index 96d0541ee2..55b1ff5224 100644 --- a/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/Columns.kt +++ b/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/Columns.kt @@ -31,11 +31,12 @@ package com.tencent.bkrepo.opdata.pojo -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + data class Columns( - @ApiModelProperty("columns text") + @get:Schema(title = "columns text") val text: String, - @ApiModelProperty("columns type") + @get:Schema(title = "columns type") val type: String ) diff --git a/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/Filter.kt b/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/Filter.kt index 7af3bea26f..62f3034657 100644 --- a/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/Filter.kt +++ b/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/Filter.kt @@ -31,13 +31,14 @@ package com.tencent.bkrepo.opdata.pojo -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + data class Filter( - @ApiModelProperty("key") + @get:Schema(title = "key") val key: String, - @ApiModelProperty("operator") + @get:Schema(title = "operator") val operator: String, - @ApiModelProperty("value") + @get:Schema(title = "value") val value: String ) diff --git a/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/NodeResult.kt b/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/NodeResult.kt index 03fa302746..5bba00c61a 100644 --- a/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/NodeResult.kt +++ b/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/NodeResult.kt @@ -31,13 +31,13 @@ package com.tencent.bkrepo.opdata.pojo -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("node查询结果") + +@Schema(title = "node查询结果") data class NodeResult( - @ApiModelProperty("target") + @get:Schema(title = "target") val target: String, - @ApiModelProperty("datapoints") + @get:Schema(title = "datapoints") val datapoints: List> ) diff --git a/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/QueryRequest.kt b/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/QueryRequest.kt index 75915bf4aa..af4712d924 100644 --- a/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/QueryRequest.kt +++ b/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/QueryRequest.kt @@ -31,33 +31,34 @@ package com.tencent.bkrepo.opdata.pojo -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + data class QueryRequest( -// @ApiModelProperty("requestId") +// @get:Schema(title = "requestId") // val requestId: String, -// @ApiModelProperty("timezone") +// @get:Schema(title = "timezone") // val timezone: String, -// @ApiModelProperty("panelId") +// @get:Schema(title = "panelId") // val panelId: Int, -// @ApiModelProperty("dashboardId") +// @get:Schema(title = "dashboardId") // val dashboardId: Int, -// @ApiModelProperty("range") +// @get:Schema(title = "range") // val range: Range, -// @ApiModelProperty("interval") +// @get:Schema(title = "interval") // val interval: String, -// @ApiModelProperty("intervalMs") +// @get:Schema(title = "intervalMs") // val intervalMs: Long, -// @ApiModelProperty("maxDataPoints") +// @get:Schema(title = "maxDataPoints") // val maxDataPoints: Long, - @ApiModelProperty("targets") + @get:Schema(title = "targets") val targets: List -// @ApiModelProperty("scopedVars") +// @get:Schema(title = "scopedVars") // val scopedVars: List, -// @ApiModelProperty("startTime") +// @get:Schema(title = "startTime") // val startTime: Long, -// @ApiModelProperty("rangeRaw") +// @get:Schema(title = "rangeRaw") // val rangeRaw: Raw, -// @ApiModelProperty("adhocFilters") +// @get:Schema(title = "adhocFilters") // val adhocFilters: List ) diff --git a/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/QueryResult.kt b/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/QueryResult.kt index bfec436ac0..a3fe2d086a 100644 --- a/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/QueryResult.kt +++ b/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/QueryResult.kt @@ -32,13 +32,14 @@ package com.tencent.bkrepo.opdata.pojo import com.tencent.bkrepo.opdata.pojo.enums.MetricsType -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + data class QueryResult( - @ApiModelProperty("columns") + @get:Schema(title = "columns") var columns: List, - @ApiModelProperty("rows") + @get:Schema(title = "rows") var rows: List>, - @ApiModelProperty("metrics类型") + @get:Schema(title = "metrics类型") var type: MetricsType ) diff --git a/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/Range.kt b/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/Range.kt index 38aa0f0b9a..dd55952f72 100644 --- a/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/Range.kt +++ b/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/Range.kt @@ -31,13 +31,14 @@ package com.tencent.bkrepo.opdata.pojo -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + data class Range( - @ApiModelProperty("from") + @get:Schema(title = "from") val from: String, - @ApiModelProperty("to") + @get:Schema(title = "to") val to: String, - @ApiModelProperty("raw") + @get:Schema(title = "raw") val raw: Raw ) diff --git a/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/Raw.kt b/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/Raw.kt index 9bc5b19c09..3286d6c776 100644 --- a/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/Raw.kt +++ b/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/Raw.kt @@ -31,11 +31,12 @@ package com.tencent.bkrepo.opdata.pojo -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + data class Raw( - @ApiModelProperty("from") + @get:Schema(title = "from") val from: String, - @ApiModelProperty("to") + @get:Schema(title = "to") val to: String ) diff --git a/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/RepoMetrics.kt b/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/RepoMetrics.kt index 25d2571d50..bf0bf5a2cc 100644 --- a/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/RepoMetrics.kt +++ b/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/RepoMetrics.kt @@ -31,17 +31,18 @@ package com.tencent.bkrepo.opdata.pojo -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + data class RepoMetrics( - @ApiModelProperty("repoName") + @get:Schema(title = "repoName") val repoName: String, - @ApiModelProperty("credentialsKey") + @get:Schema(title = "credentialsKey") val credentialsKey: String? = "default", - @ApiModelProperty("size") + @get:Schema(title = "size") var size: Long, - @ApiModelProperty("num") + @get:Schema(title = "num") val num: Long, - @ApiModelProperty("type") + @get:Schema(title = "type") val type: String? = null ) diff --git a/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/SearchRequest.kt b/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/SearchRequest.kt index c678fbc14a..ea230a1030 100644 --- a/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/SearchRequest.kt +++ b/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/SearchRequest.kt @@ -32,13 +32,13 @@ package com.tencent.bkrepo.opdata.pojo import com.tencent.bkrepo.opdata.pojo.enums.MetricsType -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("search信息") + +@Schema(title = "search信息") data class SearchRequest( - @ApiModelProperty("查询类型") + @get:Schema(title = "查询类型") val type: MetricsType?, - @ApiModelProperty("查询目标") + @get:Schema(title = "查询目标") val target: String ) diff --git a/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/Target.kt b/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/Target.kt index fdf92be727..93f12113d2 100644 --- a/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/Target.kt +++ b/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/Target.kt @@ -33,17 +33,18 @@ package com.tencent.bkrepo.opdata.pojo import com.tencent.bkrepo.opdata.pojo.enums.Metrics import com.tencent.bkrepo.opdata.pojo.enums.MetricsType -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + data class Target( - @ApiModelProperty("data") + @get:Schema(title = "data") val data: Any?, - @ApiModelProperty("target") + @get:Schema(title = "target") val target: Metrics, - @ApiModelProperty("refId") + @get:Schema(title = "refId") val refId: String, - @ApiModelProperty("hide") + @get:Schema(title = "hide") val hide: Boolean, - @ApiModelProperty("type") + @get:Schema(title = "type") val type: MetricsType ) diff --git a/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/config/GetConfigRequest.kt b/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/config/GetConfigRequest.kt index 49d4aea7d3..97dd689aec 100644 --- a/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/config/GetConfigRequest.kt +++ b/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/config/GetConfigRequest.kt @@ -1,12 +1,13 @@ package com.tencent.bkrepo.opdata.pojo.config -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + data class GetConfigRequest( - @ApiModelProperty("查询的应用名") + @get:Schema(title = "查询的应用名") val appName: String = "", - @ApiModelProperty("查询的profile") + @get:Schema(title = "查询的profile") val profile: String = "", - @ApiModelProperty("查询的key") + @get:Schema(title = "查询的key") val key:String ) diff --git a/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/config/UpdateConfigRequest.kt b/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/config/UpdateConfigRequest.kt index ed8adc6a29..8a99605f7d 100644 --- a/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/config/UpdateConfigRequest.kt +++ b/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/config/UpdateConfigRequest.kt @@ -28,16 +28,16 @@ package com.tencent.bkrepo.opdata.pojo.config import com.fasterxml.jackson.annotation.JsonInclude -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("更新配置请求体") + +@Schema(title = "更新配置请求体") @JsonInclude(JsonInclude.Include.NON_NULL) data class UpdateConfigRequest( - @ApiModelProperty("待更新的应用名") + @get:Schema(title = "待更新的应用名") val appName: String = "", - @ApiModelProperty("待更新的profile") + @get:Schema(title = "待更新的profile") val profile: String = "", - @ApiModelProperty("需要更新的配置键值对", required = true) + @get:Schema(title = "需要更新的配置键值对", required = true) val values: List ) diff --git a/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/plugin/PluginDetail.kt b/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/plugin/PluginDetail.kt index 2fb0892638..5758ae90ef 100644 --- a/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/plugin/PluginDetail.kt +++ b/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/plugin/PluginDetail.kt @@ -27,28 +27,27 @@ package com.tencent.bkrepo.opdata.pojo.plugin -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema import java.time.LocalDateTime -@ApiModel("插件信息") +@Schema(title = "插件信息") data class PluginDetail( - @ApiModelProperty("id") + @get:Schema(title = "id") val id: String, - @ApiModelProperty("版本") + @get:Schema(title = "版本") val version: String, - @ApiModelProperty("生效范围") + @get:Schema(title = "生效范围") val scope: List, - @ApiModelProperty("描述") + @get:Schema(title = "描述") val description: String, - @ApiModelProperty("代码库地址") + @get:Schema(title = "代码库地址") val gitUrl: String, - @ApiModelProperty("创建人") + @get:Schema(title = "创建人") var createdBy: String, - @ApiModelProperty("创建时间") + @get:Schema(title = "创建时间") var createdDate: LocalDateTime, - @ApiModelProperty("最后修改人") + @get:Schema(title = "最后修改人") var lastModifiedBy: String, - @ApiModelProperty("最后修改时间") + @get:Schema(title = "最后修改时间") var lastModifiedDate: LocalDateTime, ) diff --git a/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/registry/InstanceDetail.kt b/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/registry/InstanceDetail.kt index 571d4a6c35..fe3b51f7db 100644 --- a/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/registry/InstanceDetail.kt +++ b/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/registry/InstanceDetail.kt @@ -27,20 +27,21 @@ package com.tencent.bkrepo.opdata.pojo.registry -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 服务节点详细信息 */ data class InstanceDetail( - @ApiModelProperty("正在下载的请求数量", required = true) + @get:Schema(title = "正在下载的请求数量", required = true) val downloadingCount:Long, - @ApiModelProperty("正在上传的请求数量", required = true) + @get:Schema(title = "正在上传的请求数量", required = true) val uploadingCount: Long, - @ApiModelProperty("从缓存异步上传到实际存储的任务数量，不使用缓存时为-1", required = true) + @get:Schema(title = "从缓存异步上传到实际存储的任务数量，不使用缓存时为-1", required = true) val asyncTaskActiveCount: Long, - @ApiModelProperty("从缓存异步上传到实际存储的任务队列大小，不使用缓存时为-1", required = true) + @get:Schema(title = "从缓存异步上传到实际存储的任务队列大小，不使用缓存时为-1", required = true) val asyncTaskQueueSize: Long, - @ApiModelProperty("已加载的插件", required = true) + @get:Schema(title = "已加载的插件", required = true) val loadedPlugins: List? = null ) diff --git a/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/registry/InstanceInfo.kt b/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/registry/InstanceInfo.kt index 03ba9a5b89..0294a763e7 100644 --- a/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/registry/InstanceInfo.kt +++ b/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/registry/InstanceInfo.kt @@ -28,22 +28,22 @@ package com.tencent.bkrepo.opdata.pojo.registry import com.fasterxml.jackson.annotation.JsonInclude -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("服务实例信息") + +@Schema(title = "服务实例信息") @JsonInclude(JsonInclude.Include.NON_NULL) data class InstanceInfo( - @ApiModelProperty("实例id", required = true) + @get:Schema(title = "实例id", required = true) val id: String, - @ApiModelProperty("所属服务", required = true) + @get:Schema(title = "所属服务", required = true) val serviceName: String, - @ApiModelProperty("实例ip或域名", required = true) + @get:Schema(title = "实例ip或域名", required = true) val host: String, - @ApiModelProperty("实例端口", required = true) + @get:Schema(title = "实例端口", required = true) val port: Int, - @ApiModelProperty("实例状态", required = true) + @get:Schema(title = "实例状态", required = true) val status: InstanceStatus, - @ApiModelProperty("实例详情") + @get:Schema(title = "实例详情") val detail: InstanceDetail? = null ) diff --git a/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/registry/ServiceInfo.kt b/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/registry/ServiceInfo.kt index 7b4a4cf88a..c918f657f5 100644 --- a/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/registry/ServiceInfo.kt +++ b/src/backend/opdata/api-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/pojo/registry/ServiceInfo.kt @@ -28,14 +28,14 @@ package com.tencent.bkrepo.opdata.pojo.registry import com.fasterxml.jackson.annotation.JsonInclude -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("服务信息") + +@Schema(title = "服务信息") @JsonInclude(JsonInclude.Include.NON_EMPTY) data class ServiceInfo( - @ApiModelProperty("服务名") + @get:Schema(title = "服务名") val name: String, - @ApiModelProperty("服务实例信息") + @get:Schema(title = "服务实例信息") val instances: List ) diff --git a/src/backend/opdata/biz-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/controller/NotifyChannelCredentialController.kt b/src/backend/opdata/biz-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/controller/NotifyChannelCredentialController.kt index 0c79fa466a..28f580da6e 100644 --- a/src/backend/opdata/biz-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/controller/NotifyChannelCredentialController.kt +++ b/src/backend/opdata/biz-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/controller/NotifyChannelCredentialController.kt @@ -28,14 +28,14 @@ package com.tencent.bkrepo.opdata.controller import com.tencent.bkrepo.common.api.pojo.Response +import com.tencent.bkrepo.common.metadata.annotation.LogOperate import com.tencent.bkrepo.common.notify.api.NotifyChannelCredential import com.tencent.bkrepo.common.notify.service.NotifyChannelCredentialService -import com.tencent.bkrepo.common.metadata.annotation.LogOperate import com.tencent.bkrepo.common.security.permission.Principal import com.tencent.bkrepo.common.security.permission.PrincipalType import com.tencent.bkrepo.common.security.util.SecurityUtils import com.tencent.bkrepo.common.service.util.ResponseBuilder -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable @@ -51,14 +51,14 @@ import org.springframework.web.bind.annotation.RestController class NotifyChannelCredentialController( private val notifyChannelCredentialService: NotifyChannelCredentialService ) { - @ApiOperation("创建通知渠道凭据") + @Operation(summary = "创建通知渠道凭据") @PostMapping @LogOperate(type = "NOTIFY_CREATE", desensitize = true) fun create(@RequestBody credential: NotifyChannelCredential): Response { return ResponseBuilder.success(notifyChannelCredentialService.create(SecurityUtils.getUserId(), credential)) } - @ApiOperation("删除通知渠道凭据") + @Operation(summary = "删除通知渠道凭据") @DeleteMapping("/{name}") @LogOperate(type = "NOTIFY_DELETE") fun delete(@PathVariable name: String): Response { @@ -66,7 +66,7 @@ class NotifyChannelCredentialController( return ResponseBuilder.success() } - @ApiOperation("更新通知渠道凭据") + @Operation(summary = "更新通知渠道凭据") @PutMapping("/{name}") @LogOperate(type = "NOTIFY_UPDATE", desensitize = true) fun update( @@ -76,7 +76,7 @@ class NotifyChannelCredentialController( return ResponseBuilder.success(notifyChannelCredentialService.update(SecurityUtils.getUserId(), credential)) } - @ApiOperation("获取通知渠道凭据列表") + @Operation(summary = "获取通知渠道凭据列表") @GetMapping @LogOperate(type = "NOTIFY_LIST") fun list(): Response> { diff --git a/src/backend/opdata/biz-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/controller/PluginController.kt b/src/backend/opdata/biz-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/controller/PluginController.kt index 8d563b7e1d..3c581ee98e 100644 --- a/src/backend/opdata/biz-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/controller/PluginController.kt +++ b/src/backend/opdata/biz-opdata/src/main/kotlin/com/tencent/bkrepo/opdata/controller/PluginController.kt @@ -38,8 +38,8 @@ import com.tencent.bkrepo.opdata.pojo.plugin.PluginDetail import com.tencent.bkrepo.opdata.pojo.plugin.PluginListOption import com.tencent.bkrepo.opdata.pojo.plugin.PluginUpdateRequest import com.tencent.bkrepo.opdata.service.PluginService -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable @@ -49,7 +49,7 @@ import org.springframework.web.bind.annotation.RequestBody import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RestController -@Api("插件服务接口") +@Tag(name = "插件服务接口") @RestController @RequestMapping("/api/plugin") @Principal(PrincipalType.ADMIN) @@ -57,14 +57,14 @@ class PluginController( private val pluginService: PluginService ) { - @ApiOperation("插件列表") + @Operation(summary = "插件列表") @GetMapping @LogOperate(type = "PLUGIN_LIST") fun list(option: PluginListOption): Response> { return ResponseBuilder.success(pluginService.list(option)) } - @ApiOperation("创建插件") + @Operation(summary = "创建插件") @PostMapping @LogOperate(type = "PLUGIN_CREATE") fun create(@RequestBody request: PluginCreateRequest): Response { @@ -72,7 +72,7 @@ class PluginController( return ResponseBuilder.success() } - @ApiOperation("更新插件") + @Operation(summary = "更新插件") @PutMapping @LogOperate(type = "PLUGIN_UPDATE") fun update(@RequestBody request: PluginUpdateRequest): Response { @@ -80,7 +80,7 @@ class PluginController( return ResponseBuilder.success() } - @ApiOperation("删除插件") + @Operation(summary = "删除插件") @DeleteMapping("/{pluginId}") @LogOperate(type = "PLUGIN_DELETE") fun delete(@PathVariable pluginId: String): Response { @@ -88,7 +88,7 @@ class PluginController( return ResponseBuilder.success() } - @ApiOperation("加载插件") + @Operation(summary = "加载插件") @PostMapping("/load/{pluginId}") @LogOperate(type = "PLUGIN_LOAD") fun load( @@ -99,7 +99,7 @@ class PluginController( return ResponseBuilder.success() } - @ApiOperation("卸载插件") + @Operation(summary = "卸载插件") @DeleteMapping("/unload/{pluginId}") @LogOperate(type = "PLUGIN_UNLOAD") fun unload( diff --git a/src/backend/preview/api-preview/src/main/kotlin/com/tencent/bkrepo/preview/pojo/FileAttribute.kt b/src/backend/preview/api-preview/src/main/kotlin/com/tencent/bkrepo/preview/pojo/FileAttribute.kt index ab10de3140..5d47731200 100644 --- a/src/backend/preview/api-preview/src/main/kotlin/com/tencent/bkrepo/preview/pojo/FileAttribute.kt +++ b/src/backend/preview/api-preview/src/main/kotlin/com/tencent/bkrepo/preview/pojo/FileAttribute.kt @@ -31,9 +31,9 @@ package com.tencent.bkrepo.preview.pojo -import io.swagger.annotations.ApiModel +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("预览文件信息") +@Schema(title = "预览文件信息") data class FileAttribute ( // 存储类型：0-bkrepo文件，1-远程文件 var storageType: Int = 0, @@ -80,4 +80,4 @@ data class FileAttribute ( // 文件后缀 var suffix: String? = null, -) \ No newline at end of file +) diff --git a/src/backend/preview/api-preview/src/main/kotlin/com/tencent/bkrepo/preview/pojo/PreviewInfo.kt b/src/backend/preview/api-preview/src/main/kotlin/com/tencent/bkrepo/preview/pojo/PreviewInfo.kt index c8973eeb1a..5dfe058c3a 100644 --- a/src/backend/preview/api-preview/src/main/kotlin/com/tencent/bkrepo/preview/pojo/PreviewInfo.kt +++ b/src/backend/preview/api-preview/src/main/kotlin/com/tencent/bkrepo/preview/pojo/PreviewInfo.kt @@ -31,23 +31,23 @@ package com.tencent.bkrepo.preview.pojo -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 预览信息 */ -@ApiModel("预览信息") +@Schema(title = "预览信息") data class PreviewInfo ( - @ApiModelProperty("文件名称") + @get:Schema(title = "文件名称") var fileName: String? = null, - @ApiModelProperty("文件类型") + @get:Schema(title = "文件类型") var fileType: String? = null, - @ApiModelProperty("文件后缀") + @get:Schema(title = "文件后缀") var suffix: String? = null, // 文件展示模板，如officeweb、ppt等 - @ApiModelProperty("文件展示模板") + @get:Schema(title = "文件展示模板") var fileTemplate: String? = null, - @ApiModelProperty("水印") + @get:Schema(title = "水印") var watermark: Watermark? = null, -) \ No newline at end of file +) diff --git a/src/backend/preview/api-preview/src/main/kotlin/com/tencent/bkrepo/preview/pojo/PreviewOptions.kt b/src/backend/preview/api-preview/src/main/kotlin/com/tencent/bkrepo/preview/pojo/PreviewOptions.kt index 0de24e38bb..7ebee771b4 100644 --- a/src/backend/preview/api-preview/src/main/kotlin/com/tencent/bkrepo/preview/pojo/PreviewOptions.kt +++ b/src/backend/preview/api-preview/src/main/kotlin/com/tencent/bkrepo/preview/pojo/PreviewOptions.kt @@ -31,23 +31,23 @@ package com.tencent.bkrepo.preview.pojo -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("预览属性") + +@Schema(title = "预览属性") data class PreviewOptions( - @ApiModelProperty("是否禁止演示模式") + @get:Schema(title = "是否禁止演示模式") var pdfPresentationModeDisable: Boolean = true, - @ApiModelProperty("是否禁止打开文件") + @get:Schema(title = "是否禁止打开文件") var pdfOpenFileDisable: Boolean = true, - @ApiModelProperty("是否禁止打印转换生成的PDF文件") + @get:Schema(title = "是否禁止打印转换生成的PDF文件") var pdfPrintDisable: Boolean = true, - @ApiModelProperty("是否禁止下载转换生成的PDF文件") + @get:Schema(title = "是否禁止下载转换生成的PDF文件") var pdfDownloadDisable: Boolean = true, - @ApiModelProperty("是否禁止bookmarkFileConvertQueueTask") + @get:Schema(title = "是否禁止bookmarkFileConvertQueueTask") var pdfBookmarkDisable: Boolean = true, - @ApiModelProperty("是否禁止签名") + @get:Schema(title = "是否禁止签名") var pdfDisableEditing: Boolean = true, - @ApiModelProperty("是否关闭 office 预览切换开关") + @get:Schema(title = "是否关闭 office 预览切换开关") var switchDisabled: Boolean = true, -) \ No newline at end of file +) diff --git a/src/backend/preview/api-preview/src/main/kotlin/com/tencent/bkrepo/preview/pojo/Watermark.kt b/src/backend/preview/api-preview/src/main/kotlin/com/tencent/bkrepo/preview/pojo/Watermark.kt index 40ee13ff25..42cfdf5e80 100644 --- a/src/backend/preview/api-preview/src/main/kotlin/com/tencent/bkrepo/preview/pojo/Watermark.kt +++ b/src/backend/preview/api-preview/src/main/kotlin/com/tencent/bkrepo/preview/pojo/Watermark.kt @@ -31,29 +31,29 @@ package com.tencent.bkrepo.preview.pojo -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("水印信息") + +@Schema(title = "水印信息") data class Watermark( - @ApiModelProperty("水印内容") + @get:Schema(title = "水印内容") var watermarkTxt: String? = null, - @ApiModelProperty("水印x轴间隔") + @get:Schema(title = "水印x轴间隔") var watermarkXSpace: String? = null, - @ApiModelProperty("水印y轴间隔") + @get:Schema(title = "水印y轴间隔") var watermarkYSpace: String? = null, - @ApiModelProperty("水印字体") + @get:Schema(title = "水印字体") var watermarkFont: String? = null, - @ApiModelProperty("水印字体大小") + @get:Schema(title = "水印字体大小") var watermarkFontsize: String? = null, - @ApiModelProperty("水印颜色") + @get:Schema(title = "水印颜色") var watermarkColor: String? = null, - @ApiModelProperty("水印透明度") + @get:Schema(title = "水印透明度") var watermarkAlpha: String? = null, - @ApiModelProperty("水印宽度") + @get:Schema(title = "水印宽度") var watermarkWidth: String? = null, - @ApiModelProperty("水印高度") + @get:Schema(title = "水印高度") var watermarkHeight: String? = null, - @ApiModelProperty("水印倾斜度数") + @get:Schema(title = "水印倾斜度数") var watermarkAngle: String? = null, -) \ No newline at end of file +) diff --git a/src/backend/preview/api-preview/src/main/kotlin/com/tencent/bkrepo/preview/pojo/cache/PreviewFileCacheCreateRequest.kt b/src/backend/preview/api-preview/src/main/kotlin/com/tencent/bkrepo/preview/pojo/cache/PreviewFileCacheCreateRequest.kt index cbdf94e3a7..2c9f1de6cf 100644 --- a/src/backend/preview/api-preview/src/main/kotlin/com/tencent/bkrepo/preview/pojo/cache/PreviewFileCacheCreateRequest.kt +++ b/src/backend/preview/api-preview/src/main/kotlin/com/tencent/bkrepo/preview/pojo/cache/PreviewFileCacheCreateRequest.kt @@ -31,18 +31,19 @@ package com.tencent.bkrepo.preview.pojo.cache -import io.swagger.annotations.ApiModelProperty + +import io.swagger.v3.oas.annotations.media.Schema import java.time.LocalDateTime data class PreviewFileCacheCreateRequest( - @ApiModelProperty("文件md5") + @get:Schema(title = "文件md5") val md5: String, - @ApiModelProperty("项目id") + @get:Schema(title = "项目id") val projectId: String, - @ApiModelProperty("仓库Name") + @get:Schema(title = "仓库Name") val repoName: String, - @ApiModelProperty("文件路径") + @get:Schema(title = "文件路径") val fullPath: String, - @ApiModelProperty("创建时间") + @get:Schema(title = "创建时间") val createdDate: LocalDateTime? = null, ) diff --git a/src/backend/preview/api-preview/src/main/kotlin/com/tencent/bkrepo/preview/pojo/cache/PreviewFileCacheInfo.kt b/src/backend/preview/api-preview/src/main/kotlin/com/tencent/bkrepo/preview/pojo/cache/PreviewFileCacheInfo.kt index e43e8c5ebc..bf125c87e6 100644 --- a/src/backend/preview/api-preview/src/main/kotlin/com/tencent/bkrepo/preview/pojo/cache/PreviewFileCacheInfo.kt +++ b/src/backend/preview/api-preview/src/main/kotlin/com/tencent/bkrepo/preview/pojo/cache/PreviewFileCacheInfo.kt @@ -31,20 +31,20 @@ package com.tencent.bkrepo.preview.pojo.cache -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + import java.time.LocalDateTime -@ApiModel("预览缓存信息") +@Schema(title = "预览缓存信息") data class PreviewFileCacheInfo( - @ApiModelProperty("文件md5") + @get:Schema(title = "文件md5") var md5: String, - @ApiModelProperty("项目id") + @get:Schema(title = "项目id") val projectId: String, - @ApiModelProperty("仓库Name") + @get:Schema(title = "仓库Name") val repoName: String, - @ApiModelProperty("文件路径") + @get:Schema(title = "文件路径") val fullPath: String, - @ApiModelProperty("创建时间") + @get:Schema(title = "创建时间") val createdDate: LocalDateTime? = null, ) diff --git a/src/backend/pypi/biz-pypi/src/main/kotlin/com/tencent/bkrepo/pypi/controller/PypiResourceController.kt b/src/backend/pypi/biz-pypi/src/main/kotlin/com/tencent/bkrepo/pypi/controller/PypiResourceController.kt index d9f177f60d..612dc2c689 100644 --- a/src/backend/pypi/biz-pypi/src/main/kotlin/com/tencent/bkrepo/pypi/controller/PypiResourceController.kt +++ b/src/backend/pypi/biz-pypi/src/main/kotlin/com/tencent/bkrepo/pypi/controller/PypiResourceController.kt @@ -37,13 +37,13 @@ import com.tencent.bk.audit.annotations.AuditEntry import com.tencent.bk.audit.annotations.AuditInstanceRecord import com.tencent.bkrepo.common.artifact.api.ArtifactFileMap import com.tencent.bkrepo.common.artifact.audit.ActionAuditContent +import com.tencent.bkrepo.common.artifact.audit.NODE_CREATE_ACTION import com.tencent.bkrepo.common.artifact.audit.NODE_DOWNLOAD_ACTION import com.tencent.bkrepo.common.artifact.audit.NODE_RESOURCE -import com.tencent.bkrepo.common.artifact.audit.NODE_CREATE_ACTION import com.tencent.bkrepo.pypi.artifact.PypiArtifactInfo import com.tencent.bkrepo.pypi.artifact.PypiSimpleArtifactInfo import com.tencent.bkrepo.pypi.service.PypiService -import io.swagger.annotations.Api +import io.swagger.v3.oas.annotations.tags.Tag import org.slf4j.LoggerFactory import org.springframework.http.MediaType import org.springframework.web.bind.annotation.GetMapping @@ -53,7 +53,7 @@ import org.springframework.web.bind.annotation.RestController /** * pypi服务接口实现类 */ -@Api("pypi client api") +@Tag(name = "pypi client api") @RestController class PypiResourceController( private var pypiService: PypiService diff --git a/src/backend/pypi/biz-pypi/src/main/kotlin/com/tencent/bkrepo/pypi/controller/PypiWebResourceController.kt b/src/backend/pypi/biz-pypi/src/main/kotlin/com/tencent/bkrepo/pypi/controller/PypiWebResourceController.kt index 309a7532d2..b1f944fe0b 100644 --- a/src/backend/pypi/biz-pypi/src/main/kotlin/com/tencent/bkrepo/pypi/controller/PypiWebResourceController.kt +++ b/src/backend/pypi/biz-pypi/src/main/kotlin/com/tencent/bkrepo/pypi/controller/PypiWebResourceController.kt @@ -44,14 +44,14 @@ import com.tencent.bkrepo.common.service.util.ResponseBuilder import com.tencent.bkrepo.pypi.artifact.PypiArtifactInfo import com.tencent.bkrepo.pypi.service.PypiWebService import com.tencent.bkrepo.repository.pojo.packages.PackageVersion -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RestController -@Api("pypi产品接口") +@Tag(name = "pypi产品接口") @RestController @RequestMapping("/ext") class PypiWebResourceController( @@ -75,7 +75,7 @@ class PypiWebResourceController( scopeId = "#pypiArtifactInfo?.projectId", content = ActionAuditContent.REPO_PACKAGE_DELETE_CONTENT ) - @ApiOperation("pypi包删除接口") + @Operation(summary = "pypi包删除接口") @DeleteMapping(PypiArtifactInfo.PYPI_EXT_PACKAGE_DELETE) fun deletePackage(pypiArtifactInfo: PypiArtifactInfo, packageKey: String): Response { pypiWebService.deletePackage(pypiArtifactInfo, packageKey) @@ -101,7 +101,7 @@ class PypiWebResourceController( scopeId = "#pypiArtifactInfo?.projectId", content = ActionAuditContent.REPO_PACKAGE_VERSION_DELETE_CONTENT ) - @ApiOperation("pypi版本删除接口") + @Operation(summary = "pypi版本删除接口") @DeleteMapping(PypiArtifactInfo.PYPI_EXT_VERSION_DELETE) fun deleteVersion( pypiArtifactInfo: PypiArtifactInfo, @@ -113,7 +113,7 @@ class PypiWebResourceController( return ResponseBuilder.success() } - @ApiOperation("pypi版本详情接口") + @Operation(summary = "pypi版本详情接口") @GetMapping(PypiArtifactInfo.PYPI_EXT_DETAIL) fun artifactDetail( pypiArtifactInfo: PypiArtifactInfo, @@ -123,7 +123,7 @@ class PypiWebResourceController( return ResponseBuilder.success(pypiWebService.artifactDetail(pypiArtifactInfo, packageKey, version)) } - @ApiOperation("pypi包版本列表接口") + @Operation(summary = "pypi包版本列表接口") @GetMapping(PypiArtifactInfo.PYPI_EXT_PACKAGE_LIST) fun versionListPage( pypiArtifactInfo: PypiArtifactInfo, diff --git a/src/backend/pypi/biz-pypi/src/main/kotlin/com/tencent/bkrepo/pypi/util/pojo/PypiInfo.kt b/src/backend/pypi/biz-pypi/src/main/kotlin/com/tencent/bkrepo/pypi/util/pojo/PypiInfo.kt index 23500ac177..30fe43eaa4 100644 --- a/src/backend/pypi/biz-pypi/src/main/kotlin/com/tencent/bkrepo/pypi/util/pojo/PypiInfo.kt +++ b/src/backend/pypi/biz-pypi/src/main/kotlin/com/tencent/bkrepo/pypi/util/pojo/PypiInfo.kt @@ -31,15 +31,15 @@ package com.tencent.bkrepo.pypi.util.pojo -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("pypi info") + +@Schema(title = "pypi info") data class PypiInfo( - @ApiModelProperty("name") + @get:Schema(title = "name") val name: String, - @ApiModelProperty("version") + @get:Schema(title = "version") val version: String, - @ApiModelProperty("summary") + @get:Schema(title = "summary") val summary: String ) diff --git a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/api/ArtifactPushClient.kt b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/api/ArtifactPushClient.kt index 712b991d27..690a6b88c5 100644 --- a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/api/ArtifactPushClient.kt +++ b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/api/ArtifactPushClient.kt @@ -34,8 +34,8 @@ package com.tencent.bkrepo.replication.api import com.tencent.bkrepo.common.api.constant.REPLICATION_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.replication.pojo.remote.request.ArtifactPushRequest -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.context.annotation.Primary import org.springframework.web.bind.annotation.PostMapping @@ -45,12 +45,12 @@ import org.springframework.web.bind.annotation.RequestMapping /** * 制品同步到远端仓库 */ -@Api("制品同步到远端仓库") +@Tag(name = "制品同步到远端仓库") @Primary @FeignClient(REPLICATION_SERVICE_NAME, contextId = "ArtifactPushClient") @RequestMapping("/service/push") interface ArtifactPushClient { - @ApiOperation("推送对应artifact到配置的远端仓库") + @Operation(summary = "推送对应artifact到配置的远端仓库") @PostMapping("/artifact") fun artifactPush(@RequestBody request: ArtifactPushRequest): Response } diff --git a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/api/ClusterNodeClient.kt b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/api/ClusterNodeClient.kt index 9f5fb6cf7c..056e6ca979 100644 --- a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/api/ClusterNodeClient.kt +++ b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/api/ClusterNodeClient.kt @@ -30,14 +30,14 @@ package com.tencent.bkrepo.replication.api import com.tencent.bkrepo.common.api.constant.REPLICATION_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.replication.pojo.cluster.ClusterNodeInfo -import io.swagger.annotations.Api +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.context.annotation.Primary import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable import org.springframework.web.bind.annotation.RequestMapping -@Api("分发服务操作接口") +@Tag(name = "分发服务操作接口") @Primary @FeignClient(REPLICATION_SERVICE_NAME, contextId = "ServiceClusterNodeClient") @RequestMapping("/service/cluster") diff --git a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/api/DistributionClient.kt b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/api/DistributionClient.kt index 8cbaf51f7a..bc8f05fa0d 100644 --- a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/api/DistributionClient.kt +++ b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/api/DistributionClient.kt @@ -29,8 +29,8 @@ package com.tencent.bkrepo.replication.api import com.tencent.bkrepo.common.api.constant.REPLICATION_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.context.annotation.Primary import org.springframework.web.bind.annotation.DeleteMapping @@ -40,12 +40,12 @@ import org.springframework.web.bind.annotation.RequestParam /** * 分发服务操作接口 */ -@Api("分发服务操作接口") +@Tag(name = "分发服务操作接口") @Primary @FeignClient(REPLICATION_SERVICE_NAME, contextId = "DistributionClient") @RequestMapping("/service/distribution") interface DistributionClient { - @ApiOperation("删除已完成的一次性执行任务") + @Operation(summary = "删除已完成的一次性执行任务") @DeleteMapping("/delete") fun deleteRunonceTask( @RequestParam taskName: String diff --git a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/api/ReplicaTaskClient.kt b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/api/ReplicaTaskClient.kt index 770b09f811..32ef4ebcdf 100644 --- a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/api/ReplicaTaskClient.kt +++ b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/api/ReplicaTaskClient.kt @@ -31,21 +31,21 @@ import com.tencent.bkrepo.common.api.constant.REPLICATION_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.replication.pojo.task.ReplicaTaskInfo import com.tencent.bkrepo.replication.pojo.task.request.ReplicaTaskCreateRequest -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.context.annotation.Primary import org.springframework.web.bind.annotation.PostMapping import org.springframework.web.bind.annotation.RequestBody import org.springframework.web.bind.annotation.RequestMapping -@Api("同步任务服务操作接口") +@Tag(name = "同步任务服务操作接口") @Primary @FeignClient(REPLICATION_SERVICE_NAME, contextId = "ReplicaTaskClient") @RequestMapping("/service/task") interface ReplicaTaskClient { - @ApiOperation("创建任务") + @Operation(summary = "创建任务") @PostMapping("/create") fun create(@RequestBody request: ReplicaTaskCreateRequest): Response diff --git a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/api/ReplicaTaskOperationClient.kt b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/api/ReplicaTaskOperationClient.kt index d586adc5ab..cd148a9f9e 100644 --- a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/api/ReplicaTaskOperationClient.kt +++ b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/api/ReplicaTaskOperationClient.kt @@ -30,7 +30,7 @@ package com.tencent.bkrepo.replication.api import com.tencent.bkrepo.common.api.constant.REPLICATION_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.replication.pojo.remote.request.RemoteRunOnceTaskCreateRequest -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Parameter import org.springframework.cloud.openfeign.FeignClient import org.springframework.web.bind.annotation.PathVariable import org.springframework.web.bind.annotation.PostMapping @@ -47,9 +47,9 @@ interface ReplicaTaskOperationClient { */ @PostMapping("/create/runOnceTask/{projectId}/{repoName}") fun createRunOnceTask( - @ApiParam(value = "仓库ID") + @Parameter(name = "仓库ID") @PathVariable projectId: String, - @ApiParam(value = "项目ID") + @Parameter(name = "项目ID") @PathVariable repoName: String, @RequestBody requests: RemoteRunOnceTaskCreateRequest ): Response @@ -59,10 +59,10 @@ interface ReplicaTaskOperationClient { */ @PostMapping("/execute/runOnceTask/{projectId}/{repoName}") fun executeRunOnceTask( - @ApiParam(value = "仓库ID") + @Parameter(name = "仓库ID") @PathVariable projectId: String, - @ApiParam(value = "项目ID") + @Parameter(name = "项目ID") @PathVariable repoName: String, @RequestParam name: String, ): Response -} \ No newline at end of file +} diff --git a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/api/cluster/ClusterReplicaTaskClient.kt b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/api/cluster/ClusterReplicaTaskClient.kt index e595f8797e..d8695e84ee 100644 --- a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/api/cluster/ClusterReplicaTaskClient.kt +++ b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/api/cluster/ClusterReplicaTaskClient.kt @@ -33,7 +33,7 @@ import com.tencent.bkrepo.replication.pojo.request.ReplicaType import com.tencent.bkrepo.replication.pojo.task.EdgeReplicaTaskRecord import com.tencent.bkrepo.replication.pojo.task.ReplicaTaskInfo import com.tencent.bkrepo.replication.pojo.task.objects.ReplicaObjectInfo -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation import org.springframework.cloud.openfeign.FeignClient import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable @@ -47,11 +47,11 @@ import org.springframework.web.context.request.async.DeferredResult @FeignClient(REPLICATION_SERVICE_NAME, contextId = "ClusterReplicaTaskClient") interface ClusterReplicaTaskClient { - @ApiOperation("查询同步任务") + @Operation(summary = "查询同步任务") @GetMapping("/info/{taskId}") fun info(@PathVariable taskId: String): Response - @ApiOperation("查询同步任务列表") + @Operation(summary = "查询同步任务列表") @GetMapping("/list/{replicaType}") fun list( @PathVariable replicaType: ReplicaType, @@ -59,18 +59,18 @@ interface ClusterReplicaTaskClient { @RequestParam size: Int ): Response> - @ApiOperation("查询同步任务对象") + @Operation(summary = "查询同步任务对象") @GetMapping("/object/list/{taskKey}") fun listObject(@PathVariable taskKey: String): Response> - @ApiOperation("认领Edge分发任务") + @Operation(summary = "认领Edge分发任务") @GetMapping("/edge/claim") fun getEdgeReplicaTask( @RequestParam clusterName: String, @RequestParam replicatingNum: Int ): DeferredResult> - @ApiOperation("上报Edge分发任务结果") + @Operation(summary = "上报Edge分发任务结果") @PostMapping("/edge/report") fun reportEdgeReplicaTaskResult(@RequestBody edgeReplicaTaskRecord: EdgeReplicaTaskRecord): Response } diff --git a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/cluster/ClusterListOption.kt b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/cluster/ClusterListOption.kt index 1d23d33e17..13ff3d9bcb 100644 --- a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/cluster/ClusterListOption.kt +++ b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/cluster/ClusterListOption.kt @@ -30,17 +30,17 @@ package com.tencent.bkrepo.replication.pojo.cluster import com.tencent.bkrepo.common.api.constant.DEFAULT_PAGE_NUMBER import com.tencent.bkrepo.common.api.constant.DEFAULT_PAGE_SIZE import com.tencent.bkrepo.common.api.pojo.ClusterNodeType -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("节点列表选项") + +@Schema(title = "节点列表选项") class ClusterListOption( - @ApiModelProperty("当前页") + @get:Schema(title = "当前页") val pageNumber: Int = DEFAULT_PAGE_NUMBER, - @ApiModelProperty("分页大小") + @get:Schema(title = "分页大小") val pageSize: Int = DEFAULT_PAGE_SIZE, - @ApiModelProperty("节点名称, 根据该字段模糊搜索") + @get:Schema(title = "节点名称, 根据该字段模糊搜索") val name: String? = null, - @ApiModelProperty("节点类型") + @get:Schema(title = "节点类型") val type: ClusterNodeType? = null ) diff --git a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/cluster/ClusterNodeInfo.kt b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/cluster/ClusterNodeInfo.kt index 91b8297f39..d946adfd88 100644 --- a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/cluster/ClusterNodeInfo.kt +++ b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/cluster/ClusterNodeInfo.kt @@ -30,55 +30,55 @@ package com.tencent.bkrepo.replication.pojo.cluster import com.fasterxml.jackson.annotation.JsonIgnore import com.tencent.bkrepo.common.api.pojo.ClusterNodeType import com.tencent.bkrepo.replication.pojo.cluster.request.DetectType -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + import java.time.LocalDateTime /** * 集群节点信息 */ -@ApiModel("集群节点信息") +@Schema(title = "集群节点信息") data class ClusterNodeInfo( - @ApiModelProperty("集群id") + @get:Schema(title = "集群id") val id: String?, - @ApiModelProperty("集群名称") + @get:Schema(title = "集群名称") val name: String, - @ApiModelProperty("集群节点类型") + @get:Schema(title = "集群节点类型") val status: ClusterNodeStatus, - @ApiModelProperty("集群状态为非健康时显示失败原因") + @get:Schema(title = "集群状态为非健康时显示失败原因") val errorReason: String?, - @ApiModelProperty("集群节点类型") + @get:Schema(title = "集群节点类型") val type: ClusterNodeType, - @ApiModelProperty("集群地址") + @get:Schema(title = "集群地址") val url: String, - @ApiModelProperty("集群访问用户名，独立集群需要此字段") + @get:Schema(title = "集群访问用户名，独立集群需要此字段") val username: String?, - @ApiModelProperty("集群访问密码，独立集群需要此字段") + @get:Schema(title = "集群访问密码，独立集群需要此字段") @JsonIgnore val password: String?, - @ApiModelProperty("集群的证书，独立集群需要此字段") + @get:Schema(title = "集群的证书，独立集群需要此字段") val certificate: String?, - @ApiModelProperty("集群appId", required = false) + @get:Schema(title = "集群appId", required = false) var appId: String? = null, - @ApiModelProperty("集群访问凭证", required = false) + @get:Schema(title = "集群访问凭证", required = false) var accessKey: String? = null, - @ApiModelProperty("集群密钥", required = false) + @get:Schema(title = "集群密钥", required = false) @JsonIgnore var secretKey: String? = null, - @ApiModelProperty("udp端口", required = false) + @get:Schema(title = "udp端口", required = false) var udpPort: Int? = null, - @ApiModelProperty("创建者") + @get:Schema(title = "创建者") val createdBy: String, - @ApiModelProperty("集群额外信息") + @get:Schema(title = "集群额外信息") var extension: Map? = null, - @ApiModelProperty("创建日期") + @get:Schema(title = "创建日期") val createdDate: String, - @ApiModelProperty("上次修改者") + @get:Schema(title = "上次修改者") val lastModifiedBy: String, - @ApiModelProperty("上次修改日期") + @get:Schema(title = "上次修改日期") val lastModifiedDate: String, - @ApiModelProperty("节点连通性检测方式") + @get:Schema(title = "节点连通性检测方式") val detectType: DetectType?, - @ApiModelProperty("最近上报心跳时间") + @get:Schema(title = "最近上报心跳时间") val lastReportTime: LocalDateTime? ) diff --git a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/cluster/request/ClusterNodeCreateRequest.kt b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/cluster/request/ClusterNodeCreateRequest.kt index 1ef78f08ac..e82c52baa3 100644 --- a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/cluster/request/ClusterNodeCreateRequest.kt +++ b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/cluster/request/ClusterNodeCreateRequest.kt @@ -28,36 +28,36 @@ package com.tencent.bkrepo.replication.pojo.cluster.request import com.tencent.bkrepo.common.api.pojo.ClusterNodeType -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 添加集群节点请求 */ -@ApiModel("添加集群节点请求") +@Schema(title = "添加集群节点请求") class ClusterNodeCreateRequest( - @ApiModelProperty("添加的集群名称", required = true) + @get:Schema(title = "添加的集群名称", required = true) var name: String, - @ApiModelProperty("集群地址", required = true) + @get:Schema(title = "集群地址", required = true) var url: String, - @ApiModelProperty("集群的证书", required = false) + @get:Schema(title = "集群的证书", required = false) var certificate: String? = null, - @ApiModelProperty("集群认证用户名", required = false) + @get:Schema(title = "集群认证用户名", required = false) var username: String? = null, - @ApiModelProperty("集群认证密码", required = false) + @get:Schema(title = "集群认证密码", required = false) var password: String? = null, - @ApiModelProperty("集群appId", required = false) + @get:Schema(title = "集群appId", required = false) var appId: String? = null, - @ApiModelProperty("集群访问凭证", required = false) + @get:Schema(title = "集群访问凭证", required = false) var accessKey: String? = null, - @ApiModelProperty("集群密钥", required = false) + @get:Schema(title = "集群密钥", required = false) var secretKey: String? = null, - @ApiModelProperty("集群节点类型", required = true) + @get:Schema(title = "集群节点类型", required = true) var type: ClusterNodeType, - @ApiModelProperty("创建节点时是否检测连通性", required = false) + @get:Schema(title = "创建节点时是否检测连通性", required = false) var ping: Boolean = true, - @ApiModelProperty("连通性检测方式", required = true) + @get:Schema(title = "连通性检测方式", required = true) var detectType: DetectType = DetectType.PING, - @ApiModelProperty("udp port", required = false) + @get:Schema(title = "udp port", required = false) var udpPort: Int? = null, ) diff --git a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/cluster/request/ClusterNodeStatusUpdateRequest.kt b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/cluster/request/ClusterNodeStatusUpdateRequest.kt index 1f120bd938..0f99c92a9b 100644 --- a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/cluster/request/ClusterNodeStatusUpdateRequest.kt +++ b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/cluster/request/ClusterNodeStatusUpdateRequest.kt @@ -28,20 +28,20 @@ package com.tencent.bkrepo.replication.pojo.cluster.request import com.tencent.bkrepo.replication.pojo.cluster.ClusterNodeStatus -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 更新集群节点请求 */ -@ApiModel("更新集群节点请求") +@Schema(title = "更新集群节点请求") data class ClusterNodeStatusUpdateRequest( - @ApiModelProperty("集群名称", required = true) + @get:Schema(title = "集群名称", required = true) val name: String, - @ApiModelProperty("集群状态", required = false) + @get:Schema(title = "集群状态", required = false) val status: ClusterNodeStatus = ClusterNodeStatus.HEALTHY, - @ApiModelProperty("状态为非健康时显示失败原因", required = false) + @get:Schema(title = "状态为非健康时显示失败原因", required = false) val errorReason: String? = null, - @ApiModelProperty("操作用户", required = true) + @get:Schema(title = "操作用户", required = true) val operator: String ) diff --git a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/cluster/request/ClusterNodeUpdateRequest.kt b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/cluster/request/ClusterNodeUpdateRequest.kt index f0a1dedadc..97515da5e7 100644 --- a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/cluster/request/ClusterNodeUpdateRequest.kt +++ b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/cluster/request/ClusterNodeUpdateRequest.kt @@ -28,33 +28,33 @@ package com.tencent.bkrepo.replication.pojo.cluster.request import com.tencent.bkrepo.common.api.pojo.ClusterNodeType -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 更新集群节点请求 */ -@ApiModel("更新集群节点请求") +@Schema(title = "更新集群节点请求") data class ClusterNodeUpdateRequest( - @ApiModelProperty("添加的集群名称", required = true) + @get:Schema(title = "添加的集群名称", required = true) var name: String, - @ApiModelProperty("集群地址", required = false) + @get:Schema(title = "集群地址", required = false) var url: String? = null, - @ApiModelProperty("集群的证书", required = false) + @get:Schema(title = "集群的证书", required = false) var certificate: String? = null, - @ApiModelProperty("集群认证用户名", required = false) + @get:Schema(title = "集群认证用户名", required = false) var username: String? = null, - @ApiModelProperty("集群认证密码", required = false) + @get:Schema(title = "集群认证密码", required = false) var password: String? = null, - @ApiModelProperty("集群节点类型", required = true) + @get:Schema(title = "集群节点类型", required = true) var type: ClusterNodeType, - @ApiModelProperty("连通性检测方式", required = true) + @get:Schema(title = "连通性检测方式", required = true) var detectType: DetectType? = null, - @ApiModelProperty("集群appId", required = false) + @get:Schema(title = "集群appId", required = false) var appId: String? = null, - @ApiModelProperty("集群访问凭证", required = false) + @get:Schema(title = "集群访问凭证", required = false) var accessKey: String? = null, - @ApiModelProperty("集群密钥", required = false) + @get:Schema(title = "集群密钥", required = false) var secretKey: String? = null, - @ApiModelProperty("udp port", required = false) + @get:Schema(title = "udp port", required = false) var udpPort: Int? = null, ) diff --git a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/docker/OciErrorResponse.kt b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/docker/OciErrorResponse.kt index 675eab257c..a7580e9edb 100644 --- a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/docker/OciErrorResponse.kt +++ b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/docker/OciErrorResponse.kt @@ -27,13 +27,14 @@ package com.tencent.bkrepo.replication.pojo.docker -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + data class OciErrorResponse( - @ApiModelProperty("错误提示") + @get:Schema(title = "错误提示") val message: String?, - @ApiModelProperty("编码") + @get:Schema(title = "编码") val code: Any?, - @ApiModelProperty("详情") + @get:Schema(title = "详情") val detail: String? ) diff --git a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/record/ReplicaRecordDetail.kt b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/record/ReplicaRecordDetail.kt index a804f2b9a7..8868a10d14 100644 --- a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/record/ReplicaRecordDetail.kt +++ b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/record/ReplicaRecordDetail.kt @@ -31,46 +31,45 @@ import com.tencent.bkrepo.common.artifact.pojo.RepositoryType import com.tencent.bkrepo.replication.pojo.task.objects.PackageConstraint import com.tencent.bkrepo.replication.pojo.task.objects.PathConstraint import com.tencent.bkrepo.replication.pojo.task.setting.ConflictStrategy -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema import java.time.LocalDateTime -@ApiModel("同步任务执行记录详情") +@Schema(title = "同步任务执行记录详情") data class ReplicaRecordDetail( - @ApiModelProperty("详情id") + @get:Schema(title = "详情id") var id: String, - @ApiModelProperty("记录id") + @get:Schema(title = "记录id") var recordId: String, - @ApiModelProperty("本地集群名称") + @get:Schema(title = "本地集群名称") var localCluster: String, - @ApiModelProperty("远程集群名称") + @get:Schema(title = "远程集群名称") var remoteCluster: String, - @ApiModelProperty("本地仓库名称") + @get:Schema(title = "本地仓库名称") var localRepoName: String, - @ApiModelProperty("仓库类型") + @get:Schema(title = "仓库类型") val repoType: RepositoryType, - @ApiModelProperty("包限制") + @get:Schema(title = "包限制") var packageConstraint: PackageConstraint? = null, - @ApiModelProperty("路径名称") + @get:Schema(title = "路径名称") var pathConstraint: PathConstraint? = null, - @ApiModelProperty("制品名称") + @get:Schema(title = "制品名称") var artifactName: String? = null, - @ApiModelProperty("包版本") + @get:Schema(title = "包版本") var version: String? = null, - @ApiModelProperty("冲突策略") + @get:Schema(title = "冲突策略") var conflictStrategy: ConflictStrategy? = null, - @ApiModelProperty("制品大小") + @get:Schema(title = "制品大小") var size: Long? = null, - @ApiModelProperty("制品sha256") + @get:Schema(title = "制品sha256") var sha256: String? = null, - @ApiModelProperty("运行状态") + @get:Schema(title = "运行状态") var status: ExecutionStatus, - @ApiModelProperty("同步进度") + @get:Schema(title = "同步进度") var progress: ReplicaProgress, - @ApiModelProperty("开始时间") + @get:Schema(title = "开始时间") var startTime: LocalDateTime, - @ApiModelProperty("结束时间") + @get:Schema(title = "结束时间") var endTime: LocalDateTime? = null, - @ApiModelProperty("错误原因，未执行或执行成功则为null") + @get:Schema(title = "错误原因，未执行或执行成功则为null") var errorReason: String? = null ) diff --git a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/record/ReplicaRecordDetailListOption.kt b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/record/ReplicaRecordDetailListOption.kt index 8c31aa7fa4..5631191a24 100644 --- a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/record/ReplicaRecordDetailListOption.kt +++ b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/record/ReplicaRecordDetailListOption.kt @@ -29,27 +29,27 @@ package com.tencent.bkrepo.replication.pojo.record import com.tencent.bkrepo.common.api.constant.DEFAULT_PAGE_NUMBER import com.tencent.bkrepo.common.api.constant.DEFAULT_PAGE_SIZE -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("执行日志详情列表选项") + +@Schema(title = "执行日志详情列表选项") class ReplicaRecordDetailListOption( - @ApiModelProperty("当前页") + @get:Schema(title = "当前页") val pageNumber: Int = DEFAULT_PAGE_NUMBER, - @ApiModelProperty("分页大小") + @get:Schema(title = "分页大小") val pageSize: Int = DEFAULT_PAGE_SIZE, - @ApiModelProperty("包名称, 根据该字段模糊搜索") + @get:Schema(title = "包名称, 根据该字段模糊搜索") val packageName: String? = null, - @ApiModelProperty("仓库名称") + @get:Schema(title = "仓库名称") val repoName: String? = null, - @ApiModelProperty("远程节点名称") + @get:Schema(title = "远程节点名称") val clusterName: String? = null, - @ApiModelProperty("路径名称, 根据该字段前缀匹配") + @get:Schema(title = "路径名称, 根据该字段前缀匹配") val path: String? = null, - @ApiModelProperty("执行状态") + @get:Schema(title = "执行状态") val status: ExecutionStatus? = null, - @ApiModelProperty("制品名称") + @get:Schema(title = "制品名称") var artifactName: String? = null, - @ApiModelProperty("版本") + @get:Schema(title = "版本") var version: String? = null ) diff --git a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/record/ReplicaRecordInfo.kt b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/record/ReplicaRecordInfo.kt index d47d7a61d9..a16661cfc1 100644 --- a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/record/ReplicaRecordInfo.kt +++ b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/record/ReplicaRecordInfo.kt @@ -27,28 +27,27 @@ package com.tencent.bkrepo.replication.pojo.record -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema import java.time.LocalDateTime -@ApiModel("同步任务执行记录") +@Schema(title = "同步任务执行记录") data class ReplicaRecordInfo( - @ApiModelProperty("记录唯一id") + @get:Schema(title = "记录唯一id") val id: String, - @ApiModelProperty("关联任务key") + @get:Schema(title = "关联任务key") val taskKey: String, - @ApiModelProperty("任务状态") + @get:Schema(title = "任务状态") var status: ExecutionStatus, - @ApiModelProperty("开始时间") + @get:Schema(title = "开始时间") var startTime: LocalDateTime, - @ApiModelProperty("结束时间") + @get:Schema(title = "结束时间") var endTime: LocalDateTime? = null, - @ApiModelProperty("错误原因，未执行或执行成功则为null") + @get:Schema(title = "错误原因，未执行或执行成功则为null") var errorReason: String? = null, - @ApiModelProperty("已同步字节数") + @get:Schema(title = "已同步字节数") var replicatedBytes: Long? = 0, - @ApiModelProperty("总字节数") + @get:Schema(title = "总字节数") var totalBytes: Long? = 0, - @ApiModelProperty("执行结果总览") + @get:Schema(title = "执行结果总览") var replicaOverview: ReplicaOverview? = null ) diff --git a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/record/ReplicaRecordListOption.kt b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/record/ReplicaRecordListOption.kt index 61ca07623f..569de825c0 100644 --- a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/record/ReplicaRecordListOption.kt +++ b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/record/ReplicaRecordListOption.kt @@ -29,15 +29,15 @@ package com.tencent.bkrepo.replication.pojo.record import com.tencent.bkrepo.common.api.constant.DEFAULT_PAGE_NUMBER import com.tencent.bkrepo.common.api.constant.DEFAULT_PAGE_SIZE -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("执行日志详情列表选项") + +@Schema(title = "执行日志详情列表选项") data class ReplicaRecordListOption( - @ApiModelProperty("当前页") + @get:Schema(title = "当前页") val pageNumber: Int = DEFAULT_PAGE_NUMBER, - @ApiModelProperty("分页大小") + @get:Schema(title = "分页大小") val pageSize: Int = DEFAULT_PAGE_SIZE, - @ApiModelProperty("执行状态") + @get:Schema(title = "执行状态") val status: ExecutionStatus? = null ) diff --git a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/record/ReplicaTaskRecordInfo.kt b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/record/ReplicaTaskRecordInfo.kt index 5b4a5f00c6..1b5e97e68b 100644 --- a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/record/ReplicaTaskRecordInfo.kt +++ b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/record/ReplicaTaskRecordInfo.kt @@ -29,15 +29,15 @@ package com.tencent.bkrepo.replication.pojo.record import com.tencent.bkrepo.replication.pojo.request.ReplicaObjectType import com.tencent.bkrepo.replication.pojo.request.ReplicaType -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("执行记录和任务信息") + +@Schema(title = "执行记录和任务信息") data class ReplicaTaskRecordInfo( - @ApiModelProperty("同步对象类型") + @get:Schema(title = "同步对象类型") val replicaObjectType: ReplicaObjectType, - @ApiModelProperty("同步类型") + @get:Schema(title = "同步类型") val replicaType: ReplicaType, - @ApiModelProperty("执行记录信息") + @get:Schema(title = "执行记录信息") val record: ReplicaRecordInfo ) diff --git a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/record/request/RecordDetailInitialRequest.kt b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/record/request/RecordDetailInitialRequest.kt index 442c93291a..7590d22ad3 100644 --- a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/record/request/RecordDetailInitialRequest.kt +++ b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/record/request/RecordDetailInitialRequest.kt @@ -31,31 +31,31 @@ import com.tencent.bkrepo.common.artifact.pojo.RepositoryType import com.tencent.bkrepo.replication.pojo.task.objects.PackageConstraint import com.tencent.bkrepo.replication.pojo.task.objects.PathConstraint import com.tencent.bkrepo.replication.pojo.task.setting.ConflictStrategy -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("同步详情初始化请求") + +@Schema(title = "同步详情初始化请求") data class RecordDetailInitialRequest( - @ApiModelProperty("记录id") + @get:Schema(title = "记录id") val recordId: String, - @ApiModelProperty("远程集群名称") + @get:Schema(title = "远程集群名称") val remoteCluster: String, - @ApiModelProperty("本地仓库名称") + @get:Schema(title = "本地仓库名称") val localRepoName: String, - @ApiModelProperty("本地仓库类型") + @get:Schema(title = "本地仓库类型") val repoType: RepositoryType, - @ApiModelProperty("包限制") + @get:Schema(title = "包限制") var packageConstraint: PackageConstraint? = null, - @ApiModelProperty("路径名称") + @get:Schema(title = "路径名称") var pathConstraint: PathConstraint? = null, - @ApiModelProperty("制品名称") + @get:Schema(title = "制品名称") var artifactName: String? = null, - @ApiModelProperty("版本") + @get:Schema(title = "版本") var version: String? = null, - @ApiModelProperty("冲突策略") + @get:Schema(title = "冲突策略") var conflictStrategy: ConflictStrategy? = null, - @ApiModelProperty("制品大小") + @get:Schema(title = "制品大小") var size: Long? = null, - @ApiModelProperty("制品sha256值") + @get:Schema(title = "制品sha256值") var sha256: String? = null ) diff --git a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/remote/request/ArtifactPushRequest.kt b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/remote/request/ArtifactPushRequest.kt index 4f79c874b2..32efb501c5 100644 --- a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/remote/request/ArtifactPushRequest.kt +++ b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/remote/request/ArtifactPushRequest.kt @@ -27,24 +27,24 @@ package com.tencent.bkrepo.replication.pojo.remote.request -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * Artifact推送到远端仓库请求 */ -@ApiModel("Artifact推送到远端仓库请求") +@Schema(title = "Artifact推送到远端仓库请求") data class ArtifactPushRequest( - @ApiModelProperty("项目id") + @get:Schema(title = "项目id") val projectId: String, - @ApiModelProperty("仓库名") + @get:Schema(title = "仓库名") val repoName: String, - @ApiModelProperty("Package key") + @get:Schema(title = "Package key") val packageKey: String, - @ApiModelProperty("Package版本名") + @get:Schema(title = "Package版本名") val packageVersion: String, - @ApiModelProperty("Package名") + @get:Schema(title = "Package名") var packageName: String, - @ApiModelProperty("Package类型") + @get:Schema(title = "Package类型") var packageType: String ) diff --git a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/remote/request/RemoteConfigCreateRequest.kt b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/remote/request/RemoteConfigCreateRequest.kt index cfe6a9eeac..bbcecb5b52 100644 --- a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/remote/request/RemoteConfigCreateRequest.kt +++ b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/remote/request/RemoteConfigCreateRequest.kt @@ -32,48 +32,48 @@ import com.tencent.bkrepo.replication.pojo.request.ReplicaType import com.tencent.bkrepo.replication.pojo.task.objects.PackageConstraint import com.tencent.bkrepo.replication.pojo.task.objects.PathConstraint import com.tencent.bkrepo.replication.pojo.task.setting.ReplicaSetting -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 添加远端集群以及相关信息请求 */ -@ApiModel("添加远端集群以及相关信息请求") +@Schema(title = "添加远端集群以及相关信息请求") data class RemoteConfigCreateRequest( - @ApiModelProperty("名称", required = true) + @get:Schema(title = "名称", required = true) var name: String, // registry与clusterId是二选一 - @ApiModelProperty("集群id", required = false) + @get:Schema(title = "集群id", required = false) var clusterId: String? = null, - @ApiModelProperty("集群地址", required = false) + @get:Schema(title = "集群地址", required = false) var registry: String? = null, - @ApiModelProperty("集群的证书", required = false) + @get:Schema(title = "集群的证书", required = false) var certificate: String? = null, - @ApiModelProperty("集群认证用户名", required = false) + @get:Schema(title = "集群认证用户名", required = false) var username: String? = null, - @ApiModelProperty("集群认证密码", required = false) + @get:Schema(title = "集群认证密码", required = false) var password: String? = null, - @ApiModelProperty("用于执行分发任务时在目标集群进行认证的用户名", required = false) + @get:Schema(title = "用于执行分发任务时在目标集群进行认证的用户名", required = false) var remoteUserUsername: String? = null, - @ApiModelProperty("用于执行分发任务时在目标集群进行认证的密码", required = false) + @get:Schema(title = "用于执行分发任务时在目标集群进行认证的密码", required = false) var remoteUserPassword: String? = null, // 异构集群分发时以下remoteProjectId/remoteRepoName不需要 - @ApiModelProperty("远程项目") + @get:Schema(title = "远程项目") val remoteProjectId: String? = null, - @ApiModelProperty("远程仓库") + @get:Schema(title = "远程仓库") val remoteRepoName: String? = null, - @ApiModelProperty("同步对象类型, 只支持clusterId存在的情况", required = true) + @get:Schema(title = "同步对象类型, 只支持clusterId存在的情况", required = true) val replicaObjectType: ReplicaObjectType? = null, - @ApiModelProperty("包限制条件", required = false) + @get:Schema(title = "包限制条件", required = false) val packageConstraints: List? = null, - @ApiModelProperty("路径限制条件", required = false) + @get:Schema(title = "路径限制条件", required = false) val pathConstraints: List? = null, - @ApiModelProperty("同步类型", required = false) + @get:Schema(title = "同步类型", required = false) val replicaType: ReplicaType = ReplicaType.REAL_TIME, - @ApiModelProperty("任务设置", required = false) + @get:Schema(title = "任务设置", required = false) val setting: ReplicaSetting = ReplicaSetting(), - @ApiModelProperty("任务描述", required = false) + @get:Schema(title = "任务描述", required = false) val description: String? = null, - @ApiModelProperty("是否启用，默认开启", required = false) + @get:Schema(title = "是否启用，默认开启", required = false) var enable: Boolean = true ) diff --git a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/remote/request/RemoteConfigUpdateRequest.kt b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/remote/request/RemoteConfigUpdateRequest.kt index 369bd34408..f29f9d6787 100644 --- a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/remote/request/RemoteConfigUpdateRequest.kt +++ b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/remote/request/RemoteConfigUpdateRequest.kt @@ -32,46 +32,46 @@ import com.tencent.bkrepo.replication.pojo.request.ReplicaType import com.tencent.bkrepo.replication.pojo.task.objects.PackageConstraint import com.tencent.bkrepo.replication.pojo.task.objects.PathConstraint import com.tencent.bkrepo.replication.pojo.task.setting.ReplicaSetting -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 更新远端集群以及相关信息请求 */ -@ApiModel("更新远端集群以及相关信息请求") +@Schema(title = "更新远端集群以及相关信息请求") data class RemoteConfigUpdateRequest( // registry与clusterId是二选一 - @ApiModelProperty("集群id", required = false) + @get:Schema(title = "集群id", required = false) var clusterId: String? = null, - @ApiModelProperty("集群地址", required = false) + @get:Schema(title = "集群地址", required = false) var registry: String? = null, - @ApiModelProperty("集群的证书", required = false) + @get:Schema(title = "集群的证书", required = false) var certificate: String? = null, - @ApiModelProperty("集群认证用户名", required = false) + @get:Schema(title = "集群认证用户名", required = false) var username: String? = null, - @ApiModelProperty("集群认证密码", required = false) + @get:Schema(title = "集群认证密码", required = false) var password: String? = null, - @ApiModelProperty("用于执行分发任务时在远程集群进行认证的用户名", required = false) + @get:Schema(title = "用于执行分发任务时在远程集群进行认证的用户名", required = false) var remoteUserUsername: String? = null, - @ApiModelProperty("用于执行分发任务时在远程集群进行认证的密码", required = false) + @get:Schema(title = "用于执行分发任务时在远程集群进行认证的密码", required = false) var remoteUserPassword: String? = null, // 异构集群分发时以下remoteProjectId/remoteRepoName不需要 - @ApiModelProperty("远程项目") + @get:Schema(title = "远程项目") val remoteProjectId: String? = null, - @ApiModelProperty("远程仓库") + @get:Schema(title = "远程仓库") val remoteRepoName: String? = null, - @ApiModelProperty("同步对象类型, 只支持clusterId存在的情况", required = true) + @get:Schema(title = "同步对象类型, 只支持clusterId存在的情况", required = true) val replicaObjectType: ReplicaObjectType? = null, - @ApiModelProperty("包限制条件", required = false) + @get:Schema(title = "包限制条件", required = false) val packageConstraints: List? = null, - @ApiModelProperty("路径限制条件", required = false) + @get:Schema(title = "路径限制条件", required = false) val pathConstraints: List? = null, - @ApiModelProperty("同步类型", required = false) + @get:Schema(title = "同步类型", required = false) val replicaType: ReplicaType = ReplicaType.REAL_TIME, - @ApiModelProperty("任务设置", required = false) + @get:Schema(title = "任务设置", required = false) val setting: ReplicaSetting = ReplicaSetting(), - @ApiModelProperty("任务描述", required = false) + @get:Schema(title = "任务描述", required = false) val description: String? = null, - @ApiModelProperty("是否启用，默认开启", required = false) + @get:Schema(title = "是否启用，默认开启", required = false) var enable: Boolean = true ) diff --git a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/remote/request/RemoteCreateRequest.kt b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/remote/request/RemoteCreateRequest.kt index 63758a40d5..85bae6fc2f 100644 --- a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/remote/request/RemoteCreateRequest.kt +++ b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/remote/request/RemoteCreateRequest.kt @@ -27,14 +27,14 @@ package com.tencent.bkrepo.replication.pojo.remote.request -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 添加远端集群请求 */ -@ApiModel("添加远端集群请求") +@Schema(title = "添加远端集群请求") data class RemoteCreateRequest( - @ApiModelProperty("配置列表", required = true) + @get:Schema(title = "配置列表", required = true) val configs: List ) diff --git a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/remote/request/RemoteRunOnceTaskCreateRequest.kt b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/remote/request/RemoteRunOnceTaskCreateRequest.kt index 0253e8a1aa..9c43c2dca9 100644 --- a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/remote/request/RemoteRunOnceTaskCreateRequest.kt +++ b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/remote/request/RemoteRunOnceTaskCreateRequest.kt @@ -30,50 +30,50 @@ package com.tencent.bkrepo.replication.pojo.remote.request import com.tencent.bkrepo.replication.pojo.request.ReplicaObjectType import com.tencent.bkrepo.replication.pojo.request.ReplicaType import com.tencent.bkrepo.replication.pojo.task.setting.ReplicaSetting -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 创建一次性任务以及相关信息请求 */ -@ApiModel("创建一次性任务以及相关信息请求") +@Schema(title = "创建一次性任务以及相关信息请求") data class RemoteRunOnceTaskCreateRequest( - @ApiModelProperty("名称", required = true) + @get:Schema(title = "名称", required = true) var name: String, // registry与clusterId是二选一 - @ApiModelProperty("集群id", required = false) + @get:Schema(title = "集群id", required = false) var clusterId: String? = null, - @ApiModelProperty("集群地址", required = false) + @get:Schema(title = "集群地址", required = false) var registry: String? = null, - @ApiModelProperty("集群认证用户名", required = false) + @get:Schema(title = "集群认证用户名", required = false) var username: String? = null, - @ApiModelProperty("集群认证密码", required = false) + @get:Schema(title = "集群认证密码", required = false) var password: String? = null, - @ApiModelProperty("用于执行分发任务时在远程集群进行认证的用户名", required = false) + @get:Schema(title = "用于执行分发任务时在远程集群进行认证的用户名", required = false) var remoteUserUsername: String? = null, - @ApiModelProperty("用于执行分发任务时在远程集群进行认证的密码", required = false) + @get:Schema(title = "用于执行分发任务时在远程集群进行认证的密码", required = false) var remoteUserPassword: String? = null, // 异构集群分发时以下remoteProjectId/remoteRepoName不需要 - @ApiModelProperty("远程项目") + @get:Schema(title = "远程项目") val remoteProjectId: String? = null, - @ApiModelProperty("远程仓库") + @get:Schema(title = "远程仓库") val remoteRepoName: String? = null, - @ApiModelProperty("同步对象类型, 只支持clusterId存在的情况", required = true) + @get:Schema(title = "同步对象类型, 只支持clusterId存在的情况", required = true) val replicaObjectType: ReplicaObjectType? = null, - @ApiModelProperty("包名", required = false) + @get:Schema(title = "包名", required = false) val packageName: String? = null, - @ApiModelProperty("包版本", required = false) + @get:Schema(title = "包版本", required = false) val versions: List? = null, - @ApiModelProperty("推送目标版本,只有当包版本数量为1时才可以设置，仅针对镜像类型", required = false) + @get:Schema(title = "推送目标版本,只有当包版本数量为1时才可以设置，仅针对镜像类型", required = false) val targetVersions: List? = null, - @ApiModelProperty("推送路径") + @get:Schema(title = "推送路径") val pathConstraints: List? = null, - @ApiModelProperty("同步类型", required = false) + @get:Schema(title = "同步类型", required = false) val replicaType: ReplicaType = ReplicaType.RUN_ONCE, - @ApiModelProperty("任务设置", required = false) + @get:Schema(title = "任务设置", required = false) val setting: ReplicaSetting = ReplicaSetting(), - @ApiModelProperty("任务描述", required = false) + @get:Schema(title = "任务描述", required = false) val description: String? = null, - @ApiModelProperty("是否启用，默认开启", required = false) + @get:Schema(title = "是否启用，默认开启", required = false) var enable: Boolean = true ) diff --git a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/ReplicaTaskDetail.kt b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/ReplicaTaskDetail.kt index 05ec652a2f..c86ebb81ca 100644 --- a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/ReplicaTaskDetail.kt +++ b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/ReplicaTaskDetail.kt @@ -28,13 +28,13 @@ package com.tencent.bkrepo.replication.pojo.task import com.tencent.bkrepo.replication.pojo.task.objects.ReplicaObjectInfo -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("同步任务详情") + +@Schema(title = "同步任务详情") data class ReplicaTaskDetail( - @ApiModelProperty("同步任务基础信息") + @get:Schema(title = "同步任务基础信息") val task: ReplicaTaskInfo, - @ApiModelProperty("同步对象列表") + @get:Schema(title = "同步对象列表") val objects: List ) diff --git a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/ReplicaTaskInfo.kt b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/ReplicaTaskInfo.kt index de16eba788..40b5bb8e34 100644 --- a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/ReplicaTaskInfo.kt +++ b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/ReplicaTaskInfo.kt @@ -32,56 +32,55 @@ import com.tencent.bkrepo.replication.pojo.record.ExecutionStatus import com.tencent.bkrepo.replication.pojo.request.ReplicaObjectType import com.tencent.bkrepo.replication.pojo.request.ReplicaType import com.tencent.bkrepo.replication.pojo.task.setting.ReplicaSetting -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema import java.time.LocalDateTime -@ApiModel("同步任务信息") +@Schema(title = "同步任务信息") data class ReplicaTaskInfo( - @ApiModelProperty("任务id，全局唯一") + @get:Schema(title = "任务id，全局唯一") val id: String, - @ApiModelProperty("任务key，全局唯一") + @get:Schema(title = "任务key，全局唯一") val key: String, - @ApiModelProperty("任务名称，允许重复") + @get:Schema(title = "任务名称，允许重复") val name: String, - @ApiModelProperty("所属项目") + @get:Schema(title = "所属项目") val projectId: String, - @ApiModelProperty("同步对象类型", required = true) + @get:Schema(title = "同步对象类型", required = true) val replicaObjectType: ReplicaObjectType, - @ApiModelProperty("同步类型") + @get:Schema(title = "同步类型") val replicaType: ReplicaType, - @ApiModelProperty("任务设置") + @get:Schema(title = "任务设置") val setting: ReplicaSetting, - @ApiModelProperty("远程集群集合") + @get:Schema(title = "远程集群集合") val remoteClusters: Set, - @ApiModelProperty("任务描述") + @get:Schema(title = "任务描述") val description: String? = null, - @ApiModelProperty("任务状态") + @get:Schema(title = "任务状态") val status: ReplicaStatus? = null, - @ApiModelProperty("已同步字节数") + @get:Schema(title = "已同步字节数") var replicatedBytes: Long? = 0, - @ApiModelProperty("总字节数") + @get:Schema(title = "总字节数") val totalBytes: Long? = 0, - @ApiModelProperty("上次执行状态") + @get:Schema(title = "上次执行状态") var lastExecutionStatus: ExecutionStatus? = null, - @ApiModelProperty("上次执行时间") + @get:Schema(title = "上次执行时间") var lastExecutionTime: LocalDateTime? = null, - @ApiModelProperty("下次执行时间") + @get:Schema(title = "下次执行时间") var nextExecutionTime: LocalDateTime? = null, - @ApiModelProperty("执行次数") + @get:Schema(title = "执行次数") var executionTimes: Long, - @ApiModelProperty("是否启用") + @get:Schema(title = "是否启用") var enabled: Boolean = true, - @ApiModelProperty("是否记录分发日志") + @get:Schema(title = "是否记录分发日志") val record: Boolean? = null, - @ApiModelProperty("分发日志保留天数") + @get:Schema(title = "分发日志保留天数") val recordReserveDays: Long? = null, - @ApiModelProperty("创建者") + @get:Schema(title = "创建者") val createdBy: String, - @ApiModelProperty("创建日期") + @get:Schema(title = "创建日期") val createdDate: String, - @ApiModelProperty("上次修改者") + @get:Schema(title = "上次修改者") val lastModifiedBy: String, - @ApiModelProperty("上次修改日期") + @get:Schema(title = "上次修改日期") val lastModifiedDate: String ) diff --git a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/objects/PackageConstraint.kt b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/objects/PackageConstraint.kt index d6b6138245..dbc6e706c9 100644 --- a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/objects/PackageConstraint.kt +++ b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/objects/PackageConstraint.kt @@ -27,22 +27,22 @@ package com.tencent.bkrepo.replication.pojo.task.objects -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 包/版本限制 */ -@ApiModel("包/版本限制") +@Schema(title = "包/版本限制") data class PackageConstraint( - @ApiModelProperty("包唯一key") + @get:Schema(title = "包唯一key") val packageKey: String? = null, - @ApiModelProperty("包版本列表") + @get:Schema(title = "包版本列表") val versions: List? = null, - @ApiModelProperty("目标包存储版本:将源版本经过分发后存储为指定的目标版本，在源版本只有一个时生效,只针对镜像类型") + @get:Schema(title = "目标包存储版本:将源版本经过分发后存储为指定的目标版本，在源版本只有一个时生效,只针对镜像类型") val targetVersions: List? = null, - @ApiModelProperty("包正则匹配规则") + @get:Schema(title = "包正则匹配规则") val packageRegex: List? = null, - @ApiModelProperty("包版本正则匹配规则") + @get:Schema(title = "包版本正则匹配规则") val versionRegex: List? = null, ) diff --git a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/objects/PathConstraint.kt b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/objects/PathConstraint.kt index c341d3b033..8ac566492d 100644 --- a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/objects/PathConstraint.kt +++ b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/objects/PathConstraint.kt @@ -27,13 +27,13 @@ package com.tencent.bkrepo.replication.pojo.task.objects -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("路径限制") + +@Schema(title = "路径限制") data class PathConstraint( - @ApiModelProperty("路径") + @get:Schema(title = "路径") val path: String? = null, - @ApiModelProperty("路径正则匹配规则") + @get:Schema(title = "路径正则匹配规则") val pathRegex: List? = null ) diff --git a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/objects/ReplicaObjectInfo.kt b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/objects/ReplicaObjectInfo.kt index 1c44f163e4..b1e48a18c0 100644 --- a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/objects/ReplicaObjectInfo.kt +++ b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/objects/ReplicaObjectInfo.kt @@ -28,21 +28,21 @@ package com.tencent.bkrepo.replication.pojo.task.objects import com.tencent.bkrepo.common.artifact.pojo.RepositoryType -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("同步对象信息") + +@Schema(title = "同步对象信息") data class ReplicaObjectInfo( - @ApiModelProperty("本地仓库") + @get:Schema(title = "本地仓库") val localRepoName: String, - @ApiModelProperty("远程项目") + @get:Schema(title = "远程项目") val remoteProjectId: String?, - @ApiModelProperty("远程仓库") + @get:Schema(title = "远程仓库") val remoteRepoName: String?, - @ApiModelProperty("仓库类型") + @get:Schema(title = "仓库类型") val repoType: RepositoryType, - @ApiModelProperty("包限制条件") + @get:Schema(title = "包限制条件") val packageConstraints: List?, - @ApiModelProperty("路径限制条件") + @get:Schema(title = "路径限制条件") val pathConstraints: List? ) diff --git a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/request/ReplicaTaskCopyRequest.kt b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/request/ReplicaTaskCopyRequest.kt index 73f6fa2ad7..3c88133c51 100644 --- a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/request/ReplicaTaskCopyRequest.kt +++ b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/request/ReplicaTaskCopyRequest.kt @@ -27,15 +27,15 @@ package com.tencent.bkrepo.replication.pojo.task.request -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("同步任务复制请求") + +@Schema(title = "同步任务复制请求") data class ReplicaTaskCopyRequest( - @ApiModelProperty("任务唯一key", required = true) + @get:Schema(title = "任务唯一key", required = true) val key: String, - @ApiModelProperty("任务名称", required = true) + @get:Schema(title = "任务名称", required = true) val name: String, - @ApiModelProperty("任务描述", required = false) + @get:Schema(title = "任务描述", required = false) val description: String? = null ) diff --git a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/request/ReplicaTaskCreateRequest.kt b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/request/ReplicaTaskCreateRequest.kt index 693ff82b67..50187d0af8 100644 --- a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/request/ReplicaTaskCreateRequest.kt +++ b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/request/ReplicaTaskCreateRequest.kt @@ -31,31 +31,31 @@ import com.tencent.bkrepo.replication.pojo.request.ReplicaObjectType import com.tencent.bkrepo.replication.pojo.request.ReplicaType import com.tencent.bkrepo.replication.pojo.task.objects.ReplicaObjectInfo import com.tencent.bkrepo.replication.pojo.task.setting.ReplicaSetting -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("同步任务创建请求") + +@Schema(title = "同步任务创建请求") data class ReplicaTaskCreateRequest( - @ApiModelProperty("任务名称", required = true) + @get:Schema(title = "任务名称", required = true) val name: String, - @ApiModelProperty("本地项目", required = true) + @get:Schema(title = "本地项目", required = true) val localProjectId: String, - @ApiModelProperty("同步对象类型", required = true) + @get:Schema(title = "同步对象类型", required = true) val replicaObjectType: ReplicaObjectType, - @ApiModelProperty("任务对象信息", required = true) + @get:Schema(title = "任务对象信息", required = true) val replicaTaskObjects: List, - @ApiModelProperty("同步类型", required = true) + @get:Schema(title = "同步类型", required = true) val replicaType: ReplicaType = ReplicaType.SCHEDULED, - @ApiModelProperty("任务设置", required = true) + @get:Schema(title = "任务设置", required = true) val setting: ReplicaSetting, - @ApiModelProperty("远程集群集合", required = true) + @get:Schema(title = "远程集群集合", required = true) val remoteClusterIds: Set, - @ApiModelProperty("是否启用", required = true) + @get:Schema(title = "是否启用", required = true) val enabled: Boolean = true, - @ApiModelProperty("任务描述", required = false) + @get:Schema(title = "任务描述", required = false) val description: String? = null, - @ApiModelProperty("是否记录分发日志", required = true) + @get:Schema(title = "是否记录分发日志", required = true) val record: Boolean = true, - @ApiModelProperty("分发日志保留天数", required = true) + @get:Schema(title = "分发日志保留天数", required = true) val recordReserveDays: Long = 30, ) diff --git a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/request/ReplicaTaskObject.kt b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/request/ReplicaTaskObject.kt index 1d1af8042d..7ff9b9b61a 100644 --- a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/request/ReplicaTaskObject.kt +++ b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/request/ReplicaTaskObject.kt @@ -30,19 +30,19 @@ package com.tencent.bkrepo.replication.pojo.task.request import com.tencent.bkrepo.common.artifact.pojo.RepositoryType import com.tencent.bkrepo.replication.pojo.task.objects.PackageConstraint import com.tencent.bkrepo.replication.pojo.task.objects.PathConstraint -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("同步任务对象信息创建请求") + +@Schema(title = "同步任务对象信息创建请求") data class ReplicaTaskObject( - @ApiModelProperty("本地仓库", required = true) + @get:Schema(title = "本地仓库", required = true) val localRepoName: String, - @ApiModelProperty("远程仓库", required = true) + @get:Schema(title = "远程仓库", required = true) val remoteRepoName: String, - @ApiModelProperty("仓库类型", required = true) + @get:Schema(title = "仓库类型", required = true) val repoType: RepositoryType, - @ApiModelProperty("包限制条件", required = false) + @get:Schema(title = "包限制条件", required = false) val packageConstraints: List? = null, - @ApiModelProperty("路径限制条件，包限制和路径限制都为空则同步整个仓库数据", required = false) + @get:Schema(title = "路径限制条件，包限制和路径限制都为空则同步整个仓库数据", required = false) val pathConstraints: List? = null ) diff --git a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/request/ReplicaTaskUpdateRequest.kt b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/request/ReplicaTaskUpdateRequest.kt index 9cec4edc79..6f62e9727c 100644 --- a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/request/ReplicaTaskUpdateRequest.kt +++ b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/request/ReplicaTaskUpdateRequest.kt @@ -30,29 +30,29 @@ package com.tencent.bkrepo.replication.pojo.task.request import com.tencent.bkrepo.replication.pojo.request.ReplicaObjectType import com.tencent.bkrepo.replication.pojo.task.objects.ReplicaObjectInfo import com.tencent.bkrepo.replication.pojo.task.setting.ReplicaSetting -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("同步任务更新请求") + +@Schema(title = "同步任务更新请求") data class ReplicaTaskUpdateRequest( - @ApiModelProperty("任务唯一key", required = true) + @get:Schema(title = "任务唯一key", required = true) val key: String, - @ApiModelProperty("任务名称", required = true) + @get:Schema(title = "任务名称", required = true) val name: String, - @ApiModelProperty("本地项目", required = true) + @get:Schema(title = "本地项目", required = true) val localProjectId: String, - @ApiModelProperty("同步对象类型", required = true) + @get:Schema(title = "同步对象类型", required = true) val replicaObjectType: ReplicaObjectType, - @ApiModelProperty("任务对象信息", required = true) + @get:Schema(title = "任务对象信息", required = true) val replicaTaskObjects: List, - @ApiModelProperty("任务设置", required = true) + @get:Schema(title = "任务设置", required = true) val setting: ReplicaSetting, - @ApiModelProperty("远程集群集合", required = true) + @get:Schema(title = "远程集群集合", required = true) val remoteClusterIds: Set, - @ApiModelProperty("任务描述", required = false) + @get:Schema(title = "任务描述", required = false) val description: String? = null, - @ApiModelProperty("是否记录分发日志", required = true) + @get:Schema(title = "是否记录分发日志", required = true) val record: Boolean = true, - @ApiModelProperty("分发日志保留天数", required = true) + @get:Schema(title = "分发日志保留天数", required = true) val recordReserveDays: Long = 30, ) diff --git a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/request/TaskPageParam.kt b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/request/TaskPageParam.kt index cbc41b854e..73fefb53e8 100644 --- a/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/request/TaskPageParam.kt +++ b/src/backend/replication/api-replication/src/main/kotlin/com/tencent/bkrepo/replication/pojo/task/request/TaskPageParam.kt @@ -31,23 +31,23 @@ import com.tencent.bkrepo.common.api.constant.DEFAULT_PAGE_NUMBER import com.tencent.bkrepo.common.api.constant.DEFAULT_PAGE_SIZE import com.tencent.bkrepo.replication.pojo.record.ExecutionStatus import com.tencent.bkrepo.replication.pojo.task.TaskSortType -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("任务分页查参数") + +@Schema(title = "任务分页查参数") data class TaskPageParam( - @ApiModelProperty("当前页") + @get:Schema(title = "当前页") val pageNumber: Int = DEFAULT_PAGE_NUMBER, - @ApiModelProperty("分页大小") + @get:Schema(title = "分页大小") val pageSize: Int = DEFAULT_PAGE_SIZE, - @ApiModelProperty("计划名称，前缀匹配") + @get:Schema(title = "计划名称，前缀匹配") val name: String? = null, - @ApiModelProperty("上次执行状态") + @get:Schema(title = "上次执行状态") val lastExecutionStatus: ExecutionStatus? = null, - @ApiModelProperty("计划是否开启") + @get:Schema(title = "计划是否开启") val enabled: Boolean? = null, - @ApiModelProperty("排序字段") + @get:Schema(title = "排序字段") val sortType: TaskSortType? = TaskSortType.CREATED_TIME, - @ApiModelProperty("排序方向") + @get:Schema(title = "排序方向") val sortDirection: String? = "DESC" ) diff --git a/src/backend/replication/biz-replication/src/main/kotlin/com/tencent/bkrepo/replication/controller/api/RemoteDistributionController.kt b/src/backend/replication/biz-replication/src/main/kotlin/com/tencent/bkrepo/replication/controller/api/RemoteDistributionController.kt index acf4006a0c..7d5cf2352a 100644 --- a/src/backend/replication/biz-replication/src/main/kotlin/com/tencent/bkrepo/replication/controller/api/RemoteDistributionController.kt +++ b/src/backend/replication/biz-replication/src/main/kotlin/com/tencent/bkrepo/replication/controller/api/RemoteDistributionController.kt @@ -46,9 +46,9 @@ import com.tencent.bkrepo.replication.pojo.remote.request.RemoteConfigUpdateRequ import com.tencent.bkrepo.replication.pojo.remote.request.RemoteCreateRequest import com.tencent.bkrepo.replication.pojo.remote.request.RemoteRunOnceTaskCreateRequest import com.tencent.bkrepo.replication.service.RemoteNodeService -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable @@ -58,20 +58,20 @@ import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam import org.springframework.web.bind.annotation.RestController -@Api("远端分发集群用户配置接口") +@Tag(name = "远端分发集群用户配置接口") @RestController @RequestMapping("/api/remote/distribution") class RemoteDistributionController( private val remoteNodeService: RemoteNodeService ) { - @ApiOperation("创建远端集群节点") + @Operation(summary = "创建远端集群节点") @Permission(ResourceType.REPO, PermissionAction.WRITE) @PostMapping("/create/{projectId}/{repoName}") fun remoteClusterCreate( - @ApiParam(value = "仓库ID") + @Parameter(name = "仓库ID") @PathVariable projectId: String, - @ApiParam(value = "项目ID") + @Parameter(name = "项目ID") @PathVariable repoName: String, @RequestBody requests: RemoteCreateRequest ): Response> { @@ -79,13 +79,13 @@ class RemoteDistributionController( return ResponseBuilder.success() } - @ApiOperation("创建远端集群节点") + @Operation(summary = "创建远端集群节点") @Permission(ResourceType.REPO, PermissionAction.WRITE) @PostMapping("/update/{projectId}/{repoName}/{name}") fun remoteClusterUpdate( - @ApiParam(value = "仓库ID") + @Parameter(name = "仓库ID") @PathVariable projectId: String, - @ApiParam(value = "项目ID") + @Parameter(name = "项目ID") @PathVariable repoName: String, @PathVariable name: String, @RequestBody request: RemoteConfigUpdateRequest @@ -99,26 +99,26 @@ class RemoteDistributionController( return ResponseBuilder.success() } - @ApiOperation("根据name以及关联项目仓库信息查询远端集群详情") + @Operation(summary = "根据name以及关联项目仓库信息查询远端集群详情") @Permission(ResourceType.REPO, PermissionAction.READ) @GetMapping("/info/{projectId}/{repoName}/{name}", "/info/{projectId}/{repoName}") fun getByName( - @ApiParam(value = "仓库ID") + @Parameter(name = "仓库ID") @PathVariable projectId: String, - @ApiParam(value = "项目ID") + @Parameter(name = "项目ID") @PathVariable repoName: String, @PathVariable(required = false) name: String? = null ): Response> { return ResponseBuilder.success(remoteNodeService.getByName(projectId, repoName, name)) } - @ApiOperation("任务启停状态切换") + @Operation(summary = "任务启停状态切换") @Permission(ResourceType.REPO, PermissionAction.WRITE) @PostMapping("/toggle/status/{projectId}/{repoName}/{name}") fun toggleStatus( - @ApiParam(value = "仓库ID") + @Parameter(name = "仓库ID") @PathVariable projectId: String, - @ApiParam(value = "项目ID") + @Parameter(name = "项目ID") @PathVariable repoName: String, @PathVariable name: String ): Response { @@ -126,13 +126,13 @@ class RemoteDistributionController( return ResponseBuilder.success() } - @ApiOperation("根据name以及关联项目仓库信息删除远端集群详情") + @Operation(summary = "根据name以及关联项目仓库信息删除远端集群详情") @Permission(ResourceType.REPO, PermissionAction.WRITE) @DeleteMapping("/delete/{projectId}/{repoName}/{name}") fun deleteClusterNode( - @ApiParam(value = "仓库ID") + @Parameter(name = "仓库ID") @PathVariable projectId: String, - @ApiParam(value = "项目ID") + @Parameter(name = "项目ID") @PathVariable repoName: String, @PathVariable name: String ): Response { @@ -146,9 +146,9 @@ class RemoteDistributionController( @Permission(ResourceType.REPO, PermissionAction.WRITE) @PostMapping("/push/{projectId}/{repoName}/{name}") fun pushSpecialArtifact( - @ApiParam(value = "仓库ID") + @Parameter(name = "仓库ID") @PathVariable projectId: String, - @ApiParam(value = "项目ID") + @Parameter(name = "项目ID") @PathVariable repoName: String, @RequestParam packageName: String, @RequestParam version: String, @@ -182,9 +182,9 @@ class RemoteDistributionController( @Permission(ResourceType.REPO, PermissionAction.WRITE) @PostMapping("/create/runOnceTask/{projectId}/{repoName}") fun createRunOnceTask( - @ApiParam(value = "仓库ID") + @Parameter(name = "仓库ID") @PathVariable projectId: String, - @ApiParam(value = "项目ID") + @Parameter(name = "项目ID") @PathVariable repoName: String, @RequestBody requests: RemoteRunOnceTaskCreateRequest ): Response { @@ -217,9 +217,9 @@ class RemoteDistributionController( @Permission(ResourceType.REPO, PermissionAction.WRITE) @PostMapping("/execute/runOnceTask/{projectId}/{repoName}") fun executeRunOnceTask( - @ApiParam(value = "仓库ID") + @Parameter(name = "仓库ID") @PathVariable projectId: String, - @ApiParam(value = "项目ID") + @Parameter(name = "项目ID") @PathVariable repoName: String, @RequestParam name: String, ): Response { @@ -233,9 +233,9 @@ class RemoteDistributionController( @Permission(ResourceType.REPO, PermissionAction.READ) @GetMapping("/get/runOnceTaskStatus/{projectId}/{repoName}") fun getRunOnceTaskResult( - @ApiParam(value = "仓库ID") + @Parameter(name = "仓库ID") @PathVariable projectId: String, - @ApiParam(value = "项目ID") + @Parameter(name = "项目ID") @PathVariable repoName: String, @RequestParam name: String, ): Response { @@ -248,9 +248,9 @@ class RemoteDistributionController( @Permission(ResourceType.REPO, PermissionAction.DELETE) @DeleteMapping("/delete/runOnceTask/{projectId}/{repoName}") fun deleteRunOnceTaskResult( - @ApiParam(value = "仓库ID") + @Parameter(name = "仓库ID") @PathVariable projectId: String, - @ApiParam(value = "项目ID") + @Parameter(name = "项目ID") @PathVariable repoName: String, @RequestParam name: String, ): Response { diff --git a/src/backend/replication/biz-replication/src/main/kotlin/com/tencent/bkrepo/replication/controller/api/ReplicaRecordController.kt b/src/backend/replication/biz-replication/src/main/kotlin/com/tencent/bkrepo/replication/controller/api/ReplicaRecordController.kt index c4b1e5b9fa..c5c52daa68 100644 --- a/src/backend/replication/biz-replication/src/main/kotlin/com/tencent/bkrepo/replication/controller/api/ReplicaRecordController.kt +++ b/src/backend/replication/biz-replication/src/main/kotlin/com/tencent/bkrepo/replication/controller/api/ReplicaRecordController.kt @@ -39,9 +39,9 @@ import com.tencent.bkrepo.replication.pojo.record.ReplicaRecordInfo import com.tencent.bkrepo.replication.pojo.record.ReplicaRecordListOption import com.tencent.bkrepo.replication.pojo.record.ReplicaTaskRecordInfo import com.tencent.bkrepo.replication.service.ReplicaRecordService -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable import org.springframework.web.bind.annotation.RequestMapping @@ -50,26 +50,26 @@ import org.springframework.web.bind.annotation.RestController /** * 任务执行日志接口 */ -@Api("任务执行日志接口") +@Tag(name = "任务执行日志接口") @Principal(type = PrincipalType.ADMIN) @RestController @RequestMapping("/api/task/record") class ReplicaRecordController( private val replicaRecordService: ReplicaRecordService ) { - @ApiOperation("根据recordId查询任务执行日志详情") + @Operation(summary = "根据recordId查询任务执行日志详情") @GetMapping("/{recordId}") fun getRecordAndTaskInfoByRecordId(@PathVariable recordId: String): Response { return ResponseBuilder.success(replicaRecordService.getRecordAndTaskInfoByRecordId(recordId)) } - @ApiOperation("根据taskKey查询任务执行日志") + @Operation(summary = "根据taskKey查询任务执行日志") @GetMapping("/list/{key}") fun listRecordsByTaskKey(@PathVariable key: String): Response> { return ResponseBuilder.success(replicaRecordService.listRecordsByTaskKey(key)) } - @ApiOperation("根据taskKey分页查询任务执行日志") + @Operation(summary = "根据taskKey分页查询任务执行日志") @GetMapping("/page/{key}") fun listRecordsPage( @PathVariable key: String, @@ -78,23 +78,23 @@ class ReplicaRecordController( return ResponseBuilder.success(replicaRecordService.listRecordsPage(key, option)) } - @ApiOperation("根据recordId查询任务执行日志详情") + @Operation(summary = "根据recordId查询任务执行日志详情") @GetMapping("/detail/list/{recordId}") fun listDetailsByRecordId(@PathVariable recordId: String): Response> { return ResponseBuilder.success(replicaRecordService.listDetailsByRecordId(recordId)) } - @ApiOperation("根据recordId分页查询任务执行日志详情") + @Operation(summary = "根据recordId分页查询任务执行日志详情") @GetMapping("/detail/page/{recordId}") fun listRecordDetailPage( - @ApiParam(value = "执行记录id", required = true) + @Parameter(name = "执行记录id", required = true) @PathVariable recordId: String, option: ReplicaRecordDetailListOption ): Response> { return ResponseBuilder.success(replicaRecordService.listRecordDetailPage(recordId, option)) } - @ApiOperation("根据recordId查询任务执行总览信息") + @Operation(summary = "根据recordId查询任务执行总览信息") @GetMapping("/overview/{recordId}") fun getRecordOverviewByRecordId(@PathVariable recordId: String): Response { return ResponseBuilder.success(replicaRecordService.getRecordById(recordId)?.replicaOverview) diff --git a/src/backend/replication/biz-replication/src/main/kotlin/com/tencent/bkrepo/replication/controller/api/ReplicaTaskController.kt b/src/backend/replication/biz-replication/src/main/kotlin/com/tencent/bkrepo/replication/controller/api/ReplicaTaskController.kt index ffda9d2626..0f98d44295 100644 --- a/src/backend/replication/biz-replication/src/main/kotlin/com/tencent/bkrepo/replication/controller/api/ReplicaTaskController.kt +++ b/src/backend/replication/biz-replication/src/main/kotlin/com/tencent/bkrepo/replication/controller/api/ReplicaTaskController.kt @@ -39,8 +39,8 @@ import com.tencent.bkrepo.replication.pojo.task.request.ReplicaTaskCreateRequest import com.tencent.bkrepo.replication.pojo.task.request.ReplicaTaskUpdateRequest import com.tencent.bkrepo.replication.pojo.task.request.TaskPageParam import com.tencent.bkrepo.replication.service.ReplicaTaskService -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable @@ -52,32 +52,32 @@ import org.springframework.web.bind.annotation.RestController /** * 数据同步任务接口 */ -@Api("任务接口") +@Tag(name = "任务接口") @Principal(type = PrincipalType.ADMIN) @RestController @RequestMapping("/api/task") class ReplicaTaskController( private val replicaTaskService: ReplicaTaskService ) { - @ApiOperation("创建任务") + @Operation(summary = "创建任务") @PostMapping("/create") fun create(@RequestBody request: ReplicaTaskCreateRequest): Response { return ResponseBuilder.success(replicaTaskService.create(request)) } - @ApiOperation("根据任务key查询任务信息") + @Operation(summary = "根据任务key查询任务信息") @GetMapping("/info/{key}") fun getByTaskKey(@PathVariable key: String): Response { return ResponseBuilder.success(replicaTaskService.getByTaskKey(key)) } - @ApiOperation("根据任务key查询任务详情") + @Operation(summary = "根据任务key查询任务详情") @GetMapping("/detail/{key}") fun getDetailByTaskKey(@PathVariable key: String): Response { return ResponseBuilder.success(replicaTaskService.getDetailByTaskKey(key)) } - @ApiOperation("分页查询任务") + @Operation(summary = "分页查询任务") @GetMapping("/page/{projectId}") fun listReplicationTaskInfoPage( @PathVariable projectId: String, @@ -86,35 +86,35 @@ class ReplicaTaskController( return ResponseBuilder.success(replicaTaskService.listTasksPage(projectId, option)) } - @ApiOperation("删除任务") + @Operation(summary = "删除任务") @DeleteMapping("/delete/{key}") fun delete(@PathVariable key: String): Response { replicaTaskService.deleteByTaskKey(key) return ResponseBuilder.success() } - @ApiOperation("任务启停状态切换") + @Operation(summary = "任务启停状态切换") @PostMapping("/toggle/status/{key}") fun toggleStatus(@PathVariable key: String): Response { replicaTaskService.toggleStatus(key) return ResponseBuilder.success() } - @ApiOperation("任务复制") + @Operation(summary = "任务复制") @PostMapping("/copy") fun copy(@RequestBody request: ReplicaTaskCopyRequest): Response { replicaTaskService.copy(request) return ResponseBuilder.success() } - @ApiOperation("任务更新") + @Operation(summary = "任务更新") @PostMapping("/update") fun update(@RequestBody request: ReplicaTaskUpdateRequest): Response { replicaTaskService.update(request) return ResponseBuilder.success() } - @ApiOperation("执行计划") + @Operation(summary = "执行计划") @PostMapping("/execute/{key}") fun execute(@PathVariable key: String): Response { replicaTaskService.execute(key) diff --git a/src/backend/replication/biz-replication/src/main/kotlin/com/tencent/bkrepo/replication/controller/api/UserClusterNodeController.kt b/src/backend/replication/biz-replication/src/main/kotlin/com/tencent/bkrepo/replication/controller/api/UserClusterNodeController.kt index b996f15a59..f68b60a593 100644 --- a/src/backend/replication/biz-replication/src/main/kotlin/com/tencent/bkrepo/replication/controller/api/UserClusterNodeController.kt +++ b/src/backend/replication/biz-replication/src/main/kotlin/com/tencent/bkrepo/replication/controller/api/UserClusterNodeController.kt @@ -38,8 +38,8 @@ import com.tencent.bkrepo.replication.pojo.cluster.ClusterNodeInfo import com.tencent.bkrepo.replication.pojo.cluster.request.ClusterNodeCreateRequest import com.tencent.bkrepo.replication.pojo.cluster.request.ClusterNodeUpdateRequest import com.tencent.bkrepo.replication.service.ClusterNodeService -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable @@ -50,7 +50,7 @@ import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam import org.springframework.web.bind.annotation.RestController -@Api("集群节点用户接口") +@Tag(name = "集群节点用户接口") @RestController @RequestMapping("/api/cluster") @Principal(PrincipalType.ADMIN) @@ -58,31 +58,31 @@ class UserClusterNodeController( private val clusterNodeService: ClusterNodeService ) { - @ApiOperation("根据id查询节点详情") + @Operation(summary = "根据id查询节点详情") @GetMapping("/info/{id}") fun getByClusterId(@PathVariable id: String): Response { return ResponseBuilder.success(clusterNodeService.getByClusterId(id)) } - @ApiOperation("根据name查询节点详情") + @Operation(summary = "根据name查询节点详情") @GetMapping("/info") fun getByClusterName(@RequestParam name: String): Response { return ResponseBuilder.success(clusterNodeService.getByClusterName(name)) } - @ApiOperation("获取中心节点") + @Operation(summary = "获取中心节点") @GetMapping("/info/center") fun queryCenterNode(): Response { return ResponseBuilder.success(clusterNodeService.getCenterNode()) } - @ApiOperation("查询边缘节点列表") + @Operation(summary = "查询边缘节点列表") @GetMapping("/list/edge") fun listEdgeNodes(): Response> { return ResponseBuilder.success(clusterNodeService.listEdgeNodes()) } - @ApiOperation("查询所有的集群节点") + @Operation(summary = "查询所有的集群节点") @GetMapping("/list") fun listClusterNodes( name: String? = null, @@ -91,7 +91,7 @@ class UserClusterNodeController( return ResponseBuilder.success(clusterNodeService.listClusterNodes(name, type)) } - @ApiOperation("查询所有的集群节点") + @Operation(summary = "查询所有的集群节点") @GetMapping("/page") fun listClusterNodesPage( option: ClusterListOption @@ -99,7 +99,7 @@ class UserClusterNodeController( return ResponseBuilder.success(clusterNodeService.listClusterNodesPage(option)) } - @ApiOperation("根据名称判断集群节点是否存在") + @Operation(summary = "根据名称判断集群节点是否存在") @GetMapping("/exist") fun existClusterName( @RequestParam name: String @@ -107,7 +107,7 @@ class UserClusterNodeController( return ResponseBuilder.success(clusterNodeService.existClusterName(name)) } - @ApiOperation("创建集群节点") + @Operation(summary = "创建集群节点") @PostMapping("/create") fun create( @RequestAttribute userId: String, @@ -117,7 +117,7 @@ class UserClusterNodeController( return ResponseBuilder.success() } - @ApiOperation("更新集群节点") + @Operation(summary = "更新集群节点") @PostMapping("/update") fun update( @RequestBody request: ClusterNodeUpdateRequest @@ -125,7 +125,7 @@ class UserClusterNodeController( return ResponseBuilder.success(clusterNodeService.update(request)) } - @ApiOperation("根据id删除集群节点") + @Operation(summary = "根据id删除集群节点") @DeleteMapping("/delete/{id}") fun deleteClusterNode( @PathVariable id: String @@ -134,7 +134,7 @@ class UserClusterNodeController( return ResponseBuilder.success() } - @ApiOperation("测试集群间通信") + @Operation(summary = "测试集群间通信") @PostMapping("/tryConnect") fun tryConnect( @RequestParam name: String diff --git a/src/backend/replication/biz-replication/src/main/kotlin/com/tencent/bkrepo/replication/controller/api/UserReplicationController.kt b/src/backend/replication/biz-replication/src/main/kotlin/com/tencent/bkrepo/replication/controller/api/UserReplicationController.kt index 8a667b7caa..2048fac9b1 100644 --- a/src/backend/replication/biz-replication/src/main/kotlin/com/tencent/bkrepo/replication/controller/api/UserReplicationController.kt +++ b/src/backend/replication/biz-replication/src/main/kotlin/com/tencent/bkrepo/replication/controller/api/UserReplicationController.kt @@ -37,7 +37,7 @@ import com.tencent.bkrepo.replication.pojo.dispatch.request.ReplicaNodeDispatchC import com.tencent.bkrepo.replication.pojo.ext.CheckRepoDifferenceRequest import com.tencent.bkrepo.replication.service.ReplicaExtService import com.tencent.bkrepo.replication.service.ReplicaNodeDispatchService -import io.swagger.annotations.Api +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable @@ -46,7 +46,7 @@ import org.springframework.web.bind.annotation.RequestBody import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RestController -@Api("同步ext接口") +@Tag(name = "同步ext接口") @Principal(type = PrincipalType.ADMIN) @RestController @RequestMapping("/ext/") diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/MetadataClient.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/MetadataClient.kt index 92cbd8556f..a7039cde1c 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/MetadataClient.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/MetadataClient.kt @@ -35,9 +35,9 @@ import com.tencent.bkrepo.common.api.constant.REPOSITORY_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.repository.pojo.metadata.MetadataDeleteRequest import com.tencent.bkrepo.repository.pojo.metadata.MetadataSaveRequest -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.context.annotation.Primary import org.springframework.web.bind.annotation.DeleteMapping @@ -51,32 +51,32 @@ import org.springframework.web.bind.annotation.RequestParam /** * 节点元数据服务接口 */ -@Api("节点元数据服务接口") +@Tag(name = "节点元数据服务接口") @Primary @FeignClient(REPOSITORY_SERVICE_NAME, contextId = "MetadataClient") @Deprecated("replace with MetadataService") @RequestMapping("/service/metadata") interface MetadataClient { - @ApiOperation("查询节点所有元数据") + @Operation(summary = "查询节点所有元数据") @GetMapping("/list/{projectId}/{repoName}") fun listMetadata( - @ApiParam(value = "所属项目", required = true) + @Parameter(name = "所属项目", required = true) @PathVariable projectId: String, - @ApiParam(value = "仓库名称", required = true) + @Parameter(name = "仓库名称", required = true) @PathVariable repoName: String, - @ApiParam(value = "节点完整路径", required = true) + @Parameter(name = "节点完整路径", required = true) @RequestParam fullPath: String ): Response> - @ApiOperation("创建/更新元数据列表") + @Operation(summary = "创建/更新元数据列表") @PostMapping("/save") fun saveMetadata(@RequestBody request: MetadataSaveRequest): Response - @ApiOperation("删除元数据") + @Operation(summary = "删除元数据") @DeleteMapping("/delete") fun deleteMetadata(@RequestBody request: MetadataDeleteRequest): Response - @ApiOperation("添加禁用元数据") + @Operation(summary = "添加禁用元数据") @PostMapping("/forbid") fun addForbidMetadata(@RequestBody request: MetadataSaveRequest): Response } diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/NodeClient.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/NodeClient.kt index 00254e5ae0..71f738bbaa 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/NodeClient.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/NodeClient.kt @@ -34,6 +34,7 @@ package com.tencent.bkrepo.repository.api import com.tencent.bkrepo.common.api.constant.REPOSITORY_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Page import com.tencent.bkrepo.common.api.pojo.Response +import com.tencent.bkrepo.common.metadata.pojo.node.NodeRestoreRequest import com.tencent.bkrepo.common.query.model.QueryModel import com.tencent.bkrepo.repository.pojo.node.NodeDeleteResult import com.tencent.bkrepo.repository.pojo.node.NodeDetail @@ -49,14 +50,13 @@ import com.tencent.bkrepo.repository.pojo.node.service.NodeDeleteRequest import com.tencent.bkrepo.repository.pojo.node.service.NodeLinkRequest import com.tencent.bkrepo.repository.pojo.node.service.NodeMoveCopyRequest import com.tencent.bkrepo.repository.pojo.node.service.NodeRenameRequest -import com.tencent.bkrepo.common.metadata.pojo.node.NodeRestoreRequest import com.tencent.bkrepo.repository.pojo.node.service.NodeUnCompressedRequest import com.tencent.bkrepo.repository.pojo.node.service.NodeUpdateAccessDateRequest import com.tencent.bkrepo.repository.pojo.node.service.NodeUpdateRequest import com.tencent.bkrepo.repository.pojo.node.service.NodesDeleteRequest -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.context.annotation.Primary import org.springframework.web.bind.annotation.DeleteMapping @@ -71,14 +71,14 @@ import org.springframework.web.bind.annotation.RequestParam /** * 资源节点服务接口 */ -@Api("节点服务接口") +@Tag(name = "节点服务接口") @Primary @FeignClient(REPOSITORY_SERVICE_NAME, contextId = "NodeClient", primary = false) @RequestMapping("/service/node") @Deprecated("replace with NodeService") interface NodeClient { - @ApiOperation("根据路径查看节点详情") + @Operation(summary = "根据路径查看节点详情") @GetMapping("/detail/{projectId}/{repoName}") fun getNodeDetail( @PathVariable projectId: String, @@ -86,7 +86,7 @@ interface NodeClient { @RequestParam fullPath: String, ): Response - @ApiOperation("根据路径查看节点是否存在") + @Operation(summary = "根据路径查看节点是否存在") @GetMapping("/exist/{projectId}/{repoName}") fun checkExist( @PathVariable projectId: String, @@ -94,7 +94,7 @@ interface NodeClient { @RequestParam fullPath: String, ): Response - @ApiOperation("列出仓库中已存在的节点") + @Operation(summary = "列出仓库中已存在的节点") @PostMapping("/exist/list/{projectId}/{repoName}") fun listExistFullPath( @PathVariable projectId: String, @@ -110,113 +110,113 @@ interface NodeClient { @RequestBody option: NodeListOption = NodeListOption(), ): Response> - @ApiOperation("创建节点") + @Operation(summary = "创建节点") @PostMapping("/create") fun createNode(@RequestBody nodeCreateRequest: NodeCreateRequest): Response - @ApiOperation("更新节点") + @Operation(summary = "更新节点") @PostMapping("/update") fun updateNode(@RequestBody nodeUpdateRequest: NodeUpdateRequest): Response - @ApiOperation("更新节点访问时间") + @Operation(summary = "更新节点访问时间") @PostMapping("/update/access/") fun updateNodeAccessDate(@RequestBody nodeUpdateAccessDateRequest: NodeUpdateAccessDateRequest): Response - @ApiOperation("重命名节点") + @Operation(summary = "重命名节点") @PostMapping("/rename") fun renameNode(@RequestBody nodeRenameRequest: NodeRenameRequest): Response - @ApiOperation("移动节点") + @Operation(summary = "移动节点") @PostMapping("/move") fun moveNode(@RequestBody nodeMoveRequest: NodeMoveCopyRequest): Response - @ApiOperation("复制节点") + @Operation(summary = "复制节点") @PostMapping("/copy") fun copyNode(@RequestBody nodeCopyRequest: NodeMoveCopyRequest): Response - @ApiOperation("删除节点") + @Operation(summary = "删除节点") @DeleteMapping("/delete") fun deleteNode(@RequestBody nodeDeleteRequest: NodeDeleteRequest): Response - @ApiOperation("删除节点") + @Operation(summary = "删除节点") @DeleteMapping("/batch/delete") fun deleteNodes(@RequestBody nodesDeleteRequest: NodesDeleteRequest): Response - @ApiOperation("恢复节点") + @Operation(summary = "恢复节点") @PostMapping("/restore") fun restoreNode(nodeRestoreRequest: NodeRestoreRequest): Response - @ApiOperation("查询节点大小信息") + @Operation(summary = "查询节点大小信息") @GetMapping("/size/{projectId}/{repoName}") fun computeSize( - @ApiParam(value = "所属项目", required = true) + @Parameter(name = "所属项目", required = true) @PathVariable projectId: String, - @ApiParam(value = "仓库名称", required = true) + @Parameter(name = "仓库名称", required = true) @PathVariable repoName: String, - @ApiParam(value = "节点完整路径", required = true) + @Parameter(name = "节点完整路径", required = true) @RequestParam fullPath: String, - @ApiParam(value = "估计值", required = false) + @Parameter(name = "估计值", required = false) @RequestParam estimated: Boolean = false, ): Response - @ApiOperation("查询文件节点数量") + @Operation(summary = "查询文件节点数量") @GetMapping("/file/{projectId}/{repoName}") fun countFileNode( - @ApiParam(value = "所属项目", required = true) + @Parameter(name = "所属项目", required = true) @PathVariable projectId: String, - @ApiParam(value = "仓库名称", required = true) + @Parameter(name = "仓库名称", required = true) @PathVariable repoName: String, - @ApiParam(value = "节点完整路径", required = true) + @Parameter(name = "节点完整路径", required = true) @RequestParam path: String, ): Response - @ApiOperation("自定义查询节点，如不关注总记录数请使用queryWithoutCount") + @Operation(summary = "自定义查询节点，如不关注总记录数请使用queryWithoutCount") @PostMapping("/search") fun search(@RequestBody queryModel: QueryModel): Response>> - @ApiOperation("自定义查询节点，不计算总记录数") + @Operation(summary = "自定义查询节点，不计算总记录数") @PostMapping("/queryWithoutCount") fun queryWithoutCount(@RequestBody queryModel: QueryModel): Response>> @Deprecated("replace with listNodePage") - @ApiOperation("列表查询指定目录下所有节点") + @Operation(summary = "列表查询指定目录下所有节点") @GetMapping("/list/{projectId}/{repoName}") fun listNode( - @ApiParam(value = "所属项目", required = true) + @Parameter(name = "所属项目", required = true) @PathVariable projectId: String, - @ApiParam(value = "仓库名称", required = true) + @Parameter(name = "仓库名称", required = true) @PathVariable repoName: String, - @ApiParam(value = "所属目录", required = true) + @Parameter(name = "所属目录", required = true) @RequestParam path: String, - @ApiParam(value = "是否包含目录", required = false, defaultValue = "true") + @Parameter(name = "是否包含目录", required = false) @RequestParam includeFolder: Boolean = true, - @ApiParam(value = "是否深度查询文件", required = false, defaultValue = "false") + @Parameter(name = "是否深度查询文件", required = false) @RequestParam deep: Boolean = false, - @ApiParam(value = "是否包含元数据", required = false, defaultValue = "false") + @Parameter(name = "是否包含元数据", required = false) @RequestParam includeMetadata: Boolean = false, ): Response> - @ApiOperation("按sha256分页查询节点") + @Operation(summary = "按sha256分页查询节点") @PostMapping("/page", params = ["sha256"]) fun listPageNodeBySha256( @RequestParam("sha256", required = true) sha256: String, @RequestBody nodeListOption: NodeListOption ): Response> - @ApiOperation("查询已删除节点") + @Operation(summary = "查询已删除节点") @GetMapping("/deleted/detail/{projectId}/{repoName}") fun getDeletedNodeDetail( @PathVariable projectId: String, @@ -224,7 +224,7 @@ interface NodeClient { @RequestParam fullPath: String, ): Response> - @ApiOperation("通过sha256查询已删除节点") + @Operation(summary = "通过sha256查询已删除节点") @GetMapping("/deletedBySha256/detail/{projectId}/{repoName}") fun getDeletedNodeDetailBySha256( @PathVariable projectId: String, @@ -235,36 +235,36 @@ interface NodeClient { /** * 归档文件成功通知 * */ - @ApiOperation("归档节点") + @Operation(summary = "归档节点") @PutMapping("/archive/") fun archiveNode(@RequestBody nodeArchiveRequest: NodeArchiveRequest): Response /** * 恢复文件成功通知 * */ - @ApiOperation("恢复节点") + @Operation(summary = "恢复节点") @PutMapping("/archive/restore/") fun restoreNode(@RequestBody nodeArchiveRequest: NodeArchiveRequest): Response /** * 归档文件成功通知 * */ - @ApiOperation("压缩节点") + @Operation(summary = "压缩节点") @PutMapping("/compress/") fun compressedNode(@RequestBody nodeCompressedRequest: NodeCompressedRequest): Response /** * 恢复文件成功通知 * */ - @ApiOperation("解压节点") + @Operation(summary = "解压节点") @PutMapping("/uncompress/") fun uncompressedNode(@RequestBody nodeUnCompressedRequest: NodeUnCompressedRequest): Response - @ApiOperation("清理最后访问时间早于{date}的文件节点") + @Operation(summary = "清理最后访问时间早于{date}的文件节点") @DeleteMapping("/clean") fun cleanNodes(@RequestBody nodeCleanRequest: NodeCleanRequest): Response - @ApiOperation("创建软链接") + @Operation(summary = "创建软链接") @PostMapping("/link") fun link(@RequestBody nodeLinkRequest: NodeLinkRequest): Response } diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/OperateLogClient.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/OperateLogClient.kt index e220f5400a..c0e3011c7e 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/OperateLogClient.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/OperateLogClient.kt @@ -33,38 +33,38 @@ import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.common.artifact.event.base.ArtifactEvent import com.tencent.bkrepo.common.metadata.pojo.log.OpLogListOption import com.tencent.bkrepo.common.metadata.pojo.log.OperateLog -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.context.annotation.Primary import org.springframework.web.bind.annotation.PostMapping import org.springframework.web.bind.annotation.RequestBody import org.springframework.web.bind.annotation.RequestMapping -@Api("操作日志服务接口") +@Tag(name = "操作日志服务接口") @Primary @FeignClient(REPOSITORY_SERVICE_NAME, contextId = "NodeDownloadsClient") @RequestMapping("/service/log") @Deprecated("replace with OperateLogService") interface OperateLogClient { - @ApiOperation("记录操作日志") + @Operation(summary = "记录操作日志") @PostMapping("/record") fun record(@RequestBody event: ArtifactEvent): Response - @ApiOperation("批量记录操作日志") + @Operation(summary = "批量记录操作日志") @PostMapping("/record/batch") fun batchRecord(@RequestBody eventList: List): Response - @ApiOperation("记录操作日志") + @Operation(summary = "记录操作日志") @PostMapping("/save") fun save(@RequestBody log: OperateLog): Response - @ApiOperation("批量记录操作日志") + @Operation(summary = "批量记录操作日志") @PostMapping("/save/batch") fun batchSave(@RequestBody logs: List): Response - @ApiOperation("操作日志列表") + @Operation(summary = "操作日志列表") @PostMapping("/list") fun list(@RequestBody option: OpLogListOption): Response> diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/PackageClient.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/PackageClient.kt index 2165265d56..e03de99a0f 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/PackageClient.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/PackageClient.kt @@ -43,7 +43,7 @@ import com.tencent.bkrepo.repository.pojo.packages.request.PackagePopulateReques import com.tencent.bkrepo.repository.pojo.packages.request.PackageUpdateRequest import com.tencent.bkrepo.repository.pojo.packages.request.PackageVersionCreateRequest import com.tencent.bkrepo.repository.pojo.packages.request.PackageVersionUpdateRequest -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation import org.springframework.cloud.openfeign.FeignClient import org.springframework.context.annotation.Primary import org.springframework.web.bind.annotation.DeleteMapping @@ -60,7 +60,7 @@ import org.springframework.web.bind.annotation.RequestParam @Deprecated("replace with PackageService") interface PackageClient { - @ApiOperation("查询包信息") + @Operation(summary = "查询包信息") @GetMapping("/package/info/{projectId}/{repoName}") fun findPackageByKey( @PathVariable projectId: String, @@ -68,7 +68,7 @@ interface PackageClient { @RequestParam packageKey: String ): Response - @ApiOperation("根据版本名称查询版本信息") + @Operation(summary = "根据版本名称查询版本信息") @GetMapping("/version/info/{projectId}/{repoName}") fun findVersionByName( @PathVariable projectId: String, @@ -77,7 +77,7 @@ interface PackageClient { @RequestParam version: String ): Response - @ApiOperation("根据版本标签查询版本信息") + @Operation(summary = "根据版本标签查询版本信息") @GetMapping("/package/tag/{projectId}/{repoName}") fun findVersionNameByTag( @PathVariable projectId: String, @@ -86,7 +86,7 @@ interface PackageClient { @RequestParam tag: String ): Response - @ApiOperation("根据语义化版本排序查找latest版本") + @Operation(summary = "根据语义化版本排序查找latest版本") @GetMapping("/version/semver/latest/{projectId}/{repoName}") fun findLatestBySemVer( @PathVariable projectId: String, @@ -94,14 +94,14 @@ interface PackageClient { @RequestParam packageKey: String ): Response - @ApiOperation("创建包版本") + @Operation(summary = "创建包版本") @PostMapping("/version/create") fun createVersion( @RequestBody request: PackageVersionCreateRequest, @RequestParam realIpAddress: String? = null ): Response - @ApiOperation("删除包") + @Operation(summary = "删除包") @DeleteMapping("/package/delete/{projectId}/{repoName}") fun deletePackage( @PathVariable projectId: String, @@ -110,7 +110,7 @@ interface PackageClient { @RequestParam realIpAddress: String? = null ): Response - @ApiOperation("删除版本") + @Operation(summary = "删除版本") @DeleteMapping("/version/delete/{projectId}/{repoName}") fun deleteVersion( @PathVariable projectId: String, @@ -121,27 +121,27 @@ interface PackageClient { @RequestParam contentPath: String? = null, ): Response - @ApiOperation("更新包") + @Operation(summary = "更新包") @PostMapping("/package/update") fun updatePackage( @RequestBody request: PackageUpdateRequest, @RequestParam realIpAddress: String? = null ): Response - @ApiOperation("更新版本") + @Operation(summary = "更新版本") @PostMapping("/version/update") fun updateVersion( @RequestBody request: PackageVersionUpdateRequest, @RequestParam realIpAddress: String? = null ): Response - @ApiOperation("搜索包") + @Operation(summary = "搜索包") @PostMapping("/package/search") fun searchPackage( @RequestBody queryModel: QueryModel ): Response>> - @ApiOperation("分页查询版本") + @Operation(summary = "分页查询版本") @PostMapping("/version/page/{projectId}/{repoName}") fun listVersionPage( @PathVariable projectId: String, @@ -150,7 +150,7 @@ interface PackageClient { @RequestBody option: VersionListOption = VersionListOption() ): Response> - @ApiOperation("查询所有版本") + @Operation(summary = "查询所有版本") @PostMapping("/version/list/{projectId}/{repoName}") fun listAllVersion( @PathVariable projectId: String, @@ -159,7 +159,7 @@ interface PackageClient { @RequestBody option: VersionListOption = VersionListOption() ): Response> - @ApiOperation("分页查询包") + @Operation(summary = "分页查询包") @PostMapping("/package/page/{projectId}/{repoName}") fun listPackagePage( @PathVariable projectId: String, @@ -167,7 +167,7 @@ interface PackageClient { @RequestBody option: PackageListOption = PackageListOption() ): Response> - @ApiOperation("列出包中已存在的版本") + @Operation(summary = "列出包中已存在的版本") @PostMapping("/exist/list/{projectId}/{repoName}") fun listExistPackageVersion( @PathVariable projectId: String, @@ -176,14 +176,14 @@ interface PackageClient { @RequestBody packageVersionList: List = emptyList() ): Response> - @ApiOperation("查询所有包名称") + @Operation(summary = "查询所有包名称") @PostMapping("/package/list/{projectId}/{repoName}") fun listAllPackageNames( @PathVariable projectId: String, @PathVariable repoName: String ): Response> - @ApiOperation("查询包数量") + @Operation(summary = "查询包数量") @PostMapping("/package/count/{projectId}/{repoName}") fun getPackageCount( @PathVariable projectId: String, @@ -195,7 +195,7 @@ interface PackageClient { * 1. 如果包已经存在则不会更新包，跳到步骤2，否则创建新包 * 2. 遍历versionList进行版本创建，如果版本已经存在则跳过。 */ - @ApiOperation("包版本数据填充") + @Operation(summary = "包版本数据填充") @PostMapping("/package/populate") fun populatePackage( @RequestBody request: PackagePopulateRequest diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/PackageDownloadsClient.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/PackageDownloadsClient.kt index f8e8f45c56..a09a4fee28 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/PackageDownloadsClient.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/PackageDownloadsClient.kt @@ -38,30 +38,30 @@ import com.tencent.bkrepo.repository.pojo.download.PackageDownloadRecord import com.tencent.bkrepo.repository.pojo.download.PackageDownloadsDetails import com.tencent.bkrepo.repository.pojo.download.PackageDownloadsSummary import com.tencent.bkrepo.repository.pojo.download.SummaryQueryRequest -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.context.annotation.Primary import org.springframework.web.bind.annotation.PostMapping import org.springframework.web.bind.annotation.RequestBody import org.springframework.web.bind.annotation.RequestMapping -@Api("包下载统计服务接口") +@Tag(name = "包下载统计服务接口") @Primary @FeignClient(REPOSITORY_SERVICE_NAME, contextId = "PackageDownloadsClient") @RequestMapping("/service/package/downloads/") @Deprecated("replace with PackageDownloadsService") interface PackageDownloadsClient { - @ApiOperation("记录包下载") + @Operation(summary = "记录包下载") @PostMapping("/record") fun record(@RequestBody record: PackageDownloadRecord): Response - @ApiOperation("查询包下载记录明细") + @Operation(summary = "查询包下载记录明细") @PostMapping("/details") fun queryDetails(@RequestBody request: DetailsQueryRequest): Response - @ApiOperation("查询包下载总览") + @Operation(summary = "查询包下载总览") @PostMapping("/summary") fun querySummary(@RequestBody request: SummaryQueryRequest): Response } diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/PackageMetadataClient.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/PackageMetadataClient.kt index b167cf6969..2df1d8c8e4 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/PackageMetadataClient.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/PackageMetadataClient.kt @@ -34,8 +34,8 @@ package com.tencent.bkrepo.repository.api import com.tencent.bkrepo.common.api.constant.REPOSITORY_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.repository.pojo.metadata.packages.PackageMetadataSaveRequest -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.context.annotation.Primary import org.springframework.web.bind.annotation.PostMapping @@ -45,14 +45,14 @@ import org.springframework.web.bind.annotation.RequestMapping /** * 节点元数据服务接口 */ -@Api("节点元数据服务接口") +@Tag(name = "节点元数据服务接口") @Primary @FeignClient(REPOSITORY_SERVICE_NAME, contextId = "PackageMetadataClient") @RequestMapping("/service/metadata/package") @Deprecated("replace with PackageMetadataService") interface PackageMetadataClient { - @ApiOperation("创建/更新元数据列表") + @Operation(summary = "创建/更新元数据列表") @PostMapping("/save") fun saveMetadata(@RequestBody request: PackageMetadataSaveRequest): Response diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/PipelineNodeClient.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/PipelineNodeClient.kt index c77f742ce9..8dacb7bcfa 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/PipelineNodeClient.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/PipelineNodeClient.kt @@ -30,19 +30,19 @@ package com.tencent.bkrepo.repository.api import com.tencent.bkrepo.common.api.constant.REPOSITORY_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.repository.pojo.node.NodeInfo -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable import org.springframework.web.bind.annotation.RequestMapping -@Api("流水线节点") +@Tag(name = "流水线节点") @FeignClient(REPOSITORY_SERVICE_NAME, contextId = "PipelineNodeClient", primary = false) @RequestMapping("/service/pipeline") @Deprecated("replace with PipelineNodeService") interface PipelineNodeClient { @GetMapping("/list/{projectId}/{repoName}") - @ApiOperation("获取流水线制品目录") + @Operation(summary = "获取流水线制品目录") fun listPipeline(@PathVariable projectId: String, @PathVariable repoName: String): Response> } diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/ProjectClient.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/ProjectClient.kt index 5375d0a99f..90ee2e3a69 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/ProjectClient.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/ProjectClient.kt @@ -38,9 +38,9 @@ import com.tencent.bkrepo.repository.pojo.project.ProjectCreateRequest import com.tencent.bkrepo.repository.pojo.project.ProjectInfo import com.tencent.bkrepo.repository.pojo.project.ProjectMetricsInfo import com.tencent.bkrepo.repository.pojo.project.ProjectRangeQueryRequest -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.context.annotation.Primary import org.springframework.web.bind.annotation.GetMapping @@ -49,34 +49,34 @@ import org.springframework.web.bind.annotation.PostMapping import org.springframework.web.bind.annotation.RequestBody import org.springframework.web.bind.annotation.RequestMapping -@Api(description = "服务-项目接口") +@Tag(name = "服务-项目接口") @Primary @FeignClient(REPOSITORY_SERVICE_NAME, contextId = "ProjectClient") @RequestMapping("/service/project") @Deprecated("replace with ProjectService") interface ProjectClient { - @ApiOperation("查询项目信息") + @Operation(summary = "查询项目信息") @GetMapping("/info/{name}") - fun getProjectInfo(@ApiParam(value = "项目名") @PathVariable name: String): Response + fun getProjectInfo(@Parameter(name = "项目名") @PathVariable name: String): Response - @ApiOperation("列表查询项目") + @Operation(summary = "列表查询项目") @GetMapping("/list") fun listProject(): Response> - @ApiOperation("分页查询项目") + @Operation(summary = "分页查询项目") @PostMapping("/rangeQuery") fun rangeQuery(@RequestBody request: ProjectRangeQueryRequest): Response> - @ApiOperation("创建项目") + @Operation(summary = "创建项目") @PostMapping("/create") fun createProject(@RequestBody request: ProjectCreateRequest): Response - @ApiOperation("项目仓库统计信息列表") + @Operation(summary = "项目仓库统计信息列表") @PostMapping("/metrics/{name}") - fun getProjectMetrics(@ApiParam(value = "项目名") @PathVariable name: String): Response + fun getProjectMetrics(@Parameter(name = "项目名") @PathVariable name: String): Response - @ApiOperation("获取项目启用/禁用状态") + @Operation(summary = "获取项目启用/禁用状态") @PostMapping("/enabled/{name}") - fun isProjectEnabled(@ApiParam(value = "项目名") @PathVariable name: String): Response + fun isProjectEnabled(@Parameter(name = "项目名") @PathVariable name: String): Response } diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/ProjectUsageStatisticsClient.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/ProjectUsageStatisticsClient.kt index ce30893ee5..569fe5e72f 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/ProjectUsageStatisticsClient.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/ProjectUsageStatisticsClient.kt @@ -29,19 +29,19 @@ package com.tencent.bkrepo.repository.api import com.tencent.bkrepo.common.api.constant.REPOSITORY_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.web.bind.annotation.PostMapping import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam -@Api("操作统计数据接口") +@Tag(name = "操作统计数据接口") @FeignClient(REPOSITORY_SERVICE_NAME, contextId = "ProjectUsageStatisticsClient") @RequestMapping("/service/project/usage/statistics") @Deprecated("replace with ProjectUsageStatisticsService") interface ProjectUsageStatisticsClient { - @ApiOperation("增加使用数据") + @Operation(summary = "增加使用数据") @PostMapping("/inc") fun inc( @RequestParam projectId: String, diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/ProxyChannelClient.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/ProxyChannelClient.kt index 4b8efe8c62..e3a3065214 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/ProxyChannelClient.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/ProxyChannelClient.kt @@ -34,8 +34,8 @@ package com.tencent.bkrepo.repository.api import com.tencent.bkrepo.common.api.constant.REPOSITORY_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.repository.pojo.proxy.ProxyChannelInfo -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter import org.springframework.cloud.openfeign.FeignClient import org.springframework.context.annotation.Primary import org.springframework.web.bind.annotation.GetMapping @@ -52,16 +52,16 @@ import org.springframework.web.bind.annotation.RequestParam @Deprecated("replace by ProxyChannelService") interface ProxyChannelClient { - @ApiOperation("查询代理源信息") + @Operation(summary = "查询代理源信息") @GetMapping("/{projectId}/{repoName}") fun getByUniqueId( - @ApiParam(value = "所属项目", required = true) + @Parameter(name = "所属项目", required = true) @PathVariable projectId: String, - @ApiParam(value = "仓库名称", required = true) + @Parameter(name = "仓库名称", required = true) @PathVariable repoName: String, - @ApiParam(value = "type", required = true) + @Parameter(name = "type", required = true) @RequestParam repoType: String, - @ApiParam(value = "name", required = true) + @Parameter(name = "name", required = true) @RequestParam name: String ): Response } diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/RepositoryClient.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/RepositoryClient.kt index 02f72a1809..8493a484ee 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/RepositoryClient.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/RepositoryClient.kt @@ -42,9 +42,9 @@ import com.tencent.bkrepo.repository.pojo.repo.RepoListOption import com.tencent.bkrepo.repository.pojo.repo.RepoUpdateRequest import com.tencent.bkrepo.repository.pojo.repo.RepositoryDetail import com.tencent.bkrepo.repository.pojo.repo.RepositoryInfo -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping @@ -57,71 +57,71 @@ import org.springframework.web.bind.annotation.RequestParam /** * 仓库服务接口 */ -@Api("仓库服务接口") +@Tag(name = "仓库服务接口") @FeignClient(REPOSITORY_SERVICE_NAME, contextId = "RepositoryClient", primary = false) @RequestMapping("/service/repo") @Deprecated("replace with RepositoryService") interface RepositoryClient { - @ApiOperation("查询仓库信息") + @Operation(summary = "查询仓库信息") @GetMapping("/info/{projectId}/{repoName}") fun getRepoInfo( - @ApiParam(value = "所属项目", required = true) + @Parameter(name = "所属项目", required = true) @PathVariable projectId: String, - @ApiParam(value = "仓库名称", required = true) + @Parameter(name = "仓库名称", required = true) @PathVariable repoName: String ): Response - @ApiOperation("查询仓库详情") + @Operation(summary = "查询仓库详情") @GetMapping("/detail/{projectId}/{repoName}") fun getRepoDetail( - @ApiParam(value = "所属项目", required = true) + @Parameter(name = "所属项目", required = true) @PathVariable projectId: String, - @ApiParam(value = "仓库名称", required = true) + @Parameter(name = "仓库名称", required = true) @PathVariable repoName: String, - @ApiParam(value = "仓库类型", required = true) + @Parameter(name = "仓库类型", required = true) @RequestParam type: String? = null ): Response - @ApiOperation("列表查询项目所有仓库") + @Operation(summary = "列表查询项目所有仓库") @GetMapping("/list/{projectId}") fun listRepo( - @ApiParam(value = "项目id", required = true) + @Parameter(name = "项目id", required = true) @PathVariable projectId: String, - @ApiParam("仓库名称", required = false) + @Parameter(name = "仓库名称", required = false) @RequestParam name: String? = null, - @ApiParam("仓库类型", required = false) + @Parameter(name = "仓库类型", required = false) @RequestParam type: String? = null ): Response> - @ApiOperation("仓库分页查询") + @Operation(summary = "仓库分页查询") @PostMapping("/rangeQuery") fun rangeQuery(@RequestBody request: RepoRangeQueryRequest): Response> - @ApiOperation("创建仓库") + @Operation(summary = "创建仓库") @PostMapping("/create") fun createRepo(@RequestBody request: RepoCreateRequest): Response - @ApiOperation("修改仓库") + @Operation(summary = "修改仓库") @PostMapping("/update") fun updateRepo(@RequestBody request: RepoUpdateRequest): Response - @ApiOperation("删除仓库") + @Operation(summary = "删除仓库") @DeleteMapping("/delete") fun deleteRepo(@RequestBody request: RepoDeleteRequest): Response - @ApiOperation("分页查询指定类型仓库") + @Operation(summary = "分页查询指定类型仓库") @GetMapping("/page/repoType/{page}/{size}/{repoType}") fun pageByType( - @ApiParam(value = "当前页", required = true, example = "0") + @Parameter(name = "当前页", required = true, example = "0") @PathVariable page: Int, - @ApiParam(value = "分页大小", required = true, example = "20") + @Parameter(name = "分页大小", required = true, example = "20") @PathVariable size: Int, - @ApiParam(value = "仓库类型", required = true) + @Parameter(name = "仓库类型", required = true) @PathVariable repoType: String ): Response> - @ApiOperation("查询项目下的有权限的仓库列表") + @Operation(summary = "查询项目下的有权限的仓库列表") @PostMapping("/permission/{userId}/{projectId}") fun listPermissionRepo( @PathVariable userId: String, @@ -129,14 +129,14 @@ interface RepositoryClient { @RequestBody option: RepoListOption ): Response> - @ApiOperation("查询仓库大小信息") + @Operation(summary = "查询仓库大小信息") @GetMapping("/stat/{projectId}/{repoName}") fun statRepo( @PathVariable projectId: String, @PathVariable repoName: String, ): Response - @ApiOperation("更新仓库存储") + @Operation(summary = "更新仓库存储") @PostMapping("/update/storage/{projectId}/{repoName}") fun updateStorageCredentialsKey( @PathVariable projectId: String, @@ -144,7 +144,7 @@ interface RepositoryClient { @RequestParam storageCredentialsKey: String? ): Response - @ApiOperation("重置仓库旧存储") + @Operation(summary = "重置仓库旧存储") @PostMapping("/unset/storage/{projectId}/{repoName}") fun unsetOldStorageCredentialsKey( @PathVariable projectId: String, diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/StageClient.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/StageClient.kt index 107752069a..5f3a53fea6 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/StageClient.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/StageClient.kt @@ -34,7 +34,7 @@ package com.tencent.bkrepo.repository.api import com.tencent.bkrepo.common.api.constant.REPOSITORY_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.repository.pojo.stage.StageUpgradeRequest -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation import org.springframework.cloud.openfeign.FeignClient import org.springframework.context.annotation.Primary import org.springframework.web.bind.annotation.GetMapping @@ -50,7 +50,7 @@ import org.springframework.web.bind.annotation.RequestParam @Deprecated("replace with StageService") interface StageClient { - @ApiOperation("查询晋级状态") + @Operation(summary = "查询晋级状态") @GetMapping("/{projectId}/{repoName}") fun query( @PathVariable projectId: String, @@ -59,7 +59,7 @@ interface StageClient { @RequestParam version: String ): Response> - @ApiOperation("制品晋级") + @Operation(summary = "制品晋级") @PostMapping("/upgrade") fun upgrade(@RequestBody request: StageUpgradeRequest): Response } diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/cluster/ClusterMetadataClient.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/cluster/ClusterMetadataClient.kt index 1fa3398e8f..6f0a6f97c9 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/cluster/ClusterMetadataClient.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/cluster/ClusterMetadataClient.kt @@ -31,28 +31,28 @@ import com.tencent.bkrepo.common.api.constant.REPOSITORY_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.repository.pojo.metadata.MetadataDeleteRequest import com.tencent.bkrepo.repository.pojo.metadata.MetadataSaveRequest -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.PostMapping import org.springframework.web.bind.annotation.RequestBody import org.springframework.web.bind.annotation.RequestMapping -@Api("节点元数据集群接口") +@Tag(name = "节点元数据集群接口") @FeignClient(REPOSITORY_SERVICE_NAME, contextId = "ClusterMetadataClient") @RequestMapping("/cluster/metadata") interface ClusterMetadataClient { - @ApiOperation("创建/更新元数据列表") + @Operation(summary = "创建/更新元数据列表") @PostMapping("/save") fun saveMetadata(@RequestBody request: MetadataSaveRequest): Response - @ApiOperation("删除元数据") + @Operation(summary = "删除元数据") @DeleteMapping("/delete") fun deleteMetadata(@RequestBody request: MetadataDeleteRequest): Response - @ApiOperation("添加禁用元数据") + @Operation(summary = "添加禁用元数据") @PostMapping("/forbid") fun addForbidMetadata(@RequestBody request: MetadataSaveRequest): Response } diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/cluster/ClusterNodeClient.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/cluster/ClusterNodeClient.kt index 545f171dfe..4854133b56 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/cluster/ClusterNodeClient.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/cluster/ClusterNodeClient.kt @@ -29,6 +29,7 @@ package com.tencent.bkrepo.repository.api.cluster import com.tencent.bkrepo.common.api.constant.REPOSITORY_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response +import com.tencent.bkrepo.common.metadata.pojo.node.NodeRestoreRequest import com.tencent.bkrepo.repository.pojo.node.NodeDeleteResult import com.tencent.bkrepo.repository.pojo.node.NodeDetail import com.tencent.bkrepo.repository.pojo.node.NodeRestoreResult @@ -36,12 +37,11 @@ import com.tencent.bkrepo.repository.pojo.node.service.NodeCreateRequest import com.tencent.bkrepo.repository.pojo.node.service.NodeDeleteRequest import com.tencent.bkrepo.repository.pojo.node.service.NodeMoveCopyRequest import com.tencent.bkrepo.repository.pojo.node.service.NodeRenameRequest -import com.tencent.bkrepo.common.metadata.pojo.node.NodeRestoreRequest import com.tencent.bkrepo.repository.pojo.node.service.NodeUpdateAccessDateRequest import com.tencent.bkrepo.repository.pojo.node.service.NodeUpdateRequest import com.tencent.bkrepo.repository.pojo.node.service.NodesDeleteRequest -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping @@ -52,12 +52,12 @@ import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam import java.time.LocalDateTime -@Api("节点集群接口") +@Tag(name = "节点集群接口") @FeignClient(REPOSITORY_SERVICE_NAME, contextId = "ClusterNodeClient") @RequestMapping("/cluster/node") interface ClusterNodeClient { - @ApiOperation("根据路径查看节点详情") + @Operation(summary = "根据路径查看节点详情") @GetMapping("/detail/{projectId}/{repoName}") fun getNodeDetail( @PathVariable projectId: String, @@ -65,39 +65,39 @@ interface ClusterNodeClient { @RequestParam fullPath: String ): Response - @ApiOperation("创建节点") + @Operation(summary = "创建节点") @PostMapping("/create") fun createNode(@RequestBody nodeCreateRequest: NodeCreateRequest): Response - @ApiOperation("更新节点") + @Operation(summary = "更新节点") @PostMapping("/update") fun updateNode(@RequestBody nodeUpdateRequest: NodeUpdateRequest): Response - @ApiOperation("更新节点访问时间") + @Operation(summary = "更新节点访问时间") @PostMapping("/update/access/") fun updateNodeAccessDate(@RequestBody nodeUpdateAccessDateRequest: NodeUpdateAccessDateRequest): Response - @ApiOperation("重命名节点") + @Operation(summary = "重命名节点") @PostMapping("/rename") fun renameNode(@RequestBody nodeRenameRequest: NodeRenameRequest): Response - @ApiOperation("移动节点") + @Operation(summary = "移动节点") @PostMapping("/move") fun moveNode(@RequestBody nodeMoveRequest: NodeMoveCopyRequest): Response - @ApiOperation("复制节点") + @Operation(summary = "复制节点") @PostMapping("/copy") fun copyNode(@RequestBody nodeCopyRequest: NodeMoveCopyRequest): Response - @ApiOperation("删除节点") + @Operation(summary = "删除节点") @DeleteMapping("/delete") fun deleteNode(@RequestBody nodeDeleteRequest: NodeDeleteRequest): Response - @ApiOperation("删除节点") + @Operation(summary = "删除节点") @DeleteMapping("/batch/delete") fun deleteNodes(@RequestBody nodesDeleteRequest: NodesDeleteRequest): Response - @ApiOperation("删除节点") + @Operation(summary = "删除节点") @DeleteMapping("/clean/{projectId}/{repoName}/") fun deleteNodeLastModifiedBeforeDate( @PathVariable projectId: String, @@ -107,7 +107,7 @@ interface ClusterNodeClient { @RequestParam operator: String ): Response - @ApiOperation("恢复节点") + @Operation(summary = "恢复节点") @PostMapping("/restore") fun restoreNode(@RequestBody nodeRestoreRequest: NodeRestoreRequest): Response } diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/cluster/ClusterNodeShareClient.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/cluster/ClusterNodeShareClient.kt index b6c79654a1..c3290bb44c 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/cluster/ClusterNodeShareClient.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/cluster/ClusterNodeShareClient.kt @@ -32,8 +32,8 @@ import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.repository.pojo.share.ClusterShareRecordCreateRequest import com.tencent.bkrepo.repository.pojo.share.ClusterShareTokenCheckRequest import com.tencent.bkrepo.repository.pojo.share.ShareRecordInfo -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.context.annotation.Primary import org.springframework.web.bind.annotation.PostMapping @@ -44,16 +44,16 @@ import org.springframework.web.bind.annotation.RequestMapping /** * 节点分享服务接口 */ -@Api("节点分享服务接口") +@Tag(name = "节点分享服务接口") @Primary @FeignClient(REPOSITORY_SERVICE_NAME, contextId = "ClusterNodeShareClient", primary = false) @RequestMapping("/cluster/node/share") interface ClusterNodeShareClient { - @ApiOperation("创建分享链接") + @Operation(summary = "创建分享链接") @PostMapping("/create") fun create(@RequestBody request: ClusterShareRecordCreateRequest): Response - @ApiOperation("检查token") + @Operation(summary = "检查token") @PostMapping("/token") fun checkToken(@RequestBody request: ClusterShareTokenCheckRequest): Response } diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/cluster/ClusterOperateLogClient.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/cluster/ClusterOperateLogClient.kt index fefa3d8f17..1944e5697c 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/cluster/ClusterOperateLogClient.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/cluster/ClusterOperateLogClient.kt @@ -31,33 +31,33 @@ import com.tencent.bkrepo.common.api.constant.REPOSITORY_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.common.artifact.event.base.ArtifactEvent import com.tencent.bkrepo.common.metadata.pojo.log.OperateLog -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.context.annotation.Primary import org.springframework.web.bind.annotation.PostMapping import org.springframework.web.bind.annotation.RequestBody import org.springframework.web.bind.annotation.RequestMapping -@Api("操作日志服务接口") +@Tag(name = "操作日志服务接口") @Primary @FeignClient(REPOSITORY_SERVICE_NAME, contextId = "ClusterOperateLogClient") @RequestMapping("/cluster/log") interface ClusterOperateLogClient { - @ApiOperation("记录操作日志") + @Operation(summary = "记录操作日志") @PostMapping("/record") fun record(@RequestBody event: ArtifactEvent): Response - @ApiOperation("批量记录操作日志") + @Operation(summary = "批量记录操作日志") @PostMapping("/record/batch") fun batchRecord(@RequestBody eventList: List): Response - @ApiOperation("记录操作日志") + @Operation(summary = "记录操作日志") @PostMapping("/save") fun save(@RequestBody log: OperateLog): Response - @ApiOperation("批量记录操作日志") + @Operation(summary = "批量记录操作日志") @PostMapping("/save/batch") fun batchSave(@RequestBody logs: List): Response } diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/cluster/ClusterPackageClient.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/cluster/ClusterPackageClient.kt index fff84ccd06..fa9a709c38 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/cluster/ClusterPackageClient.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/cluster/ClusterPackageClient.kt @@ -36,7 +36,7 @@ import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.repository.pojo.packages.request.PackageUpdateRequest import com.tencent.bkrepo.repository.pojo.packages.request.PackageVersionCreateRequest import com.tencent.bkrepo.repository.pojo.packages.request.PackageVersionUpdateRequest -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation import org.springframework.cloud.openfeign.FeignClient import org.springframework.context.annotation.Primary import org.springframework.web.bind.annotation.DeleteMapping @@ -51,14 +51,14 @@ import org.springframework.web.bind.annotation.RequestParam @RequestMapping("/cluster") interface ClusterPackageClient { - @ApiOperation("创建包版本") + @Operation(summary = "创建包版本") @PostMapping("/version/create") fun createVersion( @RequestBody request: PackageVersionCreateRequest, @RequestParam realIpAddress: String? = null ): Response - @ApiOperation("删除包") + @Operation(summary = "删除包") @DeleteMapping("/package/delete/{projectId}/{repoName}") fun deletePackage( @PathVariable projectId: String, @@ -67,7 +67,7 @@ interface ClusterPackageClient { @RequestParam realIpAddress: String? = null ): Response - @ApiOperation("删除版本") + @Operation(summary = "删除版本") @DeleteMapping("/version/delete/{projectId}/{repoName}") fun deleteVersion( @PathVariable projectId: String, @@ -78,14 +78,14 @@ interface ClusterPackageClient { @RequestParam contentPath: String? = null, ): Response - @ApiOperation("更新包") + @Operation(summary = "更新包") @PostMapping("/package/update") fun updatePackage( @RequestBody request: PackageUpdateRequest, @RequestParam realIpAddress: String? = null ): Response - @ApiOperation("更新版本") + @Operation(summary = "更新版本") @PostMapping("/version/update") fun updateVersion( @RequestBody request: PackageVersionUpdateRequest, diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/cluster/ClusterProjectClient.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/cluster/ClusterProjectClient.kt index 1b39f6612d..96593fccb0 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/cluster/ClusterProjectClient.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/cluster/ClusterProjectClient.kt @@ -31,19 +31,19 @@ import com.tencent.bkrepo.common.api.constant.REPOSITORY_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.repository.pojo.project.ProjectCreateRequest import com.tencent.bkrepo.repository.pojo.project.ProjectInfo -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.web.bind.annotation.PostMapping import org.springframework.web.bind.annotation.RequestBody import org.springframework.web.bind.annotation.RequestMapping -@Api(description = "项目集群接口") +@Tag(name = "项目集群接口") @FeignClient(REPOSITORY_SERVICE_NAME, contextId = "ClusterProjectClient") @RequestMapping("/cluster/project") interface ClusterProjectClient { - @ApiOperation("创建项目") + @Operation(summary = "创建项目") @PostMapping("/create") fun createProject(@RequestBody request: ProjectCreateRequest): Response } diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/cluster/ClusterRepositoryClient.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/cluster/ClusterRepositoryClient.kt index f1690bc505..7ada6d347e 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/cluster/ClusterRepositoryClient.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/cluster/ClusterRepositoryClient.kt @@ -33,9 +33,9 @@ import com.tencent.bkrepo.repository.pojo.repo.RepoCreateRequest import com.tencent.bkrepo.repository.pojo.repo.RepoDeleteRequest import com.tencent.bkrepo.repository.pojo.repo.RepoUpdateRequest import com.tencent.bkrepo.repository.pojo.repo.RepositoryDetail -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping @@ -44,29 +44,29 @@ import org.springframework.web.bind.annotation.PostMapping import org.springframework.web.bind.annotation.RequestBody import org.springframework.web.bind.annotation.RequestMapping -@Api("仓库集群接口") +@Tag(name = "仓库集群接口") @FeignClient(REPOSITORY_SERVICE_NAME, contextId = "ClusterRepositoryClient") @RequestMapping("/cluster/repo") interface ClusterRepositoryClient { - @ApiOperation("查询仓库信息") + @Operation(summary = "查询仓库信息") @GetMapping("/detail/{projectId}/{repoName}") fun getRepoDetail( - @ApiParam(value = "所属项目", required = true) + @Parameter(name = "所属项目", required = true) @PathVariable projectId: String, - @ApiParam(value = "仓库名称", required = true) + @Parameter(name = "仓库名称", required = true) @PathVariable repoName: String ): Response - @ApiOperation("创建仓库") + @Operation(summary = "创建仓库") @PostMapping("/create") fun createRepo(@RequestBody request: RepoCreateRequest): Response - @ApiOperation("修改仓库") + @Operation(summary = "修改仓库") @PostMapping("/update") fun updateRepo(@RequestBody request: RepoUpdateRequest): Response - @ApiOperation("删除仓库") + @Operation(summary = "删除仓库") @DeleteMapping("/delete") fun deleteRepo(@RequestBody request: RepoDeleteRequest): Response } diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/cluster/ClusterStageClient.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/cluster/ClusterStageClient.kt index 98cf4ecac7..7e4d0b4be6 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/cluster/ClusterStageClient.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/cluster/ClusterStageClient.kt @@ -34,7 +34,7 @@ package com.tencent.bkrepo.repository.api.cluster import com.tencent.bkrepo.common.api.constant.REPOSITORY_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.repository.pojo.stage.StageUpgradeRequest -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation import org.springframework.cloud.openfeign.FeignClient import org.springframework.context.annotation.Primary import org.springframework.web.bind.annotation.PostMapping @@ -46,7 +46,7 @@ import org.springframework.web.bind.annotation.RequestMapping @RequestMapping("/cluster/stage") interface ClusterStageClient { - @ApiOperation("制品晋级") + @Operation(summary = "制品晋级") @PostMapping("/upgrade") fun upgrade(@RequestBody request: StageUpgradeRequest): Response } diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/proxy/ProxyFileReferenceClient.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/proxy/ProxyFileReferenceClient.kt index 223296b9b1..3454207555 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/proxy/ProxyFileReferenceClient.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/proxy/ProxyFileReferenceClient.kt @@ -29,13 +29,13 @@ package com.tencent.bkrepo.repository.api.proxy import com.tencent.bkrepo.common.api.constant.REPOSITORY_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response -import io.swagger.annotations.Api +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam -@Api("文件引用服务接口") +@Tag(name = "文件引用服务接口") @FeignClient(REPOSITORY_SERVICE_NAME, contextId = "ProxyFileReferenceClient", primary = false) @RequestMapping("/proxy/fileReference") interface ProxyFileReferenceClient { diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/proxy/ProxyNodeClient.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/proxy/ProxyNodeClient.kt index bf374d8d87..67735525fc 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/proxy/ProxyNodeClient.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/proxy/ProxyNodeClient.kt @@ -33,9 +33,9 @@ import com.tencent.bkrepo.repository.pojo.node.NodeDetail import com.tencent.bkrepo.repository.pojo.node.NodeInfo import com.tencent.bkrepo.repository.pojo.node.service.NodeCreateRequest import com.tencent.bkrepo.repository.pojo.node.service.NodeUpdateAccessDateRequest -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable @@ -44,12 +44,12 @@ import org.springframework.web.bind.annotation.RequestBody import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam -@Api("节点服务接口") +@Tag(name = "节点服务接口") @FeignClient(REPOSITORY_SERVICE_NAME, contextId = "ProxyNodeClient", primary = false) @RequestMapping("/proxy/node") interface ProxyNodeClient { - @ApiOperation("根据路径查看节点详情") + @Operation(summary = "根据路径查看节点详情") @GetMapping("/detail/{projectId}/{repoName}") fun getNodeDetail( @PathVariable projectId: String, @@ -57,28 +57,28 @@ interface ProxyNodeClient { @RequestParam fullPath: String ): Response - @ApiOperation("创建节点") + @Operation(summary = "创建节点") @PostMapping("/create") fun createNode(@RequestBody nodeCreateRequest: NodeCreateRequest): Response - @ApiOperation("列表查询指定目录下所有节点") + @Operation(summary = "列表查询指定目录下所有节点") @GetMapping("/list/{projectId}/{repoName}") fun listNode( - @ApiParam(value = "所属项目", required = true) + @Parameter(name = "所属项目", required = true) @PathVariable projectId: String, - @ApiParam(value = "仓库名称", required = true) + @Parameter(name = "仓库名称", required = true) @PathVariable repoName: String, - @ApiParam(value = "所属目录", required = true) + @Parameter(name = "所属目录", required = true) @RequestParam path: String, - @ApiParam(value = "是否包含目录", required = false, defaultValue = "true") + @Parameter(name = "是否包含目录", required = false) @RequestParam includeFolder: Boolean = true, - @ApiParam(value = "是否深度查询文件", required = false, defaultValue = "false") + @Parameter(name = "是否深度查询文件", required = false) @RequestParam deep: Boolean = false, - @ApiParam(value = "是否包含元数据", required = false, defaultValue = "false") + @Parameter(name = "是否包含元数据", required = false) @RequestParam includeMetadata: Boolean = false ): Response> - @ApiOperation("更新节点访问时间") + @Operation(summary = "更新节点访问时间") @PostMapping("/update/access/") fun updateNodeAccessDate(@RequestBody nodeUpdateAccessDateRequest: NodeUpdateAccessDateRequest): Response diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/proxy/ProxyOperateLogClient.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/proxy/ProxyOperateLogClient.kt index fc5409dc9f..03702b8d0d 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/proxy/ProxyOperateLogClient.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/proxy/ProxyOperateLogClient.kt @@ -31,33 +31,33 @@ import com.tencent.bkrepo.common.api.constant.REPOSITORY_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.common.artifact.event.base.ArtifactEvent import com.tencent.bkrepo.common.metadata.pojo.log.OperateLog -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.context.annotation.Primary import org.springframework.web.bind.annotation.PostMapping import org.springframework.web.bind.annotation.RequestBody import org.springframework.web.bind.annotation.RequestMapping -@Api("操作日志服务接口") +@Tag(name = "操作日志服务接口") @Primary @FeignClient(REPOSITORY_SERVICE_NAME, contextId = "ProxyOperateLogClient") @RequestMapping("/proxy/log") interface ProxyOperateLogClient { - @ApiOperation("记录操作日志") + @Operation(summary = "记录操作日志") @PostMapping("/record") fun record(@RequestBody event: ArtifactEvent): Response - @ApiOperation("批量记录操作日志") + @Operation(summary = "批量记录操作日志") @PostMapping("/record/batch") fun batchRecord(@RequestBody eventList: List): Response - @ApiOperation("记录操作日志") + @Operation(summary = "记录操作日志") @PostMapping("/save") fun save(@RequestBody log: OperateLog): Response - @ApiOperation("批量记录操作日志") + @Operation(summary = "批量记录操作日志") @PostMapping("/save/batch") fun batchSave(@RequestBody logs: List): Response } diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/proxy/ProxyRepositoryClient.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/proxy/ProxyRepositoryClient.kt index 724fc5387f..e0ae5ccb4e 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/proxy/ProxyRepositoryClient.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/api/proxy/ProxyRepositoryClient.kt @@ -31,37 +31,37 @@ import com.tencent.bkrepo.common.api.constant.REPOSITORY_SERVICE_NAME import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.repository.pojo.repo.RepositoryDetail import com.tencent.bkrepo.repository.pojo.repo.RepositoryInfo -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam -@Api("仓库服务接口") +@Tag(name = "仓库服务接口") @FeignClient(REPOSITORY_SERVICE_NAME, contextId = "ProxyRepositoryClient", primary = false) @RequestMapping("/proxy/repo") interface ProxyRepositoryClient { - @ApiOperation("查询仓库详情") + @Operation(summary = "查询仓库详情") @GetMapping("/detail/{projectId}/{repoName}") fun getRepoDetail( - @ApiParam(value = "所属项目", required = true) + @Parameter(name = "所属项目", required = true) @PathVariable projectId: String, - @ApiParam(value = "仓库名称", required = true) + @Parameter(name = "仓库名称", required = true) @PathVariable repoName: String, - @ApiParam(value = "仓库类型", required = true) + @Parameter(name = "仓库类型", required = true) @RequestParam type: String? = null ): Response - @ApiOperation("查询仓库信息") + @Operation(summary = "查询仓库信息") @GetMapping("/info/{projectId}/{repoName}") fun getRepoInfo( - @ApiParam(value = "所属项目", required = true) + @Parameter(name = "所属项目", required = true) @PathVariable projectId: String, - @ApiParam(value = "仓库名称", required = true) + @Parameter(name = "仓库名称", required = true) @PathVariable repoName: String ): Response } diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/credendials/StorageCredentialsCreateRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/credendials/StorageCredentialsCreateRequest.kt index 6ae2b339fb..900d9c3857 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/credendials/StorageCredentialsCreateRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/credendials/StorageCredentialsCreateRequest.kt @@ -33,15 +33,15 @@ package com.tencent.bkrepo.repository.pojo.credendials import com.tencent.bkrepo.common.storage.credentials.StorageCredentials import com.tencent.bkrepo.repository.pojo.UserRequest -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("存储凭据创建请求") + +@Schema(title = "存储凭据创建请求") data class StorageCredentialsCreateRequest( - @ApiModelProperty("存储凭据key") + @get:Schema(title = "存储凭据key") val key: String, - @ApiModelProperty("凭据信息") + @get:Schema(title = "凭据信息") val credentials: StorageCredentials, - @ApiModelProperty("S3或COS类型存储凭据所在区域") + @get:Schema(title = "S3或COS类型存储凭据所在区域") val region: String ) : UserRequest diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/credendials/StorageCredentialsUpdateRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/credendials/StorageCredentialsUpdateRequest.kt index d21828d337..6a31bd7981 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/credendials/StorageCredentialsUpdateRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/credendials/StorageCredentialsUpdateRequest.kt @@ -29,13 +29,13 @@ package com.tencent.bkrepo.repository.pojo.credendials import com.tencent.bkrepo.common.storage.credentials.StorageCredentials import com.tencent.bkrepo.repository.pojo.UserRequest -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("存储凭据更新请求") + +@Schema(title = "存储凭据更新请求") data class StorageCredentialsUpdateRequest( - @ApiModelProperty("更新的存储凭据内容") + @get:Schema(title = "更新的存储凭据内容") val credentials: StorageCredentials, - @ApiModelProperty(hidden = true) + @get:Schema(hidden = true) var key: String? = null ) : UserRequest diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/dependent/PackageDependentsRelation.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/dependent/PackageDependentsRelation.kt index d0af9bf36c..9ad423634d 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/dependent/PackageDependentsRelation.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/dependent/PackageDependentsRelation.kt @@ -31,17 +31,17 @@ package com.tencent.bkrepo.repository.pojo.dependent -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("包依赖关系") + +@Schema(title = "包依赖关系") data class PackageDependentsRelation( - @ApiModelProperty("所属项目", required = true) + @get:Schema(title = "所属项目", required = true) val projectId: String, - @ApiModelProperty("仓库名称", required = true) + @get:Schema(title = "仓库名称", required = true) val repoName: String, - @ApiModelProperty("包唯一key", required = true) + @get:Schema(title = "包唯一key", required = true) val packageKey: String, - @ApiModelProperty("包依赖列表", required = true) + @get:Schema(title = "包依赖列表", required = true) val dependencies: Set ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/download/DetailsQueryRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/download/DetailsQueryRequest.kt index aea405272c..8c51dd2905 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/download/DetailsQueryRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/download/DetailsQueryRequest.kt @@ -31,22 +31,21 @@ package com.tencent.bkrepo.repository.pojo.download -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema import java.time.LocalDate -@ApiModel("包下载记录查询请求") +@Schema(title = "包下载记录查询请求") data class DetailsQueryRequest( - @ApiModelProperty("所属项目", required = true) + @get:Schema(title = "所属项目", required = true) val projectId: String, - @ApiModelProperty("仓库名称", required = true) + @get:Schema(title = "仓库名称", required = true) val repoName: String, - @ApiModelProperty("包唯一key", required = true) + @get:Schema(title = "包唯一key", required = true) val packageKey: String, - @ApiModelProperty("包版本，不提供则查询所有包版本数据", required = false) + @get:Schema(title = "包版本，不提供则查询所有包版本数据", required = false) val packageVersion: String? = null, - @ApiModelProperty("查询起始日期，默认为今天", required = false) + @get:Schema(title = "查询起始日期，默认为今天", required = false) val fromDate: LocalDate? = null, - @ApiModelProperty("查询截止日期，默认为今天", required = false) + @get:Schema(title = "查询截止日期，默认为今天", required = false) val toDate: LocalDate? = null ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/download/DownloadsMigrationRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/download/DownloadsMigrationRequest.kt index 2e0f8a324c..721ebeaf6f 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/download/DownloadsMigrationRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/download/DownloadsMigrationRequest.kt @@ -31,24 +31,24 @@ package com.tencent.bkrepo.repository.pojo.download -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + import java.time.LocalDate -@ApiModel("包下载记录迁移请求") +@Schema(title = "包下载记录迁移请求") data class DownloadsMigrationRequest( - @ApiModelProperty("所属项目", required = true) + @get:Schema(title = "所属项目", required = true) val projectId: String, - @ApiModelProperty("仓库名称", required = true) + @get:Schema(title = "仓库名称", required = true) val repoName: String, - @ApiModelProperty("包唯一key", required = true) + @get:Schema(title = "包唯一key", required = true) val packageKey: String, - @ApiModelProperty("包名称", required = true) + @get:Schema(title = "包名称", required = true) val packageName: String, - @ApiModelProperty("包版本", required = true) + @get:Schema(title = "包版本", required = true) val packageVersion: String, - @ApiModelProperty("日期", required = true) + @get:Schema(title = "日期", required = true) val date: LocalDate, - @ApiModelProperty("下载数量", required = true) + @get:Schema(title = "下载数量", required = true) val count: Long ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/download/PackageDownloadRecord.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/download/PackageDownloadRecord.kt index 3e587d1434..748debcb27 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/download/PackageDownloadRecord.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/download/PackageDownloadRecord.kt @@ -31,17 +31,17 @@ package com.tencent.bkrepo.repository.pojo.download -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("包下载记录") + +@Schema(title = "包下载记录") data class PackageDownloadRecord( - @ApiModelProperty("所属项目", required = true) + @get:Schema(title = "所属项目", required = true) val projectId: String, - @ApiModelProperty("仓库名称", required = true) + @get:Schema(title = "仓库名称", required = true) val repoName: String, - @ApiModelProperty("包唯一key", required = true) + @get:Schema(title = "包唯一key", required = true) val packageKey: String, - @ApiModelProperty("包版本", required = true) + @get:Schema(title = "包版本", required = true) val packageVersion: String ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/download/PackageDownloadsDetails.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/download/PackageDownloadsDetails.kt index 496e834d52..5c2b28817b 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/download/PackageDownloadsDetails.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/download/PackageDownloadsDetails.kt @@ -31,11 +31,11 @@ package com.tencent.bkrepo.repository.pojo.download -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("包下载明细记录") + +@Schema(title = "包下载明细记录") data class PackageDownloadsDetails( - @ApiModelProperty("每天下载数量, key格式为yyyy-mm-dd") + @get:Schema(title = "每天下载数量, key格式为yyyy-mm-dd") val details: Map ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/download/PackageDownloadsSummary.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/download/PackageDownloadsSummary.kt index 06d0f358a8..673b4194ea 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/download/PackageDownloadsSummary.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/download/PackageDownloadsSummary.kt @@ -31,17 +31,17 @@ package com.tencent.bkrepo.repository.pojo.download -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("包下载总览统计") + +@Schema(title = "包下载总览统计") data class PackageDownloadsSummary( - @ApiModelProperty("下载总数") + @get:Schema(title = "下载总数") val total: Long, - @ApiModelProperty("今日下载数") + @get:Schema(title = "今日下载数") val today: Long, - @ApiModelProperty("本周下载数") + @get:Schema(title = "本周下载数") val thisWeek: Long, - @ApiModelProperty("本月下载数") + @get:Schema(title = "本月下载数") val thisMonth: Long ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/download/SummaryQueryRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/download/SummaryQueryRequest.kt index f5efbe641c..fe4b664c58 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/download/SummaryQueryRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/download/SummaryQueryRequest.kt @@ -31,17 +31,17 @@ package com.tencent.bkrepo.repository.pojo.download -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("包下载总览查询请求") + +@Schema(title = "包下载总览查询请求") data class SummaryQueryRequest( - @ApiModelProperty("所属项目", required = true) + @get:Schema(title = "所属项目", required = true) val projectId: String, - @ApiModelProperty("仓库名称", required = true) + @get:Schema(title = "仓库名称", required = true) val repoName: String, - @ApiModelProperty("包唯一key", required = true) + @get:Schema(title = "包唯一key", required = true) val packageKey: String, - @ApiModelProperty("包版本，不提供则查询所有包版本数据", required = false) + @get:Schema(title = "包版本，不提供则查询所有包版本数据", required = false) val packageVersion: String? = null ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/favorite/FavoriteCreateRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/favorite/FavoriteCreateRequest.kt index 5c05d00039..ded4f8a7c8 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/favorite/FavoriteCreateRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/favorite/FavoriteCreateRequest.kt @@ -31,20 +31,21 @@ package com.tencent.bkrepo.repository.pojo.favorite -import io.swagger.annotations.ApiModelProperty + +import io.swagger.v3.oas.annotations.media.Schema import java.time.LocalDateTime data class FavoriteCreateRequest( - @ApiModelProperty("项目id") + @get:Schema(title = "项目id") val projectId: String, - @ApiModelProperty("仓库Name") + @get:Schema(title = "仓库Name") val repoName: String, - @ApiModelProperty("文件夹路径") + @get:Schema(title = "文件夹路径") val path: String, - @ApiModelProperty("收藏用户") + @get:Schema(title = "收藏用户") val userId: String, - @ApiModelProperty("收藏时间") + @get:Schema(title = "收藏时间") val createdDate: LocalDateTime, - @ApiModelProperty("类型") + @get:Schema(title = "类型") val type: FavoriteType ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/favorite/FavoriteRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/favorite/FavoriteRequest.kt index 325f6342f5..824a503b06 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/favorite/FavoriteRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/favorite/FavoriteRequest.kt @@ -31,17 +31,17 @@ package com.tencent.bkrepo.repository.pojo.favorite -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("创建收藏文件夹") + +@Schema(title = "创建收藏文件夹") data class FavoriteRequest( - @ApiModelProperty("项目id") + @get:Schema(title = "项目id") val projectId: String, - @ApiModelProperty("仓库id") + @get:Schema(title = "仓库id") val repoName: String, - @ApiModelProperty("文件夹路径") + @get:Schema(title = "文件夹路径") val path: String, - @ApiModelProperty("文件夹路径") + @get:Schema(title = "文件夹路径") val type: FavoriteType ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/favorite/FavoriteResult.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/favorite/FavoriteResult.kt index bf9e7ad065..db4fc4b72d 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/favorite/FavoriteResult.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/favorite/FavoriteResult.kt @@ -31,17 +31,18 @@ package com.tencent.bkrepo.repository.pojo.favorite -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + data class FavoriteResult( - @ApiModelProperty("id") + @get:Schema(title = "id") val id: String?, - @ApiModelProperty("项目id") + @get:Schema(title = "项目id") val projectId: String, - @ApiModelProperty("仓库id") + @get:Schema(title = "仓库id") val repoName: String, - @ApiModelProperty("文件夹路径") + @get:Schema(title = "文件夹路径") val path: String, - @ApiModelProperty("文件夹路径") + @get:Schema(title = "文件夹路径") val type: FavoriteType ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/metadata/MetadataDeleteRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/metadata/MetadataDeleteRequest.kt index caf3a12604..91330d6cd2 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/metadata/MetadataDeleteRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/metadata/MetadataDeleteRequest.kt @@ -34,22 +34,22 @@ package com.tencent.bkrepo.repository.pojo.metadata import com.tencent.bkrepo.repository.constant.SYSTEM_USER import com.tencent.bkrepo.repository.pojo.ServiceRequest import com.tencent.bkrepo.repository.pojo.node.NodeRequest -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 元数据删除请求 */ -@ApiModel("元数据删除请求") +@Schema(title = "元数据删除请求") data class MetadataDeleteRequest( - @ApiModelProperty("项目id", required = true) + @get:Schema(title = "项目id", required = true) override val projectId: String, - @ApiModelProperty("仓库名称", required = true) + @get:Schema(title = "仓库名称", required = true) override val repoName: String, - @ApiModelProperty("节点完整路径", required = true) + @get:Schema(title = "节点完整路径", required = true) override val fullPath: String, - @ApiModelProperty("待删除的元数据key列表", required = true) + @get:Schema(title = "待删除的元数据key列表", required = true) val keyList: Set, - @ApiModelProperty("操作用户") + @get:Schema(title = "操作用户") override val operator: String = SYSTEM_USER ) : NodeRequest, ServiceRequest diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/metadata/MetadataSaveRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/metadata/MetadataSaveRequest.kt index 6f0fb5ead1..ae85d0a1a1 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/metadata/MetadataSaveRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/metadata/MetadataSaveRequest.kt @@ -34,27 +34,27 @@ package com.tencent.bkrepo.repository.pojo.metadata import com.tencent.bkrepo.repository.constant.SYSTEM_USER import com.tencent.bkrepo.repository.pojo.ServiceRequest import com.tencent.bkrepo.repository.pojo.node.NodeRequest -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 创建/更新元数据请求 */ -@ApiModel("创建或更新元数据请求") +@Schema(title = "创建或更新元数据请求") data class MetadataSaveRequest( - @ApiModelProperty("项目id", required = true) + @get:Schema(title = "项目id", required = true) override val projectId: String, - @ApiModelProperty("仓库名称", required = true) + @get:Schema(title = "仓库名称", required = true) override val repoName: String, - @ApiModelProperty("节点完整路径", required = true) + @get:Schema(title = "节点完整路径", required = true) override val fullPath: String, - @ApiModelProperty("元数据key-value数据", required = true) + @get:Schema(title = "元数据key-value数据", required = true) @Deprecated("仅用于兼容旧接口", replaceWith = ReplaceWith("nodeMetadata")) val metadata: Map? = null, - @ApiModelProperty("需要创建或更新的元数据", required = true) + @get:Schema(title = "需要创建或更新的元数据", required = true) val nodeMetadata: List? = null, - @ApiModelProperty("是否替换元数据，删除原有元数据再新增元数据", required = false) + @get:Schema(title = "是否替换元数据，删除原有元数据再新增元数据", required = false) val replace: Boolean = false, - @ApiModelProperty("操作用户") + @get:Schema(title = "操作用户") override val operator: String = SYSTEM_USER ) : NodeRequest, ServiceRequest diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/metadata/UserMetadataDeleteRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/metadata/UserMetadataDeleteRequest.kt index 70aa0e2317..52587b3d30 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/metadata/UserMetadataDeleteRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/metadata/UserMetadataDeleteRequest.kt @@ -31,14 +31,14 @@ package com.tencent.bkrepo.repository.pojo.metadata -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 元数据删除请求 */ -@ApiModel("元数据删除请求") +@Schema(title = "元数据删除请求") data class UserMetadataDeleteRequest( - @ApiModelProperty("待删除的元数据key列表", required = true) + @get:Schema(title = "待删除的元数据key列表", required = true) val keyList: Set ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/metadata/UserMetadataSaveRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/metadata/UserMetadataSaveRequest.kt index 0acca5c932..28300c05dd 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/metadata/UserMetadataSaveRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/metadata/UserMetadataSaveRequest.kt @@ -31,17 +31,17 @@ package com.tencent.bkrepo.repository.pojo.metadata -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 创建/更新元数据请求 */ -@ApiModel("创建或更新元数据请求") +@Schema(title = "创建或更新元数据请求") data class UserMetadataSaveRequest( - @ApiModelProperty("元数据key-value数据") + @get:Schema(title = "元数据key-value数据") @Deprecated("仅用于兼容旧接口", replaceWith = ReplaceWith("nodeMetadata")) val metadata: Map? = null, - @ApiModelProperty("元数据") + @get:Schema(title = "元数据") val nodeMetadata: List? = null ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/metadata/packages/PackageMetadataSaveRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/metadata/packages/PackageMetadataSaveRequest.kt index f32d485946..dad3ef1e84 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/metadata/packages/PackageMetadataSaveRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/metadata/packages/PackageMetadataSaveRequest.kt @@ -35,24 +35,24 @@ import com.tencent.bkrepo.repository.constant.SYSTEM_USER import com.tencent.bkrepo.repository.pojo.ServiceRequest import com.tencent.bkrepo.repository.pojo.metadata.MetadataModel import com.tencent.bkrepo.repository.pojo.packages.PackageVersionRequest -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 包创建/更新元数据请求 */ -@ApiModel("依赖源包创建或更新元数据请求") +@Schema(title = "依赖源包创建或更新元数据请求") data class PackageMetadataSaveRequest( - @ApiModelProperty("项目id", required = true) + @get:Schema(title = "项目id", required = true) override val projectId: String, - @ApiModelProperty("仓库名称", required = true) + @get:Schema(title = "仓库名称", required = true) override val repoName: String, - @ApiModelProperty("包唯一key", required = true) + @get:Schema(title = "包唯一key", required = true) override val packageKey: String, - @ApiModelProperty("包版本", required = true) + @get:Schema(title = "包版本", required = true) override val version: String, - @ApiModelProperty("需要创建或更新的元数据", required = true) + @get:Schema(title = "需要创建或更新的元数据", required = true) val versionMetadata: List? = null, - @ApiModelProperty("操作用户") + @get:Schema(title = "操作用户") override val operator: String = SYSTEM_USER ) : PackageVersionRequest, ServiceRequest diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/metadata/packages/UserPackageMetadataSaveRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/metadata/packages/UserPackageMetadataSaveRequest.kt index ca580ac2c7..0f004f08b1 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/metadata/packages/UserPackageMetadataSaveRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/metadata/packages/UserPackageMetadataSaveRequest.kt @@ -32,18 +32,18 @@ package com.tencent.bkrepo.repository.pojo.metadata.packages import com.tencent.bkrepo.repository.pojo.metadata.MetadataModel -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 创建/更新元数据请求 */ -@ApiModel("创建或更新元数据请求") +@Schema(title = "创建或更新元数据请求") data class UserPackageMetadataSaveRequest( - @ApiModelProperty("包唯一key", required = true) + @get:Schema(title = "包唯一key", required = true) val packageKey: String, - @ApiModelProperty("包版本", required = true) + @get:Schema(title = "包版本", required = true) val version: String, - @ApiModelProperty("元数据") + @get:Schema(title = "元数据") val versionMetadata: List? = null ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/FileExtensionStatInfo.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/FileExtensionStatInfo.kt index dd7feb6f41..1d4d47e26c 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/FileExtensionStatInfo.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/FileExtensionStatInfo.kt @@ -31,22 +31,22 @@ package com.tencent.bkrepo.repository.pojo.node -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 文件后缀名统计信息类 */ -@ApiModel("文件后缀名统计信息类") +@Schema(title = "文件后缀名统计信息类") data class FileExtensionStatInfo( - @ApiModelProperty("项目id") + @get:Schema(title = "项目id") val projectId: String, - @ApiModelProperty("仓库名") + @get:Schema(title = "仓库名") val repoName: String?, - @ApiModelProperty("文件后缀名") + @get:Schema(title = "文件后缀名") val extension: String, - @ApiModelProperty("文件数量") + @get:Schema(title = "文件数量") val num: Long, - @ApiModelProperty("文件大小") + @get:Schema(title = "文件大小") val size: Long ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/NodeDeleteResult.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/NodeDeleteResult.kt index cd06a0f59c..d05248c7f1 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/NodeDeleteResult.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/NodeDeleteResult.kt @@ -27,19 +27,18 @@ package com.tencent.bkrepo.repository.pojo.node -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema import java.time.LocalDateTime /** * 节点删除结果 */ -@ApiModel("节点删除结果") +@Schema(title = "节点删除结果") data class NodeDeleteResult( - @ApiModelProperty("删除节点数量") + @get:Schema(title = "删除节点数量") val deletedNumber: Long, - @ApiModelProperty("删除节点大小") + @get:Schema(title = "删除节点大小") val deletedSize: Long, - @ApiModelProperty("删除时间") + @get:Schema(title = "删除时间") val deletedTime: LocalDateTime ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/NodeDeletedPoint.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/NodeDeletedPoint.kt index bb560042b6..8a46ab03f5 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/NodeDeletedPoint.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/NodeDeletedPoint.kt @@ -31,27 +31,26 @@ package com.tencent.bkrepo.repository.pojo.node -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema import java.time.LocalDateTime /** * 节点删除点 */ -@ApiModel("节点删除点") +@Schema(title = "节点删除点") data class NodeDeletedPoint( - @ApiModelProperty("记录id") + @get:Schema(title = "记录id") val id: Long, - @ApiModelProperty("完整路径") + @get:Schema(title = "完整路径") val fullPath: String, - @ApiModelProperty("文件大小，单位byte") + @get:Schema(title = "文件大小，单位byte") val size: Long, - @ApiModelProperty("文件sha256") + @get:Schema(title = "文件sha256") val sha256: String? = null, - @ApiModelProperty("元数据") + @get:Schema(title = "元数据") val metadata: Map, - @ApiModelProperty("删除用户") + @get:Schema(title = "删除用户") val deletedBy: String, - @ApiModelProperty("删除时间") + @get:Schema(title = "删除时间") val deletedTime: LocalDateTime ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/NodeDetail.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/NodeDetail.kt index 396e39d038..4aa7e1d914 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/NodeDetail.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/NodeDetail.kt @@ -34,58 +34,58 @@ package com.tencent.bkrepo.repository.pojo.node import com.tencent.bkrepo.common.artifact.constant.METADATA_KEY_PACKAGE_NAME import com.tencent.bkrepo.common.artifact.constant.METADATA_KEY_PACKAGE_VERSION import com.tencent.bkrepo.repository.pojo.metadata.MetadataModel -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 节点详细信息 */ -@ApiModel("节点详细信息") +@Schema(title = "节点详细信息") data class NodeDetail( - @ApiModelProperty("节点基本信息") + @get:Schema(title = "节点基本信息") @Deprecated("冗余信息，nodeInfo信息已包含在NodeDetail字段中，nodeInfo将来会删除") val nodeInfo: NodeInfo, - @ApiModelProperty("创建者") + @get:Schema(title = "创建者") val createdBy: String = nodeInfo.createdBy, - @ApiModelProperty("创建时间") + @get:Schema(title = "创建时间") val createdDate: String = nodeInfo.createdDate, - @ApiModelProperty("修改者") + @get:Schema(title = "修改者") val lastModifiedBy: String = nodeInfo.lastModifiedBy, - @ApiModelProperty("修改时间") + @get:Schema(title = "修改时间") val lastModifiedDate: String = nodeInfo.lastModifiedDate, - @ApiModelProperty("访问时间") + @get:Schema(title = "访问时间") val lastAccessDate: String? = nodeInfo.lastAccessDate, - @ApiModelProperty("是否为文件夹") + @get:Schema(title = "是否为文件夹") val folder: Boolean = nodeInfo.folder, - @ApiModelProperty("路径") + @get:Schema(title = "路径") val path: String = nodeInfo.path, - @ApiModelProperty("资源名称") + @get:Schema(title = "资源名称") val name: String = nodeInfo.name, - @ApiModelProperty("完整路径") + @get:Schema(title = "完整路径") val fullPath: String = nodeInfo.fullPath, - @ApiModelProperty("文件大小，单位byte") + @get:Schema(title = "文件大小，单位byte") val size: Long = nodeInfo.size, - @ApiModelProperty("文件节点个数") + @get:Schema(title = "文件节点个数") val nodeNum: Long? = nodeInfo.nodeNum, - @ApiModelProperty("文件sha256") + @get:Schema(title = "文件sha256") val sha256: String? = nodeInfo.sha256, - @ApiModelProperty("文件md5") + @get:Schema(title = "文件md5") val md5: String? = nodeInfo.md5, - @ApiModelProperty("元数据") + @get:Schema(title = "元数据") val metadata: Map = nodeInfo.metadata.orEmpty(), - @ApiModelProperty("元数据") + @get:Schema(title = "元数据") val nodeMetadata: List = nodeInfo.nodeMetadata.orEmpty(), - @ApiModelProperty("所属项目id") + @get:Schema(title = "所属项目id") val projectId: String = nodeInfo.projectId, - @ApiModelProperty("所属仓库名称") + @get:Schema(title = "所属仓库名称") val repoName: String = nodeInfo.repoName, - @ApiModelProperty("集群信息") + @get:Schema(title = "集群信息") val clusterNames: Set? = nodeInfo.clusterNames, - @ApiModelProperty("是否归档") + @get:Schema(title = "是否归档") val archived: Boolean? = nodeInfo.archived, - @ApiModelProperty("是否压缩") + @get:Schema(title = "是否压缩") val compressed: Boolean? = nodeInfo.compressed, ) { /** diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/NodeInfo.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/NodeInfo.kt index be1742865e..e79d2b0dc2 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/NodeInfo.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/NodeInfo.kt @@ -33,61 +33,61 @@ package com.tencent.bkrepo.repository.pojo.node import com.fasterxml.jackson.annotation.JsonInclude import com.tencent.bkrepo.repository.pojo.metadata.MetadataModel -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 节点信息 */ -@ApiModel("节点信息") +@Schema(title = "节点信息") data class NodeInfo( var id: String? = null, - @ApiModelProperty("创建者") + @get:Schema(title = "创建者") val createdBy: String, - @ApiModelProperty("创建时间") + @get:Schema(title = "创建时间") val createdDate: String, - @ApiModelProperty("修改者") + @get:Schema(title = "修改者") val lastModifiedBy: String, - @ApiModelProperty("修改时间") + @get:Schema(title = "修改时间") val lastModifiedDate: String, - @ApiModelProperty("访问时间") + @get:Schema(title = "访问时间") val lastAccessDate: String? = null, - @ApiModelProperty("是否为文件夹") + @get:Schema(title = "是否为文件夹") val folder: Boolean, - @ApiModelProperty("路径") + @get:Schema(title = "路径") val path: String, - @ApiModelProperty("资源名称") + @get:Schema(title = "资源名称") val name: String, - @ApiModelProperty("完整路径") + @get:Schema(title = "完整路径") val fullPath: String, - @ApiModelProperty("文件大小，单位byte") + @get:Schema(title = "文件大小，单位byte") val size: Long, - @ApiModelProperty("文件节点个数") + @get:Schema(title = "文件节点个数") val nodeNum: Long? = null, - @ApiModelProperty("文件sha256") + @get:Schema(title = "文件sha256") val sha256: String? = null, - @ApiModelProperty("文件md5") + @get:Schema(title = "文件md5") val md5: String? = null, - @ApiModelProperty("元数据") + @get:Schema(title = "元数据") val metadata: Map? = null, - @ApiModelProperty("元数据信息") + @get:Schema(title = "元数据信息") val nodeMetadata: List? = null, - @ApiModelProperty("所属项目id") + @get:Schema(title = "所属项目id") val projectId: String, - @ApiModelProperty("所属仓库名称") + @get:Schema(title = "所属仓库名称") val repoName: String, - @ApiModelProperty("拷贝的源存储key") + @get:Schema(title = "拷贝的源存储key") val copyFromCredentialsKey: String? = null, - @ApiModelProperty("拷贝的目标存储key") + @get:Schema(title = "拷贝的目标存储key") val copyIntoCredentialsKey: String? = null, - @ApiModelProperty("删除时间") + @get:Schema(title = "删除时间") @JsonInclude(JsonInclude.Include.NON_NULL) val deleted: String? = null, - @ApiModelProperty("集群信息") + @get:Schema(title = "集群信息") val clusterNames: Set? = null, - @ApiModelProperty("是否归档") + @get:Schema(title = "是否归档") val archived: Boolean? = null, - @ApiModelProperty("是否压缩") + @get:Schema(title = "是否压缩") val compressed: Boolean? = null, ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/NodeListOption.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/NodeListOption.kt index 2caa0340c6..aef7b6f1c6 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/NodeListOption.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/NodeListOption.kt @@ -34,31 +34,31 @@ package com.tencent.bkrepo.repository.pojo.node import com.tencent.bkrepo.common.api.constant.DEFAULT_PAGE_NUMBER import com.tencent.bkrepo.common.api.constant.DEFAULT_PAGE_SIZE import com.tencent.bkrepo.repository.constant.SYSTEM_USER -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("节点列表选项") + +@Schema(title = "节点列表选项") data class NodeListOption( - @ApiModelProperty("当前页") + @get:Schema(title = "当前页") val pageNumber: Int = DEFAULT_PAGE_NUMBER, - @ApiModelProperty("分页大小") + @get:Schema(title = "分页大小") val pageSize: Int = DEFAULT_PAGE_SIZE, - @ApiModelProperty("是否包含目录") + @get:Schema(title = "是否包含目录") val includeFolder: Boolean = true, - @ApiModelProperty("是否包含元数据") + @get:Schema(title = "是否包含元数据") val includeMetadata: Boolean = false, - @ApiModelProperty("是否深度查询文件") + @get:Schema(title = "是否深度查询文件") val deep: Boolean = false, - @ApiModelProperty("是否排序，目录在前，文件在后，并按照文件名称排序") + @get:Schema(title = "是否排序，目录在前，文件在后，并按照文件名称排序") val sort: Boolean = false, - @ApiModelProperty("排序字段") + @get:Schema(title = "排序字段") val sortProperty: List = emptyList(), - @ApiModelProperty("排序方向") + @get:Schema(title = "排序方向") val direction: List = emptyList(), - @ApiModelProperty("无权限路径") + @get:Schema(title = "无权限路径") var noPermissionPath: List = emptyList(), - @ApiModelProperty("有权限的路径") + @get:Schema(title = "有权限的路径") var hasPermissionPath: List? = null, - @ApiModelProperty("操作用户") + @get:Schema(title = "操作用户") var operator: String = SYSTEM_USER, ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/NodeRestoreResult.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/NodeRestoreResult.kt index d25b41f970..0b8a0e8293 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/NodeRestoreResult.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/NodeRestoreResult.kt @@ -31,17 +31,18 @@ package com.tencent.bkrepo.repository.pojo.node -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 节点恢复结果 */ data class NodeRestoreResult( val fullPath: String, - @ApiModelProperty("实际恢复的节点数量，包含了conflictCount") + @get:Schema(title = "实际恢复的节点数量，包含了conflictCount") val restoreCount: Long = 0L, - @ApiModelProperty("发生冲突并跳过的节点数量") + @get:Schema(title = "发生冲突并跳过的节点数量") val skipCount: Long = 0L, - @ApiModelProperty("发生冲突并覆盖的节点数量") + @get:Schema(title = "发生冲突并覆盖的节点数量") val conflictCount: Long = 0L ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/NodeSizeInfo.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/NodeSizeInfo.kt index 400ad08e06..4f476d8f94 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/NodeSizeInfo.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/NodeSizeInfo.kt @@ -31,18 +31,18 @@ package com.tencent.bkrepo.repository.pojo.node -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 节点大小信息 */ -@ApiModel("节点大小信息") +@Schema(title = "节点大小信息") data class NodeSizeInfo( - @ApiModelProperty("子节点数量, 包含文件夹") + @get:Schema(title = "子节点数量, 包含文件夹") val subNodeCount: Long = 0, - @ApiModelProperty("子节点数量, 不包含文件夹") + @get:Schema(title = "子节点数量, 不包含文件夹") val subNodeWithoutFolderCount: Long = 0, - @ApiModelProperty("文件大小总和") + @get:Schema(title = "文件大小总和") val size: Long ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeArchiveRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeArchiveRequest.kt index f97a8ac5f7..d918b4eb14 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeArchiveRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeArchiveRequest.kt @@ -2,15 +2,16 @@ package com.tencent.bkrepo.repository.pojo.node.service import com.tencent.bkrepo.repository.pojo.ServiceRequest import com.tencent.bkrepo.repository.pojo.node.NodeRequest -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + data class NodeArchiveRequest( - @ApiModelProperty("所属项目", required = true) + @get:Schema(title = "所属项目", required = true) override val projectId: String, - @ApiModelProperty("仓库名称", required = true) + @get:Schema(title = "仓库名称", required = true) override val repoName: String, - @ApiModelProperty("节点完整路径", required = true) + @get:Schema(title = "节点完整路径", required = true) override val fullPath: String, - @ApiModelProperty("操作用户", required = true) + @get:Schema(title = "操作用户", required = true) override val operator: String, ) : NodeRequest, ServiceRequest diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeArchiveRestoreRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeArchiveRestoreRequest.kt index 545a0d7e44..beedc894ad 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeArchiveRestoreRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeArchiveRestoreRequest.kt @@ -32,21 +32,22 @@ package com.tencent.bkrepo.repository.pojo.node.service import com.tencent.bkrepo.repository.pojo.ServiceRequest -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 节点恢复选项 */ data class NodeArchiveRestoreRequest( - @ApiModelProperty("项目id") + @get:Schema(title = "项目id") val projectId: String, - @ApiModelProperty("仓库名称") + @get:Schema(title = "仓库名称") val repoName: String, - @ApiModelProperty("路径") + @get:Schema(title = "路径") val path: String?, - @ApiModelProperty("元数据") + @get:Schema(title = "元数据") val metadata: Map = emptyMap(), - @ApiModelProperty("恢复限制个数") + @get:Schema(title = "恢复限制个数") val limit: Int = 10000, override val operator: String, ) : ServiceRequest diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeCleanRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeCleanRequest.kt index e4492a0302..ed187676fa 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeCleanRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeCleanRequest.kt @@ -28,18 +28,19 @@ package com.tencent.bkrepo.repository.pojo.node.service import com.tencent.bkrepo.repository.pojo.ServiceRequest -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + import java.time.LocalDateTime data class NodeCleanRequest( - @ApiModelProperty("所属项目", required = true) + @get:Schema(title = "所属项目", required = true) val projectId: String, - @ApiModelProperty("仓库名称", required = true) + @get:Schema(title = "仓库名称", required = true) val repoName: String, - @ApiModelProperty("清理目录", required = true) + @get:Schema(title = "清理目录", required = true) val path: String, - @ApiModelProperty("时间条件", required = true) + @get:Schema(title = "时间条件", required = true) val date: LocalDateTime, - @ApiModelProperty("操作用户", required = true) + @get:Schema(title = "操作用户", required = true) override val operator: String ): ServiceRequest diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeCompressedRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeCompressedRequest.kt index 945edafbf6..e98e150f22 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeCompressedRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeCompressedRequest.kt @@ -2,15 +2,16 @@ package com.tencent.bkrepo.repository.pojo.node.service import com.tencent.bkrepo.repository.pojo.ServiceRequest import com.tencent.bkrepo.repository.pojo.node.NodeRequest -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + data class NodeCompressedRequest( - @ApiModelProperty("所属项目", required = true) + @get:Schema(title = "所属项目", required = true) override val projectId: String, - @ApiModelProperty("仓库名称", required = true) + @get:Schema(title = "仓库名称", required = true) override val repoName: String, - @ApiModelProperty("节点完整路径", required = true) + @get:Schema(title = "节点完整路径", required = true) override val fullPath: String, - @ApiModelProperty("操作用户", required = true) + @get:Schema(title = "操作用户", required = true) override val operator: String, ) : NodeRequest, ServiceRequest diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeCreateRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeCreateRequest.kt index 5cb327e0a1..9fa5411314 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeCreateRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeCreateRequest.kt @@ -36,44 +36,43 @@ import com.tencent.bkrepo.repository.pojo.AuditableRequest import com.tencent.bkrepo.repository.pojo.ServiceRequest import com.tencent.bkrepo.repository.pojo.metadata.MetadataModel import com.tencent.bkrepo.repository.pojo.node.NodeRequest -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema import java.time.LocalDateTime /** * 创建节点请求 */ -@ApiModel("创建节点请求") +@Schema(title = "创建节点请求") data class NodeCreateRequest( - @ApiModelProperty("所属项目", required = true) + @get:Schema(title = "所属项目", required = true) override val projectId: String, - @ApiModelProperty("仓库名称", required = true) + @get:Schema(title = "仓库名称", required = true) override val repoName: String, - @ApiModelProperty("完整路径", required = true) + @get:Schema(title = "完整路径", required = true) override val fullPath: String, - @ApiModelProperty("是否为文件夹", required = true) + @get:Schema(title = "是否为文件夹", required = true) val folder: Boolean, - @ApiModelProperty("过期时间，单位天(0代表永久保存)") + @get:Schema(title = "过期时间，单位天(0代表永久保存)") val expires: Long = 0, - @ApiModelProperty("是否覆盖") + @get:Schema(title = "是否覆盖") val overwrite: Boolean = false, - @ApiModelProperty("文件大小，单位byte") + @get:Schema(title = "文件大小，单位byte") val size: Long? = null, - @ApiModelProperty("文件sha256") + @get:Schema(title = "文件sha256") val sha256: String? = null, - @ApiModelProperty("文件md5") + @get:Schema(title = "文件md5") val md5: String? = null, - @ApiModelProperty("元数据信息") + @get:Schema(title = "元数据信息") @Deprecated("仅用于兼容旧接口", replaceWith = ReplaceWith("nodeMetadata")) val metadata: Map? = null, - @ApiModelProperty("元数据信息") + @get:Schema(title = "元数据信息") val nodeMetadata: List? = null, - @ApiModelProperty("操作用户") + @get:Schema(title = "操作用户") override val operator: String = SYSTEM_USER, override val createdBy: String? = null, override var createdDate: LocalDateTime? = null, override val lastModifiedBy: String? = null, override var lastModifiedDate: LocalDateTime? = null, - @ApiModelProperty("是否SEPARATE_UPLOAD") + @get:Schema(title = "是否SEPARATE_UPLOAD") val separate: Boolean = false ) : NodeRequest, ServiceRequest, AuditableRequest diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeDeleteRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeDeleteRequest.kt index 6e0289aab2..c51b5e526f 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeDeleteRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeDeleteRequest.kt @@ -33,20 +33,20 @@ package com.tencent.bkrepo.repository.pojo.node.service import com.tencent.bkrepo.repository.pojo.ServiceRequest import com.tencent.bkrepo.repository.pojo.node.NodeRequest -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 节点删除请求 */ -@ApiModel("节点删除请求") +@Schema(title = "节点删除请求") data class NodeDeleteRequest( - @ApiModelProperty("所属项目", required = true) + @get:Schema(title = "所属项目", required = true) override val projectId: String, - @ApiModelProperty("仓库名称", required = true) + @get:Schema(title = "仓库名称", required = true) override val repoName: String, - @ApiModelProperty("节点完整路径", required = true) + @get:Schema(title = "节点完整路径", required = true) override val fullPath: String, - @ApiModelProperty("操作用户", required = true) + @get:Schema(title = "操作用户", required = true) override val operator: String ) : NodeRequest, ServiceRequest diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeLinkRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeLinkRequest.kt index a780ec1ae5..53dbcd9b6f 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeLinkRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeLinkRequest.kt @@ -31,29 +31,29 @@ import com.tencent.bkrepo.repository.constant.SYSTEM_USER import com.tencent.bkrepo.repository.pojo.ServiceRequest import com.tencent.bkrepo.repository.pojo.metadata.MetadataModel import com.tencent.bkrepo.repository.pojo.node.NodeRequest -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("创建链接节点请求") + +@Schema(title = "创建链接节点请求") data class NodeLinkRequest( - @ApiModelProperty("所属项目", required = true) + @get:Schema(title = "所属项目", required = true) override val projectId: String, - @ApiModelProperty("仓库名称", required = true) + @get:Schema(title = "仓库名称", required = true) override val repoName: String, - @ApiModelProperty("完整路径", required = true) + @get:Schema(title = "完整路径", required = true) override val fullPath: String, - @ApiModelProperty("目标节点所属项目", required = false) + @get:Schema(title = "目标节点所属项目", required = false) val targetProjectId: String, - @ApiModelProperty("目标节点仓库名称", required = false) + @get:Schema(title = "目标节点仓库名称", required = false) val targetRepoName: String, - @ApiModelProperty("目标节点完整路径", required = false) + @get:Schema(title = "目标节点完整路径", required = false) val targetFullPath: String, - @ApiModelProperty("是否检查目标节点存在") + @get:Schema(title = "是否检查目标节点存在") val checkTargetExist: Boolean = true, - @ApiModelProperty("是否覆盖") + @get:Schema(title = "是否覆盖") val overwrite: Boolean = false, - @ApiModelProperty("元数据信息") + @get:Schema(title = "元数据信息") val nodeMetadata: List? = null, - @ApiModelProperty("操作用户") + @get:Schema(title = "操作用户") override val operator: String = SYSTEM_USER, ) : NodeRequest, ServiceRequest diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeMoveCopyRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeMoveCopyRequest.kt index 827cc34179..1210082485 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeMoveCopyRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeMoveCopyRequest.kt @@ -32,34 +32,34 @@ package com.tencent.bkrepo.repository.pojo.node.service import com.tencent.bkrepo.repository.pojo.node.NodeRequest -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 节点移动/复制请求 */ -@ApiModel("节点移动/复制请求") +@Schema(title = "节点移动/复制请求") data class NodeMoveCopyRequest( - @ApiModelProperty("源项目id", required = true) + @get:Schema(title = "源项目id", required = true) val srcProjectId: String, - @ApiModelProperty("源仓库名称", required = true) + @get:Schema(title = "源仓库名称", required = true) val srcRepoName: String, - @ApiModelProperty("源节点路径", required = true) + @get:Schema(title = "源节点路径", required = true) val srcFullPath: String, - @ApiModelProperty("目的项目id", required = false) + @get:Schema(title = "目的项目id", required = false) val destProjectId: String? = null, - @ApiModelProperty("目的仓库名称", required = false) + @get:Schema(title = "目的仓库名称", required = false) val destRepoName: String? = null, - @ApiModelProperty("目的路径", required = true) + @get:Schema(title = "目的路径", required = true) val destFullPath: String, - @ApiModelProperty("目的路径是否为目录", required = false) + @get:Schema(title = "目的路径是否为目录", required = false) var destNodeFolder: Boolean? = null, // commit-edge模式，移动edge节点到目录，center没有此目录时，需要此字段标记目的路径为目录 @Deprecated("This property is deprecated!", ReplaceWith("destFullPath")) - @ApiModelProperty("目的路径", required = false) + @get:Schema(title = "目的路径", required = false) val destPath: String? = null, - @ApiModelProperty("同名文件是否覆盖", required = false) + @get:Schema(title = "同名文件是否覆盖", required = false) val overwrite: Boolean = false, - @ApiModelProperty("操作用户", required = true) + @get:Schema(title = "操作用户", required = true) val operator: String ) : NodeRequest { override val projectId: String diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeRenameRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeRenameRequest.kt index ba15661d94..2f10792721 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeRenameRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeRenameRequest.kt @@ -33,22 +33,22 @@ package com.tencent.bkrepo.repository.pojo.node.service import com.tencent.bkrepo.repository.pojo.ServiceRequest import com.tencent.bkrepo.repository.pojo.node.NodeRequest -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 节点重命名请求 */ -@ApiModel("节点重命名请求") +@Schema(title = "节点重命名请求") data class NodeRenameRequest( - @ApiModelProperty("所属项目", required = true) + @get:Schema(title = "所属项目", required = true) override val projectId: String, - @ApiModelProperty("仓库名称", required = true) + @get:Schema(title = "仓库名称", required = true) override val repoName: String, - @ApiModelProperty("节点完整路径", required = true) + @get:Schema(title = "节点完整路径", required = true) override val fullPath: String, - @ApiModelProperty("节点新完整路径", required = true) + @get:Schema(title = "节点新完整路径", required = true) val newFullPath: String, - @ApiModelProperty("操作用户", required = true) + @get:Schema(title = "操作用户", required = true) override val operator: String ) : NodeRequest, ServiceRequest diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeSetLengthRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeSetLengthRequest.kt index ebcb0c4f42..7cccc25e39 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeSetLengthRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeSetLengthRequest.kt @@ -29,16 +29,17 @@ package com.tencent.bkrepo.repository.pojo.node.service import com.tencent.bkrepo.repository.pojo.ServiceRequest import com.tencent.bkrepo.repository.pojo.node.NodeRequest -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + data class NodeSetLengthRequest( - @ApiModelProperty("所属项目", required = true) + @get:Schema(title = "所属项目", required = true) override val projectId: String, - @ApiModelProperty("仓库名称", required = true) + @get:Schema(title = "仓库名称", required = true) override val repoName: String, - @ApiModelProperty("节点完整路径", required = true) + @get:Schema(title = "节点完整路径", required = true) override val fullPath: String, - @ApiModelProperty("操作用户", required = true) + @get:Schema(title = "操作用户", required = true) override val operator: String, val newLength: Long ) : NodeRequest, ServiceRequest diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeUnCompressedRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeUnCompressedRequest.kt index 8b85171c92..3d5a2dfaf5 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeUnCompressedRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeUnCompressedRequest.kt @@ -2,15 +2,16 @@ package com.tencent.bkrepo.repository.pojo.node.service import com.tencent.bkrepo.repository.pojo.ServiceRequest import com.tencent.bkrepo.repository.pojo.node.NodeRequest -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + data class NodeUnCompressedRequest( - @ApiModelProperty("所属项目", required = true) + @get:Schema(title = "所属项目", required = true) override val projectId: String, - @ApiModelProperty("仓库名称", required = true) + @get:Schema(title = "仓库名称", required = true) override val repoName: String, - @ApiModelProperty("节点完整路径", required = true) + @get:Schema(title = "节点完整路径", required = true) override val fullPath: String, - @ApiModelProperty("操作用户", required = true) + @get:Schema(title = "操作用户", required = true) override val operator: String, ) : NodeRequest, ServiceRequest diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeUpdateRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeUpdateRequest.kt index b74e269c20..b7dd6d8add 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeUpdateRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodeUpdateRequest.kt @@ -33,19 +33,19 @@ package com.tencent.bkrepo.repository.pojo.node.service import com.tencent.bkrepo.repository.pojo.ServiceRequest import com.tencent.bkrepo.repository.pojo.node.NodeRequest -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("节点更新请求") + +@Schema(title = "节点更新请求") data class NodeUpdateRequest( - @ApiModelProperty("所属项目", required = true) + @get:Schema(title = "所属项目", required = true) override val projectId: String, - @ApiModelProperty("仓库名称", required = true) + @get:Schema(title = "仓库名称", required = true) override val repoName: String, - @ApiModelProperty("节点完整路径", required = true) + @get:Schema(title = "节点完整路径", required = true) override val fullPath: String, - @ApiModelProperty("过期时间，单位天(0代表永久保存)") + @get:Schema(title = "过期时间，单位天(0代表永久保存)") val expires: Long = 0, - @ApiModelProperty("操作用户", required = true) + @get:Schema(title = "操作用户", required = true) override val operator: String ) : NodeRequest, ServiceRequest diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodesDeleteRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodesDeleteRequest.kt index 5c8460eb88..24507e4b84 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodesDeleteRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/service/NodesDeleteRequest.kt @@ -1,22 +1,22 @@ package com.tencent.bkrepo.repository.pojo.node.service import com.tencent.bkrepo.repository.pojo.ServiceRequest -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 节点批量删除请求 */ -@ApiModel("节点批量删除请求") +@Schema(title = "节点批量删除请求") class NodesDeleteRequest( - @ApiModelProperty("所属项目", required = true) + @get:Schema(title = "所属项目", required = true) val projectId: String, - @ApiModelProperty("仓库名称", required = true) + @get:Schema(title = "仓库名称", required = true) val repoName: String, - @ApiModelProperty("节点完整路径列表", required = true) + @get:Schema(title = "节点完整路径列表", required = true) val fullPaths: List, - @ApiModelProperty("操作用户", required = true) + @get:Schema(title = "操作用户", required = true) override val operator: String, - @ApiModelProperty("是否为文件夹", required = false) + @get:Schema(title = "是否为文件夹", required = false) val isFolder: Boolean ? = false ) : ServiceRequest diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/user/UserNodeArchiveRestoreRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/user/UserNodeArchiveRestoreRequest.kt index af1ddd9ece..267619751e 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/user/UserNodeArchiveRestoreRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/user/UserNodeArchiveRestoreRequest.kt @@ -1,18 +1,18 @@ package com.tencent.bkrepo.repository.pojo.node.user -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("归档节点恢复请求") + +@Schema(title = "归档节点恢复请求") data class UserNodeArchiveRestoreRequest( - @ApiModelProperty("项目id") + @get:Schema(title = "项目id") val projectId: String, - @ApiModelProperty("仓库名称") + @get:Schema(title = "仓库名称") val repoName: String, - @ApiModelProperty("路径") + @get:Schema(title = "路径") val path: String?, - @ApiModelProperty("元数据") + @get:Schema(title = "元数据") val metadata: Map = emptyMap(), - @ApiModelProperty("恢复限制个数") + @get:Schema(title = "恢复限制个数") val limit: Int = 10000, ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/user/UserNodeCreateRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/user/UserNodeCreateRequest.kt index e4b139b71e..18bbe13cb1 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/user/UserNodeCreateRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/user/UserNodeCreateRequest.kt @@ -34,34 +34,33 @@ package com.tencent.bkrepo.repository.pojo.node.user import com.tencent.bkrepo.repository.pojo.AuditableRequest import com.tencent.bkrepo.repository.pojo.UserRequest import com.tencent.bkrepo.repository.pojo.node.NodeRequest -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema import java.time.LocalDateTime /** * 创建节点请求 */ -@ApiModel("创建节点请求") +@Schema(title = "创建节点请求") data class UserNodeCreateRequest( - @ApiModelProperty("所属项目", required = true) + @get:Schema(title = "所属项目", required = true) override val projectId: String, - @ApiModelProperty("仓库名称", required = true) + @get:Schema(title = "仓库名称", required = true) override val repoName: String, - @ApiModelProperty("完整路径", required = true) + @get:Schema(title = "完整路径", required = true) override val fullPath: String, - @ApiModelProperty("是否为文件夹", required = true) + @get:Schema(title = "是否为文件夹", required = true) val folder: Boolean, - @ApiModelProperty("过期时间，单位天(0代表永久保存)") + @get:Schema(title = "过期时间，单位天(0代表永久保存)") val expires: Long = 0, - @ApiModelProperty("是否覆盖") + @get:Schema(title = "是否覆盖") val overwrite: Boolean = false, - @ApiModelProperty("文件大小，单位byte") + @get:Schema(title = "文件大小，单位byte") val size: Long? = null, - @ApiModelProperty("文件sha256") + @get:Schema(title = "文件sha256") val sha256: String? = null, - @ApiModelProperty("文件md5") + @get:Schema(title = "文件md5") val md5: String? = null, - @ApiModelProperty("元数据信息") + @get:Schema(title = "元数据信息") val metadata: Map? = null, override val createdBy: String? = null, override val createdDate: LocalDateTime? = null, diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/user/UserNodeLinkRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/user/UserNodeLinkRequest.kt index 1fb4be62cf..5410848ff9 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/user/UserNodeLinkRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/user/UserNodeLinkRequest.kt @@ -30,25 +30,25 @@ package com.tencent.bkrepo.repository.pojo.node.user import com.tencent.bkrepo.repository.pojo.UserRequest import com.tencent.bkrepo.repository.pojo.metadata.MetadataModel import com.tencent.bkrepo.repository.pojo.node.NodeRequest -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("创建链接节点请求") + +@Schema(title = "创建链接节点请求") data class UserNodeLinkRequest( - @ApiModelProperty("所属项目", required = true) + @get:Schema(title = "所属项目", required = true) override val projectId: String, - @ApiModelProperty("仓库名称", required = true) + @get:Schema(title = "仓库名称", required = true) override val repoName: String, - @ApiModelProperty("完整路径", required = true) + @get:Schema(title = "完整路径", required = true) override val fullPath: String, - @ApiModelProperty("目标节点所属项目", required = false) + @get:Schema(title = "目标节点所属项目", required = false) val targetProjectId: String, - @ApiModelProperty("目标节点仓库名称", required = false) + @get:Schema(title = "目标节点仓库名称", required = false) val targetRepoName: String, - @ApiModelProperty("目标节点完整路径", required = false) + @get:Schema(title = "目标节点完整路径", required = false) val targetFullPath: String, - @ApiModelProperty("是否覆盖") + @get:Schema(title = "是否覆盖") val overwrite: Boolean = false, - @ApiModelProperty("元数据信息") + @get:Schema(title = "元数据信息") val nodeMetadata: List? = null, ) : NodeRequest, UserRequest diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/user/UserNodeMoveCopyRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/user/UserNodeMoveCopyRequest.kt index 4f081ed7a1..fa48a6b92d 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/user/UserNodeMoveCopyRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/user/UserNodeMoveCopyRequest.kt @@ -31,29 +31,29 @@ package com.tencent.bkrepo.repository.pojo.node.user -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 用户节点移动/复制请求 */ -@ApiModel("用户节点移动/复制请求") +@Schema(title = "用户节点移动/复制请求") data class UserNodeMoveCopyRequest( - @ApiModelProperty("源项目id", required = true) + @get:Schema(title = "源项目id", required = true) val srcProjectId: String, - @ApiModelProperty("源仓库名称", required = true) + @get:Schema(title = "源仓库名称", required = true) val srcRepoName: String, - @ApiModelProperty("源节点路径", required = true) + @get:Schema(title = "源节点路径", required = true) val srcFullPath: String, - @ApiModelProperty("目的项目id", required = false) + @get:Schema(title = "目的项目id", required = false) val destProjectId: String? = null, - @ApiModelProperty("目的仓库名称", required = false) + @get:Schema(title = "目的仓库名称", required = false) val destRepoName: String? = null, - @ApiModelProperty("目的路径", required = true) + @get:Schema(title = "目的路径", required = true) val destFullPath: String, @Deprecated("This property is deprecated!", ReplaceWith("destFullPath")) - @ApiModelProperty("目的路径", required = false) + @get:Schema(title = "目的路径", required = false) val destPath: String? = null, - @ApiModelProperty("同名文件是否覆盖", required = false) + @get:Schema(title = "同名文件是否覆盖", required = false) val overwrite: Boolean = false ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/user/UserNodeRenameRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/user/UserNodeRenameRequest.kt index 9baa35936d..3d3e18049e 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/user/UserNodeRenameRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/user/UserNodeRenameRequest.kt @@ -33,20 +33,20 @@ package com.tencent.bkrepo.repository.pojo.node.user import com.tencent.bkrepo.repository.pojo.UserRequest import com.tencent.bkrepo.repository.pojo.node.NodeRequest -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 节点重命名请求 */ -@ApiModel("节点重命名请求") +@Schema(title = "节点重命名请求") data class UserNodeRenameRequest( - @ApiModelProperty("所属项目", required = true) + @get:Schema(title = "所属项目", required = true) override val projectId: String, - @ApiModelProperty("仓库名称", required = true) + @get:Schema(title = "仓库名称", required = true) override val repoName: String, - @ApiModelProperty("节点完整路径", required = true) + @get:Schema(title = "节点完整路径", required = true) override val fullPath: String, - @ApiModelProperty("节点新完整路径", required = true) + @get:Schema(title = "节点新完整路径", required = true) val newFullPath: String ) : NodeRequest, UserRequest diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/user/UserNodeUpdateRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/user/UserNodeUpdateRequest.kt index 516428b6c4..6206947d88 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/user/UserNodeUpdateRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/node/user/UserNodeUpdateRequest.kt @@ -31,11 +31,11 @@ package com.tencent.bkrepo.repository.pojo.node.user -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("节点更新请求") + +@Schema(title = "节点更新请求") data class UserNodeUpdateRequest( - @ApiModelProperty("过期时间，单位天(0代表永久保存)") + @get:Schema(title = "过期时间，单位天(0代表永久保存)") val expires: Long = 0 ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/packages/PackageListOption.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/packages/PackageListOption.kt index 001ce5e6d9..6a8adb0e4a 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/packages/PackageListOption.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/packages/PackageListOption.kt @@ -33,15 +33,15 @@ package com.tencent.bkrepo.repository.pojo.packages import com.tencent.bkrepo.common.api.constant.DEFAULT_PAGE_NUMBER import com.tencent.bkrepo.common.api.constant.DEFAULT_PAGE_SIZE -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("包列表选项") + +@Schema(title = "包列表选项") data class PackageListOption( - @ApiModelProperty("当前页") + @get:Schema(title = "当前页") var pageNumber: Int = DEFAULT_PAGE_NUMBER, - @ApiModelProperty("分页大小") + @get:Schema(title = "分页大小") var pageSize: Int = DEFAULT_PAGE_SIZE, - @ApiModelProperty("包名称, 根据该字段模糊搜索") + @get:Schema(title = "包名称, 根据该字段模糊搜索") var packageName: String? = null ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/packages/PackageSummary.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/packages/PackageSummary.kt index 01295e52f1..a47426f5b4 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/packages/PackageSummary.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/packages/PackageSummary.kt @@ -31,46 +31,45 @@ package com.tencent.bkrepo.repository.pojo.packages -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema import java.time.LocalDateTime /** * 包总览信息 */ -@ApiModel("包总览信息") +@Schema(title = "包总览信息") data class PackageSummary( - @ApiModelProperty("创建者") + @get:Schema(title = "创建者") val createdBy: String, - @ApiModelProperty("创建时间") + @get:Schema(title = "创建时间") val createdDate: LocalDateTime, - @ApiModelProperty("修改者") + @get:Schema(title = "修改者") val lastModifiedBy: String, - @ApiModelProperty("修改时间") + @get:Schema(title = "修改时间") val lastModifiedDate: LocalDateTime, - @ApiModelProperty("所属项目id") + @get:Schema(title = "所属项目id") val projectId: String, - @ApiModelProperty("所属仓库名称") + @get:Schema(title = "所属仓库名称") val repoName: String, - @ApiModelProperty("包名称") + @get:Schema(title = "包名称") val name: String, - @ApiModelProperty("包唯一key") + @get:Schema(title = "包唯一key") val key: String, - @ApiModelProperty("包类型") + @get:Schema(title = "包类型") var type: PackageType, - @ApiModelProperty("最新版名称") + @get:Schema(title = "最新版名称") val latest: String, - @ApiModelProperty("下载次数") + @get:Schema(title = "下载次数") val downloads: Long, - @ApiModelProperty("版本数量") + @get:Schema(title = "版本数量") var versions: Long, - @ApiModelProperty("包简要描述") + @get:Schema(title = "包简要描述") var description: String? = null, - @ApiModelProperty("版本标签") + @get:Schema(title = "版本标签") val versionTag: Map, - @ApiModelProperty("扩展字段") + @get:Schema(title = "扩展字段") val extension: Map, - @ApiModelProperty("历史版本") + @get:Schema(title = "历史版本") val historyVersion: Set ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/packages/PackageVersion.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/packages/PackageVersion.kt index 6f41ae6171..990c1d52f4 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/packages/PackageVersion.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/packages/PackageVersion.kt @@ -32,47 +32,47 @@ package com.tencent.bkrepo.repository.pojo.packages import com.tencent.bkrepo.repository.pojo.metadata.MetadataModel -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + import java.time.LocalDateTime /** * 包信息 */ -@ApiModel("包信息") +@Schema(title = "包信息") data class PackageVersion( - @ApiModelProperty("创建者") + @get:Schema(title = "创建者") val createdBy: String, - @ApiModelProperty("创建时间") + @get:Schema(title = "创建时间") val createdDate: LocalDateTime, - @ApiModelProperty("修改者") + @get:Schema(title = "修改者") val lastModifiedBy: String, - @ApiModelProperty("修改时间") + @get:Schema(title = "修改时间") val lastModifiedDate: LocalDateTime, - @ApiModelProperty("包版本") + @get:Schema(title = "包版本") val name: String, - @ApiModelProperty("包大小") + @get:Schema(title = "包大小") val size: Long, - @ApiModelProperty("下载次数") + @get:Schema(title = "下载次数") var downloads: Long, - @ApiModelProperty("制品晋级阶段") + @get:Schema(title = "制品晋级阶段") val stageTag: List, - @ApiModelProperty("元数据") + @get:Schema(title = "元数据") val metadata: Map, - @ApiModelProperty("元数据") + @get:Schema(title = "元数据") val packageMetadata: List, - @ApiModelProperty("标签") + @get:Schema(title = "标签") val tags: List, - @ApiModelProperty("扩展字段") + @get:Schema(title = "扩展字段") val extension: Map, - @ApiModelProperty("包内容文件路径") + @get:Schema(title = "包内容文件路径") @Deprecated("replace by contentPaths") val contentPath: String? = null, - @ApiModelProperty("包内容文件路径列表") + @get:Schema(title = "包内容文件路径列表") val contentPaths: Set? = null, - @ApiModelProperty("清单文件路径") + @get:Schema(title = "清单文件路径") val manifestPath: String? = null, - @ApiModelProperty("集群名") + @get:Schema(title = "集群名") val clusterNames: Set? = null ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/packages/VersionListOption.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/packages/VersionListOption.kt index 02bc82b434..7d27dc2abb 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/packages/VersionListOption.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/packages/VersionListOption.kt @@ -35,23 +35,23 @@ import com.tencent.bkrepo.common.api.constant.DEFAULT_PAGE_NUMBER import com.tencent.bkrepo.common.api.constant.DEFAULT_PAGE_SIZE import com.tencent.bkrepo.common.query.model.Sort.Direction import com.tencent.bkrepo.repository.pojo.metadata.MetadataModel -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("版本列表选项") + +@Schema(title = "版本列表选项") data class VersionListOption( - @ApiModelProperty("当前页") + @get:Schema(title = "当前页") val pageNumber: Int = DEFAULT_PAGE_NUMBER, - @ApiModelProperty("分页大小") + @get:Schema(title = "分页大小") val pageSize: Int = DEFAULT_PAGE_SIZE, - @ApiModelProperty("版本") + @get:Schema(title = "版本") val version: String? = null, - @ApiModelProperty("晋级tag, 多个tag以逗号分隔") + @get:Schema(title = "晋级tag, 多个tag以逗号分隔") val stageTag: String? = null, - @ApiModelProperty("元数据") + @get:Schema(title = "元数据") val metadata: List? = null, - @ApiModelProperty("排序字段") + @get:Schema(title = "排序字段") val sortProperty: String? = null, - @ApiModelProperty("排序方向") + @get:Schema(title = "排序方向") val direction: Direction? = Direction.DESC ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/packages/request/PackagePopulateRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/packages/request/PackagePopulateRequest.kt index fc72ba6013..0867f9facf 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/packages/request/PackagePopulateRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/packages/request/PackagePopulateRequest.kt @@ -32,34 +32,34 @@ package com.tencent.bkrepo.repository.pojo.packages.request import com.tencent.bkrepo.repository.pojo.packages.PackageType -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema import java.time.LocalDateTime data class PackagePopulateRequest( - @ApiModelProperty("创建者") + @get:Schema(title = "创建者") val createdBy: String, - @ApiModelProperty("创建时间") + @get:Schema(title = "创建时间") val createdDate: LocalDateTime, - @ApiModelProperty("修改者") + @get:Schema(title = "修改者") val lastModifiedBy: String, - @ApiModelProperty("修改时间") + @get:Schema(title = "修改时间") val lastModifiedDate: LocalDateTime, - @ApiModelProperty("项目id") + @get:Schema(title = "项目id") val projectId: String, - @ApiModelProperty("仓库名称") + @get:Schema(title = "仓库名称") val repoName: String, - @ApiModelProperty("包名称") + @get:Schema(title = "包名称") val name: String, - @ApiModelProperty("包唯一标识符") + @get:Schema(title = "包唯一标识符") val key: String, - @ApiModelProperty("包类型") + @get:Schema(title = "包类型") val type: PackageType, - @ApiModelProperty("包简要描述") + @get:Schema(title = "包简要描述") val description: String? = null, - @ApiModelProperty("版本列表") + @get:Schema(title = "版本列表") val versionList: List, - @ApiModelProperty("包版本标签") + @get:Schema(title = "包版本标签") val versionTag: Map? = null, - @ApiModelProperty("扩展字段") + @get:Schema(title = "扩展字段") val extension: Map? = null ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/packages/request/PackageUpdateRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/packages/request/PackageUpdateRequest.kt index 51d61dc388..6f1a01be9b 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/packages/request/PackageUpdateRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/packages/request/PackageUpdateRequest.kt @@ -31,21 +31,22 @@ package com.tencent.bkrepo.repository.pojo.packages.request -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + data class PackageUpdateRequest( - @ApiModelProperty("项目id") + @get:Schema(title = "项目id") val projectId: String, - @ApiModelProperty("仓库名称") + @get:Schema(title = "仓库名称") val repoName: String, - @ApiModelProperty("包唯一标识符") + @get:Schema(title = "包唯一标识符") val packageKey: String, - @ApiModelProperty("包名称") + @get:Schema(title = "包名称") val name: String? = null, - @ApiModelProperty("包简要描述") + @get:Schema(title = "包简要描述") val description: String? = null, - @ApiModelProperty("包版本标签") + @get:Schema(title = "包版本标签") val versionTag: Map? = null, - @ApiModelProperty("包扩展字段") + @get:Schema(title = "包扩展字段") val extension: Map? = null ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/packages/request/PackageVersionCreateRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/packages/request/PackageVersionCreateRequest.kt index b3717db83a..7d5e3bafeb 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/packages/request/PackageVersionCreateRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/packages/request/PackageVersionCreateRequest.kt @@ -33,48 +33,49 @@ package com.tencent.bkrepo.repository.pojo.packages.request import com.tencent.bkrepo.repository.pojo.metadata.MetadataModel import com.tencent.bkrepo.repository.pojo.packages.PackageType -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + data class PackageVersionCreateRequest( - @ApiModelProperty("项目id") + @get:Schema(title = "项目id") val projectId: String, - @ApiModelProperty("仓库名称") + @get:Schema(title = "仓库名称") val repoName: String, - @ApiModelProperty("包名称") + @get:Schema(title = "包名称") val packageName: String, - @ApiModelProperty("包唯一标识符") + @get:Schema(title = "包唯一标识符") val packageKey: String, - @ApiModelProperty("包类型") + @get:Schema(title = "包类型") val packageType: PackageType, - @ApiModelProperty("包简要描述") + @get:Schema(title = "包简要描述") val packageDescription: String? = null, - @ApiModelProperty("包版本标签") + @get:Schema(title = "包版本标签") val versionTag: Map? = null, - @ApiModelProperty("包扩展字段") + @get:Schema(title = "包扩展字段") val packageExtension: Map? = null, - @ApiModelProperty("版本名称") + @get:Schema(title = "版本名称") val versionName: String, - @ApiModelProperty("版本大小") + @get:Schema(title = "版本大小") val size: Long, - @ApiModelProperty("版本描述文件路径") + @get:Schema(title = "版本描述文件路径") var manifestPath: String? = null, - @ApiModelProperty("版本内容文件路径") + @get:Schema(title = "版本内容文件路径") var artifactPath: String? = null, - @ApiModelProperty("版本构件阶段") + @get:Schema(title = "版本构件阶段") val stageTag: List? = null, - @ApiModelProperty("版本元数据") + @get:Schema(title = "版本元数据") @Deprecated("仅用于兼容旧接口", replaceWith = ReplaceWith("packageMetadata")) val metadata: Map? = null, - @ApiModelProperty("版本元数据") + @get:Schema(title = "版本元数据") val packageMetadata: List? = null, - @ApiModelProperty("标签") + @get:Schema(title = "标签") val tags: List? = null, - @ApiModelProperty("版本扩展字段") + @get:Schema(title = "版本扩展字段") val extension: Map? = null, - @ApiModelProperty("是否允许覆盖") + @get:Schema(title = "是否允许覆盖") val overwrite: Boolean = false, - @ApiModelProperty("创建人") + @get:Schema(title = "创建人") val createdBy: String, - @ApiModelProperty("同版本是否包含多个制品") + @get:Schema(title = "同版本是否包含多个制品") val multiArtifact: Boolean = false ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/packages/request/PackageVersionUpdateRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/packages/request/PackageVersionUpdateRequest.kt index fee9d68e4b..c7a6ceb2c2 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/packages/request/PackageVersionUpdateRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/packages/request/PackageVersionUpdateRequest.kt @@ -32,32 +32,33 @@ package com.tencent.bkrepo.repository.pojo.packages.request import com.tencent.bkrepo.repository.pojo.metadata.MetadataModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + data class PackageVersionUpdateRequest( - @ApiModelProperty("项目id") + @get:Schema(title = "项目id") val projectId: String, - @ApiModelProperty("仓库名称") + @get:Schema(title = "仓库名称") val repoName: String, - @ApiModelProperty("包唯一标识符") + @get:Schema(title = "包唯一标识符") val packageKey: String, - @ApiModelProperty("版本名称") + @get:Schema(title = "版本名称") val versionName: String, - @ApiModelProperty("版本大小") + @get:Schema(title = "版本大小") val size: Long? = null, - @ApiModelProperty("版本描述文件路径") + @get:Schema(title = "版本描述文件路径") var manifestPath: String? = null, - @ApiModelProperty("版本内容文件路径") + @get:Schema(title = "版本内容文件路径") var artifactPath: String? = null, - @ApiModelProperty("版本构件阶段") + @get:Schema(title = "版本构件阶段") val stageTag: List? = null, - @ApiModelProperty("标签") + @get:Schema(title = "标签") val tags: List? = null, - @ApiModelProperty("版本元数据") + @get:Schema(title = "版本元数据") @Deprecated("仅用于兼容旧接口", replaceWith = ReplaceWith("packageMetadata")) val metadata: Map? = null, - @ApiModelProperty("版本元数据") + @get:Schema(title = "版本元数据") val packageMetadata: List? = null, - @ApiModelProperty("版本扩展字段") + @get:Schema(title = "版本扩展字段") val extension: Map? = null ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/packages/request/PopulatedPackageVersion.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/packages/request/PopulatedPackageVersion.kt index ee49cc4f2d..5236d09057 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/packages/request/PopulatedPackageVersion.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/packages/request/PopulatedPackageVersion.kt @@ -32,36 +32,36 @@ package com.tencent.bkrepo.repository.pojo.packages.request import com.tencent.bkrepo.repository.pojo.metadata.MetadataModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema import java.time.LocalDateTime data class PopulatedPackageVersion( - @ApiModelProperty("创建者") + @get:Schema(title = "创建者") val createdBy: String, - @ApiModelProperty("创建时间") + @get:Schema(title = "创建时间") val createdDate: LocalDateTime, - @ApiModelProperty("修改者") + @get:Schema(title = "修改者") val lastModifiedBy: String, - @ApiModelProperty("修改时间") + @get:Schema(title = "修改时间") val lastModifiedDate: LocalDateTime, - @ApiModelProperty("版本名称") + @get:Schema(title = "版本名称") val name: String, - @ApiModelProperty("版本大小") + @get:Schema(title = "版本大小") val size: Long, - @ApiModelProperty("下载次数") + @get:Schema(title = "下载次数") var downloads: Long, - @ApiModelProperty("版本描述文件路径") + @get:Schema(title = "版本描述文件路径") var manifestPath: String? = null, - @ApiModelProperty("版本内容文件路径") + @get:Schema(title = "版本内容文件路径") var artifactPath: String? = null, - @ApiModelProperty("版本构件阶段") + @get:Schema(title = "版本构件阶段") val stageTag: List? = null, - @ApiModelProperty("版本元数据") + @get:Schema(title = "版本元数据") @Deprecated("仅用于兼容旧接口", replaceWith = ReplaceWith("packageMetadata")) val metadata: Map? = null, - @ApiModelProperty("版本元数据") + @get:Schema(title = "版本元数据") val packageMetadata: List? = null, - @ApiModelProperty("扩展字段") + @get:Schema(title = "扩展字段") val extension: Map? = null ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/project/ProjectCreateRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/project/ProjectCreateRequest.kt index 096261a2aa..91d6f13bb7 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/project/ProjectCreateRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/project/ProjectCreateRequest.kt @@ -32,23 +32,23 @@ package com.tencent.bkrepo.repository.pojo.project import com.tencent.bkrepo.repository.constant.SYSTEM_USER -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("创建项目请求") + +@Schema(title = "创建项目请求") data class ProjectCreateRequest( - @ApiModelProperty("项目名", required = true) + @get:Schema(title = "项目名", required = true) override val name: String, - @ApiModelProperty("显示名", required = true) + @get:Schema(title = "显示名", required = true) val displayName: String, - @ApiModelProperty("描述", required = true) + @get:Schema(title = "描述", required = true) val description: String? = null, - @ApiModelProperty("创建权限", required = false) + @get:Schema(title = "创建权限", required = false) val createPermission: Boolean = true, - @ApiModelProperty("操作用户", required = false) + @get:Schema(title = "操作用户", required = false) val operator: String = SYSTEM_USER, - @ApiModelProperty("项目元数据", required = false) + @get:Schema(title = "项目元数据", required = false) val metadata: List = emptyList(), - @ApiModelProperty("项目新建仓库默认使用的存储", required = false) + @get:Schema(title = "项目新建仓库默认使用的存储", required = false) val credentialsKey: String? = null, ) : ProjectRequest diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/project/ProjectInfo.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/project/ProjectInfo.kt index 44bca9ae43..0991e2db55 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/project/ProjectInfo.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/project/ProjectInfo.kt @@ -31,29 +31,29 @@ package com.tencent.bkrepo.repository.pojo.project -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("项目信息") + +@Schema(title = "项目信息") data class ProjectInfo( - @ApiModelProperty("名称") + @get:Schema(title = "名称") val name: String, - @ApiModelProperty("显示名称") + @get:Schema(title = "显示名称") val displayName: String, - @ApiModelProperty("描述") + @get:Schema(title = "描述") val description: String, - @ApiModelProperty("创建者") + @get:Schema(title = "创建者") val createdBy: String, - @ApiModelProperty("创建日期") + @get:Schema(title = "创建日期") val createdDate: String, - @ApiModelProperty("上次修改者") + @get:Schema(title = "上次修改者") val lastModifiedBy: String, - @ApiModelProperty("上次修改日期") + @get:Schema(title = "上次修改日期") val lastModifiedDate: String, - @ApiModelProperty("是否已生成蓝鲸v3-rbac默认项目组") + @get:Schema(title = "是否已生成蓝鲸v3-rbac默认项目组") val rbacFlag: Boolean = false, - @ApiModelProperty("项目元数据") + @get:Schema(title = "项目元数据") val metadata: List = emptyList(), - @ApiModelProperty("项目新建仓库默认使用的存储") + @get:Schema(title = "项目新建仓库默认使用的存储") val credentialsKey: String? = null, ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/project/ProjectListOption.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/project/ProjectListOption.kt index 288623ff5c..ca8e48c434 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/project/ProjectListOption.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/project/ProjectListOption.kt @@ -27,21 +27,21 @@ package com.tencent.bkrepo.repository.pojo.project -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("项目列表选项") + +@Schema(title = "项目列表选项") data class ProjectListOption( - @ApiModelProperty("当前页") + @get:Schema(title = "当前页") val pageNumber: Int?, - @ApiModelProperty("分页大小") + @get:Schema(title = "分页大小") val pageSize: Int?, - @ApiModelProperty("项目名列表") + @get:Schema(title = "项目名列表") val names: List?, - @ApiModelProperty("项目展示名列表") + @get:Schema(title = "项目展示名列表") val displayNames: List?, - @ApiModelProperty("排序字段") + @get:Schema(title = "排序字段") val sortProperty: List?, - @ApiModelProperty("排序方向") + @get:Schema(title = "排序方向") val direction: List? ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/project/ProjectMetricsInfo.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/project/ProjectMetricsInfo.kt index 7b5b01a975..89f5b87026 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/project/ProjectMetricsInfo.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/project/ProjectMetricsInfo.kt @@ -28,18 +28,18 @@ package com.tencent.bkrepo.repository.pojo.project import com.tencent.bkrepo.repository.pojo.repo.RepoMetricsInfo -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema import java.time.LocalDateTime data class ProjectMetricsInfo( - @ApiModelProperty("projectId") + @get:Schema(title = "projectId") var projectId: String, - @ApiModelProperty("nodeNum") + @get:Schema(title = "nodeNum") var nodeNum: Long, - @ApiModelProperty("capSize") + @get:Schema(title = "capSize") var capSize: Long, - @ApiModelProperty("repoMetrics") + @get:Schema(title = "repoMetrics") val repoMetrics: List, - @ApiModelProperty("createdDate") + @get:Schema(title = "createdDate") val createdDate: LocalDateTime? = LocalDateTime.now() ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/project/ProjectRangeQueryRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/project/ProjectRangeQueryRequest.kt index eaf9419f33..855f4e3909 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/project/ProjectRangeQueryRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/project/ProjectRangeQueryRequest.kt @@ -31,17 +31,17 @@ package com.tencent.bkrepo.repository.pojo.project -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("创建项目请求") + +@Schema(title = "创建项目请求") data class ProjectRangeQueryRequest( - @ApiModelProperty("项目Id", required = true) + @get:Schema(title = "项目Id", required = true) val projectIds: List, - @ApiModelProperty("分页偏移量", required = false) + @get:Schema(title = "分页偏移量", required = false) val offset: Long = 0L, - @ApiModelProperty("分页大小", required = false) + @get:Schema(title = "分页大小", required = false) val limit: Int = 20, - @ApiModelProperty("项目元数据", required = false) + @get:Schema(title = "项目元数据", required = false) val projectMetadata: List = emptyList(), ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/project/ProjectSearchOption.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/project/ProjectSearchOption.kt index 97f4e2189e..dcb8f00269 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/project/ProjectSearchOption.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/project/ProjectSearchOption.kt @@ -29,15 +29,15 @@ package com.tencent.bkrepo.repository.pojo.project import com.tencent.bkrepo.common.api.constant.DEFAULT_PAGE_NUMBER import com.tencent.bkrepo.common.api.constant.DEFAULT_PAGE_SIZE -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("项目搜索选项") + +@Schema(title = "项目搜索选项") data class ProjectSearchOption( - @ApiModelProperty("当前页") + @get:Schema(title = "当前页") val pageNumber: Int = DEFAULT_PAGE_NUMBER, - @ApiModelProperty("分页大小") + @get:Schema(title = "分页大小") val pageSize: Int = DEFAULT_PAGE_SIZE, - @ApiModelProperty("项目名前缀") + @get:Schema(title = "项目名前缀") val namePrefix: String? = null ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/project/ProjectUpdateRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/project/ProjectUpdateRequest.kt index af21a803c5..c6c6141ea5 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/project/ProjectUpdateRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/project/ProjectUpdateRequest.kt @@ -31,19 +31,19 @@ package com.tencent.bkrepo.repository.pojo.project -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("编辑项目请求") + +@Schema(title = "编辑项目请求") data class ProjectUpdateRequest( - @ApiModelProperty("显示名", required = false) + @get:Schema(title = "显示名", required = false) val displayName: String? = null, - @ApiModelProperty("描述", required = false) + @get:Schema(title = "描述", required = false) val description: String? = null, - @ApiModelProperty("项目元数据", required = false) + @get:Schema(title = "项目元数据", required = false) val metadata: List = emptyList(), - @ApiModelProperty("项目新建仓库默认使用的存储", required = false) + @get:Schema(title = "项目新建仓库默认使用的存储", required = false) val credentialsKey: String? = null, - @ApiModelProperty("设置项目新建仓库默认使用默认存储", required = false) + @get:Schema(title = "设置项目新建仓库默认使用默认存储", required = false) val useDefaultCredentialsKey: Boolean? = false, ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/project/RepoRangeQueryRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/project/RepoRangeQueryRequest.kt index 08f3434128..6fe1989c09 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/project/RepoRangeQueryRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/project/RepoRangeQueryRequest.kt @@ -31,17 +31,17 @@ package com.tencent.bkrepo.repository.pojo.project -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("创建项目请求") + +@Schema(title = "创建项目请求") data class RepoRangeQueryRequest( - @ApiModelProperty("仓库名称", required = true) + @get:Schema(title = "仓库名称", required = true) val repoNames: List, - @ApiModelProperty("项目ID", required = true) + @get:Schema(title = "项目ID", required = true) val projectId: String, - @ApiModelProperty("分页偏移量", required = false) + @get:Schema(title = "分页偏移量", required = false) val offset: Long = 0L, - @ApiModelProperty("分页大小", required = false) + @get:Schema(title = "分页大小", required = false) val limit: Int = 20 ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/project/UserProjectCreateRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/project/UserProjectCreateRequest.kt index 6f6b3da1c3..d3d7699043 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/project/UserProjectCreateRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/project/UserProjectCreateRequest.kt @@ -31,19 +31,19 @@ package com.tencent.bkrepo.repository.pojo.project -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("创建项目请求") + +@Schema(title = "创建项目请求") data class UserProjectCreateRequest( - @ApiModelProperty("项目名") + @get:Schema(title = "项目名") override val name: String, - @ApiModelProperty("显示名") + @get:Schema(title = "显示名") val displayName: String, - @ApiModelProperty("描述") + @get:Schema(title = "描述") val description: String, - @ApiModelProperty("创建本地权限") + @get:Schema(title = "创建本地权限") val createPermission: Boolean = true, - @ApiModelProperty("项目元数据") + @get:Schema(title = "项目元数据") val metadata: List = emptyList(), ) : ProjectRequest diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/proxy/ProxyChannelCreateRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/proxy/ProxyChannelCreateRequest.kt index a7d0d74fab..df855f18e9 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/proxy/ProxyChannelCreateRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/proxy/ProxyChannelCreateRequest.kt @@ -32,30 +32,30 @@ package com.tencent.bkrepo.repository.pojo.proxy import com.tencent.bkrepo.common.artifact.pojo.RepositoryType -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 代理源创建请求 */ -@ApiModel("代理源创建请求") +@Schema(title = "代理源创建请求") data class ProxyChannelCreateRequest( - @ApiModelProperty("所属项目id", required = true) + @get:Schema(title = "所属项目id", required = true) val projectId: String, - @ApiModelProperty("仓库名称", required = true) + @get:Schema(title = "仓库名称", required = true) val repoName: String, - @ApiModelProperty("是否为公有源", required = false) + @get:Schema(title = "是否为公有源", required = false) val public: Boolean = true, - @ApiModelProperty("代理源名称", required = true) + @get:Schema(title = "代理源名称", required = true) val name: String, - @ApiModelProperty("代理源url", required = true) + @get:Schema(title = "代理源url", required = true) val url: String, - @ApiModelProperty("代理源仓库类型", required = true) + @get:Schema(title = "代理源仓库类型", required = true) val repoType: RepositoryType, - @ApiModelProperty("代理源认证凭证key", required = true) + @get:Schema(title = "代理源认证凭证key", required = true) val credentialKey: String? = null, - @ApiModelProperty("代理源认证用户名", required = true) + @get:Schema(title = "代理源认证用户名", required = true) val username: String? = null, - @ApiModelProperty("代理源认证密码", required = true) + @get:Schema(title = "代理源认证密码", required = true) val password: String? = null ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/proxy/ProxyChannelDeleteRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/proxy/ProxyChannelDeleteRequest.kt index 97b00f7c7a..2b5feddb6c 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/proxy/ProxyChannelDeleteRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/proxy/ProxyChannelDeleteRequest.kt @@ -32,20 +32,20 @@ package com.tencent.bkrepo.repository.pojo.proxy import com.tencent.bkrepo.common.artifact.pojo.RepositoryType -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 代理源创建请求 */ -@ApiModel("代理源删除请求") +@Schema(title = "代理源删除请求") data class ProxyChannelDeleteRequest( - @ApiModelProperty("所属项目id", required = true) + @get:Schema(title = "所属项目id", required = true) val projectId: String, - @ApiModelProperty("仓库名称", required = true) + @get:Schema(title = "仓库名称", required = true) val repoName: String, - @ApiModelProperty("代理源名称", required = true) + @get:Schema(title = "代理源名称", required = true) val name: String, - @ApiModelProperty("代理源仓库类型", required = true) + @get:Schema(title = "代理源仓库类型", required = true) val repoType: RepositoryType ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/proxy/ProxyChannelInfo.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/proxy/ProxyChannelInfo.kt index d61803b120..5a8ec41c30 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/proxy/ProxyChannelInfo.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/proxy/ProxyChannelInfo.kt @@ -32,29 +32,29 @@ package com.tencent.bkrepo.repository.pojo.proxy import com.tencent.bkrepo.common.artifact.pojo.RepositoryType -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("代理源信息") + +@Schema(title = "代理源信息") data class ProxyChannelInfo( - @ApiModelProperty("所属项目id", required = true) + @get:Schema(title = "所属项目id", required = true) val projectId: String, - @ApiModelProperty("仓库名称", required = true) + @get:Schema(title = "仓库名称", required = true) val repoName: String, - @ApiModelProperty("id") + @get:Schema(title = "id") val id: String, - @ApiModelProperty("是否为公有源") + @get:Schema(title = "是否为公有源") val public: Boolean, - @ApiModelProperty("代理源名称") + @get:Schema(title = "代理源名称") val name: String, - @ApiModelProperty("代理源url") + @get:Schema(title = "代理源url") val url: String, - @ApiModelProperty("代理源仓库类型") + @get:Schema(title = "代理源仓库类型") val repoType: RepositoryType, - @ApiModelProperty("代理源认证凭证key") + @get:Schema(title = "代理源认证凭证key") val credentialKey: String? = null, - @ApiModelProperty("代理源认证用户名") + @get:Schema(title = "代理源认证用户名") val username: String? = null, - @ApiModelProperty("代理源认证密码") + @get:Schema(title = "代理源认证密码") val password: String? = null ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/proxy/ProxyChannelUpdateRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/proxy/ProxyChannelUpdateRequest.kt index 891eca1dc0..4f1bff4242 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/proxy/ProxyChannelUpdateRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/proxy/ProxyChannelUpdateRequest.kt @@ -32,30 +32,30 @@ package com.tencent.bkrepo.repository.pojo.proxy import com.tencent.bkrepo.common.artifact.pojo.RepositoryType -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 代理源更新请求 */ -@ApiModel("代理源更新请求") +@Schema(title = "代理源更新请求") data class ProxyChannelUpdateRequest( - @ApiModelProperty("所属项目id", required = true) + @get:Schema(title = "所属项目id", required = true) val projectId: String, - @ApiModelProperty("仓库名称", required = true) + @get:Schema(title = "仓库名称", required = true) val repoName: String, - @ApiModelProperty("是否为公有源", required = false) + @get:Schema(title = "是否为公有源", required = false) val public: Boolean = true, - @ApiModelProperty("代理源名称", required = true) + @get:Schema(title = "代理源名称", required = true) val name: String, - @ApiModelProperty("代理源url", required = true) + @get:Schema(title = "代理源url", required = true) val url: String, - @ApiModelProperty("代理源仓库类型", required = false) + @get:Schema(title = "代理源仓库类型", required = false) val repoType: RepositoryType, - @ApiModelProperty("代理源认证凭证key", required = false) + @get:Schema(title = "代理源认证凭证key", required = false) val credentialKey: String? = null, - @ApiModelProperty("代理源认证用户名", required = false) + @get:Schema(title = "代理源认证用户名", required = false) val username: String? = null, - @ApiModelProperty("代理源认证密码", required = false) + @get:Schema(title = "代理源认证密码", required = false) val password: String? = null ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/RepoCreateRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/RepoCreateRequest.kt index 7e241e0417..d3818d478c 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/RepoCreateRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/RepoCreateRequest.kt @@ -35,37 +35,37 @@ import com.tencent.bkrepo.common.artifact.pojo.RepositoryCategory import com.tencent.bkrepo.common.artifact.pojo.RepositoryType import com.tencent.bkrepo.common.artifact.pojo.configuration.RepositoryConfiguration import com.tencent.bkrepo.repository.constant.SYSTEM_USER -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 创建仓库请求 */ -@ApiModel("创建仓库请求") +@Schema(title = "创建仓库请求") data class RepoCreateRequest( - @ApiModelProperty("所属项目id", required = true) + @get:Schema(title = "所属项目id", required = true) override val projectId: String, - @ApiModelProperty("仓库名称", required = true) + @get:Schema(title = "仓库名称", required = true) override val name: String, - @ApiModelProperty("仓库类型", required = true) + @get:Schema(title = "仓库类型", required = true) val type: RepositoryType, - @ApiModelProperty("仓库类别", required = true) + @get:Schema(title = "仓库类别", required = true) val category: RepositoryCategory, - @ApiModelProperty("是否公开", required = true) + @get:Schema(title = "是否公开", required = true) val public: Boolean, - @ApiModelProperty("简要描述", required = false) + @get:Schema(title = "简要描述", required = false) val description: String? = null, - @ApiModelProperty("仓库配置", required = true) + @get:Schema(title = "仓库配置", required = true) val configuration: RepositoryConfiguration? = null, - @ApiModelProperty("存储凭证key", required = false) + @get:Schema(title = "存储凭证key", required = false) val storageCredentialsKey: String? = null, - @ApiModelProperty("仓库配额", required = false) + @get:Schema(title = "仓库配额", required = false) val quota: Long? = null, - @ApiModelProperty("来自插件的请求", required = false) + @get:Schema(title = "来自插件的请求", required = false) val pluginRequest: Boolean = false, - @ApiModelProperty("操作用户", required = false) + @get:Schema(title = "操作用户", required = false) val operator: String = SYSTEM_USER, - @ApiModelProperty("是否展示", required = true) + @get:Schema(title = "是否展示", required = true) val display: Boolean = true ) : RepoRequest diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/RepoDeleteRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/RepoDeleteRequest.kt index 7c63317075..26586d1781 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/RepoDeleteRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/RepoDeleteRequest.kt @@ -31,17 +31,17 @@ package com.tencent.bkrepo.repository.pojo.repo -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("更新删除请求") + +@Schema(title = "更新删除请求") data class RepoDeleteRequest( - @ApiModelProperty("所属项目id", required = true) + @get:Schema(title = "所属项目id", required = true) override val projectId: String, - @ApiModelProperty("仓库名称", required = true) + @get:Schema(title = "仓库名称", required = true) override val name: String, - @ApiModelProperty("是否强制删除（忽略存在的文件）", required = false) + @get:Schema(title = "是否强制删除（忽略存在的文件）", required = false) val forced: Boolean = false, - @ApiModelProperty("操作用户", required = true) + @get:Schema(title = "操作用户", required = true) val operator: String ) : RepoRequest diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/RepoListOption.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/RepoListOption.kt index ed63879148..7f9db1a849 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/RepoListOption.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/RepoListOption.kt @@ -27,19 +27,19 @@ package com.tencent.bkrepo.repository.pojo.repo -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("仓库列表选项") + +@Schema(title = "仓库列表选项") data class RepoListOption( - @ApiModelProperty("仓库名称(前缀匹配，忽略大小写)", required = false) + @get:Schema(title = "仓库名称(前缀匹配，忽略大小写)", required = false) val name: String? = null, - @ApiModelProperty("仓库类型", required = false) + @get:Schema(title = "仓库类型", required = false) val type: String? = null, - @ApiModelProperty("仓库类别", required = false) + @get:Schema(title = "仓库类别", required = false) val category: String? = null, - @ApiModelProperty("是否可展示的仓库", required = false) + @get:Schema(title = "是否可展示的仓库", required = false) val display: Boolean? = true, - @ApiModelProperty("包含的仓库列表，不受display限制", required = false) + @get:Schema(title = "包含的仓库列表，不受display限制", required = false) val include: String? = null, ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/RepoMetricsInfo.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/RepoMetricsInfo.kt index 2cad97113a..e3ed2278a2 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/RepoMetricsInfo.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/RepoMetricsInfo.kt @@ -27,15 +27,16 @@ package com.tencent.bkrepo.repository.pojo.repo -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + data class RepoMetricsInfo( - @ApiModelProperty("repoName") + @get:Schema(title = "repoName") val repoName: String, - @ApiModelProperty("credentialsKey") + @get:Schema(title = "credentialsKey") val credentialsKey: String? = "default", - @ApiModelProperty("size") + @get:Schema(title = "size") var size: Long, - @ApiModelProperty("num") + @get:Schema(title = "num") val num: Long ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/RepoQuotaInfo.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/RepoQuotaInfo.kt index 144d069fd2..835afb6525 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/RepoQuotaInfo.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/RepoQuotaInfo.kt @@ -31,13 +31,13 @@ package com.tencent.bkrepo.repository.pojo.repo -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("仓库配额信息") + +@Schema(title = "仓库配额信息") data class RepoQuotaInfo( - @ApiModelProperty("仓库配额") + @get:Schema(title = "仓库配额") val quota: Long?, - @ApiModelProperty("已使用容量") + @get:Schema(title = "已使用容量") val used: Long? ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/RepoUpdateRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/RepoUpdateRequest.kt index e96ea64bec..900525317d 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/RepoUpdateRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/RepoUpdateRequest.kt @@ -32,28 +32,28 @@ package com.tencent.bkrepo.repository.pojo.repo import com.tencent.bkrepo.common.artifact.pojo.configuration.RepositoryConfiguration -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 更新仓库请求 */ -@ApiModel("更新仓库请求") +@Schema(title = "更新仓库请求") data class RepoUpdateRequest( - @ApiModelProperty("所属项目id", required = true) + @get:Schema(title = "所属项目id", required = true) override val projectId: String, - @ApiModelProperty("仓库名称", required = true) + @get:Schema(title = "仓库名称", required = true) override val name: String, - @ApiModelProperty("是否公开", required = false) + @get:Schema(title = "是否公开", required = false) val public: Boolean? = null, - @ApiModelProperty("简要描述", required = false) + @get:Schema(title = "简要描述", required = false) val description: String? = null, - @ApiModelProperty("扩展信息", required = false) + @get:Schema(title = "扩展信息", required = false) val configuration: RepositoryConfiguration? = null, - @ApiModelProperty("仓库配额", required = false) + @get:Schema(title = "仓库配额", required = false) val quota: Long? = null, - @ApiModelProperty("操作用户", required = true) + @get:Schema(title = "操作用户", required = true) val operator: String, - @ApiModelProperty("是否展示", required = true) + @get:Schema(title = "是否展示", required = true) val display: Boolean = true ) : RepoRequest diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/RepositoryDetail.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/RepositoryDetail.kt index e96abe9452..9c087a2ae7 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/RepositoryDetail.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/RepositoryDetail.kt @@ -35,42 +35,42 @@ import com.tencent.bkrepo.common.artifact.pojo.RepositoryCategory import com.tencent.bkrepo.common.artifact.pojo.RepositoryType import com.tencent.bkrepo.common.artifact.pojo.configuration.RepositoryConfiguration import com.tencent.bkrepo.common.storage.credentials.StorageCredentials -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 仓库详情 */ -@ApiModel("仓库详情") +@Schema(title = "仓库详情") data class RepositoryDetail( - @ApiModelProperty("所属项目id") + @get:Schema(title = "所属项目id") val projectId: String, - @ApiModelProperty("仓库名称") + @get:Schema(title = "仓库名称") val name: String, - @ApiModelProperty("仓库类型") + @get:Schema(title = "仓库类型") val type: RepositoryType, - @ApiModelProperty("仓库类别") + @get:Schema(title = "仓库类别") val category: RepositoryCategory, - @ApiModelProperty("是否公开") + @get:Schema(title = "是否公开") val public: Boolean, - @ApiModelProperty("简要描述") + @get:Schema(title = "简要描述") val description: String?, - @ApiModelProperty("仓库配置信息") + @get:Schema(title = "仓库配置信息") val configuration: RepositoryConfiguration, - @ApiModelProperty("存储身份信息") + @get:Schema(title = "存储身份信息") val storageCredentials: StorageCredentials?, - @ApiModelProperty("旧存储身份信息") + @get:Schema(title = "旧存储身份信息") var oldCredentialsKey:String?, - @ApiModelProperty("创建者") + @get:Schema(title = "创建者") val createdBy: String, - @ApiModelProperty("创建日期") + @get:Schema(title = "创建日期") val createdDate: String, - @ApiModelProperty("上次修改者") + @get:Schema(title = "上次修改者") val lastModifiedBy: String, - @ApiModelProperty("上次修改日期") + @get:Schema(title = "上次修改日期") val lastModifiedDate: String, - @ApiModelProperty("仓库配额") + @get:Schema(title = "仓库配额") val quota: Long?, - @ApiModelProperty("仓库已使用容量") + @get:Schema(title = "仓库已使用容量") val used: Long? ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/RepositoryInfo.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/RepositoryInfo.kt index b9ab73cab6..c9ea8b4750 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/RepositoryInfo.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/RepositoryInfo.kt @@ -34,43 +34,43 @@ package com.tencent.bkrepo.repository.pojo.repo import com.tencent.bkrepo.common.artifact.pojo.RepositoryCategory import com.tencent.bkrepo.common.artifact.pojo.RepositoryType import com.tencent.bkrepo.common.artifact.pojo.configuration.RepositoryConfiguration -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 仓库信息 */ -@ApiModel("仓库信息") +@Schema(title = "仓库信息") data class RepositoryInfo( val id: String? = null, - @ApiModelProperty("所属项目id") + @get:Schema(title = "所属项目id") val projectId: String, - @ApiModelProperty("仓库名称") + @get:Schema(title = "仓库名称") val name: String, - @ApiModelProperty("仓库类型") + @get:Schema(title = "仓库类型") val type: RepositoryType, - @ApiModelProperty("仓库类别") + @get:Schema(title = "仓库类别") val category: RepositoryCategory, - @ApiModelProperty("是否公开") + @get:Schema(title = "是否公开") val public: Boolean, - @ApiModelProperty("简要描述") + @get:Schema(title = "简要描述") val description: String?, - @ApiModelProperty("仓库配置信息") + @get:Schema(title = "仓库配置信息") val configuration: RepositoryConfiguration, - @ApiModelProperty("存储凭证key") + @get:Schema(title = "存储凭证key") val storageCredentialsKey: String?, - @ApiModelProperty("创建者") + @get:Schema(title = "创建者") val createdBy: String, - @ApiModelProperty("创建日期") + @get:Schema(title = "创建日期") val createdDate: String, - @ApiModelProperty("上次修改者") + @get:Schema(title = "上次修改者") val lastModifiedBy: String, - @ApiModelProperty("上次修改日期") + @get:Schema(title = "上次修改日期") val lastModifiedDate: String, - @ApiModelProperty("仓库配额") + @get:Schema(title = "仓库配额") val quota: Long?, - @ApiModelProperty("仓库已使用容量") + @get:Schema(title = "仓库已使用容量") val used: Long?, - @ApiModelProperty("是否展示") + @get:Schema(title = "是否展示") val display: Boolean ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/UserRepoCreateRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/UserRepoCreateRequest.kt index d1d3882829..9628574257 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/UserRepoCreateRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/UserRepoCreateRequest.kt @@ -34,34 +34,34 @@ package com.tencent.bkrepo.repository.pojo.repo import com.tencent.bkrepo.common.artifact.pojo.RepositoryCategory import com.tencent.bkrepo.common.artifact.pojo.RepositoryType import com.tencent.bkrepo.common.artifact.pojo.configuration.RepositoryConfiguration -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * 创建仓库请求 */ -@ApiModel("创建仓库请求") +@Schema(title = "创建仓库请求") data class UserRepoCreateRequest( - @ApiModelProperty("所属项目id", required = true) + @get:Schema(title = "所属项目id", required = true) override val projectId: String, - @ApiModelProperty("仓库名称", required = true) + @get:Schema(title = "仓库名称", required = true) override val name: String, - @ApiModelProperty("仓库类型", required = true) + @get:Schema(title = "仓库类型", required = true) val type: RepositoryType, - @ApiModelProperty("仓库类别", required = true) + @get:Schema(title = "仓库类别", required = true) val category: RepositoryCategory = RepositoryCategory.COMPOSITE, - @ApiModelProperty("是否公开", required = true) + @get:Schema(title = "是否公开", required = true) val public: Boolean = false, - @ApiModelProperty("简要描述", required = false) + @get:Schema(title = "简要描述", required = false) val description: String? = null, - @ApiModelProperty("仓库配置", required = true) + @get:Schema(title = "仓库配置", required = true) val configuration: RepositoryConfiguration? = null, - @ApiModelProperty("存储凭证key", required = false) + @get:Schema(title = "存储凭证key", required = false) val storageCredentialsKey: String? = null, - @ApiModelProperty("仓库配额", required = false) + @get:Schema(title = "仓库配额", required = false) val quota: Long? = null, - @ApiModelProperty("来自插件的请求", required = false) + @get:Schema(title = "来自插件的请求", required = false) val pluginRequest: Boolean = false, - @ApiModelProperty("是否展示", required = true) + @get:Schema(title = "是否展示", required = true) val display: Boolean = true ) : RepoRequest diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/UserRepoUpdateRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/UserRepoUpdateRequest.kt index 25ede8d916..acc958e09b 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/UserRepoUpdateRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/repo/UserRepoUpdateRequest.kt @@ -32,19 +32,19 @@ package com.tencent.bkrepo.repository.pojo.repo import com.tencent.bkrepo.common.artifact.pojo.configuration.RepositoryConfiguration -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("用户创建仓库请求") + +@Schema(title = "用户创建仓库请求") data class UserRepoUpdateRequest( - @ApiModelProperty("是否公开", required = false) + @get:Schema(title = "是否公开", required = false) val public: Boolean? = null, - @ApiModelProperty("简要描述", required = false) + @get:Schema(title = "简要描述", required = false) val description: String? = null, - @ApiModelProperty("扩展信息", required = false) + @get:Schema(title = "扩展信息", required = false) val configuration: RepositoryConfiguration? = null, - @ApiModelProperty("仓库配额", required = false) + @get:Schema(title = "仓库配额", required = false) val quota: Long? = null, - @ApiModelProperty("是否展示", required = true) + @get:Schema(title = "是否展示", required = true) val display: Boolean = true ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/share/BatchShareRecordCreateRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/share/BatchShareRecordCreateRequest.kt index b64259b0be..5c1cea5e17 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/share/BatchShareRecordCreateRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/share/BatchShareRecordCreateRequest.kt @@ -32,21 +32,21 @@ package com.tencent.bkrepo.repository.pojo.share import com.tencent.bkrepo.repository.pojo.UserRequest -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("批量创建分享请求") + +@Schema(title = "批量创建分享请求") data class BatchShareRecordCreateRequest( - @ApiModelProperty("项目id") + @get:Schema(title = "项目id") val projectId: String, - @ApiModelProperty("仓库名称") + @get:Schema(title = "仓库名称") val repoName: String, - @ApiModelProperty("完整路径列表") + @get:Schema(title = "完整路径列表") val fullPathList: Set, - @ApiModelProperty("分享用户") + @get:Schema(title = "分享用户") val authorizedUserList: List = emptyList(), - @ApiModelProperty("分享IP") + @get:Schema(title = "分享IP") val authorizedIpList: List = emptyList(), - @ApiModelProperty("有效时间，单位秒") + @get:Schema(title = "有效时间，单位秒") val expireSeconds: Long = 0 ) : UserRequest diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/share/ShareRecordCreateRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/share/ShareRecordCreateRequest.kt index ce3df9494b..c6b202fb74 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/share/ShareRecordCreateRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/share/ShareRecordCreateRequest.kt @@ -32,15 +32,15 @@ package com.tencent.bkrepo.repository.pojo.share import com.tencent.bkrepo.repository.pojo.UserRequest -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("创建分享请求") + +@Schema(title = "创建分享请求") data class ShareRecordCreateRequest( - @ApiModelProperty("分享用户") + @get:Schema(title = "分享用户") val authorizedUserList: List = emptyList(), - @ApiModelProperty("分享IP") + @get:Schema(title = "分享IP") val authorizedIpList: List = emptyList(), - @ApiModelProperty("有效时间，单位秒") + @get:Schema(title = "有效时间，单位秒") val expireSeconds: Long = 0 ) : UserRequest diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/share/ShareRecordInfo.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/share/ShareRecordInfo.kt index 5ef19a5967..01cfbdefd3 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/share/ShareRecordInfo.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/share/ShareRecordInfo.kt @@ -31,25 +31,25 @@ package com.tencent.bkrepo.repository.pojo.share -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("分享记录信息") + +@Schema(title = "分享记录信息") data class ShareRecordInfo( - @ApiModelProperty("项目") + @get:Schema(title = "项目") val projectId: String, - @ApiModelProperty("仓库") + @get:Schema(title = "仓库") val repoName: String, - @ApiModelProperty("完整路径") + @get:Schema(title = "完整路径") val fullPath: String, - @ApiModelProperty("分享url") + @get:Schema(title = "分享url") val shareUrl: String, - @ApiModelProperty("授权用户") + @get:Schema(title = "授权用户") val authorizedUserList: List, - @ApiModelProperty("授权IP") + @get:Schema(title = "授权IP") val authorizedIpList: List, - @ApiModelProperty("过期时间") + @get:Schema(title = "过期时间") val expireDate: String?, - @ApiModelProperty("创建人") + @get:Schema(title = "创建人") val createdBy: String ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/software/ProjectPackageOverview.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/software/ProjectPackageOverview.kt index 17f87857f4..94e223d6f3 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/software/ProjectPackageOverview.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/software/ProjectPackageOverview.kt @@ -1,8 +1,8 @@ package com.tencent.bkrepo.repository.pojo.software -import io.swagger.annotations.ApiModel +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("软件源包搜索结果总览") +@Schema(title = "软件源包搜索结果总览") data class ProjectPackageOverview( val projectId: String, var repos: MutableSet, diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/token/TemporaryTokenCreateRequest.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/token/TemporaryTokenCreateRequest.kt index a5a72eed2f..1948d231d2 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/token/TemporaryTokenCreateRequest.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/token/TemporaryTokenCreateRequest.kt @@ -31,26 +31,25 @@ package com.tencent.bkrepo.repository.pojo.token -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema import java.time.Duration -@ApiModel("创建临时token请求") +@Schema(title = "创建临时token请求") data class TemporaryTokenCreateRequest( - @ApiModelProperty("项目id") + @get:Schema(title = "项目id") val projectId: String, - @ApiModelProperty("仓库名称") + @get:Schema(title = "仓库名称") val repoName: String, - @ApiModelProperty("授权路径列表") + @get:Schema(title = "授权路径列表") val fullPathSet: Set, - @ApiModelProperty("授权用户") + @get:Schema(title = "授权用户") val authorizedUserSet: Set = emptySet(), - @ApiModelProperty("授权IP") + @get:Schema(title = "授权IP") val authorizedIpSet: Set = emptySet(), - @ApiModelProperty("有效时间，单位秒") + @get:Schema(title = "有效时间，单位秒") val expireSeconds: Long = Duration.ofDays(1).seconds, - @ApiModelProperty("允许访问次数，为空表示无限制") + @get:Schema(title = "允许访问次数，为空表示无限制") val permits: Int? = null, - @ApiModelProperty("token类型") + @get:Schema(title = "token类型") val type: TokenType ) diff --git a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/token/TemporaryTokenInfo.kt b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/token/TemporaryTokenInfo.kt index 0eb49b27f7..09f9af06f1 100644 --- a/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/token/TemporaryTokenInfo.kt +++ b/src/backend/repository/api-repository/src/main/kotlin/com/tencent/bkrepo/repository/pojo/token/TemporaryTokenInfo.kt @@ -31,29 +31,29 @@ package com.tencent.bkrepo.repository.pojo.token -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("临时token信息") + +@Schema(title = "临时token信息") data class TemporaryTokenInfo( - @ApiModelProperty("项目") + @get:Schema(title = "项目") val projectId: String, - @ApiModelProperty("仓库") + @get:Schema(title = "仓库") val repoName: String, - @ApiModelProperty("授权路径") + @get:Schema(title = "授权路径") val fullPath: String, - @ApiModelProperty("token") + @get:Schema(title = "token") val token: String, - @ApiModelProperty("授权用户") + @get:Schema(title = "授权用户") val authorizedUserList: Set, - @ApiModelProperty("授权IP") + @get:Schema(title = "授权IP") val authorizedIpList: Set, - @ApiModelProperty("过期时间") + @get:Schema(title = "过期时间") val expireDate: String?, - @ApiModelProperty("允许下载次数") + @get:Schema(title = "允许下载次数") val permits: Int?, - @ApiModelProperty("token类型") + @get:Schema(title = "token类型") val type: TokenType, - @ApiModelProperty("创建者") + @get:Schema(title = "创建者") val createdBy: String ) diff --git a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/FavoriteController.kt b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/FavoriteController.kt index 0aeeb57679..5a38223b1d 100644 --- a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/FavoriteController.kt +++ b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/FavoriteController.kt @@ -44,8 +44,8 @@ import com.tencent.bkrepo.repository.pojo.favorite.FavoriteRequest import com.tencent.bkrepo.repository.pojo.favorite.FavoriteResult import com.tencent.bkrepo.repository.pojo.favorite.FavoriteType import com.tencent.bkrepo.repository.service.favorites.FavoriteService -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.PathVariable import org.springframework.web.bind.annotation.PostMapping @@ -55,7 +55,7 @@ import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RestController import java.time.LocalDateTime -@Api("用户收藏接口") +@Tag(name = "用户收藏接口") @RestController @RequestMapping("/api/favorite") class FavoriteController( @@ -63,7 +63,7 @@ class FavoriteController( private val permissionManager: PermissionManager ) { - @ApiOperation("创建收藏文件夹") + @Operation(summary = "创建收藏文件夹") @PostMapping("/create") fun createFavorite( @RequestAttribute userId: String, @@ -90,7 +90,7 @@ class FavoriteController( } } - @ApiOperation("删除收藏") + @Operation(summary = "删除收藏") @DeleteMapping("/delete/{id}") fun removeFavorite( @RequestAttribute userId: String, @@ -108,7 +108,7 @@ class FavoriteController( return ResponseBuilder.fail(HttpStatus.BAD_REQUEST.value, "id not existed") } - @ApiOperation("收藏文件夹分页查询") + @Operation(summary = "收藏文件夹分页查询") @PostMapping("/query") fun pageFavorite( @RequestAttribute userId: String, diff --git a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserArtifactPreloadController.kt b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserArtifactPreloadController.kt index b4be322fa6..0257634221 100644 --- a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserArtifactPreloadController.kt +++ b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserArtifactPreloadController.kt @@ -47,8 +47,8 @@ import com.tencent.bkrepo.common.mongo.dao.util.Pages import com.tencent.bkrepo.common.security.permission.Permission import com.tencent.bkrepo.common.security.util.SecurityUtils import com.tencent.bkrepo.common.service.util.ResponseBuilder -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable @@ -61,7 +61,7 @@ import org.springframework.web.bind.annotation.RestController import kotlin.contracts.ExperimentalContracts import kotlin.contracts.contract -@Api("制品预加载接口") +@Tag(name = "制品预加载接口") @RestController @RequestMapping("/api/preload") @ExperimentalContracts @@ -71,7 +71,7 @@ class UserArtifactPreloadController( private val permissionManager: PermissionManager, ) { - @ApiOperation("创建预加载策略") + @Operation(summary = "创建预加载策略") @PostMapping("/strategy") fun createStrategy(@RequestBody request: ArtifactPreloadStrategyCreateRequest): Response { checkPreloadEnabled(preloadPlanService, preloadStrategyService) @@ -82,7 +82,7 @@ class UserArtifactPreloadController( return ResponseBuilder.success(strategy) } - @ApiOperation("更新预加载策略") + @Operation(summary = "更新预加载策略") @PutMapping("/strategy") fun updateStrategy(@RequestBody request: ArtifactPreloadStrategyUpdateRequest): Response { checkPreloadEnabled(preloadPlanService, preloadStrategyService) @@ -91,7 +91,7 @@ class UserArtifactPreloadController( return ResponseBuilder.success(strategy) } - @ApiOperation("删除预加载策略") + @Operation(summary = "删除预加载策略") @DeleteMapping("/strategy/{projectId}/{repoName}/{id}") @Permission(type = ResourceType.REPO, action = PermissionAction.MANAGE) fun deleteStrategy( @@ -104,7 +104,7 @@ class UserArtifactPreloadController( return ResponseBuilder.success() } - @ApiOperation("获取所有预加载策略") + @Operation(summary = "获取所有预加载策略") @GetMapping("/strategy/{projectId}/{repoName}") @Permission(type = ResourceType.REPO, action = PermissionAction.READ) fun listStrategies( @@ -115,7 +115,7 @@ class UserArtifactPreloadController( return ResponseBuilder.success(preloadStrategyService.list(projectId, repoName)) } - @ApiOperation("创建预加载计划") + @Operation(summary = "创建预加载计划") @PostMapping("/plan") fun preload(@RequestBody request: ArtifactPreloadPlanCreateRequest): Response { checkPreloadEnabled(preloadPlanService, preloadStrategyService) @@ -123,7 +123,7 @@ class UserArtifactPreloadController( return ResponseBuilder.success(preloadPlanService.createPlan(request)) } - @ApiOperation("分页查询预加载计划") + @Operation(summary = "分页查询预加载计划") @Permission(type = ResourceType.REPO, action = PermissionAction.READ) @GetMapping("/plan/{projectId}/{repoName}") fun pagePlans( @@ -137,7 +137,7 @@ class UserArtifactPreloadController( return ResponseBuilder.success(page) } - @ApiOperation("删除预加载计划") + @Operation(summary = "删除预加载计划") @DeleteMapping("/plan/{projectId}/{repoName}/{id}") @Permission(type = ResourceType.REPO, action = PermissionAction.MANAGE) fun deletePlan( @@ -150,7 +150,7 @@ class UserArtifactPreloadController( return ResponseBuilder.success() } - @ApiOperation("删除仓库的所有预加载计划") + @Operation(summary = "删除仓库的所有预加载计划") @DeleteMapping("/plan/{projectId}/{repoName}") @Permission(type = ResourceType.REPO, action = PermissionAction.MANAGE) fun deleteAllPlans( diff --git a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserBkCiWebhookController.kt b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserBkCiWebhookController.kt index 9eb72440b2..0855be2232 100644 --- a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserBkCiWebhookController.kt +++ b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserBkCiWebhookController.kt @@ -34,7 +34,7 @@ import com.tencent.bkrepo.common.api.util.readJsonString import com.tencent.bkrepo.common.metadata.config.RepositoryProperties import com.tencent.bkrepo.repository.pojo.webhook.BkCiDevXEnabledPayload import com.tencent.bkrepo.repository.service.webhook.BkciWebhookListener -import io.swagger.annotations.Api +import io.swagger.v3.oas.annotations.tags.Tag import org.apache.commons.codec.digest.HmacAlgorithms import org.apache.commons.codec.digest.HmacUtils import org.slf4j.LoggerFactory @@ -46,7 +46,7 @@ import org.springframework.web.bind.annotation.RequestHeader import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RestController -@Api("用于监听蓝盾事件") +@Tag(name = "用于监听蓝盾事件") @RestController @RequestMapping("/api/webhook/receiver/bkci") class UserBkCiWebhookController( diff --git a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserFileReferenceController.kt b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserFileReferenceController.kt index 450e4077a0..41f72bbb3e 100644 --- a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserFileReferenceController.kt +++ b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserFileReferenceController.kt @@ -30,21 +30,21 @@ package com.tencent.bkrepo.repository.controller.user import com.tencent.bkrepo.common.api.exception.NotFoundException import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.common.artifact.message.ArtifactMessageCode -import com.tencent.bkrepo.common.security.permission.Principal -import com.tencent.bkrepo.common.security.permission.PrincipalType -import com.tencent.bkrepo.common.service.util.ResponseBuilder import com.tencent.bkrepo.common.metadata.pojo.file.FileReference import com.tencent.bkrepo.common.metadata.service.file.FileReferenceService import com.tencent.bkrepo.common.metadata.service.repo.RepositoryService -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import com.tencent.bkrepo.common.security.permission.Principal +import com.tencent.bkrepo.common.security.permission.PrincipalType +import com.tencent.bkrepo.common.service.util.ResponseBuilder +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 import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam import org.springframework.web.bind.annotation.RestController -@Api("文件引用接口") +@Tag(name = "文件引用接口") @Principal(PrincipalType.ADMIN) @RestController @RequestMapping("/api/references") @@ -52,7 +52,7 @@ class UserFileReferenceController( private val fileReferenceService: FileReferenceService, private val repositoryService: RepositoryService ) { - @ApiOperation("获取文件引用信息") + @Operation(summary = "获取文件引用信息") @GetMapping("/{sha256}") fun getFileReference( @RequestParam("projectId", required = false) projectId: String? = null, diff --git a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserListViewController.kt b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserListViewController.kt index 67f318bd32..b7825cb2c8 100644 --- a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserListViewController.kt +++ b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserListViewController.kt @@ -40,13 +40,13 @@ import com.tencent.bkrepo.common.security.permission.Permission import com.tencent.bkrepo.common.security.permission.Principal import com.tencent.bkrepo.common.security.permission.PrincipalType import com.tencent.bkrepo.repository.service.file.ListViewService -import io.swagger.annotations.Api +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RestController -@Api("用户节点列表页") +@Tag(name = "用户节点列表页") @RestController @RequestMapping("/api/list") class UserListViewController( diff --git a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserMetadataController.kt b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserMetadataController.kt index 2a792cd9f4..273af6dbc3 100644 --- a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserMetadataController.kt +++ b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserMetadataController.kt @@ -54,8 +54,8 @@ import com.tencent.bkrepo.repository.pojo.metadata.MetadataDeleteRequest import com.tencent.bkrepo.repository.pojo.metadata.MetadataSaveRequest import com.tencent.bkrepo.repository.pojo.metadata.UserMetadataDeleteRequest import com.tencent.bkrepo.repository.pojo.metadata.UserMetadataSaveRequest -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PostMapping @@ -67,7 +67,7 @@ import org.springframework.web.bind.annotation.RestController /** * 元数据接口实现类 */ -@Api("节点元数据用户接口") +@Tag(name = "节点元数据用户接口") @RestController @RequestMapping("/api/metadata") class UserMetadataController( @@ -91,7 +91,7 @@ class UserMetadataController( scopeId = "#artifactInfo?.projectId", content = ActionAuditContent.NODE_METADATA_VIEW_CONTENT ) - @ApiOperation("查询元数据列表") + @Operation(summary = "查询元数据列表") @Permission(type = ResourceType.NODE, action = PermissionAction.READ) @GetMapping(DEFAULT_MAPPING_URI) fun listMetadata( @@ -120,7 +120,7 @@ class UserMetadataController( scopeId = "#artifactInfo?.projectId", content = ActionAuditContent.NODE_METADATA_EDIT_CONTENT ) - @ApiOperation("创建/更新元数据列表") + @Operation(summary = "创建/更新元数据列表") @Permission(type = ResourceType.NODE, action = PermissionAction.WRITE) @PostMapping(DEFAULT_MAPPING_URI) fun save( @@ -160,7 +160,7 @@ class UserMetadataController( scopeId = "#artifactInfo?.projectId", content = ActionAuditContent.NODE_METADATA_FORBID_CONTENT ) - @ApiOperation("创建/更新禁用元数据") + @Operation(summary = "创建/更新禁用元数据") @Permission(type = ResourceType.REPO, action = PermissionAction.UPDATE) @PostMapping("/forbid$DEFAULT_MAPPING_URI") fun forbidMetadata( @@ -198,7 +198,7 @@ class UserMetadataController( scopeId = "#artifactInfo?.projectId", content = ActionAuditContent.NODE_METADATA_DELETE_CONTENT ) - @ApiOperation("删除元数据") + @Operation(summary = "删除元数据") @Permission(type = ResourceType.NODE, action = PermissionAction.DELETE) @DeleteMapping(DEFAULT_MAPPING_URI) fun delete( diff --git a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserMetadataLabelController.kt b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserMetadataLabelController.kt index b78b18d34b..e052173c4a 100644 --- a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserMetadataLabelController.kt +++ b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserMetadataLabelController.kt @@ -36,8 +36,8 @@ import com.tencent.bkrepo.repository.pojo.metadata.label.MetadataLabelRequest import com.tencent.bkrepo.repository.pojo.metadata.label.UserLabelCreateRequest import com.tencent.bkrepo.repository.pojo.metadata.label.UserLabelUpdateRequest import com.tencent.bkrepo.repository.service.metadata.MetadataLabelService -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable @@ -47,7 +47,7 @@ import org.springframework.web.bind.annotation.RequestBody import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RestController -@Api("元数据标签管理接口") +@Tag(name = "元数据标签管理接口") @RestController @RequestMapping("/api/metadata/label") class UserMetadataLabelController( @@ -55,7 +55,7 @@ class UserMetadataLabelController( private val permissionManager: PermissionManager ) { - @ApiOperation("创建标签") + @Operation(summary = "创建标签") @PostMapping("/{projectId}") fun create( @PathVariable projectId: String, @@ -72,7 +72,7 @@ class UserMetadataLabelController( return ResponseBuilder.success() } - @ApiOperation("更新标签") + @Operation(summary = "更新标签") @PutMapping("/{projectId}/{labelKey}") fun update( @PathVariable projectId: String, @@ -90,7 +90,7 @@ class UserMetadataLabelController( return ResponseBuilder.success() } - @ApiOperation("查询项目下所有标签") + @Operation(summary = "查询项目下所有标签") @GetMapping("/{projectId}") fun list( @PathVariable projectId: String @@ -99,7 +99,7 @@ class UserMetadataLabelController( return ResponseBuilder.success(metadataLabelService.listAll(projectId)) } - @ApiOperation("查询标签详情") + @Operation(summary = "查询标签详情") @GetMapping("/{projectId}/{labelKey}") fun detail( @PathVariable projectId: String, @@ -109,7 +109,7 @@ class UserMetadataLabelController( return ResponseBuilder.success(metadataLabelService.detail(projectId, labelKey)) } - @ApiOperation("删除标签") + @Operation(summary = "删除标签") @DeleteMapping("/{projectId}/{labelKey}") fun delete( @PathVariable projectId: String, diff --git a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserNodeController.kt b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserNodeController.kt index 9f3d0f4790..1f2fdbe273 100644 --- a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserNodeController.kt +++ b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserNodeController.kt @@ -53,6 +53,9 @@ import com.tencent.bkrepo.common.artifact.audit.NODE_VIEW_ACTION import com.tencent.bkrepo.common.artifact.message.ArtifactMessageCode import com.tencent.bkrepo.common.artifact.path.PathUtils import com.tencent.bkrepo.common.metadata.permission.PermissionManager +import com.tencent.bkrepo.common.metadata.pojo.node.NodeRestoreOption +import com.tencent.bkrepo.common.metadata.service.node.NodeSearchService +import com.tencent.bkrepo.common.metadata.service.node.NodeService import com.tencent.bkrepo.common.query.model.QueryModel import com.tencent.bkrepo.common.security.permission.Permission import com.tencent.bkrepo.common.security.permission.Principal @@ -63,7 +66,6 @@ import com.tencent.bkrepo.repository.pojo.node.NodeDeletedPoint import com.tencent.bkrepo.repository.pojo.node.NodeDetail import com.tencent.bkrepo.repository.pojo.node.NodeInfo import com.tencent.bkrepo.repository.pojo.node.NodeListOption -import com.tencent.bkrepo.common.metadata.pojo.node.NodeRestoreOption import com.tencent.bkrepo.repository.pojo.node.NodeRestoreResult import com.tencent.bkrepo.repository.pojo.node.NodeSizeInfo import com.tencent.bkrepo.repository.pojo.node.service.NodeArchiveRestoreRequest @@ -80,11 +82,9 @@ import com.tencent.bkrepo.repository.pojo.node.user.UserNodeMoveCopyRequest import com.tencent.bkrepo.repository.pojo.node.user.UserNodeRenameRequest import com.tencent.bkrepo.repository.pojo.node.user.UserNodeUpdateRequest import com.tencent.bkrepo.repository.pojo.software.ProjectPackageOverview -import com.tencent.bkrepo.common.metadata.service.node.NodeSearchService -import com.tencent.bkrepo.common.metadata.service.node.NodeService -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.format.annotation.DateTimeFormat import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping @@ -98,7 +98,7 @@ import org.springframework.web.bind.annotation.RestController import java.time.LocalDateTime import javax.validation.constraints.Size -@Api("节点用户接口") +@Tag(name = "节点用户接口") @RestController @RequestMapping("/api/node") class UserNodeController( @@ -124,7 +124,7 @@ class UserNodeController( scopeId = "#artifactInfo?.projectId", content = ActionAuditContent.NODE_VIEW_CONTENT ) - @ApiOperation("根据路径查看节点详情") + @Operation(summary = "根据路径查看节点详情") @Permission(type = ResourceType.NODE, action = PermissionAction.READ) @GetMapping(DEFAULT_MAPPING_URI/* Deprecated */, "/detail/$DEFAULT_MAPPING_URI") fun getNodeDetail( @@ -153,7 +153,7 @@ class UserNodeController( scopeId = "#artifactInfo?.projectId", content = ActionAuditContent.NODE_CREATE_CONTENT ) - @ApiOperation("创建文件夹") + @Operation(summary = "创建文件夹") @Permission(type = ResourceType.REPO, action = PermissionAction.WRITE) @PostMapping(DEFAULT_MAPPING_URI/* Deprecated */, "/mkdir/$DEFAULT_MAPPING_URI") fun mkdir( @@ -192,7 +192,7 @@ class UserNodeController( scopeId = "#artifactInfo?.projectId", content = ActionAuditContent.NODE_DELETE_CONTENT ) - @ApiOperation("删除节点") + @Operation(summary = "删除节点") @Permission(type = ResourceType.NODE, action = PermissionAction.DELETE) @DeleteMapping(DEFAULT_MAPPING_URI/* Deprecated */, "/delete/$DEFAULT_MAPPING_URI") fun deleteNode( @@ -228,7 +228,7 @@ class UserNodeController( scopeId = "#projectId", content = ActionAuditContent.NODE_DELETE_CONTENT ) - @ApiOperation("批量删除节点") + @Operation(summary = "批量删除节点") @Permission(type = ResourceType.REPO, action = PermissionAction.DELETE) @DeleteMapping("/batch/{projectId}/{repoName}") fun deleteNodes( @@ -249,7 +249,7 @@ class UserNodeController( return ResponseBuilder.success(nodeService.deleteNodes(nodesDeleteRequest)) } - @ApiOperation("统计批量删除节点数") + @Operation(summary = "统计批量删除节点数") @Permission(type = ResourceType.REPO, action = PermissionAction.DELETE) @PostMapping("/batch/{projectId}/{repoName}") fun countBatchDeleteNode( @@ -290,7 +290,7 @@ class UserNodeController( scopeId = "#artifactInfo?.projectId", content = ActionAuditContent.NODE_CLEAN_CONTENT ) - @ApiOperation("清理最后访问时间早于{date}的文件节点") + @Operation(summary = "清理最后访问时间早于{date}的文件节点") @Permission(type = ResourceType.NODE, action = PermissionAction.DELETE) @DeleteMapping("/clean/$DEFAULT_MAPPING_URI") fun deleteNodeLastModifiedBeforeDate( @@ -311,7 +311,7 @@ class UserNodeController( ) } - @ApiOperation("创建链接节点") + @Operation(summary = "创建链接节点") @PostMapping("/link") fun link( @RequestAttribute userId: String, @@ -356,7 +356,7 @@ class UserNodeController( scopeId = "#artifactInfo?.projectId", content = ActionAuditContent.NODE_EXPIRES_EDIT_CONTENT ) - @ApiOperation("更新节点") + @Operation(summary = "更新节点") @Permission(type = ResourceType.NODE, action = PermissionAction.UPDATE) @PostMapping("/update/$DEFAULT_MAPPING_URI") fun updateNode( @@ -395,7 +395,7 @@ class UserNodeController( scopeId = "#artifactInfo?.projectId", content = ActionAuditContent.NODE_RENAME_CONTENT ) - @ApiOperation("重命名节点") + @Operation(summary = "重命名节点") @Permission(type = ResourceType.NODE, action = PermissionAction.UPDATE) @PostMapping("/rename/$DEFAULT_MAPPING_URI") fun renameNode( @@ -419,7 +419,7 @@ class UserNodeController( } @Deprecated("/rename/{projectId}/{repoName}/**") - @ApiOperation("重命名节点") + @Operation(summary = "重命名节点") @PostMapping("/rename") fun renameNode( @RequestAttribute userId: String, @@ -464,7 +464,7 @@ class UserNodeController( scopeId = "#request?.srcProjectId", content = ActionAuditContent.NODE_MOVE_CONTENT ) - @ApiOperation("移动节点") + @Operation(summary = "移动节点") @PostMapping("/move") fun moveNode( @RequestAttribute userId: String, @@ -511,7 +511,7 @@ class UserNodeController( scopeId = "#request?.srcProjectId", content = ActionAuditContent.NODE_COPY_CONTENT ) - @ApiOperation("复制节点") + @Operation(summary = "复制节点") @PostMapping("/copy") fun copyNode( @RequestAttribute userId: String, @@ -535,7 +535,7 @@ class UserNodeController( } } - @ApiOperation("查询节点大小信息") + @Operation(summary = "查询节点大小信息") @Permission(type = ResourceType.NODE, action = PermissionAction.READ) @GetMapping("/size/$DEFAULT_MAPPING_URI") fun computeSize(artifactInfo: ArtifactInfo): Response { @@ -543,7 +543,7 @@ class UserNodeController( return ResponseBuilder.success(nodeSizeInfo) } - @ApiOperation("查询时间早于{date}的节点大小信息") + @Operation(summary = "查询时间早于{date}的节点大小信息") @Permission(type = ResourceType.NODE, action = PermissionAction.READ) @GetMapping("/calculate/$DEFAULT_MAPPING_URI") fun computeSizeBefore( @@ -556,7 +556,7 @@ class UserNodeController( return ResponseBuilder.success(nodeSizeInfo) } - @ApiOperation("分页查询节点") + @Operation(summary = "分页查询节点") @Permission(type = ResourceType.NODE, action = PermissionAction.READ) @GetMapping("/page/$DEFAULT_MAPPING_URI") fun listPageNode( @@ -567,7 +567,7 @@ class UserNodeController( return ResponseBuilder.success(nodePage) } - @ApiOperation("按sha256分页查询节点") + @Operation(summary = "按sha256分页查询节点") @Principal(PrincipalType.ADMIN) @GetMapping("/page", params = ["sha256"]) fun listPageNodeBySha256( @@ -579,7 +579,7 @@ class UserNodeController( .let { ResponseBuilder.success(it) } } - @ApiOperation("查询节点删除点") + @Operation(summary = "查询节点删除点") @Permission(type = ResourceType.NODE, action = PermissionAction.READ) @GetMapping("/list-deleted/$DEFAULT_MAPPING_URI") fun listDeletedPoint(artifactInfo: ArtifactInfo): Response> { @@ -604,7 +604,7 @@ class UserNodeController( scopeId = "#artifactInfo?.projectId", content = ActionAuditContent.NODE_RESTORE_CONTENT ) - @ApiOperation("恢复被删除节点") + @Operation(summary = "恢复被删除节点") @Permission(type = ResourceType.NODE, action = PermissionAction.WRITE) @PostMapping("/restore/$DEFAULT_MAPPING_URI") fun restoreNode( @@ -615,34 +615,34 @@ class UserNodeController( return ResponseBuilder.success(nodeService.restoreNode(artifactInfo, nodeRestoreOption)) } - @ApiOperation("自定义查询节点，如不关注总记录数请使用queryWithoutCount") + @Operation(summary = "自定义查询节点，如不关注总记录数请使用queryWithoutCount") @PostMapping("/search") fun search(@RequestBody queryModel: QueryModel): Response>> { return ResponseBuilder.success(nodeSearchService.search(queryModel)) } @Deprecated("replace with search") - @ApiOperation("自定义查询节点") + @Operation(summary = "自定义查询节点") @PostMapping("/query") fun query(@RequestBody queryModel: QueryModel): Response>> { return ResponseBuilder.success(nodeSearchService.search(queryModel)) } - @ApiOperation("自定义查询节点，不计算总记录数") + @Operation(summary = "自定义查询节点，不计算总记录数") @PostMapping("/queryWithoutCount") fun queryWithoutCount(@RequestBody queryModel: QueryModel): Response>> { return ResponseBuilder.success(nodeSearchService.searchWithoutCount(queryModel)) } - @ApiOperation("仓库 包数量 总览") + @Operation(summary = "仓库 包数量 总览") @GetMapping("/search/overview") fun nodeGlobalSearchOverview( @RequestAttribute userId: String, @RequestParam projectId: String, - @ApiParam(value = "文件名", required = true) + @Parameter(name = "文件名", required = true) @RequestParam name: String, - @ApiParam(value = "仓库名 多个仓库以 `,` 分隔", required = false, example = "report,log") + @Parameter(name = "仓库名 多个仓库以 `,` 分隔", required = false, example = "report,log") @RequestParam exRepo: String?, ): Response> { @@ -656,7 +656,7 @@ class UserNodeController( ) } - @ApiOperation("恢复归档文件") + @Operation(summary = "恢复归档文件") @PostMapping("/archive/restore") fun restoreArchiveNode( @RequestAttribute userId: String, diff --git a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserOperateLogController.kt b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserOperateLogController.kt index 31e244073c..b53f510ad9 100644 --- a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserOperateLogController.kt +++ b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserOperateLogController.kt @@ -39,9 +39,9 @@ import com.tencent.bkrepo.common.security.exception.PermissionException import com.tencent.bkrepo.common.security.permission.PrincipalType import com.tencent.bkrepo.common.security.util.SecurityUtils import com.tencent.bkrepo.common.service.util.ResponseBuilder -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter +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 @@ -49,7 +49,7 @@ import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam import org.springframework.web.bind.annotation.RestController -@Api("操作日志用户接口") +@Tag(name = "操作日志用户接口") @RestController @RequestMapping("/api/log") class UserOperateLogController( @@ -65,24 +65,24 @@ class UserOperateLogController( return ResponseBuilder.success(operateLogService.listPage(option)) } - @ApiOperation("审计日志查询接口") + @Operation(summary = "审计日志查询接口") @GetMapping("/page") fun page( - @ApiParam("资源类型", required = false) + @Parameter(name = "资源类型", required = false) @RequestParam type: String?, - @ApiParam("项目名", required = false) + @Parameter(name = "项目名", required = false) @RequestParam projectId: String?, - @ApiParam("仓库名", required = false) + @Parameter(name = "仓库名", required = false) @RequestParam repoName: String?, - @ApiParam("操作人", required = false) + @Parameter(name = "操作人", required = false) @RequestParam operator: String?, - @ApiParam("开始时间", required = false) + @Parameter(name = "开始时间", required = false) @RequestParam startTime: String?, - @ApiParam("结束时间", required = false) + @Parameter(name = "结束时间", required = false) @RequestParam endTime: String?, - @ApiParam("页数", required = false, defaultValue = "1") + @Parameter(name = "页数", required = false) @RequestParam pageNumber: Int?, - @ApiParam("每页数量", required = false, defaultValue = "20") + @Parameter(name = "每页数量", required = false) @RequestParam pageSize: Int? ): Response> { checkPermission(projectId) diff --git a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserPackageController.kt b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserPackageController.kt index e2c3484f03..c49799a27f 100644 --- a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserPackageController.kt +++ b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserPackageController.kt @@ -35,6 +35,8 @@ import com.tencent.bkrepo.auth.pojo.enums.PermissionAction import com.tencent.bkrepo.auth.pojo.enums.ResourceType import com.tencent.bkrepo.common.api.pojo.Page import com.tencent.bkrepo.common.api.pojo.Response +import com.tencent.bkrepo.common.metadata.service.packages.PackageService +import com.tencent.bkrepo.common.metadata.service.packages.PackageStatisticsService import com.tencent.bkrepo.common.query.model.QueryModel import com.tencent.bkrepo.common.security.permission.Permission import com.tencent.bkrepo.common.service.util.ResponseBuilder @@ -43,10 +45,8 @@ import com.tencent.bkrepo.repository.pojo.packages.PackageSummary import com.tencent.bkrepo.repository.pojo.packages.PackageVersion import com.tencent.bkrepo.repository.pojo.packages.VersionListOption import com.tencent.bkrepo.repository.pojo.software.ProjectPackageOverview -import com.tencent.bkrepo.common.metadata.service.packages.PackageService -import com.tencent.bkrepo.common.metadata.service.packages.PackageStatisticsService import com.tencent.bkrepo.repository.service.packages.PackageDownloadService -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable @@ -67,7 +67,7 @@ class UserPackageController( private val packageStatisticsService: PackageStatisticsService ) { - @ApiOperation("分页查询包") + @Operation(summary = "分页查询包") @Permission(type = ResourceType.REPO, action = PermissionAction.READ) @GetMapping("/package/page/{projectId}/{repoName}") fun listPackagePage( @@ -79,7 +79,7 @@ class UserPackageController( return ResponseBuilder.success(pageResult) } - @ApiOperation("分页查询版本") + @Operation(summary = "分页查询版本") @Permission(type = ResourceType.REPO, action = PermissionAction.READ) @GetMapping("/version/page/{projectId}/{repoName}") fun listVersionPage( @@ -92,7 +92,7 @@ class UserPackageController( return ResponseBuilder.success(pageResult) } - @ApiOperation("查询所有版本") + @Operation(summary = "查询所有版本") @Permission(type = ResourceType.REPO, action = PermissionAction.READ) @PostMapping("/version/list/{projectId}/{repoName}") fun listAllVersion( @@ -105,7 +105,7 @@ class UserPackageController( return ResponseBuilder.success(versions) } - @ApiOperation("查询包信息") + @Operation(summary = "查询包信息") @Permission(type = ResourceType.REPO, action = PermissionAction.READ) @GetMapping("/package/info/{projectId}/{repoName}") fun findPackageByKey( @@ -116,7 +116,7 @@ class UserPackageController( return ResponseBuilder.success(packageService.findPackageByKey(projectId, repoName, packageKey)) } - @ApiOperation("删除包") + @Operation(summary = "删除包") @Permission(type = ResourceType.REPO, action = PermissionAction.WRITE) @DeleteMapping("/package/delete/{projectId}/{repoName}") fun deletePackage( @@ -128,7 +128,7 @@ class UserPackageController( return ResponseBuilder.success() } - @ApiOperation("删除版本") + @Operation(summary = "删除版本") @Permission(type = ResourceType.REPO, action = PermissionAction.WRITE) @DeleteMapping("/version/delete/{projectId}/{repoName}") fun deleteVersion( @@ -142,7 +142,7 @@ class UserPackageController( return ResponseBuilder.success() } - @ApiOperation("搜索包") + @Operation(summary = "搜索包") @PostMapping("/package/search") fun searchPackage( @RequestBody queryModel: QueryModel @@ -150,7 +150,7 @@ class UserPackageController( return ResponseBuilder.success(packageService.searchPackage(queryModel)) } - @ApiOperation("下载版本") + @Operation(summary = "下载版本") @Permission(type = ResourceType.REPO, action = PermissionAction.READ) @GetMapping("/version/download/{projectId}/{repoName}") fun downloadVersion( @@ -162,7 +162,7 @@ class UserPackageController( packageDownloadService.downloadVersion(projectId, repoName, packageKey, version) } - @ApiOperation("仓库 包数量 总览") + @Operation(summary = "仓库 包数量 总览") @GetMapping("/package/search/overview") fun packageOverview( @RequestParam repoType: String, diff --git a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserPackageDownloadsController.kt b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserPackageDownloadsController.kt index a228f0509e..8220e33698 100644 --- a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserPackageDownloadsController.kt +++ b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserPackageDownloadsController.kt @@ -34,21 +34,21 @@ package com.tencent.bkrepo.repository.controller.user import com.tencent.bkrepo.auth.pojo.enums.PermissionAction import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.common.metadata.permission.PermissionManager +import com.tencent.bkrepo.common.metadata.service.packages.PackageDownloadsService import com.tencent.bkrepo.common.service.util.ResponseBuilder import com.tencent.bkrepo.repository.pojo.download.DetailsQueryRequest import com.tencent.bkrepo.repository.pojo.download.PackageDownloadsDetails import com.tencent.bkrepo.repository.pojo.download.PackageDownloadsSummary import com.tencent.bkrepo.repository.pojo.download.SummaryQueryRequest -import com.tencent.bkrepo.common.metadata.service.packages.PackageDownloadsService -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.PostMapping import org.springframework.web.bind.annotation.RequestAttribute import org.springframework.web.bind.annotation.RequestBody import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RestController -@Api("构建下载量统计用户接口") +@Tag(name = "构建下载量统计用户接口") @RestController @RequestMapping("/api/package/downloads/") class UserPackageDownloadsController( @@ -56,7 +56,7 @@ class UserPackageDownloadsController( private val permissionManager: PermissionManager ) { - @ApiOperation("查询包下载记录明细") + @Operation(summary = "查询包下载记录明细") @PostMapping("/details") fun queryDetails( @RequestAttribute userId: String, @@ -68,7 +68,7 @@ class UserPackageDownloadsController( } } - @ApiOperation("查询包下载总览") + @Operation(summary = "查询包下载总览") @PostMapping("/summary") fun querySummary( @RequestAttribute userId: String, diff --git a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserPackageMetadataController.kt b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserPackageMetadataController.kt index 1c3cf7f78b..e5c6355f42 100644 --- a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserPackageMetadataController.kt +++ b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserPackageMetadataController.kt @@ -34,13 +34,13 @@ package com.tencent.bkrepo.repository.controller.user import com.tencent.bkrepo.auth.pojo.enums.PermissionAction import com.tencent.bkrepo.auth.pojo.enums.ResourceType import com.tencent.bkrepo.common.api.pojo.Response +import com.tencent.bkrepo.common.metadata.service.metadata.PackageMetadataService import com.tencent.bkrepo.common.security.permission.Permission import com.tencent.bkrepo.common.service.util.ResponseBuilder import com.tencent.bkrepo.repository.pojo.metadata.packages.PackageMetadataSaveRequest import com.tencent.bkrepo.repository.pojo.metadata.packages.UserPackageMetadataSaveRequest -import com.tencent.bkrepo.common.metadata.service.metadata.PackageMetadataService -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.PathVariable import org.springframework.web.bind.annotation.PostMapping import org.springframework.web.bind.annotation.RequestAttribute @@ -51,14 +51,14 @@ import org.springframework.web.bind.annotation.RestController /** * 元数据接口实现类 */ -@Api("包元数据用户接口") +@Tag(name = "包元数据用户接口") @RestController @RequestMapping("/api/metadata/package") class UserPackageMetadataController( private val packageMetadataService: PackageMetadataService ) { - @ApiOperation("创建/更新禁用元数据列表") + @Operation(summary = "创建/更新禁用元数据列表") @Permission(type = ResourceType.REPO, action = PermissionAction.UPDATE) @PostMapping("/forbid/{projectId}/{repoName}") fun forbidMetadata( @@ -80,7 +80,7 @@ class UserPackageMetadataController( return ResponseBuilder.success() } - @ApiOperation("保存元数据") + @Operation(summary = "保存元数据") @Permission(type = ResourceType.REPO, action = PermissionAction.UPDATE) @PostMapping("/{projectId}/{repoName}") fun saveMetadata( diff --git a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserPackageRepairController.kt b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserPackageRepairController.kt index 9963e4d88c..8188a350a3 100644 --- a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserPackageRepairController.kt +++ b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserPackageRepairController.kt @@ -1,11 +1,11 @@ package com.tencent.bkrepo.repository.controller.user import com.tencent.bkrepo.common.api.pojo.Response +import com.tencent.bkrepo.common.metadata.service.packages.PackageRepairService import com.tencent.bkrepo.common.security.permission.Principal import com.tencent.bkrepo.common.security.permission.PrincipalType import com.tencent.bkrepo.common.service.util.ResponseBuilder -import com.tencent.bkrepo.common.metadata.service.packages.PackageRepairService -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PutMapping import org.springframework.web.bind.annotation.RestController @@ -15,7 +15,7 @@ class UserPackageRepairController( private val packageRepairService: PackageRepairService ) { - @ApiOperation("修改历史版本") + @Operation(summary = "修改历史版本") @Principal(PrincipalType.ADMIN) @GetMapping("/version/history/repair") fun repairHistoryVersion(): Response { @@ -23,7 +23,7 @@ class UserPackageRepairController( return ResponseBuilder.success() } - @ApiOperation("修正包的版本数") + @Operation(summary = "修正包的版本数") @Principal(PrincipalType.ADMIN) @PutMapping("/package/version/recount") fun repairVersionCount(): Response { diff --git a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserProjectController.kt b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserProjectController.kt index bf4d2e06a8..203010707f 100644 --- a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserProjectController.kt +++ b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserProjectController.kt @@ -32,15 +32,15 @@ import com.tencent.bk.audit.annotations.AuditEntry import com.tencent.bk.audit.annotations.AuditInstanceRecord import com.tencent.bk.audit.annotations.AuditRequestBody import com.tencent.bk.audit.context.ActionAuditContext -import com.tencent.bkrepo.common.artifact.audit.PROJECT_CREATE_ACTION -import com.tencent.bkrepo.common.artifact.audit.PROJECT_EDIT_ACTION -import com.tencent.bkrepo.common.artifact.audit.PROJECT_RESOURCE import com.tencent.bkrepo.auth.pojo.enums.PermissionAction import com.tencent.bkrepo.common.api.pojo.Page import com.tencent.bkrepo.common.api.pojo.Response +import com.tencent.bkrepo.common.artifact.audit.ActionAuditContent +import com.tencent.bkrepo.common.artifact.audit.PROJECT_CREATE_ACTION +import com.tencent.bkrepo.common.artifact.audit.PROJECT_EDIT_ACTION +import com.tencent.bkrepo.common.artifact.audit.PROJECT_RESOURCE import com.tencent.bkrepo.common.metadata.permission.PermissionManager import com.tencent.bkrepo.common.metadata.service.project.ProjectService -import com.tencent.bkrepo.common.artifact.audit.ActionAuditContent import com.tencent.bkrepo.common.security.permission.Principal import com.tencent.bkrepo.common.security.permission.PrincipalType import com.tencent.bkrepo.common.service.util.ResponseBuilder @@ -51,9 +51,9 @@ import com.tencent.bkrepo.repository.pojo.project.ProjectMetricsInfo import com.tencent.bkrepo.repository.pojo.project.ProjectSearchOption import com.tencent.bkrepo.repository.pojo.project.ProjectUpdateRequest import com.tencent.bkrepo.repository.pojo.project.UserProjectCreateRequest -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable import org.springframework.web.bind.annotation.PostMapping @@ -64,7 +64,7 @@ import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam import org.springframework.web.bind.annotation.RestController -@Api("项目用户接口") +@Tag(name = "项目用户接口") @RestController @RequestMapping("/api/project") class UserProjectController( @@ -84,7 +84,7 @@ class UserProjectController( scopeId = "#userProjectRequest?.name", content = ActionAuditContent.PROJECT_CREATE_CONTENT ) - @ApiOperation("创建项目") + @Operation(summary = "创建项目") @Principal(PrincipalType.GENERAL) @PostMapping("/create") fun createProject( @@ -107,24 +107,24 @@ class UserProjectController( return ResponseBuilder.success() } - @ApiOperation("查询项目是否存在") + @Operation(summary = "查询项目是否存在") @GetMapping("/exist/{projectId}") fun checkExist( @RequestAttribute userId: String, - @ApiParam(value = "项目ID", required = true) + @Parameter(name = "项目ID", required = true) @PathVariable projectId: String ): Response { permissionManager.checkProjectPermission(PermissionAction.READ, projectId) return ResponseBuilder.success(projectService.checkExist(projectId)) } - @ApiOperation("校验项目参数是否存在") + @Operation(summary = "校验项目参数是否存在") @GetMapping("/exist") fun checkProjectExist( @RequestAttribute userId: String, - @ApiParam(value = "项目ID", required = false) + @Parameter(name = "项目ID", required = false) @RequestParam name: String?, - @ApiParam(value = "项目ID", required = false) + @Parameter(name = "项目ID", required = false) @RequestParam displayName: String? ): Response { return ResponseBuilder.success(projectService.checkProjectExist(name, displayName)) @@ -144,11 +144,11 @@ class UserProjectController( scopeId = "#name", content = ActionAuditContent.PROJECT_EDIT_CONTENT ) - @ApiOperation("编辑项目") + @Operation(summary = "编辑项目") @PutMapping("/{name}") fun updateProject( @RequestAttribute userId: String, - @ApiParam(value = "项目ID", required = true) + @Parameter(name = "项目ID", required = true) @PathVariable name: String, @AuditRequestBody @RequestBody projectUpdateRequest: ProjectUpdateRequest @@ -158,14 +158,14 @@ class UserProjectController( return ResponseBuilder.success(projectService.updateProject(name, projectUpdateRequest)) } - @ApiOperation("分页查询所有项目列表") + @Operation(summary = "分页查询所有项目列表") @GetMapping("/search") @Principal(PrincipalType.ADMIN) fun searchProject(option: ProjectSearchOption): Response> { return ResponseBuilder.success(projectService.searchProject(option)) } - @ApiOperation("项目列表") + @Operation(summary = "项目列表") @GetMapping("/list") fun listProject( @RequestAttribute userId: String, @@ -188,7 +188,7 @@ class UserProjectController( content = ActionAuditContent.PROJECT_CREATE_CONTENT ) @Deprecated("waiting kb-ci", replaceWith = ReplaceWith("createProject")) - @ApiOperation("创建项目") + @Operation(summary = "创建项目") @Principal(PrincipalType.PLATFORM) @PostMapping fun create( @@ -198,20 +198,20 @@ class UserProjectController( return this.createProject(userId, userProjectRequest) } - @ApiOperation("项目仓库统计信息列表") + @Operation(summary = "项目仓库统计信息列表") @GetMapping("/metrics/{projectId}") fun projectMetricsList( - @ApiParam(value = "项目ID", required = true) + @Parameter(name = "项目ID", required = true) @PathVariable projectId: String ): Response { permissionManager.checkProjectPermission(PermissionAction.READ, projectId) return ResponseBuilder.success(projectService.getProjectMetricsInfo(projectId)) } - @ApiOperation("获取项目启用/禁用状态") + @Operation(summary = "获取项目启用/禁用状态") @GetMapping("/enabled/{projectId}") fun isProjectEnabled( - @ApiParam(value = "项目ID", required = true) + @Parameter(name = "项目ID", required = true) @PathVariable projectId: String ): Response { return ResponseBuilder.success(projectService.isProjectEnabled(projectId)) diff --git a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserProxyChannelController.kt b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserProxyChannelController.kt index 73deecad33..7c8c382e9a 100644 --- a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserProxyChannelController.kt +++ b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserProxyChannelController.kt @@ -33,34 +33,34 @@ package com.tencent.bkrepo.repository.controller.user import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.common.artifact.pojo.RepositoryType +import com.tencent.bkrepo.common.metadata.service.repo.ProxyChannelService import com.tencent.bkrepo.common.service.util.ResponseBuilder import com.tencent.bkrepo.repository.pojo.proxy.ProxyChannelInfo -import com.tencent.bkrepo.common.metadata.service.repo.ProxyChannelService -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam import org.springframework.web.bind.annotation.RestController -@Api("代理源用户接口") +@Tag(name = "代理源用户接口") @RestController @RequestMapping("/api/proxy-channel") class UserProxyChannelController( private val proxyChannelService: ProxyChannelService ) { - @ApiOperation("查询代理源信息") + @Operation(summary = "查询代理源信息") @GetMapping("/{projectId}/{repoName}") fun getByUniqueId( - @ApiParam(value = "所属项目", required = true) + @Parameter(name = "所属项目", required = true) @PathVariable projectId: String, - @ApiParam(value = "仓库名称", required = true) + @Parameter(name = "仓库名称", required = true) @PathVariable repoName: String, - @ApiParam(value = "type", required = true) + @Parameter(name = "type", required = true) @RequestParam repoType: String, - @ApiParam(value = "name", required = true) + @Parameter(name = "name", required = true) @RequestParam name: String ): Response { val repoType = try { diff --git a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserRepositoryController.kt b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserRepositoryController.kt index 95599a3c17..5e1228d4c9 100644 --- a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserRepositoryController.kt +++ b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserRepositoryController.kt @@ -33,6 +33,11 @@ import com.tencent.bk.audit.annotations.AuditEntry import com.tencent.bk.audit.annotations.AuditInstanceRecord import com.tencent.bk.audit.annotations.AuditRequestBody import com.tencent.bk.audit.context.ActionAuditContext +import com.tencent.bkrepo.auth.pojo.enums.PermissionAction +import com.tencent.bkrepo.auth.pojo.enums.ResourceType +import com.tencent.bkrepo.common.api.pojo.Page +import com.tencent.bkrepo.common.api.pojo.Response +import com.tencent.bkrepo.common.artifact.audit.ActionAuditContent import com.tencent.bkrepo.common.artifact.audit.PROJECT_RESOURCE import com.tencent.bkrepo.common.artifact.audit.PROJECT_VIEW_ACTION import com.tencent.bkrepo.common.artifact.audit.REPO_CREATE_ACTION @@ -40,12 +45,7 @@ import com.tencent.bkrepo.common.artifact.audit.REPO_DELETE_ACTION import com.tencent.bkrepo.common.artifact.audit.REPO_EDIT_ACTION import com.tencent.bkrepo.common.artifact.audit.REPO_RESOURCE import com.tencent.bkrepo.common.artifact.audit.REPO_VIEW_ACTION -import com.tencent.bkrepo.auth.pojo.enums.PermissionAction -import com.tencent.bkrepo.auth.pojo.enums.ResourceType -import com.tencent.bkrepo.common.api.pojo.Page -import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.common.metadata.permission.PermissionManager -import com.tencent.bkrepo.common.artifact.audit.ActionAuditContent import com.tencent.bkrepo.common.metadata.service.node.NodeService import com.tencent.bkrepo.common.metadata.service.repo.QuotaService import com.tencent.bkrepo.common.metadata.service.repo.RepositoryService @@ -61,9 +61,9 @@ import com.tencent.bkrepo.repository.pojo.repo.RepositoryDetail import com.tencent.bkrepo.repository.pojo.repo.RepositoryInfo import com.tencent.bkrepo.repository.pojo.repo.UserRepoCreateRequest import com.tencent.bkrepo.repository.pojo.repo.UserRepoUpdateRequest -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable @@ -74,7 +74,7 @@ import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam import org.springframework.web.bind.annotation.RestController -@Api("仓库用户接口") +@Tag(name = "仓库用户接口") @RestController @RequestMapping("/api/repo") class UserRepositoryController( @@ -100,30 +100,30 @@ class UserRepositoryController( scopeId = "#projectId", content = ActionAuditContent.REPO_VIEW_CONTENT ) - @ApiOperation("根据名称类型查询仓库") + @Operation(summary = "根据名称类型查询仓库") @Permission(type = ResourceType.REPO, action = PermissionAction.READ) @GetMapping("/info/{projectId}/{repoName}", "/info/{projectId}/{repoName}/{type}") fun getRepoInfo( - @ApiParam(value = "所属项目", required = true) + @Parameter(name = "所属项目", required = true) @PathVariable projectId: String, - @ApiParam(value = "仓库名称", required = true) + @Parameter(name = "仓库名称", required = true) @PathVariable repoName: String, - @ApiParam(value = "仓库类型", required = true) + @Parameter(name = "仓库类型", required = true) @PathVariable type: String? = null, ): Response { return ResponseBuilder.success(repositoryService.getRepoInfo(projectId, repoName, type)) } - @ApiOperation("根据名称查询仓库是否存在") + @Operation(summary = "根据名称查询仓库是否存在") @GetMapping("/exist/{projectId}/{repoName}") fun checkExist( - @ApiParam(value = "所属项目", required = true) + @Parameter(name = "所属项目", required = true) @PathVariable projectId: String, - @ApiParam(value = "仓库名称", required = true) + @Parameter(name = "仓库名称", required = true) @PathVariable repoName: String, ): Response { @@ -149,7 +149,7 @@ class UserRepositoryController( scopeId = "#userRepoCreateRequest?.projectId", content = ActionAuditContent.REPO_CREATE_CONTENT ) - @ApiOperation("创建仓库") + @Operation(summary = "创建仓库") @PostMapping("/create") fun createRepo( @RequestAttribute userId: String, @@ -196,11 +196,11 @@ class UserRepositoryController( scopeId = "#projectId", content = ActionAuditContent.REPO_LIST_CONTENT ) - @ApiOperation("查询有权限的仓库列表") + @Operation(summary = "查询有权限的仓库列表") @GetMapping("/list/{projectId}") fun listUserRepo( @RequestAttribute userId: String, - @ApiParam(value = "项目id", required = true) + @Parameter(name = "项目id", required = true) @PathVariable projectId: String, repoListOption: RepoListOption, @@ -224,17 +224,17 @@ class UserRepositoryController( scopeId = "#projectId", content = ActionAuditContent.REPO_LIST_CONTENT ) - @ApiOperation("分页查询有权限的仓库列表") + @Operation(summary = "分页查询有权限的仓库列表") @GetMapping("/page/{projectId}/{pageNumber}/{pageSize}") fun listUserRepoPage( @RequestAttribute userId: String, - @ApiParam(value = "项目id", required = true) + @Parameter(name = "项目id", required = true) @PathVariable projectId: String, - @ApiParam(value = "当前页", required = true, example = "0") + @Parameter(name = "当前页", required = true, example = "0") @PathVariable pageNumber: Int, - @ApiParam(value = "分页大小", required = true, example = "20") + @Parameter(name = "分页大小", required = true, example = "20") @PathVariable pageSize: Int, repoListOption: RepoListOption, @@ -259,14 +259,14 @@ class UserRepositoryController( scopeId = "#projectId", content = ActionAuditContent.REPO_QUOTE_VIEW_CONTENT ) - @ApiOperation("查询仓库配额") + @Operation(summary = "查询仓库配额") @Permission(type = ResourceType.REPO, action = PermissionAction.READ) @GetMapping("/quota/{projectId}/{repoName}") fun getRepoQuota( - @ApiParam(value = "所属项目", required = true) + @Parameter(name = "所属项目", required = true) @PathVariable projectId: String, - @ApiParam(value = "仓库名称", required = true) + @Parameter(name = "仓库名称", required = true) @PathVariable repoName: String, ): Response { @@ -290,18 +290,18 @@ class UserRepositoryController( scopeId = "#projectId", content = ActionAuditContent.REPO_QUOTE_EDIT_CONTENT ) - @ApiOperation("修改仓库配额") + @Operation(summary = "修改仓库配额") @Permission(type = ResourceType.REPO, action = PermissionAction.MANAGE) @PostMapping("/quota/{projectId}/{repoName}") fun updateRepoQuota( @RequestAttribute userId: String, - @ApiParam(value = "所属项目", required = true) + @Parameter(name = "所属项目", required = true) @PathVariable projectId: String, - @ApiParam(value = "仓库名称", required = true) + @Parameter(name = "仓库名称", required = true) @PathVariable repoName: String, - @ApiParam(value = "仓库配额", required = true) + @Parameter(name = "仓库配额", required = true) @RequestParam quota: Long, ): Response { @@ -332,18 +332,18 @@ class UserRepositoryController( scopeId = "#projectId", content = ActionAuditContent.REPO_DELETE_CONTENT ) - @ApiOperation("删除仓库") + @Operation(summary = "删除仓库") @Permission(type = ResourceType.REPO, action = PermissionAction.DELETE) @DeleteMapping("/delete/{projectId}/{repoName}") fun deleteRepo( @RequestAttribute userId: String, - @ApiParam(value = "所属项目", required = true) + @Parameter(name = "所属项目", required = true) @PathVariable projectId: String, - @ApiParam(value = "仓库名称", required = true) + @Parameter(name = "仓库名称", required = true) @PathVariable repoName: String, - @ApiParam(value = "是否强制删除", required = false) + @Parameter(name = "是否强制删除", required = false) @RequestParam forced: Boolean = false, ): Response { @@ -367,15 +367,15 @@ class UserRepositoryController( scopeId = "#projectId", content = ActionAuditContent.REPO_EDIT_CONTENT ) - @ApiOperation("更新仓库") + @Operation(summary = "更新仓库") @Permission(type = ResourceType.REPO, action = PermissionAction.MANAGE) @PostMapping("/update/{projectId}/{repoName}") fun updateRepo( @RequestAttribute userId: String, - @ApiParam(value = "所属项目", required = true) + @Parameter(name = "所属项目", required = true) @PathVariable projectId: String, - @ApiParam(value = "仓库名称", required = true) + @Parameter(name = "仓库名称", required = true) @PathVariable repoName: String, @RequestBody request: UserRepoUpdateRequest, @@ -413,7 +413,7 @@ class UserRepositoryController( content = ActionAuditContent.REPO_CREATE_CONTENT ) @Deprecated("waiting kb-ci and bk", replaceWith = ReplaceWith("createRepo")) - @ApiOperation("创建仓库") + @Operation(summary = "创建仓库") @PostMapping fun create( @RequestAttribute userId: String, @@ -422,7 +422,7 @@ class UserRepositoryController( return this.createRepo(userId, userRepoCreateRequest) } - @ApiOperation("查询可归档文件大小") + @Operation(summary = "查询可归档文件大小") @GetMapping("/archive/available") fun getArchivableSize( @RequestParam projectId: String, diff --git a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserShareController.kt b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserShareController.kt index c0152d8bca..5cd724712f 100644 --- a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserShareController.kt +++ b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserShareController.kt @@ -36,9 +36,6 @@ import com.tencent.bk.audit.annotations.AuditAttribute import com.tencent.bk.audit.annotations.AuditEntry import com.tencent.bk.audit.annotations.AuditInstanceRecord import com.tencent.bk.audit.context.ActionAuditContext -import com.tencent.bkrepo.common.artifact.audit.NODE_DOWNLOAD_ACTION -import com.tencent.bkrepo.common.artifact.audit.NODE_RESOURCE -import com.tencent.bkrepo.common.artifact.audit.NODE_VIEW_ACTION import com.tencent.bkrepo.auth.pojo.enums.PermissionAction import com.tencent.bkrepo.auth.pojo.enums.ResourceType import com.tencent.bkrepo.common.api.pojo.Response @@ -46,17 +43,20 @@ import com.tencent.bkrepo.common.artifact.api.ArtifactInfo import com.tencent.bkrepo.common.artifact.api.ArtifactPathVariable import com.tencent.bkrepo.common.artifact.api.DefaultArtifactInfo import com.tencent.bkrepo.common.artifact.api.DefaultArtifactInfo.Companion.DEFAULT_MAPPING_URI +import com.tencent.bkrepo.common.artifact.audit.ActionAuditContent +import com.tencent.bkrepo.common.artifact.audit.NODE_DOWNLOAD_ACTION +import com.tencent.bkrepo.common.artifact.audit.NODE_RESOURCE +import com.tencent.bkrepo.common.artifact.audit.NODE_VIEW_ACTION import com.tencent.bkrepo.common.artifact.path.PathUtils import com.tencent.bkrepo.common.metadata.permission.PermissionManager -import com.tencent.bkrepo.common.artifact.audit.ActionAuditContent import com.tencent.bkrepo.common.security.permission.Permission import com.tencent.bkrepo.common.service.util.ResponseBuilder import com.tencent.bkrepo.repository.pojo.share.BatchShareRecordCreateRequest import com.tencent.bkrepo.repository.pojo.share.ShareRecordCreateRequest import com.tencent.bkrepo.repository.pojo.share.ShareRecordInfo import com.tencent.bkrepo.repository.service.file.ShareService -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +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.PostMapping import org.springframework.web.bind.annotation.RequestAttribute @@ -68,7 +68,7 @@ import org.springframework.web.bind.annotation.RestController /** * 用户分享接口 */ -@Api("节点分享用户接口") +@Tag(name = "节点分享用户接口") @RestController @RequestMapping("/api/share") class UserShareController( @@ -93,7 +93,7 @@ class UserShareController( scopeId = "#artifactInfo?.projectId", content = ActionAuditContent.NODE_SHARE_CREATE_CONTENT ) - @ApiOperation("创建分享链接") + @Operation(summary = "创建分享链接") @Permission(type = ResourceType.NODE, action = PermissionAction.WRITE) @PostMapping(DEFAULT_MAPPING_URI) fun share( @@ -128,7 +128,7 @@ class UserShareController( scopeId = "#batchShareRecordCreateRequest?.projectId", content = ActionAuditContent.NODE_SHARE_CREATE_CONTENT ) - @ApiOperation("批量创建分享链接") + @Operation(summary = "批量创建分享链接") @PostMapping("/batch") fun batchShare( @RequestAttribute userId: String, @@ -170,7 +170,7 @@ class UserShareController( scopeId = "#artifactInfo?.projectId", content = ActionAuditContent.NODE_SHARE_DOWNLOAD_CONTENT ) - @ApiOperation("下载分享文件") + @Operation(summary = "下载分享文件") @GetMapping(DEFAULT_MAPPING_URI) fun download( @RequestAttribute userId: String, diff --git a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserSoftwarePackageController.kt b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserSoftwarePackageController.kt index 1897674dd9..ba6b249b15 100644 --- a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserSoftwarePackageController.kt +++ b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserSoftwarePackageController.kt @@ -7,8 +7,8 @@ import com.tencent.bkrepo.common.query.model.QueryModel import com.tencent.bkrepo.common.service.util.ResponseBuilder import com.tencent.bkrepo.repository.pojo.software.ProjectPackageOverview import com.tencent.bkrepo.repository.service.packages.SoftwarePackageService -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +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.PostMapping import org.springframework.web.bind.annotation.RequestBody @@ -16,14 +16,14 @@ import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam import org.springframework.web.bind.annotation.RestController -@Api("软件源包接口") +@Tag(name = "软件源包接口") @RestController @RequestMapping("/api/software/package") class UserSoftwarePackageController( private val softwarePackageService: SoftwarePackageService ) { - @ApiOperation("软件源包查询接口") + @Operation(summary = "软件源包查询接口") @PostMapping("/search") fun searchPackage( @RequestBody queryModel: QueryModel @@ -31,7 +31,7 @@ class UserSoftwarePackageController( return ResponseBuilder.success(softwarePackageService.searchPackage(queryModel)) } - @ApiOperation("仓库 包数量 总览") + @Operation(summary = "仓库 包数量 总览") @GetMapping("/search/overview") fun packageOverview( @RequestParam repoType: RepositoryType, diff --git a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserSoftwareRepositoryController.kt b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserSoftwareRepositoryController.kt index 2caab9dd95..f5ee8302fc 100644 --- a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserSoftwareRepositoryController.kt +++ b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserSoftwareRepositoryController.kt @@ -6,9 +6,9 @@ import com.tencent.bkrepo.common.artifact.pojo.RepositoryType import com.tencent.bkrepo.common.service.util.ResponseBuilder import com.tencent.bkrepo.repository.pojo.repo.RepositoryInfo import com.tencent.bkrepo.repository.service.repo.SoftwareRepositoryService -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable import org.springframework.web.bind.annotation.RequestAttribute @@ -16,26 +16,26 @@ import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam import org.springframework.web.bind.annotation.RestController -@Api("软件源仓库接口") +@Tag(name = "软件源仓库接口") @RestController @RequestMapping("/api/software/repo") class UserSoftwareRepositoryController( private val softwareRepositoryService: SoftwareRepositoryService ) { - @ApiOperation("软件源仓库列表") + @Operation(summary = "软件源仓库列表") @GetMapping("/page/{pageNumber}/{pageSize}") fun softwareRepoPage( @RequestAttribute userId: String, - @ApiParam(value = "当前页", required = true, example = "0") + @Parameter(name = "当前页", required = true, example = "0") @PathVariable pageNumber: Int, - @ApiParam(value = "分页大小", required = true, example = "20") + @Parameter(name = "分页大小", required = true, example = "20") @PathVariable pageSize: Int, - @ApiParam(value = "项目id", required = false) + @Parameter(name = "项目id", required = false) @RequestParam projectId: String?, - @ApiParam(value = "仓库名", required = false) + @Parameter(name = "仓库名", required = false) @RequestParam name: String?, - @ApiParam(value = "仓库类型", required = false) + @Parameter(name = "仓库类型", required = false) @RequestParam type: String? ): Response> { val repoType = type?.let { RepositoryType.valueOf(it.toUpperCase()) } diff --git a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserStageController.kt b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserStageController.kt index a9f9adf074..6605020672 100644 --- a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserStageController.kt +++ b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserStageController.kt @@ -34,11 +34,11 @@ package com.tencent.bkrepo.repository.controller.user import com.tencent.bkrepo.auth.pojo.enums.PermissionAction import com.tencent.bkrepo.auth.pojo.enums.ResourceType import com.tencent.bkrepo.common.api.pojo.Response +import com.tencent.bkrepo.common.metadata.service.packages.StageService import com.tencent.bkrepo.common.security.permission.Permission import com.tencent.bkrepo.common.service.util.ResponseBuilder import com.tencent.bkrepo.repository.pojo.stage.StageUpgradeRequest -import com.tencent.bkrepo.common.metadata.service.packages.StageService -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable import org.springframework.web.bind.annotation.PostMapping @@ -56,7 +56,7 @@ class UserStageController( private val stageService: StageService ) { - @ApiOperation("查询制品状态") + @Operation(summary = "查询制品状态") @Permission(type = ResourceType.REPO, action = PermissionAction.READ) @GetMapping("/{projectId}/{repoName}") fun query( @@ -68,7 +68,7 @@ class UserStageController( return ResponseBuilder.success(stageService.query(projectId, repoName, packageKey, version)) } - @ApiOperation("制品晋级") + @Operation(summary = "制品晋级") @Permission(type = ResourceType.REPO, action = PermissionAction.WRITE) @PostMapping("/upgrade/{projectId}/{repoName}") fun upgrade( diff --git a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserStorageCredentialsController.kt b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserStorageCredentialsController.kt index 1239240a54..ab33e4d8a7 100644 --- a/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserStorageCredentialsController.kt +++ b/src/backend/repository/biz-repository/src/main/kotlin/com/tencent/bkrepo/repository/controller/user/UserStorageCredentialsController.kt @@ -34,6 +34,7 @@ package com.tencent.bkrepo.repository.controller.user import com.tencent.bkrepo.common.api.exception.SystemErrorException import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.common.metadata.annotation.LogOperate +import com.tencent.bkrepo.common.metadata.service.repo.StorageCredentialService import com.tencent.bkrepo.common.security.permission.Principal import com.tencent.bkrepo.common.security.permission.PrincipalType import com.tencent.bkrepo.common.service.util.ResponseBuilder @@ -45,9 +46,8 @@ import com.tencent.bkrepo.common.storage.credentials.StorageCredentials import com.tencent.bkrepo.repository.message.RepositoryMessageCode import com.tencent.bkrepo.repository.pojo.credendials.StorageCredentialsCreateRequest import com.tencent.bkrepo.repository.pojo.credendials.StorageCredentialsUpdateRequest -import com.tencent.bkrepo.common.metadata.service.repo.StorageCredentialService -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable @@ -59,7 +59,7 @@ import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam import org.springframework.web.bind.annotation.RestController -@Api("存储凭据管理") +@Tag(name = "存储凭据管理") @Principal(PrincipalType.ADMIN) @RestController @RequestMapping("/api/storage/credentials") @@ -67,7 +67,7 @@ class UserStorageCredentialsController( private val storageCredentialService: StorageCredentialService ) { - @ApiOperation("创建凭据") + @Operation(summary = "创建凭据") @PostMapping @LogOperate(type = "STORAGE_CREDENTIALS_CREATE", desensitize = true) fun create( @@ -78,7 +78,7 @@ class UserStorageCredentialsController( return ResponseBuilder.buildTyped(createdCredential) } - @ApiOperation("更新凭据") + @Operation(summary = "更新凭据") @PutMapping("/{credentialsKey}") @LogOperate(type = "STORAGE_CREDENTIALS_UPDATE", desensitize = true) fun update( @@ -91,7 +91,7 @@ class UserStorageCredentialsController( return ResponseBuilder.buildTyped(updatedCredentials) } - @ApiOperation("获取凭据列表") + @Operation(summary = "获取凭据列表") @GetMapping fun list(@RequestParam("region", required = false) region: String?): Response> { val storageCredentialsList = storageCredentialService.list(region).map { @@ -104,14 +104,14 @@ class UserStorageCredentialsController( return ResponseBuilder.buildTyped(storageCredentialsList) } - @ApiOperation("获取默认凭据") + @Operation(summary = "获取默认凭据") @GetMapping("/default") @LogOperate(type = "STORAGE_CREDENTIALS_LIST") fun default(): Response { return ResponseBuilder.buildTyped(mask(storageCredentialService.default())) } - @ApiOperation("删除凭据") + @Operation(summary = "删除凭据") @DeleteMapping("/{credentialKey}") @LogOperate(type = "STORAGE_CREDENTIALS_DELETE") fun delete(@PathVariable("credentialKey") credentialKey: String): Response { diff --git a/src/backend/router-controller/api-router-controller/src/main/kotlin/com/tencent/bkrepo/router/api/RouterControllerClient.kt b/src/backend/router-controller/api-router-controller/src/main/kotlin/com/tencent/bkrepo/router/api/RouterControllerClient.kt index 3f96c1ef60..ffd99ec379 100644 --- a/src/backend/router-controller/api-router-controller/src/main/kotlin/com/tencent/bkrepo/router/api/RouterControllerClient.kt +++ b/src/backend/router-controller/api-router-controller/src/main/kotlin/com/tencent/bkrepo/router/api/RouterControllerClient.kt @@ -33,8 +33,8 @@ import com.tencent.bkrepo.router.pojo.AddRouterNodeRequest import com.tencent.bkrepo.router.pojo.RemoveRouterNodeRequest import com.tencent.bkrepo.router.pojo.RouterNode import com.tencent.bkrepo.router.pojo.RouterPolicy -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.cloud.openfeign.FeignClient import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping @@ -44,11 +44,11 @@ import org.springframework.web.bind.annotation.RequestBody import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam -@Api("路由控制器接口") +@Tag(name = "路由控制器接口") @FeignClient(ROUTER_CONTROLLER_SERVICE_NAME, contextId = "RouterControllerClient", primary = false) @RequestMapping("/service/router") interface RouterControllerClient { - @ApiOperation("添加节点位置") + @Operation(summary = "添加节点位置") @PostMapping("/node/location/{projectId}/{repoName}") fun addNode( @PathVariable projectId: String, @@ -57,7 +57,7 @@ interface RouterControllerClient { @RequestParam routerNodeId: String, ) - @ApiOperation("删除节点位置") + @Operation(summary = "删除节点位置") @DeleteMapping("/node/location/{projectId}/{repoName}") fun removeNode( @PathVariable projectId: String, @@ -66,7 +66,7 @@ interface RouterControllerClient { @RequestParam routerNodeId: String, ) - @ApiOperation("批量删除") + @Operation(summary = "批量删除") @DeleteMapping("/nodes/location/{projectId}/{repoName}") fun removeNodes( @PathVariable projectId: String, @@ -74,7 +74,7 @@ interface RouterControllerClient { @RequestParam fullPath: String, ) - @ApiOperation("获取重定向的URL") + @Operation(summary = "获取重定向的URL") @GetMapping("/node/location/{projectId}/{repoName}") fun getRedirectUrl( @PathVariable projectId: String, @@ -84,7 +84,7 @@ interface RouterControllerClient { @RequestParam serviceName: String ): Response - @ApiOperation("获取路由策略") + @Operation(summary = "获取路由策略") @GetMapping("/policy/list") fun listRouterPolicies(): Response> diff --git a/src/backend/router-controller/biz-router-controller/src/main/kotlin/com/tencent/bkrepo/router/contoller/user/RouterAdminController.kt b/src/backend/router-controller/biz-router-controller/src/main/kotlin/com/tencent/bkrepo/router/contoller/user/RouterAdminController.kt index 0b7bb098a1..7e7a156528 100644 --- a/src/backend/router-controller/biz-router-controller/src/main/kotlin/com/tencent/bkrepo/router/contoller/user/RouterAdminController.kt +++ b/src/backend/router-controller/biz-router-controller/src/main/kotlin/com/tencent/bkrepo/router/contoller/user/RouterAdminController.kt @@ -44,7 +44,7 @@ import com.tencent.bkrepo.router.pojo.user.UserRemoveRouterNodeRequest import com.tencent.bkrepo.router.pojo.user.UserRemoveRouterPolicyRequest import com.tencent.bkrepo.router.service.RouterAdminService import com.tencent.bkrepo.router.service.RouterControllerService -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.Operation import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PostMapping @@ -62,7 +62,7 @@ class RouterAdminController( val routerControllerService: RouterControllerService, ) { - @ApiOperation("增加路由策略") + @Operation(summary = "增加路由策略") @PostMapping("/policy") fun addPolicy( @RequestAttribute userId: String, @@ -79,7 +79,7 @@ class RouterAdminController( } } - @ApiOperation("删除路由策略") + @Operation(summary = "删除路由策略") @DeleteMapping("/policy") fun removePolicy( @RequestAttribute userId: String, @@ -95,7 +95,7 @@ class RouterAdminController( } } - @ApiOperation("新增路由节点") + @Operation(summary = "新增路由节点") @PostMapping("/node") fun addRouterNode( @RequestAttribute userId: String, @@ -114,7 +114,7 @@ class RouterAdminController( } } - @ApiOperation("移除路由节点") + @Operation(summary = "移除路由节点") @DeleteMapping("/node") fun removeRouterNode( @RequestAttribute userId: String, @@ -130,19 +130,19 @@ class RouterAdminController( } } - @ApiOperation("获取所有路由策略") + @Operation(summary = "获取所有路由策略") @GetMapping("/policy/list") fun listPolicies(): Response> { return ResponseBuilder.success(routerAdminService.listPolicies()) } - @ApiOperation("获取所有路由节点") + @Operation(summary = "获取所有路由节点") @GetMapping("/node/list") fun listRouterNodes(): Response> { return ResponseBuilder.success(routerAdminService.listRouterNodes()) } - @ApiOperation("获取文件节点位置") + @Operation(summary = "获取文件节点位置") @GetMapping("/node/location") fun listNodeLocations( @RequestParam projectId: String, @@ -165,7 +165,7 @@ class RouterAdminController( * @param fullPath 文件完整路径 * @param routerNodeId 所在节点id * */ - @ApiOperation("新增文件节点位置") + @Operation(summary = "新增文件节点位置") @PostMapping("/node/location") fun addNode(projectId: String, repoName: String, fullPath: String, routerNodeId: String): Response { return ResponseBuilder.success( @@ -185,7 +185,7 @@ class RouterAdminController( * @param fullPath 文件完整路径 * @param routerNodeId 所在节点id * */ - @ApiOperation("删除文件节点位置") + @Operation(summary = "删除文件节点位置") @DeleteMapping("/node/location") fun removeNode(projectId: String, repoName: String, fullPath: String, routerNodeId: String): Response { routerControllerService.removeNode( diff --git a/src/backend/rpm/api-rpm/src/main/kotlin/com/tencent/bkrepo/rpm/api/RpmWebResource.kt b/src/backend/rpm/api-rpm/src/main/kotlin/com/tencent/bkrepo/rpm/api/RpmWebResource.kt index 0af6d86dca..dfb686dfc4 100644 --- a/src/backend/rpm/api-rpm/src/main/kotlin/com/tencent/bkrepo/rpm/api/RpmWebResource.kt +++ b/src/backend/rpm/api-rpm/src/main/kotlin/com/tencent/bkrepo/rpm/api/RpmWebResource.kt @@ -35,26 +35,26 @@ import com.tencent.bkrepo.common.api.pojo.Page import com.tencent.bkrepo.common.api.pojo.Response import com.tencent.bkrepo.common.artifact.api.ArtifactPathVariable import com.tencent.bkrepo.rpm.artifact.RpmArtifactInfo -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation -import io.swagger.annotations.ApiParam +import io.swagger.v3.oas.annotations.Operation +import io.swagger.v3.oas.annotations.Parameter +import io.swagger.v3.oas.annotations.tags.Tag import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam -@Api("Rpm 产品-web接口") +@Tag(name = "Rpm 产品-web接口") @RequestMapping("/ext") interface RpmWebResource { - @ApiOperation("rpm 包删除接口") + @Operation(summary = "rpm 包删除接口") @DeleteMapping(RpmArtifactInfo.RPM_EXT_PACKAGE_DELETE) fun deletePackage( @ArtifactPathVariable rpmArtifactInfo: RpmArtifactInfo, @RequestParam packageKey: String ): Response - @ApiOperation("rpm 版本删除接口") + @Operation(summary = "rpm 版本删除接口") @DeleteMapping(RpmArtifactInfo.RPM_EXT_VERSION_DELETE) fun deleteVersion( @ArtifactPathVariable rpmArtifactInfo: RpmArtifactInfo, @@ -62,7 +62,7 @@ interface RpmWebResource { @RequestParam version: String? ): Response - @ApiOperation("rpm 版本详情接口") + @Operation(summary = "rpm 版本详情接口") @GetMapping(RpmArtifactInfo.RPM_EXT_DETAIL) fun artifactDetail( @ArtifactPathVariable rpmArtifactInfo: RpmArtifactInfo, @@ -73,9 +73,9 @@ interface RpmWebResource { @GetMapping(RpmArtifactInfo.RPM_EXT_LIST) fun list( @ArtifactPathVariable rpmArtifactInfo: RpmArtifactInfo, - @ApiParam(value = "当前页", required = true, defaultValue = "0") + @Parameter(name = "当前页", required = true) @RequestParam page: Int = 0, - @ApiParam(value = "分页大小", required = true, defaultValue = "20") + @Parameter(name = "分页大小", required = true) @RequestParam size: Int = 20 ): Response> } diff --git a/src/backend/rpm/api-rpm/src/main/kotlin/com/tencent/bkrepo/rpm/pojo/RpmDeleteResponse.kt b/src/backend/rpm/api-rpm/src/main/kotlin/com/tencent/bkrepo/rpm/pojo/RpmDeleteResponse.kt index c72f8901b2..e5a4dad8ce 100644 --- a/src/backend/rpm/api-rpm/src/main/kotlin/com/tencent/bkrepo/rpm/pojo/RpmDeleteResponse.kt +++ b/src/backend/rpm/api-rpm/src/main/kotlin/com/tencent/bkrepo/rpm/pojo/RpmDeleteResponse.kt @@ -31,17 +31,17 @@ package com.tencent.bkrepo.rpm.pojo -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("Rpm 仓库delete失败时返回信息") + +@Schema(title = "Rpm 仓库delete失败时返回信息") data class RpmDeleteResponse( - @ApiModelProperty("项目") + @get:Schema(title = "项目") val projectId: String, - @ApiModelProperty("仓库") + @get:Schema(title = "仓库") val repoName: String, - @ApiModelProperty("构件uri") + @get:Schema(title = "构件uri") val artifactUri: String, - @ApiModelProperty("失败原因") + @get:Schema(title = "失败原因") val description: String ) diff --git a/src/backend/rpm/api-rpm/src/main/kotlin/com/tencent/bkrepo/rpm/pojo/RpmUploadResponse.kt b/src/backend/rpm/api-rpm/src/main/kotlin/com/tencent/bkrepo/rpm/pojo/RpmUploadResponse.kt index a087320e84..04e8f834c7 100644 --- a/src/backend/rpm/api-rpm/src/main/kotlin/com/tencent/bkrepo/rpm/pojo/RpmUploadResponse.kt +++ b/src/backend/rpm/api-rpm/src/main/kotlin/com/tencent/bkrepo/rpm/pojo/RpmUploadResponse.kt @@ -31,21 +31,21 @@ package com.tencent.bkrepo.rpm.pojo -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("Rpm 仓库upload成功时返回信息") + +@Schema(title = "Rpm 仓库upload成功时返回信息") data class RpmUploadResponse( - @ApiModelProperty("项目") + @get:Schema(title = "项目") val projectId: String, - @ApiModelProperty("仓库") + @get:Schema(title = "仓库") val repoName: String, - @ApiModelProperty("构件uri") + @get:Schema(title = "构件uri") val artifactUri: String, - @ApiModelProperty("构件sha256") + @get:Schema(title = "构件sha256") val sha256: String, - @ApiModelProperty("构件md5") + @get:Schema(title = "构件md5") val md5: String, - @ApiModelProperty("上传结果描述") + @get:Schema(title = "上传结果描述") val description: String ) diff --git a/src/backend/rpm/biz-rpm/src/main/kotlin/com/tencent/bkrepo/rpm/pojo/RepoDataPojo.kt b/src/backend/rpm/biz-rpm/src/main/kotlin/com/tencent/bkrepo/rpm/pojo/RepoDataPojo.kt index 8075a47927..96dd0bc738 100644 --- a/src/backend/rpm/biz-rpm/src/main/kotlin/com/tencent/bkrepo/rpm/pojo/RepoDataPojo.kt +++ b/src/backend/rpm/biz-rpm/src/main/kotlin/com/tencent/bkrepo/rpm/pojo/RepoDataPojo.kt @@ -33,18 +33,18 @@ package com.tencent.bkrepo.rpm.pojo import com.tencent.bkrepo.rpm.REPODATA import com.tencent.bkrepo.rpm.exception.RpmRepoDataException -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema + /** * repodataPath : 索引目录的父级路径 `/`开头，`/`结尾 * artifactRelativePath：保存在索引中的路径 ， 不要`/` */ -@ApiModel("索引目录数据类") +@Schema(title = "索引目录数据类") data class RepoDataPojo( - @ApiModelProperty("契合本次请求的repodata_depth 目录路径") + @get:Schema(title = "契合本次请求的repodata_depth 目录路径") val repoDataPath: String, - @ApiModelProperty("构件相对于索引文件的保存路径") + @get:Schema(title = "构件相对于索引文件的保存路径") val artifactRelativePath: String ) { diff --git a/src/backend/webhook/api-webhook/src/main/kotlin/com/tencent/bkrepo/webhook/pojo/CreateWebHookRequest.kt b/src/backend/webhook/api-webhook/src/main/kotlin/com/tencent/bkrepo/webhook/pojo/CreateWebHookRequest.kt index 3fb0fbee3f..de73be1c8c 100644 --- a/src/backend/webhook/api-webhook/src/main/kotlin/com/tencent/bkrepo/webhook/pojo/CreateWebHookRequest.kt +++ b/src/backend/webhook/api-webhook/src/main/kotlin/com/tencent/bkrepo/webhook/pojo/CreateWebHookRequest.kt @@ -31,22 +31,22 @@ import com.tencent.bkrepo.common.artifact.event.base.EventType import com.tencent.bkrepo.common.metadata.annotation.Sensitive import com.tencent.bkrepo.common.metadata.handler.MaskPartMapValue import com.tencent.bkrepo.webhook.constant.AssociationType -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("创建WebHook请求") + +@Schema(title = "创建WebHook请求") data class CreateWebHookRequest( - @ApiModelProperty("回调地址") + @get:Schema(title = "回调地址") val url: String, - @ApiModelProperty("自定义请求头") + @get:Schema(title = "自定义请求头") @Sensitive(handler = MaskPartMapValue::class) val headers: Map = emptyMap(), - @ApiModelProperty("触发事件") + @get:Schema(title = "触发事件") val triggers: List, - @ApiModelProperty("关联对象类型") + @get:Schema(title = "关联对象类型") val associationType: AssociationType, - @ApiModelProperty("关联对象id") + @get:Schema(title = "关联对象id") val associationId: String = "", - @ApiModelProperty("事件资源key正则模式") + @get:Schema(title = "事件资源key正则模式") val resourceKeyPattern: String? = null ) diff --git a/src/backend/webhook/api-webhook/src/main/kotlin/com/tencent/bkrepo/webhook/pojo/ListWebHookLogOption.kt b/src/backend/webhook/api-webhook/src/main/kotlin/com/tencent/bkrepo/webhook/pojo/ListWebHookLogOption.kt index 0b25b5b5df..95638f02fa 100644 --- a/src/backend/webhook/api-webhook/src/main/kotlin/com/tencent/bkrepo/webhook/pojo/ListWebHookLogOption.kt +++ b/src/backend/webhook/api-webhook/src/main/kotlin/com/tencent/bkrepo/webhook/pojo/ListWebHookLogOption.kt @@ -30,19 +30,19 @@ package com.tencent.bkrepo.webhook.pojo import com.tencent.bkrepo.common.api.constant.DEFAULT_PAGE_NUMBER import com.tencent.bkrepo.common.api.constant.DEFAULT_PAGE_SIZE import com.tencent.bkrepo.webhook.constant.WebHookRequestStatus -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("WebHook日志列表查询选项") + +@Schema(title = "WebHook日志列表查询选项") data class ListWebHookLogOption( - @ApiModelProperty("当前页") + @get:Schema(title = "当前页") val pageNumber: Int = DEFAULT_PAGE_NUMBER, - @ApiModelProperty("分页大小") + @get:Schema(title = "分页大小") val pageSize: Int = DEFAULT_PAGE_SIZE, - @ApiModelProperty("开始日期") + @get:Schema(title = "开始日期") val startDate: String?, - @ApiModelProperty("结束日期") + @get:Schema(title = "结束日期") val endDate: String?, - @ApiModelProperty("请求状态") + @get:Schema(title = "请求状态") val status: WebHookRequestStatus? ) diff --git a/src/backend/webhook/api-webhook/src/main/kotlin/com/tencent/bkrepo/webhook/pojo/UpdateWebHookRequest.kt b/src/backend/webhook/api-webhook/src/main/kotlin/com/tencent/bkrepo/webhook/pojo/UpdateWebHookRequest.kt index 4ec8317b86..54994fd600 100644 --- a/src/backend/webhook/api-webhook/src/main/kotlin/com/tencent/bkrepo/webhook/pojo/UpdateWebHookRequest.kt +++ b/src/backend/webhook/api-webhook/src/main/kotlin/com/tencent/bkrepo/webhook/pojo/UpdateWebHookRequest.kt @@ -30,20 +30,20 @@ package com.tencent.bkrepo.webhook.pojo import com.tencent.bkrepo.common.artifact.event.base.EventType import com.tencent.bkrepo.common.metadata.annotation.Sensitive import com.tencent.bkrepo.common.metadata.handler.MaskPartMapValue -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema -@ApiModel("更新WebHook请求") + +@Schema(title = "更新WebHook请求") data class UpdateWebHookRequest( - @ApiModelProperty("id") + @get:Schema(title = "id") val id: String, - @ApiModelProperty("回调地址") + @get:Schema(title = "回调地址") val url: String? = null, - @ApiModelProperty("请求头") + @get:Schema(title = "请求头") @Sensitive(handler = MaskPartMapValue::class) val headers: Map? = null, - @ApiModelProperty("触发事件") + @get:Schema(title = "触发事件") val triggers: List? = null, - @ApiModelProperty("事件资源key正则模型") + @get:Schema(title = "事件资源key正则模型") val resourceKeyPattern: String? = null ) diff --git a/src/backend/webhook/api-webhook/src/main/kotlin/com/tencent/bkrepo/webhook/pojo/WebHook.kt b/src/backend/webhook/api-webhook/src/main/kotlin/com/tencent/bkrepo/webhook/pojo/WebHook.kt index 0b4e775c3c..c2144e6c07 100644 --- a/src/backend/webhook/api-webhook/src/main/kotlin/com/tencent/bkrepo/webhook/pojo/WebHook.kt +++ b/src/backend/webhook/api-webhook/src/main/kotlin/com/tencent/bkrepo/webhook/pojo/WebHook.kt @@ -29,32 +29,31 @@ package com.tencent.bkrepo.webhook.pojo import com.tencent.bkrepo.common.artifact.event.base.EventType import com.tencent.bkrepo.webhook.constant.AssociationType -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema import java.time.LocalDateTime -@ApiModel("WebHook信息") +@Schema(title = "WebHook信息") data class WebHook( - @ApiModelProperty("id") + @get:Schema(title = "id") val id: String, - @ApiModelProperty("回调地址") + @get:Schema(title = "回调地址") val url: String, - @ApiModelProperty("自定义请求头") + @get:Schema(title = "自定义请求头") val headers: Map? = null, - @ApiModelProperty("触发事件") + @get:Schema(title = "触发事件") val triggers: List, - @ApiModelProperty("关联对象类型") + @get:Schema(title = "关联对象类型") val associationType: AssociationType, - @ApiModelProperty("关联对象id") + @get:Schema(title = "关联对象id") val associationId: String, - @ApiModelProperty("事件资源key正则模式") + @get:Schema(title = "事件资源key正则模式") val resourceKeyPattern: String? = null, - @ApiModelProperty("创建人") + @get:Schema(title = "创建人") val createdBy: String, - @ApiModelProperty("创建时间") + @get:Schema(title = "创建时间") val createdDate: LocalDateTime, - @ApiModelProperty("最近修改人") + @get:Schema(title = "最近修改人") val lastModifiedBy: String, - @ApiModelProperty("最近修改时间") + @get:Schema(title = "最近修改时间") val lastModifiedDate: LocalDateTime ) diff --git a/src/backend/webhook/api-webhook/src/main/kotlin/com/tencent/bkrepo/webhook/pojo/WebHookLog.kt b/src/backend/webhook/api-webhook/src/main/kotlin/com/tencent/bkrepo/webhook/pojo/WebHookLog.kt index 30dabb8ad5..ab4c73263b 100644 --- a/src/backend/webhook/api-webhook/src/main/kotlin/com/tencent/bkrepo/webhook/pojo/WebHookLog.kt +++ b/src/backend/webhook/api-webhook/src/main/kotlin/com/tencent/bkrepo/webhook/pojo/WebHookLog.kt @@ -29,32 +29,31 @@ package com.tencent.bkrepo.webhook.pojo import com.tencent.bkrepo.common.artifact.event.base.EventType import com.tencent.bkrepo.webhook.constant.WebHookRequestStatus -import io.swagger.annotations.ApiModel -import io.swagger.annotations.ApiModelProperty +import io.swagger.v3.oas.annotations.media.Schema import java.time.LocalDateTime -@ApiModel("WebHook日志信息") +@Schema(title = "WebHook日志信息") data class WebHookLog( - @ApiModelProperty("id") + @get:Schema(title = "id") val id: String, - @ApiModelProperty("WebHook回调地址") + @get:Schema(title = "WebHook回调地址") val webHookUrl: String, - @ApiModelProperty("触发事件") + @get:Schema(title = "触发事件") val triggeredEvent: EventType, - @ApiModelProperty("请求头") + @get:Schema(title = "请求头") val requestHeaders: Map, - @ApiModelProperty("请求载荷") + @get:Schema(title = "请求载荷") val requestPayload: String, - @ApiModelProperty("请求状态") + @get:Schema(title = "请求状态") val status: WebHookRequestStatus, - @ApiModelProperty("响应头") + @get:Schema(title = "响应头") val responseHeaders: Map? = null, - @ApiModelProperty("响应体") + @get:Schema(title = "响应体") val responseBody: String? = null, - @ApiModelProperty("请求耗时") + @get:Schema(title = "请求耗时") val requestDuration: Long, - @ApiModelProperty("请求时间") + @get:Schema(title = "请求时间") val requestTime: LocalDateTime, - @ApiModelProperty("错误信息") + @get:Schema(title = "错误信息") val errorMsg: String? = null ) diff --git a/src/backend/webhook/biz-webhook/src/main/kotlin/com/tencent/bkrepo/webhook/controller/UserLogController.kt b/src/backend/webhook/biz-webhook/src/main/kotlin/com/tencent/bkrepo/webhook/controller/UserLogController.kt index ac15526bf3..844493159f 100644 --- a/src/backend/webhook/biz-webhook/src/main/kotlin/com/tencent/bkrepo/webhook/controller/UserLogController.kt +++ b/src/backend/webhook/biz-webhook/src/main/kotlin/com/tencent/bkrepo/webhook/controller/UserLogController.kt @@ -34,21 +34,21 @@ import com.tencent.bkrepo.common.service.util.ResponseBuilder import com.tencent.bkrepo.webhook.pojo.ListWebHookLogOption import com.tencent.bkrepo.webhook.pojo.WebHookLog import com.tencent.bkrepo.webhook.service.LogService -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +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 import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RestController -@Api("WebHook日志管理接口") +@Tag(name = "WebHook日志管理接口") @RestController @RequestMapping("/api/log") class UserLogController( private val logService: LogService ) { - @ApiOperation("查询WebHook日志列表") + @Operation(summary = "查询WebHook日志列表") @GetMapping("/list/{webHookId}") @LogOperate(type = "WEBHOOK_LOG_LIST") fun listWebHookLog( diff --git a/src/backend/webhook/biz-webhook/src/main/kotlin/com/tencent/bkrepo/webhook/controller/UserWebHookController.kt b/src/backend/webhook/biz-webhook/src/main/kotlin/com/tencent/bkrepo/webhook/controller/UserWebHookController.kt index 150a656ee1..5f30990498 100644 --- a/src/backend/webhook/biz-webhook/src/main/kotlin/com/tencent/bkrepo/webhook/controller/UserWebHookController.kt +++ b/src/backend/webhook/biz-webhook/src/main/kotlin/com/tencent/bkrepo/webhook/controller/UserWebHookController.kt @@ -36,8 +36,8 @@ import com.tencent.bkrepo.webhook.pojo.UpdateWebHookRequest import com.tencent.bkrepo.webhook.pojo.WebHook import com.tencent.bkrepo.webhook.pojo.WebHookLog import com.tencent.bkrepo.webhook.service.WebHookService -import io.swagger.annotations.Api -import io.swagger.annotations.ApiOperation +import io.swagger.v3.oas.annotations.tags.Tag +import io.swagger.v3.oas.annotations.Operation import org.springframework.web.bind.annotation.DeleteMapping import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.PathVariable @@ -49,14 +49,14 @@ import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RequestParam import org.springframework.web.bind.annotation.RestController -@Api("WebHook管理接口") +@Tag(name = "WebHook管理接口") @RestController @RequestMapping("/api/webhook") class UserWebHookController( private val webHookService: WebHookService ) { - @ApiOperation("创建WebHook") + @Operation(summary = "创建WebHook") @PostMapping("/create") @LogOperate(type = "WEBHOOK_CREATE", desensitize = true) fun createWebHook( @@ -67,7 +67,7 @@ class UserWebHookController( return ResponseBuilder.success() } - @ApiOperation("更新WebHook") + @Operation(summary = "更新WebHook") @PutMapping("/update") @LogOperate(type = "WEBHOOK_UPDATE", desensitize = true) fun updateWebHook( @@ -78,7 +78,7 @@ class UserWebHookController( return ResponseBuilder.success() } - @ApiOperation("删除WebHook") + @Operation(summary = "删除WebHook") @DeleteMapping("/delete/{id}") @LogOperate(type = "WEBHOOK_DELETE") fun deleteWebHook( @@ -89,7 +89,7 @@ class UserWebHookController( return ResponseBuilder.success() } - @ApiOperation("查询WebHook") + @Operation(summary = "查询WebHook") @GetMapping("/{id}") fun getWebHook( @RequestAttribute userId: String, @@ -98,7 +98,7 @@ class UserWebHookController( return ResponseBuilder.success(webHookService.getWebHook(userId, id)) } - @ApiOperation("查询WebHook列表") + @Operation(summary = "查询WebHook列表") @GetMapping("/list") @LogOperate(type = "WEBHOOK_LIST") fun listWebHook( @@ -109,7 +109,7 @@ class UserWebHookController( return ResponseBuilder.success(webHookService.listWebHook(userId, associationType, associationId)) } - @ApiOperation("测试WebHook") + @Operation(summary = "测试WebHook") @PostMapping("/test/{id}") fun testWebHook( @RequestAttribute userId: String, @@ -118,7 +118,7 @@ class UserWebHookController( return ResponseBuilder.success(webHookService.testWebHook(userId, id)) } - @ApiOperation("重试WebHook请求") + @Operation(summary = "重试WebHook请求") @PostMapping("/retry/{logId}") fun retryWebHookRequest( @PathVariable logId: String