budgets

package

v0.0.0-...-0362a01 Latest Latest Go to latest Published: Aug 6, 2018 License: AGPL-3.0 Imports: 5 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.

This section is empty.

type BudgetResource struct {
	smolder.Resource
}

BudgetResource is the resource responsible for /budgets

func (r *BudgetResource) Get(context smolder.APIContext, request *restful.Request, response *restful.Response, params map[string][]string)

Get sends out items matching the query parameters

func (r *BudgetResource) GetAuthRequired() bool

GetAuthRequired returns true because all requests need authentication

func (r *BudgetResource) GetDoc() string

GetDoc returns the description of this API endpoint

func (r *BudgetResource) GetParams() []*restful.Parameter

GetParams returns the parameters supported by this API endpoint

func (r *BudgetResource) Register(container *restful.Container, config smolder.APIConfig, context smolder.APIContextFactory)

Register this resource with the container to setup all the routes

func (r *BudgetResource) Returns() interface{}

Returns returns the model that will be returned

type BudgetResponse struct {
	smolder.Response

	Budgets []budgetInfoResponse `json:"budgets,omitempty"`
}

BudgetResponse is the common response to 'budget' requests

func (r *BudgetResponse) EmptyResponse() interface{}

EmptyResponse returns an empty API response for this endpoint if there's no data to respond with

func (r *BudgetResponse) Init(context smolder.APIContext)

Init a new response