README
¶
Go API Client for WeDeploy Project 
To install:
go get -u github.com/wedeploy/wedeploy-sdk-go
Contributing
You can get the latest wedeploy-sdk-go source code with go get -u github.com/wedeploy/wedeploy-sdk-go
In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Integration tests should be written as well.
The master branch of this repository on GitHub is protected:
- force-push is disabled
- tests MUST pass on Travis before merging changes to master
- branches MUST be up to date with master before merging
Keep your commits neat. Try to always rebase your changes before publishing them.
goreportcard can be used online or locally to detect defects and static analysis results from tools such as go vet, go lint, gocyclo, and more. Run errcheck to fix ignored error returns.
Using go test and go cover are essential to make sure your code is covered with unit tests.
License
BSD-3-Clause, © Liferay, Inc.
Documentation
¶
Index ¶
- Variables
- type HTTPClient
- type StatusError
- type WeDeploy
- func (w *WeDeploy) Aggregate(ai ...interface{}) *WeDeploy
- func (w *WeDeploy) Auth(args ...string) *WeDeploy
- func (w *WeDeploy) Body(body io.Reader) *WeDeploy
- func (w *WeDeploy) Context() context.Context
- func (w *WeDeploy) Count() *WeDeploy
- func (w *WeDeploy) DecodeJSON(class interface{}) (err error)
- func (w *WeDeploy) Delete() error
- func (w *WeDeploy) Filter(ai ...interface{}) *WeDeploy
- func (w *WeDeploy) Form(key, value string) *WeDeploy
- func (w *WeDeploy) Get() error
- func (w *WeDeploy) Head() error
- func (w *WeDeploy) Header(key, value string) *WeDeploy
- func (w *WeDeploy) Highlight(field string) *WeDeploy
- func (w *WeDeploy) Limit(limit int) *WeDeploy
- func (w *WeDeploy) Offset(offset int) *WeDeploy
- func (w *WeDeploy) Param(key, value string) *WeDeploy
- func (w *WeDeploy) Params() url.Values
- func (w *WeDeploy) Patch() error
- func (w *WeDeploy) Path(paths ...string) *WeDeploy
- func (w *WeDeploy) Post() error
- func (w *WeDeploy) Put() error
- func (w *WeDeploy) SetContext(ctx context.Context)
- func (w *WeDeploy) Sort(field string, direction ...string) *WeDeploy
- func (w *WeDeploy) Timeout(timeout time.Duration)
Constants ¶
This section is empty.
Variables ¶
var ( // Version of Go API Client for WeDeploy Project Version = "master" // UserAgent of the WeDeploy wedeploy-sdk-go client UserAgent = "WeDeploy/" + Version + " (+https://wedeploy.com)" )
Functions ¶
This section is empty.
Types ¶
type HTTPClient ¶
type HTTPClient struct {
// contains filtered or unexported fields
}
HTTPClient of the library
func NewHTTPClient ¶
func NewHTTPClient() *HTTPClient
NewHTTPClient to use an alternative HTTP Client
func (*HTTPClient) SetHTTP ¶
func (h *HTTPClient) SetHTTP(hc *http.Client)
SetHTTP sets the default HTTP Client to use
type StatusError ¶
type StatusError struct {
Code int
}
StatusError is used for HTTP status code >= 400
func (StatusError) Error ¶
func (s StatusError) Error() string
type WeDeploy ¶
type WeDeploy struct {
ID int
URL string
Time time.Time
Query *query.Builder
FormValues *url.Values
Headers http.Header
RequestBody io.Reader
Request *http.Request
Response *http.Response
// contains filtered or unexported fields
}
WeDeploy is the structure for a WeDeploy query
func (*WeDeploy) DecodeJSON ¶
DecodeJSON decodes a JSON response
func (*WeDeploy) Param ¶
Param sets a query string param to the Request URL Check TestParamParsingErrorSilentFailure if you find unexpected result
func (*WeDeploy) Params ¶
Params gets the params from the Request URL Check TestParamsParsingErrorSilentFailure if you find unexpected result
func (*WeDeploy) SetContext ¶
SetContext for the request
Source Files
Directories