configapi

Documentation

Index

• func CreateConfigEndpoint(r *app.Router)
• func DeleteConfigEndpoint(r *app.Router)
• func GetConfigByIDEndpoint(r *app.Router)
• func GetConfigsEndpoint(r *app.Router)
• func GetFlatConfigEndpoint(grp *app.Router)
• func ListSchemasEndpoint(grp *app.Router)
• func PatchConfigEndpoint(r *app.Router)
• func Setup(a *app.App, grp *echo.Group)
• func TestConfigEndpoint(r *app.Router)
• func UpdateConfigEndpoint(r *app.Router)
• type CreateConfigRequest
• type CreateConfigResponse
• type DeleteConfigResponse
• type GetConfigByIDResponse
• type GetConfigsResponse
• type ListSchemasResponse
• type PatchConfigRequest
• type PatchConfigResponse
• type SchemaModel
• type TestConfigRequest
• type UpdateConfigRequest
• type UpdateConfigResponse

Functions

func CreateConfigEndpoint

func CreateConfigEndpoint(r *app.Router)

func DeleteConfigEndpoint

func DeleteConfigEndpoint(r *app.Router)

func GetConfigByIDEndpoint

func GetConfigByIDEndpoint(r *app.Router)

func GetConfigsEndpoint

func GetConfigsEndpoint(r *app.Router)

func GetFlatConfigEndpoint

func GetFlatConfigEndpoint(grp *app.Router)

GetFlatConfigEndpoint provides access to the UI configuration.

func ListSchemasEndpoint

func ListSchemasEndpoint(grp *app.Router)

func PatchConfigEndpoint

func PatchConfigEndpoint(r *app.Router)

func Setup

func Setup(a *app.App, grp *echo.Group)

Setup configures all endpoints for the configapi.

func TestConfigEndpoint

func TestConfigEndpoint(r *app.Router)

func UpdateConfigEndpoint

func UpdateConfigEndpoint(r *app.Router)

Types

type CreateConfigRequest

type CreateConfigRequest struct {
	Config map[string]interface{} `json:"config"`
}

type CreateConfigResponse

type CreateConfigResponse struct {
	ID      string `json:"id"`
	Warning string `json:"warning,omitempty"`
}

type DeleteConfigResponse

type DeleteConfigResponse struct {
	ID      string `json:"id"`
	Warning string `json:"warning,omitempty"`
}

type GetConfigByIDResponse

type GetConfigByIDResponse struct {
	Config map[string]interface{} `json:"config"`
}

type GetConfigsResponse

type GetConfigsResponse struct {
	Configs map[string]map[string]interface{} `json:"configs"`
}

type ListSchemasResponse

type ListSchemasResponse struct {
	Schemas []SchemaModel `json:"schemas"`
}

type PatchConfigRequest

type PatchConfigRequest struct {
	Config map[string]interface{} `json:"config"`
}

type PatchConfigResponse

type PatchConfigResponse struct {
	ID      string `json:"id"`
	Warning string `json:"warning,omitempty"`
}

type SchemaModel

type SchemaModel struct {
	runtime.Schema
	Options []conf.OptionSpec `json:"options"`
}

type TestConfigRequest

type TestConfigRequest struct {
	Config     map[string]interface{} `json:"config"`
	TestConfig map[string]interface{} `json:"testConfig"`
}

type UpdateConfigRequest

type UpdateConfigRequest struct {
	Config map[string]interface{} `json:"config"`
}

type UpdateConfigResponse

type UpdateConfigResponse struct {
	ID      string `json:"id"`
	Warning string `json:"warning,omitempty"`
}