api

Documentation

Index

• func NewRootEndpoint(config *config.CfAPIConfig) echo.HandlerFunc
• func RegisterHandlers(echoInstance *echo.Echo, database *sql.DB, jwtMiddleware echo.MiddlewareFunc, ...)
• type Root
• type RootLinks

Functions

func NewRootEndpoint

func NewRootEndpoint(config *config.CfAPIConfig) echo.HandlerFunc

func RegisterHandlers

func RegisterHandlers(
	echoInstance *echo.Echo,
	database *sql.DB,
	jwtMiddleware echo.MiddlewareFunc,
	rateLimitMiddleware echo.MiddlewareFunc,
	conf *config.CfAPIConfig,
)

Types

type Root

type Root struct {
	Links RootLinks `json:"links"`
}

type RootLinks

type RootLinks struct {
	AppSSH            *info.Link `json:"app_ssh"`
	BitsService       *info.Link `json:"bits_service"`
	CloudControllerV2 *info.Link `json:"cloud_controller_v2"`
	CloudControllerV3 *info.Link `json:"cloud_controller_v3"`
	Credhub           *info.Link `json:"credhub"`
	LogCache          *info.Link `json:"log_cache"`
	LogStream         *info.Link `json:"log_stream"`
	Logging           *info.Link `json:"logging"`
	Login             *info.Link `json:"login"`
	NetworkPolicyV0   *info.Link `json:"network_policy_v0"`
	NetworkPolicyV1   *info.Link `json:"network_policy_v1"`
	Routing           *info.Link `json:"routing"`
	Self              *info.Link `json:"self"`
	UAA               *info.Link `json:"uaa"`
}