Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ControlPlane ¶
type ControlPlane struct {
Echo *echo.Echo
Logger echo.Logger
Encryptor crypto.Encryptor
Hasher crypto.Hasher
Repo repo.Repo
Enforcer repo.Enforcer
Validator *validator.Validate
}
ControlPlane is the control plane for OPV
func MustNewControlPlane ¶
func MustNewControlPlane() *ControlPlane
MustNewControlPlane creates a new control plane
func (*ControlPlane) CreateGrant ¶
func (cp *ControlPlane) CreateGrant(c echo.Context) error
CreateGrant is the endpoint for creating a new grant @tags Grant @summary Create a grant @description Create a grant @id create-grant @accept json @produce json @param createGrant body apimodel.CreateGrant true "Create Grant parameters" @success 200 {object} apimodel.Grant @failure 400 {object} echo.HTTPError @failure 500 {object} echo.HTTPError @router /grants [post]
func (*ControlPlane) Healthz ¶
func (cp *ControlPlane) Healthz(c echo.Context) error
Healthz godoc @tags Healthz @summary Show the health of the controlplane @description Show the health of the controlplane @id healthz @produce json @success 200 {object} apimodel.Healthz @failure 500 {object} echo.HTTPError @router /healthz [get]
func (*ControlPlane) QueryAPIAudits ¶
func (cp *ControlPlane) QueryAPIAudits(c echo.Context) error
QueryAPIAudits is the endpoint for querying a list of api audit logs @tags Audit @summary Query API Audits @description Query API Audits @id query-api-audits @accept json @produce json @param domain query string false "Domain" @param plane query string false "Plane" @param http_path query string false "HTTP Path" @param http_method query string false "HTTP Method" @param sent_http_status query int false "Sent HTTP Status" @param limit query int false "Limit" @param offset query int false "Offset" @param order_by query string false "Order By" @param order_desc query bool false "Order Desc" @success 200 {object} []apimodel.APIAudit @failure 400 {object} echo.HTTPError @failure 500 {object} echo.HTTPError @router /api_audits [get]
func (*ControlPlane) Stop ¶
func (cp *ControlPlane) Stop()
Stop will wait for the signal and gracefully shuts down the control plane.
Source Files