types

Documentation

Index

• type Action
• type ActionDef
• type ActionExecutionConfig
• type ActionType
• type ActionsCodegenRequest
• type ActionsCodegenResponse
• type CodegenExecutionConfig
• type CodegenFile
• type Common
  • func (c *Common) SetExportDefault()
• type CustomTypeDef
• type CustomTypes
• type DerivePayload
• type SDLFromRequest
• type SDLFromResponse
• type SDLPayload
• type SDLToRequest
• type SDLToResponse

Types

type Action

type Action struct {
	Name        string      `json:"name" yaml:"name"`
	Definition  ActionDef   `json:"definition" yaml:"definition"`
	Permissions yaml.Node   `json:"-" yaml:"permissions,omitempty"`
	Comment     interface{} `json:"comment,omitempty" yaml:"comment,omitempty"`
}

type ActionDef

type ActionDef struct {
	Kind                 string      `json:"kind" yaml:"kind"`
	Type                 ActionType  `json:"type" yaml:"type,omitempty"`
	Handler              string      `json:"handler" yaml:"handler"`
	Arguments            []yaml.Node `json:"arguments" yaml:"arguments,omitempty"`
	OutputType           string      `json:"output_type" yaml:"output_type,omitempty"`
	ForwardClientHeaders bool        `json:"-" yaml:"forward_client_headers,omitempty"`
	Headers              yaml.Node   `json:"-" yaml:"headers,omitempty"`
	Timeout              int         `json:"-" yaml:"timeout,omitempty"`
	RequestTransform     yaml.Node   `json:"request_transform,omitempty" yaml:"request_transform,omitempty"`
	ResponseTransform    yaml.Node   `json:"response_transform,omitempty" yaml:"response_transform,omitempty"`
}

type ActionExecutionConfig

type ActionExecutionConfig struct {
	// Kind of the action
	Kind string `json:"kind" yaml:"kind"`
	// The action's webhook URL
	HandlerWebhookBaseURL string `json:"handler_webhook_baseurl" yaml:"handler_webhook_baseurl"`
	// Config required to generate codegen
	Codegen *CodegenExecutionConfig `json:"codegen,omitempty" yaml:"codegen,omitempty"`
}

ActionExecutionConfig represents the config required for creating an action.

type ActionType

type ActionType string

const (
	// For query type
	ActionTypeQuery ActionType = "query"
	// For mutation type
	ActionTypeMutation = "mutation"
)

type ActionsCodegenRequest

type ActionsCodegenRequest struct {
	ActionName    string                  `json:"action_name" yaml:"action_name,omitempty"`
	SDL           SDLPayload              `json:"sdl" yaml:"sdl,omitempty"`
	Derive        DerivePayload           `json:"derive,omitempty"`
	CodegenConfig *CodegenExecutionConfig `json:"codegen_config" yaml:"codegen_config,omitempty"`
}

type ActionsCodegenResponse

type ActionsCodegenResponse struct {
	Files []CodegenFile `json:"codegen" yaml:"codegen,omitempty"`
}

type CodegenExecutionConfig

type CodegenExecutionConfig struct {
	// Framework to be used
	Framework string `json:"framework" yaml:"framework"`
	// OutputDir - path to the directory where generated files will be saved.
	OutputDir string `json:"output_dir" yaml:"output_dir"`
	URI       string `json:"uri,omitempty" yaml:"uri,omitempty"`
}

CodegenExecutionConfig represents the config required to generate codegen for an action.

type CodegenFile

type CodegenFile struct {
	Name    string `json:"name"`
	Content string `json:"content"`
}

type Common

type Common struct {
	Actions     []Action    `json:"actions" yaml:"actions"`
	CustomTypes CustomTypes `json:"custom_types" yaml:"custom_types"`
}

func (*Common) SetExportDefault

func (c *Common) SetExportDefault()

type CustomTypeDef

type CustomTypeDef struct {
	Name          string      `json:"name" yaml:"name"`
	Description   *string     `json:"description,omitempty" yaml:"description,omitempty"`
	Fields        []yaml.Node `json:"fields,omitempty" yaml:"fields,omitempty"`
	Values        []yaml.Node `json:"values,omitempty" yaml:"values,omitempty"`
	Relationships yaml.Node   `json:"-" yaml:"relationships,omitempty"`
}

type CustomTypes

type CustomTypes struct {
	Enums        []CustomTypeDef `json:"enums" yaml:"enums"`
	InputObjects []CustomTypeDef `json:"input_objects" yaml:"input_objects"`
	Objects      []CustomTypeDef `json:"objects" yaml:"objects"`
	Scalars      []CustomTypeDef `json:"scalars" yaml:"scalars"`
}

type DerivePayload

type DerivePayload struct {
	IntrospectionSchema hasura.IntrospectionSchema `json:"introspection_schema" yaml:"introspection_schema,omitempty"`
	Operation           string                     `json:"operation" yaml:"operation,omitempty"`
	ActionName          string                     `json:"action_name" yaml:"action_name,omitempty"`
}

DerivePayload defines the object required to derive operation

type SDLFromRequest

type SDLFromRequest struct {
	SDL SDLPayload `json:"sdl"`
}

type SDLFromResponse

type SDLFromResponse struct {
	Types   CustomTypes `json:"types"`
	Actions []Action    `json:"actions"`
}

type SDLPayload

type SDLPayload struct {
	Complete string `json:"complete"`
}

type SDLToRequest

type SDLToRequest struct {
	Types   CustomTypes   `json:"types,omitempty" yaml:"types,omitempty"`
	Actions []Action      `json:"actions,omitempty" yaml:"actions,omitempty"`
	Derive  DerivePayload `json:"derive,omitempty" yaml:"derive,omitempty"`
}

type SDLToResponse

type SDLToResponse struct {
	SDL SDLPayload `json:"sdl"`
}