Documentation
¶
Index ¶
- type DataPlane
- func (dp *DataPlane) CreateFact(c echo.Context) error
- func (dp *DataPlane) CreateFactType(c echo.Context) error
- func (dp *DataPlane) CreateScope(c echo.Context) error
- func (dp *DataPlane) Healthz(c echo.Context) error
- func (dp *DataPlane) QueryFactTypes(c echo.Context) error
- func (dp *DataPlane) QueryScopes(c echo.Context) error
- func (dp *DataPlane) ShowFact(c echo.Context) error
- func (dp *DataPlane) Start()
- func (dp *DataPlane) Stop()
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DataPlane ¶
type DataPlane struct {
Echo *echo.Echo
Logger echo.Logger
Encryptor crypto.Encryptor
Hasher crypto.Hasher
Repo repo.Repo
Enforcer repo.Enforcer
Validator *validator.Validate
}
DataPlane represents the data plane struct
func MustNewDataPlane ¶
func MustNewDataPlane() *DataPlane
MustNewDataPlane creates a new DataPlane, otherwise panic
func (*DataPlane) CreateFact ¶
CreateFact godoc @tags Fact @summary Create a fact @description create a fact @id create-fact @accept json @produce json @security ApiKeyAuth @param createFact body apimodel.CreateFact true "Create Fact Parameters" @success 200 {object} apimodel.Fact @failure 400 {object} echo.HTTPError @failure 500 {object} echo.HTTPError @router /facts [post]
func (*DataPlane) CreateFactType ¶
CreateFactType godoc @tags Fact @summary Create a fact type @description create a fact type @id create-fact-type @accept json @produce json @security ApiKeyAuth @param createFact body apimodel.CreateFactType true "Create Fact Type Parameters" @success 200 {object} apimodel.CreateFactType @failure 400 {object} echo.HTTPError @failure 500 {object} echo.HTTPError @router /fact_types [post]
func (*DataPlane) CreateScope ¶
CreateScope godoc @tags Scope @summary Create a scope @description Create a scope @id create-scope @accept json @produce json @security ApiKeyAuth @param createScope body apimodel.CreateScope true "Create Scope parameters" @success 200 {object} apimodel.Scope @failure 400 {object} echo.HTTPError @failure 500 {object} echo.HTTPError @router /scopes [post]
func (*DataPlane) Healthz ¶
Healthz godoc @tags Healthz @summary Show the health of the dataplane @description Show the health of the dataplane @id healthz @produce json @success 200 {object} apimodel.Healthz @failure 500 {object} echo.HTTPError @router /healthz [get]
func (*DataPlane) QueryFactTypes ¶
QueryFactTypes godoc @tags Fact @summary Query fact types @description Query fact types @id show-fact-types @produce json @security ApiKeyAuth @param slug query string false "Fact Type Slug" @param builtin query boolean false "Builtin Fact Type Slug" @success 200 {object} []apimodel.FactType @failure 400 {object} echo.HTTPError @failure 500 {object} echo.HTTPError @router /fact_types [get]
func (*DataPlane) QueryScopes ¶
QueryScopes godoc @tags Scope @summary Query scopes @description Query scopes @id query-scopes @produce json @security ApiKeyAuth @param custom_id query string false "get scopes by custom_id" @success 200 {object} []apimodel.Scope @failure 400 {object} echo.HTTPError @failure 404 {object} echo.HTTPError @failure 500 {object} echo.HTTPError @router /scopes [get]
func (*DataPlane) ShowFact ¶
ShowFact godoc @tags Fact @summary Show a fact @description Show a fact by ID @id show-fact-by-id @accept json @produce json @security ApiKeyAuth @param id path string true "Fact ID" @success 200 {object} apimodel.Fact @failure 400 {object} echo.HTTPError @failure 500 {object} echo.HTTPError @router /facts/{id} [get]
Source Files