lunny/git-lfs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

api/lifecycle: documentation tweaks

Browse Source
This commit is contained in:
Taylor Blau 2016-05-20 17:52:35 -06:00
parent c7f2cd0211
commit 1a9d2aba06
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
api/lifecycle.go
View File

@ -3,7 +3,8 @@ package api
import "net/http"
// TODO(taylor): extract interface for *http.Request; update methods.
// TODO: extract interface for *http.Request; update methods. This will be in a
// later iteration of the API client.
// A Lifecycle represents and encapsulates the behavior on an API request from
// inception to cleanup.
@ -13,7 +14,8 @@ import "net/http"
// several more fine-grained methods that are used by the client to manage the
// lifecycle of a request in a platform-agnostic fashion.
type Lifecycle interface {
// Build creates a sendable request by using the given RequestSchema.
// Build creates a sendable request by using the given RequestSchema as
// a model.
Build(req *RequestSchema) (*http.Request, error)
// Execute transforms generated request into a wrapped repsonse, (and
@ -24,7 +26,7 @@ type Lifecycle interface {
// Cleanup is called after the request has been completed and its
// response has been processed. It is meant to preform any post-request
// actions necessary, like closing or resetting the connection. If an
// error was encountered in doin this operation, it should be returned
// from this method, or otherwise nil.
// error was encountered in doing this operation, it should be returned
// from this method, otherwise nil.
Cleanup(resp Response) error
}