Documentation
¶
Index ¶
- type CodeResource
- func (r *CodeResource) Get(context smolder.APIContext, request *restful.Request, ...)
- func (r *CodeResource) GetAuthRequired() bool
- func (r *CodeResource) GetByIDs(context smolder.APIContext, request *restful.Request, ...)
- func (r *CodeResource) GetByIDsAuthRequired() bool
- func (r *CodeResource) GetDoc() string
- func (r *CodeResource) GetParams() []*restful.Parameter
- func (r *CodeResource) Register(container *restful.Container, config smolder.APIConfig, ...)
- func (r *CodeResource) Returns() interface{}
- type CodeResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CodeResource ¶
CodeResource is the resource responsible for /codes
func (*CodeResource) Get ¶
func (r *CodeResource) Get(context smolder.APIContext, request *restful.Request, response *restful.Response, params map[string][]string)
Get sends out items matching the query parameters
func (*CodeResource) GetAuthRequired ¶
func (r *CodeResource) GetAuthRequired() bool
GetAuthRequired returns true because all requests need authentication
func (*CodeResource) GetByIDs ¶
func (r *CodeResource) GetByIDs(context smolder.APIContext, request *restful.Request, response *restful.Response, ids []string)
GetByIDs sends out all items matching a set of IDs
func (*CodeResource) GetByIDsAuthRequired ¶
func (r *CodeResource) GetByIDsAuthRequired() bool
GetByIDsAuthRequired returns true because all requests need authentication
func (*CodeResource) GetDoc ¶
func (r *CodeResource) GetDoc() string
GetDoc returns the description of this API endpoint
func (*CodeResource) GetParams ¶
func (r *CodeResource) GetParams() []*restful.Parameter
GetParams returns the parameters supported by this API endpoint
func (*CodeResource) Register ¶
func (r *CodeResource) Register(container *restful.Container, config smolder.APIConfig, context smolder.APIContextFactory)
Register this resource with the container to setup all the routes
func (*CodeResource) Returns ¶
func (r *CodeResource) Returns() interface{}
Returns returns the model that will be returned
type CodeResponse ¶
type CodeResponse struct {
smolder.Response
Codes []codeInfoResponse `json:"codes,omitempty"`
Budgets []budgets.BudgetInfoResponse `json:"budgets,omitempty"`
Projects []projects.ProjectInfoResponse `json:"projects,omitempty"`
// contains filtered or unexported fields
}
CodeResponse is the common response to 'code' requests
func (*CodeResponse) AddBudget ¶
func (r *CodeResponse) AddBudget(budget *db.Budget)
AddBudget adds a budget to the response
func (*CodeResponse) AddCode ¶
func (r *CodeResponse) AddCode(code *db.Code)
AddCode adds a code to the response
func (*CodeResponse) EmptyResponse ¶
func (r *CodeResponse) EmptyResponse() interface{}
EmptyResponse returns an empty API response for this endpoint if there's no data to respond with
func (*CodeResponse) Init ¶
func (r *CodeResponse) Init(context smolder.APIContext)
Init a new response
Source Files