handlers

Documentation

Index

• func GeospatialData(fs *filestore.FileStore) echo.HandlerFunc
• func Index(fs *filestore.FileStore) echo.HandlerFunc
• func IsAModel(fs *filestore.FileStore) echo.HandlerFunc
• func IsGeospatial(fs *filestore.FileStore) echo.HandlerFunc
• func ModelType(fs *filestore.FileStore) echo.HandlerFunc
• func ModelVersion(fs *filestore.FileStore) echo.HandlerFunc
• func Ping(fs *filestore.FileStore) echo.HandlerFunc
• type SimpleResponse

Functions

func GeospatialData

func GeospatialData(fs *filestore.FileStore) echo.HandlerFunc

GeospatialData godoc @Summary Extract geospatial data @Description Extract geospatial data from a HMS model given an s3 key @Tags MCAT @Accept json @Produce json @Param definition_file query string true "/models/hms/Truckee_River/Truckee_River.hms" @Success 200 {object} interface{} @Failure 500 {object} SimpleResponse @Router /geospatialdata [get]

func Index

func Index(fs *filestore.FileStore) echo.HandlerFunc

Index godoc @Summary Index a HMS model @Description Extract metadata from a HMS model given an s3 key @Tags MCAT @Accept json @Produce json @Param definition_file query string true "/models/hms/Truckee_River/Truckee_River.hms" @Success 200 {object} hms.Model @Failure 500 {object} SimpleResponse @Router /index [get]

func IsAModel

func IsAModel(fs *filestore.FileStore) echo.HandlerFunc

IsAModel godoc @Summary Check if the given key is a HMS model @Description Check if the given key is a HMS model @Tags MCAT @Accept json @Produce json @Param definition_file query string true "/models/hms/Truckee_River/Truckee_River.hms" @Success 200 {object} bool @Router /isamodel [get]

func IsGeospatial

func IsGeospatial(fs *filestore.FileStore) echo.HandlerFunc

IsGeospatial godoc @Summary Check if the HMS model has geospatial information @Description Check if the HMS model has geospatial information @Tags MCAT @Accept json @Produce json @Param definition_file query string true "/models/hms/Truckee_River/Truckee_River.hms" @Success 200 {object} bool @Router /isgeospatial [get]

func ModelType

func ModelType(fs *filestore.FileStore) echo.HandlerFunc

ModelType godoc @Summary Extract the model type @Description Extract the model type given an s3 key @Tags MCAT @Accept json @Produce json @Param definition_file query string true "/models/hms/Truckee_River/Truckee_River.hms" @Success 200 {string} string "HMS" @Failure 500 {object} SimpleResponse @Router /modeltype [get]

func ModelVersion

func ModelVersion(fs *filestore.FileStore) echo.HandlerFunc

ModelVersion godoc @Summary Extract the HMS model version @Description Extract the HMS model version given an s3 key @Tags MCAT @Accept json @Produce json @Param definition_file query string true "/models/hms/Truckee_River/Truckee_River.hms" @Success 200 {string} string "4.0" @Failure 500 {object} SimpleResponse @Router /modelversion [get]

func Ping

func Ping(fs *filestore.FileStore) echo.HandlerFunc

Ping godoc @Summary Status Check @Description Check which services are operational @Tags Health Check @Accept json @Produce json @Success 200 {object} SimpleResponse @Router /ping [get]

Types

type SimpleResponse

type SimpleResponse struct {
	Status  int
	Message string
}