diff --git a/README.md b/README.md index f7efbbe..6a0e558 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ Data Manager 데이터 마이그레이션 기술의 검증을 위한 환경을 해당 가이드는 Ubuntu 22.04 대상으로 설치 및 명령어 사용방법을 작성한 가이드입니다. -* [Data Manager 기능명세서](docs/Datamanager-Function-Specification.md) +* [Data Manager API 가이드](https://m-cmp.github.io/api/?url=https://raw.githubusercontent.com/cloud-barista/mc-data-manager/main/websrc/docs/swagger.yaml) * [Data Manager 사용가이드](docs/Datamanager-Usage-Guide.md) * [Data Manager 도커가이드](docs/Datamanager-Docker-Guide.md) * [Data Manager 데모가이드](docs/Datamanager-Demo-Guide.md) diff --git a/websrc/controllers/healthCheckHandlers.go b/websrc/controllers/healthCheckHandlers.go index 33388bb..b606a68 100644 --- a/websrc/controllers/healthCheckHandlers.go +++ b/websrc/controllers/healthCheckHandlers.go @@ -29,7 +29,7 @@ import ( // @ID GetSystemReadyHandler // @Summary Get System Ready Handler // @Description Get System Ready -// @Tags [Ready] +// @Tags [Already Check System] // @Produce json // @Success 200 {object} models.BasicResponse "System is Ready" // @Failure 404 {object} models.BasicResponse "Profile Load , Failed: err" diff --git a/websrc/controllers/serivceHandlers.go b/websrc/controllers/serivceHandlers.go index 7f643f4..9059177 100644 --- a/websrc/controllers/serivceHandlers.go +++ b/websrc/controllers/serivceHandlers.go @@ -28,7 +28,7 @@ import ( // @ID DeleteServiceAndTaskAllHandler // @Summary Delete a Task // @Description Delete an All Service and Task. -// @Tags [service] +// @Tags [Service] // @Produce json // @Success 200 {object} models.BasicResponse "Successfully deleted the All Service" // @Failure 404 {object} models.BasicResponse "Clear All Task , Failed" diff --git a/websrc/docs/docs.go b/websrc/docs/docs.go index 2656b4d..4627c23 100644 --- a/websrc/docs/docs.go +++ b/websrc/docs/docs.go @@ -352,7 +352,7 @@ const docTemplate = `{ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/models.GenarateTask" + "$ref": "#/definitions/models.DataTask" } } ], @@ -540,7 +540,7 @@ const docTemplate = `{ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/models.GenarateTask" + "$ref": "#/definitions/models.DataTask" } } ], @@ -987,6 +987,33 @@ const docTemplate = `{ } } }, + "/readyZ": { + "get": { + "description": "Get System Ready", + "produces": [ + "application/json" + ], + "tags": [ + "[Already Check System]" + ], + "summary": "Get System Ready Handler", + "operationId": "GetSystemReadyHandler", + "responses": { + "200": { + "description": "System is Ready", + "schema": { + "$ref": "#/definitions/models.BasicResponse" + } + }, + "404": { + "description": "Profile Load , Failed: err", + "schema": { + "$ref": "#/definitions/models.BasicResponse" + } + } + } + } + }, "/restore": { "get": { "description": "Retrieve a list of all Tasks in the system.", @@ -1466,7 +1493,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[service]" + "[Service]" ], "summary": "Delete a Task", "operationId": "DeleteServiceAndTaskAllHandler", @@ -1724,6 +1751,23 @@ const docTemplate = `{ } } }, + "models.DataTask": { + "type": "object", + "properties": { + "dummy": { + "$ref": "#/definitions/models.GenFileParams" + }, + "operationId": { + "type": "string" + }, + "sourcePoint": { + "$ref": "#/definitions/models.ProviderConfig" + }, + "targetPoint": { + "$ref": "#/definitions/models.ProviderConfig" + } + } + }, "models.GenFileParams": { "type": "object", "properties": { diff --git a/websrc/docs/swagger.json b/websrc/docs/swagger.json index d46d8e8..01e5e92 100644 --- a/websrc/docs/swagger.json +++ b/websrc/docs/swagger.json @@ -345,7 +345,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/models.GenarateTask" + "$ref": "#/definitions/models.DataTask" } } ], @@ -533,7 +533,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/models.GenarateTask" + "$ref": "#/definitions/models.DataTask" } } ], @@ -980,6 +980,33 @@ } } }, + "/readyZ": { + "get": { + "description": "Get System Ready", + "produces": [ + "application/json" + ], + "tags": [ + "[Already Check System]" + ], + "summary": "Get System Ready Handler", + "operationId": "GetSystemReadyHandler", + "responses": { + "200": { + "description": "System is Ready", + "schema": { + "$ref": "#/definitions/models.BasicResponse" + } + }, + "404": { + "description": "Profile Load , Failed: err", + "schema": { + "$ref": "#/definitions/models.BasicResponse" + } + } + } + } + }, "/restore": { "get": { "description": "Retrieve a list of all Tasks in the system.", @@ -1459,7 +1486,7 @@ "application/json" ], "tags": [ - "[service]" + "[Service]" ], "summary": "Delete a Task", "operationId": "DeleteServiceAndTaskAllHandler", @@ -1717,6 +1744,23 @@ } } }, + "models.DataTask": { + "type": "object", + "properties": { + "dummy": { + "$ref": "#/definitions/models.GenFileParams" + }, + "operationId": { + "type": "string" + }, + "sourcePoint": { + "$ref": "#/definitions/models.ProviderConfig" + }, + "targetPoint": { + "$ref": "#/definitions/models.ProviderConfig" + } + } + }, "models.GenFileParams": { "type": "object", "properties": { diff --git a/websrc/docs/swagger.yaml b/websrc/docs/swagger.yaml index 160eb27..cf72a19 100644 --- a/websrc/docs/swagger.yaml +++ b/websrc/docs/swagger.yaml @@ -27,6 +27,17 @@ definitions: Result: type: string type: object + models.DataTask: + properties: + dummy: + $ref: '#/definitions/models.GenFileParams' + operationId: + type: string + sourcePoint: + $ref: '#/definitions/models.ProviderConfig' + targetPoint: + $ref: '#/definitions/models.ProviderConfig' + type: object models.GenFileParams: properties: checkCSV: @@ -495,7 +506,7 @@ paths: name: RequestBody required: true schema: - $ref: '#/definitions/models.GenarateTask' + $ref: '#/definitions/models.DataTask' produces: - application/json responses: @@ -619,7 +630,7 @@ paths: name: RequestBody required: true schema: - $ref: '#/definitions/models.GenarateTask' + $ref: '#/definitions/models.DataTask' produces: - application/json responses: @@ -835,6 +846,24 @@ paths: summary: Migrate data from RDBMS to RDBMS tags: - '[Migrate]' + /readyZ: + get: + description: Get System Ready + operationId: GetSystemReadyHandler + produces: + - application/json + responses: + "200": + description: System is Ready + schema: + $ref: '#/definitions/models.BasicResponse' + "404": + description: 'Profile Load , Failed: err' + schema: + $ref: '#/definitions/models.BasicResponse' + summary: Get System Ready Handler + tags: + - '[Already Check System]' /restore: get: description: Retrieve a list of all Tasks in the system. @@ -1167,7 +1196,7 @@ paths: $ref: '#/definitions/models.BasicResponse' summary: Delete a Task tags: - - '[service]' + - '[Service]' /task: get: description: Retrieve a list of all Tasks in the system.