Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var IsReady = false
View Source
var OkMessage = model.SimpleMsg{}
Functions ¶
func CheckReady ¶
func CheckReady(c echo.Context) error
CheckReady func is for checking Grasshopper server health.
@ID health-check-readyz
@Summary Check Ready
@Description Check Grasshopper is ready
@Tags [Admin] System management
@Accept json
@Produce json
@Success 200 {object} model.SimpleMsg "Successfully get ready state."
@Failure 500 {object} common.ErrorResponse "Failed to check ready state."
@Router /readyz [get]
func GetPackageSoftwareMigrationLog ¶ added in v0.3.1
func GetPackageSoftwareMigrationLog(c echo.Context) error
GetPackageSoftwareMigrationLog godoc
@ID get-software-migration-log
@Summary Get Software Migration Log
@Description Get the software migration log.
@Tags [Migration] Software migration APIs
@Accept json
@Produce json
@Param executionId path string true "ID of the software migration execution."
@Success 200 {object} model.MigrationLogRes "Successfully get the software migration log"
@Failure 400 {object} common.ErrorResponse "Sent bad request."
@Failure 500 {object} common.ErrorResponse "Failed to get the software migration log"
@Router /software/package/migrate/log/{executionId} [get]
func GetSoftwareMigrationList ¶ added in v0.3.1
func GetSoftwareMigrationList(c echo.Context) error
GetSoftwareMigrationList godoc
@ID get-migration-list
@Summary Get Migration List
@Description Get software migration list.
@Tags [Migration] Software migration APIs
@Accept json
@Produce json
@Param softwareMigrateReq body softwaremodel.SourceGroupSoftwareProperty true "Refined software list."
@Success 200 {object} model.MigrationListRes "Successfully get software migration list."
@Failure 400 {object} common.ErrorResponse "Sent bad request."
@Failure 500 {object} common.ErrorResponse "Failed to get software migration list."
@Router /software/migration_list [post]
func MigrateSoftware ¶ added in v0.2.2
func MigrateSoftware(c echo.Context) error
MigrateSoftware godoc
@ID migrate-software
@Summary Migrate Software
@Description Migrate pieces of software to target.
@Tags [Migration] Software migration APIs
@Accept json
@Produce json
@Param softwareMigrateReq body model.SoftwareMigrateReq true "Software migrate request."
@Success 200 {object} model.SoftwareMigrateRes "Successfully migrated pieces of software."
@Failure 400 {object} common.ErrorResponse "Sent bad request."
@Failure 500 {object} common.ErrorResponse "Failed to migrate pieces of software."
@Router /software/migrate [post]
Types ¶
This section is empty.
Source Files
Click to show internal directories.
Click to hide internal directories.