Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶ added in v0.1.2969
type Client struct {
Debug bool
Endpoint string
Host string
Token string
// contains filtered or unexported fields
}
A Client is an HTTP client for our GraphQL endpoint.
type Request ¶ added in v0.1.2969
type Request struct {
Query string `json:"query"`
Variables map[string]interface{} `json:"variables"`
// Header represent any request headers that will be set
// when the request is made.
Header http.Header `json:"-"`
}
Request is a GraphQL request.
func NewAuthorizedRequest ¶
NewAuthorizedRequest returns a new GraphQL request with the authorization headers set for CircleCI auth.
func NewUnauthorizedRequest ¶ added in v0.1.3397
NewUnauthorizedRequest returns a new GraphQL request without any authorization header.
type Response ¶ added in v0.1.3397
type Response struct {
Data interface{}
Errors ResponseErrorsCollection
}
Response wraps the result from our GraphQL server response including out-of-band errors and the data itself.
type ResponseError ¶ added in v0.1.3397
type ResponseError struct {
Message string
}
ResponseError represents the key-value pair of data returned by the GraphQL server to represent errors.
type ResponseErrorsCollection ¶ added in v0.1.3397
type ResponseErrorsCollection []ResponseError
ResponseErrorsCollection represents a slice of errors returned by the GraphQL server out-of-band from the actual data.
func (ResponseErrorsCollection) Error ¶ added in v0.1.3397
func (errs ResponseErrorsCollection) Error() string
Error turns a ResponseErrorsCollection into an acceptable error string that can be printed to the user.