servicecatalogroutes

Documentation

Index

• Constants
• func SetUpCatalogSwagger(rg *gin.RouterGroup, apiStaticFS http.FileSystem, ...)
• func SetUpHealthCheck(server *gin.Engine)
• func SetUpSwagger(rg *gin.RouterGroup, apiStaticFS http.FileSystem)
• func SetupDeployedModelRoute(rg *gin.RouterGroup, getter GetDeployedModelFunc)
• type DeployedModelHandler
  • func (t *DeployedModelHandler) Handle(c *gin.Context)
• type DeployedModelHandlerParams
• type GetDeployedModelFunc

Constants

const GetDeployedModelInfoURL = "/model-info/:id"

const (
	HealthCheckURL = "/health"
)

Functions

func SetUpCatalogSwagger

func SetUpCatalogSwagger(rg *gin.RouterGroup, apiStaticFS http.FileSystem, reader swagger.DefinitionReader)

SetUpCatalogSwagger serves swagger documentation that combine all deployed models on a single page

func SetUpHealthCheck

func SetUpHealthCheck(server *gin.Engine)

func SetUpSwagger

func SetUpSwagger(rg *gin.RouterGroup, apiStaticFS http.FileSystem)

func SetupDeployedModelRoute

func SetupDeployedModelRoute(rg *gin.RouterGroup, getter GetDeployedModelFunc)

@Summary Get info about deployed model @Description Get info about deployed model @Name id @Accept json @Produce json @Param id path string true "ModelDeployment ID" @Success 200 {object} model.DeployedModel @Failure 404 {object} httputil.HTTPResult @Failure 400 {object} httputil.HTTPResult @Router /service-catalog/model-info/{id} [get]

Types

type DeployedModelHandler

type DeployedModelHandler struct {
	GetDeployedModel GetDeployedModelFunc
}

func (*DeployedModelHandler) Handle

func (t *DeployedModelHandler) Handle(c *gin.Context)

type DeployedModelHandlerParams

type DeployedModelHandlerParams struct {
	ID string `uri:"id" binding:"required"`
}

type GetDeployedModelFunc

type GetDeployedModelFunc func(deploymentID string) (model_types.DeployedModel, error)