protocol

Documentation

Index

• type Data
• type GQLBatchRequest
• type GQLBatchResponse
• type GQLError
  • func (e *GQLError) Error() string
  • func (e *GQLError) RawMessage() string
• type GQLRequest
• type GQLResponse
• type Meta
• type UserFacingError
  • func (e *UserFacingError) Error() string

Types

type Data

type Data struct {
	Result json.RawMessage `json:"result"`
}

type GQLBatchRequest

type GQLBatchRequest struct {
	Batch       []GQLRequest `json:"batch"`
	Transaction bool         `json:"transaction"`
}

GQLBatchRequest is the payload for GraphQL queries

type GQLBatchResponse

type GQLBatchResponse struct {
	Errors []GQLError    `json:"errors"`
	Result []GQLResponse `json:"batchResult"`
}

type GQLError

type GQLError struct {
	Message         string           `json:"error"`
	UserFacingError *UserFacingError `json:"user_facing_error"`
	Path            []string         `json:"path"`
}

GQLError is a GraphQL Message

func (*GQLError) Error

func (e *GQLError) Error() string

func (*GQLError) RawMessage

func (e *GQLError) RawMessage() string

type GQLRequest

type GQLRequest struct {
	Query     string                 `json:"query"`
	Variables map[string]interface{} `json:"variables"`
}

GQLRequest is the payload for GraphQL queries

type GQLResponse

type GQLResponse struct {
	Data       Data                   `json:"data"`
	Errors     []GQLError             `json:"errors"`
	Extensions map[string]interface{} `json:"extensions"`
}

GQLResponse is the default GraphQL response

type Meta

type Meta struct {
	Target interface{} `json:"target"` // can be of type []string or string
}

type UserFacingError

type UserFacingError struct {
	IsPanic   bool   `json:"is_panic"`
	Message   string `json:"message"`
	Meta      Meta   `json:"meta"`
	ErrorCode string `json:"error_code"`
}

func (*UserFacingError) Error

func (e *UserFacingError) Error() string