controller

Documentation

Index

• type CommonController
  • func NewCommonController(dic *di.Container, r *echo.Echo, serviceName string, serviceVersion string) *CommonController
  • func (c *CommonController) AddSecret(e echo.Context) error
  • func (c *CommonController) Config(e echo.Context) error
  • func (c *CommonController) Ping(e echo.Context) error
  • func (c *CommonController) SetCustomConfigInfo(customConfig interfaces.UpdatableConfig)
  • func (c *CommonController) SetSDKVersion(sdkVersion string)
  • func (c *CommonController) Version(e echo.Context) error

Types

type CommonController

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

CommonController controller for common REST APIs

func NewCommonController

func NewCommonController(dic *di.Container, r *echo.Echo, serviceName string, serviceVersion string) *CommonController

func (*CommonController) AddSecret

func (c *CommonController) AddSecret(e echo.Context) error

AddSecret handles the request to the /secret endpoint. Is used to add EdgeX Service exclusive secret to the Secret Store It returns a response as specified by the API swagger in the openapi directory

func (*CommonController) Config

func (c *CommonController) Config(e echo.Context) error

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

func (*CommonController) Ping

func (c *CommonController) Ping(e echo.Context) error

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

func (*CommonController) SetCustomConfigInfo

func (c *CommonController) 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 (*CommonController) SetSDKVersion

func (c *CommonController) SetSDKVersion(sdkVersion string)

SetSDKVersion sets the service's skd version

func (*CommonController) Version

func (c *CommonController) Version(e echo.Context) error

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