rsapi

type API struct {
	Auth                  Authenticator         // Authenticator, signs requests for auth
	Host                  string                // API host, e.g. "us-3.rightscale.com"
	Client                httpclient.HTTPClient // Underlying http client (not used for authentication requests as these necessitate special redirect handling)
	FetchLocationResource bool                  // Whether to fetch resource pointed by Location header
	Metadata              APIMetadata           // Generated API metadata
	VersionHeader         string                // Version header name, defaults to X-Api-Version
	FileEncoding          int                   // Encoding for file uploads. 0 = mime, 1 = json
}

type APICommandRegistrar interface {
	// Register subcommands for all resource actions
	// Store subcommand parse results into given command line value recipient
	RegisterActionCommands(apiName string, metadata map[string]*metadata.Resource,
		cmdValues ActionCommands)
}

type APIMetadata map[string]*metadata.Resource

type APIParams map[string]interface{}

type ActionCommand struct {
	Href     string   // Resource or collection href
	Params   []string // Action parameters
	ShowHelp string   // Whether to list flags supported by resource action
}

type ActionCommands map[string]*ActionCommand

type Authenticator interface {
	// Sign signs the given http Request (adds the auth headers).
	Sign(req *http.Request) error
	// SetHost updates the host used by the authenticator to create sessions.
	// This method is called internally by the various API clients upon creation.
	SetHost(host string)
	// CanAuthenticate returns nil if the authenticator is able to sign requests successfully
	// or an error with additional information otherwise.
	// It makes a test request to CM 1.5 to validate the provided credentials.
	CanAuthenticate(host string) error
}

type CommandTarget struct {
	Resource *metadata.Resource   // Resource command applies to
	Action   *metadata.Action     // Action command corresponds to
	Path     *metadata.ActionPath // Action path
	Href     string               // Resource href
}

type FileUpload struct {
	Name     string    // Multipart part name
	Filename string    // Uploaded filename
	Reader   io.Reader // Backing reader
}

type ParsedCommand struct {
	HTTPMethod    string
	URI           string
	QueryParams   APIParams
	PayloadParams APIParams
}

type Registrar struct {
	// Kingpin command under which API subcommands should be registered
	APICmd *kingpin.CmdClause
}

type SourceUpload struct {
	Reader io.Reader
}