Documentation
¶
Overview ¶
Package http implements the HTTP transport protocol.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var DefaultClient = NewClient(nil)
DefaultClient is the default HTTP client, which uses `http.DefaultClient`.
Functions ¶
func NewClient ¶
NewClient creates a new client with a custom net/http client. See `InstallProtocol` to install and override default http client. Unless a properly initialized client is given, it will fall back into `http.DefaultClient`.
Note that for HTTP client cannot distinguist between private repositories and unexistent repositories on GitHub. So it returns `ErrAuthorizationRequired` for both.
Types ¶
type AuthMethod ¶
type AuthMethod interface {
transport.AuthMethod
SetAuth(r *http.Request)
}
AuthMethod is concrete implementation of common.AuthMethod for HTTP services
type BasicAuth ¶
type BasicAuth struct {
Username, Password string
}
BasicAuth represent a HTTP basic auth
type Err ¶
Err is a dedicated error to return errors based on status code
func (*Err) StatusCode ¶
StatusCode returns the status code of the response
type TokenAuth ¶ added in v4.5.0
type TokenAuth struct {
Token string
}
TokenAuth implements an http.AuthMethod that can be used with http transport to authenticate with HTTP token authentication (also known as bearer authentication).
IMPORTANT: If you are looking to use OAuth tokens with popular servers (e.g. GitHub, Bitbucket, GitLab) you should use BasicAuth instead. These servers use basic HTTP authentication, with the OAuth token as user or password. Check the documentation of your git server for details.
Source Files