api

Documentation

Overview

Copyright (c) 2015, Alberto Corsín Lafuente All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Index

• func AddResource(w http.ResponseWriter, r *http.Request)
• func DeleteResource(w http.ResponseWriter, r *http.Request)
• func GetResource(w http.ResponseWriter, r *http.Request)
• func GetResources(w http.ResponseWriter, r *http.Request)
• func PatchResource(w http.ResponseWriter, r *http.Request)
• func ResourceOptions(w http.ResponseWriter, r *http.Request)
• func UpdateResource(w http.ResponseWriter, r *http.Request)
• type Resource

Functions

func AddResource

func AddResource(w http.ResponseWriter, r *http.Request)

AddResource creates a new resource owned by the current user

func DeleteResource

func DeleteResource(w http.ResponseWriter, r *http.Request)

DeleteResource deletes a given resource owned by the current user

func GetResource

func GetResource(w http.ResponseWriter, r *http.Request)

GetResource retrieves a resource owned by the current user given its resource Id.

func GetResources

func GetResources(w http.ResponseWriter, r *http.Request)

GetResources retrieves all resources for the current logged user

func PatchResource

func PatchResource(w http.ResponseWriter, r *http.Request)

PatchResource allows partial updates of a given resource owned by the current user

func ResourceOptions

func ResourceOptions(w http.ResponseWriter, r *http.Request)

ResourceOptions returns the Access-Control tier headers for this API resource

func UpdateResource

func UpdateResource(w http.ResponseWriter, r *http.Request)

UpdateResource allows to full update a record in the database

Types

type Resource

type Resource struct {
	Id   string `json:"-"`
	Href string `json:"href,omitempty"`
}