rest

Documentation

Index

• type Controller
  • func NewController(router *mux.Router, dic *di.Container, serviceName string) *Controller
  • func (c *Controller) AddSecret(writer http.ResponseWriter, request *http.Request)
  • func (c *Controller) Config(writer http.ResponseWriter, request *http.Request)
  • func (c *Controller) Metrics(writer http.ResponseWriter, request *http.Request)
  • func (c *Controller) Ping(writer http.ResponseWriter, request *http.Request)
  • func (c *Controller) SetCustomConfigInfo(customConfig interfaces.UpdatableConfig)
  • func (c *Controller) Version(writer http.ResponseWriter, request *http.Request)

Types

type Controller

type Controller struct {
	// contains filtered or unexported fields
}

Controller controller for V2 REST APIs

func NewController

func NewController(router *mux.Router, dic *di.Container, serviceName string) *Controller

NewController creates and initializes an Controller

func (*Controller) AddSecret

func (c *Controller) AddSecret(writer http.ResponseWriter, request *http.Request)

AddSecret handles the request to add App Service exclusive secret to the Secret Store It returns a response as specified by the V2 API swagger in openapi/v2

func (*Controller) Config

func (c *Controller) Config(writer http.ResponseWriter, request *http.Request)

Config handles the request to /config endpoint. Is used to request the service's configuration It returns a response as specified by the V2 API swagger in openapi/v2

func (*Controller) Metrics

func (c *Controller) Metrics(writer http.ResponseWriter, request *http.Request)

Metrics handles the request to the /metrics endpoint, memory and cpu utilization stats It returns a response as specified by the V2 API swagger in openapi/v2

func (*Controller) Ping

func (c *Controller) Ping(writer http.ResponseWriter, request *http.Request)

Ping handles the request to /ping endpoint. Is used to test if the service is working It returns a response as specified by the V2 API swagger in openapi/v2

func (*Controller) SetCustomConfigInfo

func (c *Controller) SetCustomConfigInfo(customConfig interfaces.UpdatableConfig)

SetCustomConfigInfo sets the custom configuration, which is used to include the service's custom config in the /config endpoint response.

func (*Controller) Version

func (c *Controller) Version(writer http.ResponseWriter, request *http.Request)

Version handles the request to /version endpoint. Is used to request the service's versions It returns a response as specified by the V2 API swagger in openapi/v2