generate swagger json

Former-commit-id: c10f79046986459c3420a66a05bb3d080cfef456

api/desc/ai/pcm-ai.api

@@ -141,7 +141,7 @@ type ExportParams {
 type SearchCondition {
 	Coefficient    string       `json:"coefficient,optional" copier:"Coefficient"`
 	FrameInVideo   int64        `json:"frameInVideo,optional" copier:"FrameInVideo"`
-	Hard           string       `json:"coefficient,optional" copier:"Hard"`
+	Hard           string       `json:"hard,optional" copier:"Hard"`
 	Kvp            string       `json:"kvp,optional" copier:"Kvp"`
 	ImportOrigin   string       `json:"importOrigin,optional" copier:"ImportOrigin"`
 	LabelList      SearchLabels `json:"labelList,optional" copier:"LabelList"`
@@ -310,7 +310,7 @@ type OperatorParam {
 type (
 	ListImportTasksReq {
 		ProjectId string `path:"projectId"`
-		DatasetId string `path:"datasetId""`
+		DatasetId string `path:"datasetId"`
 		Limit     int32  `form:"limit,optional"`
 		Offset    int32  `form:"offSet,optional"`
 	/****************parmas from modelArtsType	********************/
@@ -1510,7 +1510,7 @@ type (
 		Metadatas      MetadataS      `json:"metadata,optional"`
 		AlgorithmsCtRq AlgorithmsCtRq `json:"algorithm,optional"`
 		SpecsCtRq      SpecsCtRq      `json:"spec,optional"`
-		ProjectId      string         `path:"projectId""`
+		ProjectId      string         `path:"projectId"`
 	/****************智算类型 ModelartsType parmas ********************/
 		ModelArtsType  string `json:"modelArtsType,optional"`
 	/****************parmas from octpus

api/desc/pcm.api

@@ -11,7 +11,7 @@ import (
 )
 
 info(
-	title: "type title here"
+	title: "pcm api service"
 	desc: "type desc here"
 	author: "type author here"
 	email: "type email here"
@@ -24,65 +24,83 @@ info(
 	group : core
 )
 service pcm {
+	@doc "查询P端服务列表"
 	@handler participantListHandler
 	get /core/participantList returns (participantListResp)
 
+	@doc "yaml提交任务"
 	@handler scheduleTaskByYamlHandler
 	post /core/scheduleTaskByYaml (scheduleTaskByYamlReq) returns (scheduleTaskByYamlResp)
 
+	@doc "删除任务"
 	@handler deleteTaskHandler
 	delete /core/deleteTask/:id (deleteTaskReq)
 
-	// 任务列表接口
+	@doc "查询任务列表"
 	@handler TaskListHandler
 	get /core/taskList (taskListReq)returns (taskListResp)
 
-	// 任务详情接口
+	@doc "查询任务详情"
 	@handler TaskDetailHandler
 	get /core/taskDetail/:taskId (taskDetailReq) returns (taskDetailResp)
 
+	@doc "任务概览"
 	@handler JobTotalHandler
 	get /core/jobTotal returns (jobTotalResp)
 
+	@doc "数据中心概览"
 	@handler listCenterHandler
 	get /core/listCenter returns (listCenterResp)
 
+	@doc "查询集群列表"
 	@handler listClusterHandler
 	get /core/listCluster/:centerId (listClusterReq) returns (listClusterResp)
 
+	@doc "提交任务(超算)"
 	@handler submitJobHandler
 	post /core/submitJob (submitJobReq) returns (submitJobResp)
 
+	@doc "获取region"
 	@handler getRegionHandler
 	get /core/getRegion returns (getRegionResp)
 
+	@doc "获取region列表"
 	@handler listRegionHandler
 	get /core/listRegion returns (listRegionResp)
 
+	@doc "查询算力"
 	@handler getComputingPowerHandler
 	get /core/getComputingPower returns (cpResp)
 
+	@doc "查询通用信息"
 	@handler getGeneralInfoHandler
 	get /core/getGeneralInfo returns (GiResp)
 
+	@doc "查询各域资源信息"
 	@handler listDomainResourceHandler
 	get /core/listDomainResource returns (DomainResourceResp)
 
+	@doc "查询控制面板配置信息"
 	@handler getResourcePanelConfigHandler
 	get /core/getResourcePanelConfigHandler returns (ResourcePanelConfigResp)
 
+	@doc "设置控制面板配置信息"
 	@handler putResourcePanelConfigHandler
 	put /core/resourcePanelConfigHandler (ResourcePanelConfigReq)
 
+	@doc "获取算力统计信息"
 	@handler getComputilityStatisticsHandler
 	get /core/getComputilityStatistics returns (ComputilityStatisticsResp)
 
+    @doc "获取节点资产"
 	@handler nodeAssetsHandler
 	get /core/assets returns (NodeAssetsResp)
 
+	@doc "保存hashcat"
 	@handler saveHashcatHandler
 	post /core/saveHashcat (SaveHashcatReq)
 
+	@doc "获取hashcat"
 	@handler getHashcatHandler
 	get /core/getHashcat/:crackTaskId (getHashcatHandlerReq) returns (getHashcatHandlerResp)
 }
@@ -93,12 +111,15 @@ service pcm {
 	group : hpc
 )
 service pcm {
+	@doc "超算查询任务列表"
 	@handler listJobHandler
 	get /hpc/listJob (listJobReq) returns (listJobResp)
 
+	@doc "超算查询历史任务列表"
 	@handler listHistoryJobHandler
 	get /hpc/listHistoryJob (listHistoryJobReq) returns (listHistoryJobResp)
 
+	@doc "超算查询资产列表"
 	@handler queueAssetsHandler
 	get /queue/assets returns (QueueAssetsResp)
 }
@@ -109,9 +130,11 @@ service pcm {
 	group : cloud
 )
 service pcm {
+	@doc "云算任务列表"
 	@handler cloudListHandler
 	get /task/list returns (cloudListResp)
 
+	@doc "yaml删除"
 	@handler deleteYamlHandler
 	get /cloud/DeleteYaml (ApplyReq) returns (DeleteResp)
 }
@@ -122,89 +145,122 @@ service pcm {
 	group : ai
 )
 service pcm {
+	@doc "查询数据集列表"
 	@handler listDataSetHandler
 	get /ai/listDataSet/:projectId (DataSetReq) returns (DataSetResp)
 
+	@doc "创建数据集"
 	@handler CreateDataSetHandler
 	post /ai/createDataSet/:projectId (CreateDataSetReq) returns (CreateDataSetResp)
 
+	@doc "删除数据集"
 	@handler DeleteDataSetHandler
 	delete /ai/deleteDataSet/:projectId/:datasetId (DeleteDataSetReq) returns (DeleteDataSetResp)
-	//	creat task  创建导入任务
+
+	@doc "创建导入任务"
 	@handler CreateTaskHandler
 	post /ai/CreateTask/:projectId/:datasetId (ImportTaskDataReq) returns (ImportTaskDataResp)
-	//	get taskList 查询数据集导入任务列表
+
+	@doc "查询数据集导入任务列表"
 	@handler ListImportHandler
 	get /ai/ListImport/:projectId/:datasetId (ListImportTasksReq) returns (ListImportTasksResp)
-	//	ListTrainingJobs 查询训练作业列表
+
+	@doc "查询训练作业列表"
 	@handler GetListTrainingJobsHandler
 	get /ai/GetListTrainingJobs/:projectId (ListTrainingJobsreq) returns (ListTrainingJobsresp)
-	//	DeleteTrainingJob 删除训练作业
+
+	@doc "删除训练作业"
 	@handler DeleteTrainingJobHandler
 	delete /ai/DeleteTrainingJob/:projectId/:trainingJobId (DeleteTrainingJobReq) returns (DeleteTrainingJobResp)
-	//   CreateAlgorithm 创建算法
+
+	@doc "创建算法"
 	@handler CreateAlgorithmHandler
 	post /ai/CreateAlgorithm/:projectId (CreateAlgorithmReq) returns (CreateAlgorithmResp)
-	// ListAlgorithms 查询创建算法列表
+
+	@doc "查询创建算法列表"
 	@handler ListAlgorithms
-	//get 	/ai/ListAlgorithms (ListAlgorithmsReq) returns (ListAlgorithmsResp)
 	get /ai/ListAlgorithms/:projectId (ListAlgorithmsReq) returns (ListAlgorithmsResp)
-	// DeleteAlgorithm 删除算法
+
+	@doc "删除算法"
 	@handler DeleteAlgorithm
 	delete /ai/DeleteAlgorithm/:projectId/:algorithmId (DeleteAlgorithmReq) returns (DeleteAlgorithmResp)
-	//   CreateTrainingJob 创建训练作业
+
+	@doc "创建训练作业"
 	@handler CreateTrainingJobHandler
 	post /ai/CreateTrainingJob/:projectId (CreateTrainingJobReq) returns (CreateTrainingJobResp)
-	// ShowAlgorithmByUuid 展示算法详情
+
+	@doc "展示算法详情"
 	@handler ShowAlgorithmByUuid
 	get /ai/ShowAlgorithmByUuid/:projectId/:algorithmId (ShowAlgorithmByUuidReq) returns (ShowAlgorithmByUuidResp)
 
-	//	creat export task  创建导出任务
+	@doc "创建导出任务"
 	@handler CreateExportTaskHandler
 	post /ai/CreateExportTask/:projectId/:datasetId (CreateExportTaskReq) returns (ExportTaskDataResp)
-	@handler GetExportTasksOfDatasetHandler
+
+	@doc "获取导出任务数据集"
+    @handler GetExportTasksOfDatasetHandler
 	get /ai/GetExportTasksOfDataset/:projectId/:datasetId (GetExportTasksOfDatasetReq) returns (GetExportTasksOfDatasetResp)
+
+	@doc "获取导出任务数据集状态"
 	@handler GetExportTaskStatusOfDatasetHandler
 	get /ai/GetExportTaskStatusOfDataset/:projectId/:resourceId/:taskId (GetExportTaskStatusOfDatasetReq) returns (GetExportTaskStatusOfDatasetResp)
 
-	// create processor task 创建处理任务
+	@doc "创建处理任务"
 	@handler CreateProcessorTaskHandler
 	post /ai/CreateProcessorTask (CreateProcessorTaskReq) returns (CreateProcessorTaskResp)
 
-	//	create service 创建服务
+	@doc "创建服务"
 	@handler CreateServiceHandler
 	post /ai/CreateService/:projectId (CreateServiceReq) returns (CreateServiceResp)
-	//	list services 展示服务
+
+	@doc "展示服务"
 	@handler ListServicesHandler
 	get /ai/ListServices/:projectId (ListServicesReq) returns (ListServicesResp)
-	//	Show service 展示服务详情
+
+	@doc "展示服务详情"
 	@handler ShowServiceHandler
 	get /ai/ShowService/:projectId/:serviceId (ShowServiceReq) returns (ShowServiceResp)
-	//	Delete service 删除服务
+
+	@doc "删除服务"
 	@handler DeleteServiceHandler
 	delete /ai/DeleteService/:projectId/:serviceId (DeleteServiceReq) returns (DeleteServiceResp)
-	//	ListClusters查询专属资源池列表
+
+	@doc "查询专属资源池列表"
 	@handler ListClustersHandler
 	get /ai/ListClusters (ListClustersReq) returns (ListClustersResp)
 
 	/******************Notebook Method start*************************/
+
+	@doc "查询notebook列表"
 	@handler listNotebookHandler
 	get /ai/listNotebook (ListNotebookReq) returns (ListNotebookResp)
+
+	@doc "创建notebook"
 	@handler createNotebookHandler
 	post /ai/createNotebook (CreateNotebookReq) returns (CreateNotebookResp)
+
+	@doc "启动notebook"
 	@handler startNotebookHandler
 	post /ai/startNotebook (StartNotebookReq) returns (StartNotebookResp)
+
+	@doc "停止notebook"
 	@handler stopNotebookHandler
 	post /ai/stopNotebook (StopNotebookReq) returns (StopNotebookResp)
+
+	@doc "查询notebook存储"
 	@handler getNotebookStorageHandler
 	get /ai/getNotebookStorage (GetNotebookStorageReq) returns (GetNotebookStorageResp)
+
+	@doc "挂载notebook存储"
 	@handler mountNotebookStorageHandler
 	post /ai/mountNotebookStorage (MountNotebookStorageReq) returns (MountNotebookStorageResp)
 	/******************Notebook Method end*************************/
 
 	/******************Visualization Job Method start*************************/
+	@doc "获取虚拟化任务"
 	@handler getVisualizationJobHandler
 	get /ai/getVisualizationJob (GetVisualizationJobReq) returns (GetVisualizationJobResp)
+	@doc "创建虚拟化任务"
 	@handler createVisualizationJobHandler
 	post /ai/CreateVisualizationJob (CreateVisualizationJobReq) returns (CreateVisualizationJobResp)
 	/******************Visualization Job Method start*************************/
@@ -216,10 +272,13 @@ service pcm {
 	group : storage
 )
 service pcm {
+	@doc "存储概览"
 	@handler screenStorageHandler
 	get /storage/screenStorage (StorageScreenReq) returns (StorageScreenResp)
+	@doc "日常算力查询"
 	@handler dailyPowerScreenHandler
 	get /storage/dailyPowerScreen (DailyPowerScreenReq) returns (DailyPowerScreenResp)
+	@doc "算力中心算力情况"
 	@handler perCenterComputerPowersHandler
 	get /storage/perCenterComputerPowers (PerCenterComputerPowersReq) returns (PerCenterComputerPowersResp)
 }
@@ -230,18 +289,23 @@ service pcm {
 	group : image
 )
 service pcm {
+	@doc "镜像上传"
 	@handler uploadHandler
 	post /upload
 
+	@doc "镜像分块"
 	@handler chunkHandler
 	post /chunk
 
+	@doc "查询镜像列表"
 	@handler imageListHandler
 	get /image/list returns (imageListResp)
 
+	@doc "数据集检查"
 	@handler dataSetCheckHandler
 	get /dataSet/check/:fileMd5 (checkReq) returns (checkResp)
 
+	@doc "上传数据集"
 	@handler uploadDataSetHandler
 	post /dataSet/upload
 }
@@ -252,87 +316,151 @@ service pcm {
 	group : vm
 )
 service pcm {
-	/*概览*/
+	@doc "openstack计算中心概览"
 	@handler GetComputeLimitsHandler
 	get /vm/getComputeLimits (GetComputeLimitsReq) returns (GetComputeLimitsResp)
+
+	@doc "查询卷列表"
 	@handler GetVolumeLimitsHandler
 	get /vm/getVolumeLimits (GetVolumeLimitsReq) returns (GetVolumeLimitsResp)
-	/*实例*/
+
+	@doc "查询虚拟机列表"
 	@handler ListServerHandler
 	get /vm/listServer (ListServersReq) returns (ListServersResp)
+
+	@doc "查询虚拟机详情列表"
 	@handler ListServersDetailedHandler
 	get /vm/listServersDetailed (ListServersDetailedReq) returns (ListServersDetailedResp)
+
+	@doc "删除虚拟机"
 	@handler DeleteServerHandler
 	delete /vm/deleteServer (DeleteServerReq) returns (DeleteServerResp)
+
+	@doc "创建虚拟机"
 	@handler CreateServerHandler
 	post /vm/createServer (CreateServerReq) returns (CreateServerResp)
+
+	@doc "根据ID查询虚拟机详情"
 	@handler GetServersDetailedByIdHandler
 	get /vm/getServersDetailedById (GetServersDetailedByIdReq) returns (GetServersDetailedByIdResp)
+
+	@doc "更新虚拟机"
 	@handler UpdateServerHandler
 	put /vm/updateServer (UpdateServerReq) returns (UpdateServerResp)
+
+	@doc "启动虚拟机"
 	@handler StartServerHandler
 	post /vm/startServer (StartServerReq) returns (StartServerResp)
+
+	@doc "停止虚拟机"
 	@handler StopServerHandler
 	post /vm/stopServer (StopServerReq) returns (StopServerResp)
+
+	@doc "重启虚拟机"
 	@handler RebootServerHandler
 	post /vm/rebootServer (RebootServerReq) returns (RebootServerResp)
+
+	@doc "暂停虚拟机"
 	@handler PauseServerHandler
 	post /vm/pauseServer (PauseServerReq) returns (PauseServerResp)
-	/*镜像*/
+
+	@doc "查询镜像列表"
 	@handler ListImagesHandler
 	get /vm/listImages (ListImagesReq) returns (ListImagesResp)
+
+	@doc "删除镜像"
 	@handler DeleteImageHandler
 	delete /vm/deleteImage (DeleteImageReq) returns (DeleteImageResp)
+
+	@doc "创建镜像"
 	@handler CreateImageHandler
 	post /vm/createImage (CreateImageReq) returns (CreateImageResp)
+
+	@doc "上传镜像"
 	@handler UploadImageHandler
 	put /vm/uploadImage (UploadOsImageReq) returns (UploadOsImageResp)
 
-	/*网络*/
+	@doc "查询网络列表"
 	@handler ListNetworksHandler
 	get /vm/listNetworks (ListNetworksReq) returns (ListNetworksResp)
+
+	@doc "删除网络"
 	@handler DeleteNetworkHandler
 	delete /vm/deleteNetwork (DeleteNetworkReq) returns (DeleteNetworkResp)
+
+	@doc "创建网络"
 	@handler CreateNetworkHandler
 	post /vm/createNetwork (CreateNetworkReq) returns (CreateNetworkResp)
+
+	@doc "创建子网"
 	@handler CreateSubnetHandler
 	post /vm/createSubnet (CreateSubnetReq) returns (CreateSubnetResp)
+
+	@doc "查询网络详情"
 	@handler ShowNetworkDetailsHandler
 	get /vm/showNetworkDetails (ShowNetworkDetailsReq) returns (ShowNetworkDetailsResp)
+
+	@doc "更新网络"
 	@handler UpdateNetworkHandler
 	put /vm/updateNetwork (UpdateNetworkReq) returns (UpdateNetworkResp)
+
+	@doc "批量创建网络"
 	@handler BulkCreateNetworksHandler
 	post /vm/bulkCreateNetworks (BulkCreateNetworksReq) returns (BulkCreateNetworksResp)
 
-	/*卷*/
+	@doc "查询卷详情列表"
 	@handler ListVolumesDetailHandler
 	get /vm/listVolumesDetail (ListVolumesDetailReq) returns (ListVolumesDetailResp)
+
+	@doc "删除卷"
 	@handler DeleteVolumeHandler
 	delete /vm/deleteVolume (DeleteVolumeReq) returns (DeleteVolumeResp)
+
+	@doc "创建卷"
 	@handler CreateVolumeHandler
 	post /vm/createVolume (CreateVolumeReq) returns (CreateVolumeResp)
+
+	@doc "查询规格详情列表"
 	@handler ListFlavorsDetailHandler
 	get /vm/listFlavorsDetail (ListFlavorsDetailReq) returns (ListFlavorsDetailResp)
+
+	@doc "查询规格类型列表"
 	@handler ListVolumeTypesHandler
 	get /vm/listVolumeTypes (ListVolumeTypesReq) returns (ListVolumeTypesResp)
+
+	@doc "更新卷"
 	@handler UpdateVolumeHandler
 	put /vm/updateVolume (UpdateVolumeReq) returns (UpdateVolumeResp)
+
+	@doc "创建卷类型"
 	@handler CreateVolumeTypesHandler
 	post /vm/createVolumeTypes (CreateVolumeTypeReq) returns (CreateVolumeTypeResp)
+
+	@doc "删除卷类型"
 	@handler DeleteVolumeTypeHandler
 	delete /vm/deleteVolumeType (DeleteVolumeTypeReq) returns (DeleteVolumeTypeResp)
+
+	@doc "查询卷列表"
 	@handler ListVolumesHandler
 	get /vm/listVolumes (ListVolumesReq) returns (ListVolumesResp)
+
+	@doc "根据ID获取卷详情"
 	@handler GetVolumeDetailedByIdHandler
 	get /vm/getVolumeDetailedById (GetVolumeDetailedByIdReq) returns (GetVolumeDetailedByIdResp)
 
-	// Bare Metal
+	@doc "查询节点列表"
 	@handler ListNodesHandler
 	get /vm/listNodes (ListNodesReq) returns (ListNodesResp)
+
+	@doc "创建节点"
 	@handler CreateNodeHandler
 	post /vm/createNode (CreateNodeReq) returns (CreateNodeResp)
+
+	@doc "删除节点"
 	@handler DeleteNodeHandler
 	delete /vm/deleteNode (DeleteNodeReq) returns (DeleteNodeResp)
+
+	@doc "查询节点详情"
 	@handler ShowNodeDetailsHandler
 	get  /vm/showNodeDetails (ShowNodeDetailsReq) returns (ShowNodeDetailsResp)
 }

api/desc/storage/pcm-storage.api

@@ -31,7 +31,7 @@ type (
         TrainJob string `json:"trainJob" copier:"TrainJob"`
         ComputeScale int32 `json:"computeScale" copier:"ComputeScale"`
         StorageScale int32 `json:"storageScale" copier:"StorageScale"`
-        Province string `json:"path:"province" copier:"Province"`
+        Province string `json:"path:province" copier:"Province"`
         City string `json:"city" copier:"City"`
         CoordinateX int32 `json:"coordinateX" copier:"CoordinateX"`
         CoordinateY int32 `json:"coordinateY" copier:"CoordinateY"`

api/desc/vm/pcm-vm.api

@@ -903,7 +903,7 @@ type(
         Links  []Links  `json:"links" copier:"Links"`
         Maintenance  bool  `json:"maintenance" copier:"Maintenance"`
         Name  string  `json:"name" copier:"Name"`
-        PowerState  string  `json:"name" copier:"PowerState"`
+        PowerState  string  `json:"power_state" copier:"PowerState"`
         ProvisionState  string  `json:"provision_state" copier:"ProvisionState"`
         Uuid  string  `json:"uuid" copier:"Uuid"`
     }