Documentation
¶
Index ¶
Constants ¶
View Source
const ( ParamName = "name" ParamProject = "project" APIV1Prefix = "/api/v1" PathDashboard = "dashboards" PathDatasource = "datasources" PathFolder = "folders" PathGlobalDatasource = "globaldatasources" PathGlobalSecret = "globalsecrets" PathGlobalVariable = "globalvariables" PathProject = "projects" PathSecret = "secrets" PathVariable = "variables" )
Variables ¶
View Source
var ( InternalError = &PersesError{message: "internal server error"} NotFoundError = &PersesError{message: "document not found"} ConflictError = &PersesError{message: "document already exists"} BadRequestError = &PersesError{message: "bad request"} )
View Source
var ProjectResourcePathList = []string{ PathDashboard, PathDatasource, PathFolder, PathSecret, PathVariable, }
ProjectResourcePathList is containing the list of the resource path that are part of a project.
Functions ¶
func GetNameParameter ¶ added in v0.40.0
func GetProjectParameter ¶ added in v0.12.0
func HandleBadRequestError ¶ added in v0.26.0
func HandleError ¶
HandleError is translating the given error to the echoHTTPError
Types ¶
type Parameters ¶
func ExtractParameters ¶ added in v0.40.0
func ExtractParameters(ctx echo.Context) Parameters
type PersesError ¶
type PersesError struct {
// contains filtered or unexported fields
}
func (*PersesError) Error ¶
func (e *PersesError) Error() string
type Toolbox ¶
type Toolbox interface {
Create(ctx echo.Context, entity api.Entity) error
Update(ctx echo.Context, entity api.Entity) error
Delete(ctx echo.Context) error
Get(ctx echo.Context) error
List(ctx echo.Context, q databaseModel.Query) error
}
Toolbox is an interface that defines the different methods that can be used in the different endpoint of the API. This is a way to align the code of the different endpoint.
func NewToolBox ¶
func NewToolBox(service ToolboxService) Toolbox
type ToolboxService ¶
type ToolboxService interface {
Create(entity api.Entity) (interface{}, error)
Update(entity api.Entity, parameters Parameters) (interface{}, error)
Delete(parameters Parameters) error
Get(parameters Parameters) (interface{}, error)
List(q databaseModel.Query, parameters Parameters) (interface{}, error)
}
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package dependency provides different manager that will be used to instantiate the different services and daos of the API.
|
Package dependency provides different manager that will be used to instantiate the different services and daos of the API. |
Click to show internal directories.
Click to hide internal directories.