api

package

v0.2.1 Latest Latest Go to latest Published: Nov 5, 2017 License: MIT Imports: 17 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

Repository

github.com/andrexus/cloud-initer

Links

Open Source Insights

Documentation ¶

Index ¶

type API
- func NewAPI(config *conf.Configuration, db *bolt.DB) *API
type APIListResponse
type APIResponse
- func NewAPIResponseFromValidationError(errors validator.ValidationErrors) *APIResponse
type CustomValidator
- func (cv *CustomValidator) Validate(i interface{}) error
type ErrorResponseItem

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type API ¶

type API struct {
	// contains filtered or unexported fields
}

API is the data holder for the API

func NewAPI ¶

func NewAPI(config *conf.Configuration, db *bolt.DB) *API

NewAPI will create an api instance that is ready to start

func (*API) EnvironmentGet ¶ added in v0.2.0

func (api *API) EnvironmentGet(ctx echo.Context) error

func (*API) EnvironmentUpdate ¶ added in v0.2.0

func (api *API) EnvironmentUpdate(ctx echo.Context) error

func (*API) InstanceCreate ¶

func (api *API) InstanceCreate(ctx echo.Context) error

func (*API) InstanceDelete ¶

func (api *API) InstanceDelete(ctx echo.Context) error

func (*API) InstanceGet ¶

func (api *API) InstanceGet(ctx echo.Context) error

func (*API) InstanceList ¶

func (api *API) InstanceList(ctx echo.Context) error

func (*API) InstanceUpdate ¶

func (api *API) InstanceUpdate(ctx echo.Context) error

func (*API) MetaData ¶

func (api *API) MetaData(ctx echo.Context) error

func (*API) Preview ¶ added in v0.2.0

func (api *API) Preview(ctx echo.Context) error

func (*API) Start ¶

func (api *API) Start() error

Start will start the API on the specified port

func (*API) Stop ¶

func (api *API) Stop() error

Stop will shutdown the engine internally

func (*API) UserData ¶

func (api *API) UserData(ctx echo.Context) error

type APIListResponse ¶

type APIListResponse struct {
	Page     int         `json:"page"`
	PageSize int         `json:"pageSize"`
	Total    int         `json:"total"`
	Items    interface{} `json:"items"`
}

type APIResponse ¶

type APIResponse struct {
	Status  enums.APIResponseStatus `json:"status"`
	Message string                  `json:"message"`
	Errors  []ErrorResponseItem     `json:"errors,omitempty"`
}

func NewAPIResponseFromValidationError ¶ added in v0.1.3

func NewAPIResponseFromValidationError(errors validator.ValidationErrors) *APIResponse

type CustomValidator ¶ added in v0.1.3

type CustomValidator struct {
	// contains filtered or unexported fields
}

func (*CustomValidator) Validate ¶ added in v0.1.3

func (cv *CustomValidator) Validate(i interface{}) error

type ErrorResponseItem ¶ added in v0.1.3

type ErrorResponseItem struct {
	Field   string `json:"field,omitempty"`
	Message string `json:"message"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL