api

Documentation

Overview

api provides common functionality for all the iron.io APIs

Index

• Variables
• func DumpRequest(req *http.Request)
• func DumpResponse(response *http.Response)
• type HTTPResponseError
  • func ResponseAsError(response *http.Response) HTTPResponseError
• type URL
  • func Action(cs config.Settings, prefix string, suffix ...string) *URL
  • func ActionEndpoint(cs config.Settings, endpoint string) *URL
  • func VersionAction(cs config.Settings) *URL
  • func (u *URL) QueryAdd(key string, format string, value interface{}) *URL
  • func (u *URL) Req(method string, in, out interface{}) (err error)
  • func (u *URL) Request(method string, body io.Reader) (response *http.Response, err error)

Variables

var HTTPErrorDescriptions = map[int]string{
	http.StatusUnauthorized:     "The OAuth token is either not provided or invalid",
	http.StatusNotFound:         "The resource, project, or endpoint being requested doesn't exist.",
	http.StatusMethodNotAllowed: "This endpoint doesn't support that particular verb",
	http.StatusNotAcceptable:    "Required fields are missing",
}

var (

	// HttpClient is the client used by iron_go to make each http request. It is exported in case
	// the client would like to modify it from the default behavior from http.DefaultClient.
	HttpClient = &http.Client{}
)

var MaxRequestRetries = 5

Functions

func DumpRequest

func DumpRequest(req *http.Request)

func DumpResponse

func DumpResponse(response *http.Response)

Types

type HTTPResponseError

type HTTPResponseError interface {
	Error() string
	Response() *http.Response
}

func ResponseAsError

func ResponseAsError(response *http.Response) HTTPResponseError

type URL

type URL struct {
	URL      url.URL
	Settings config.Settings
}

func Action

func Action(cs config.Settings, prefix string, suffix ...string) *URL

func ActionEndpoint

func ActionEndpoint(cs config.Settings, endpoint string) *URL

func VersionAction

func VersionAction(cs config.Settings) *URL

func (*URL) QueryAdd

func (u *URL) QueryAdd(key string, format string, value interface{}) *URL

func (*URL) Req

func (u *URL) Req(method string, in, out interface{}) (err error)

func (*URL) Request

func (u *URL) Request(method string, body io.Reader) (response *http.Response, err error)