configapi

package

v1.3.0 Latest Latest Go to latest Published: Apr 16, 2024 License: MIT Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

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)

GetFlatConfigEndpoint provides access to the UI configuration.

func ListSchemasEndpoint(grp *app.Router)

func PatchConfigEndpoint(r *app.Router)

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

Setup configures all endpoints for the configapi.

func TestConfigEndpoint(r *app.Router)

func UpdateConfigEndpoint(r *app.Router)

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

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

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

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

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

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

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

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

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

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

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

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