api

Documentation

Index

• func NewTestServiceCLICommand() *cobra.Command
• func NewTestServiceCLICommandWithClientProvider(clientProvider CLITestServiceClientProvider) *cobra.Command
• func RegisterRoutesTestService(router wrouter.Router, impl TestService, routerParams ...wrouter.RouteParam) error
• type CLIConfig
• type CLITestServiceClientProvider
  • func NewDefaultCLITestServiceClientProvider() CLITestServiceClientProvider
• type CustomObject
  • func (o CustomObject) MarshalYAML() (interface{}, error)
  • func (o *CustomObject) UnmarshalYAML(unmarshal func(interface{}) error) error
• type RidAlias
  • func (a RidAlias) MarshalText() ([]byte, error)
  • func (a RidAlias) MarshalYAML() (interface{}, error)
  • func (a RidAlias) String() string
  • func (a *RidAlias) UnmarshalText(data []byte) error
  • func (a *RidAlias) UnmarshalYAML(unmarshal func(interface{}) error) error
• type StringAlias
• type TestService
• type TestServiceCLICommand
• type TestServiceClient
  • func NewTestServiceClient(client httpclient.Client) TestServiceClient

Functions

func NewTestServiceCLICommand

func NewTestServiceCLICommand() *cobra.Command

func NewTestServiceCLICommandWithClientProvider

func NewTestServiceCLICommandWithClientProvider(clientProvider CLITestServiceClientProvider) *cobra.Command

func RegisterRoutesTestService

func RegisterRoutesTestService(router wrouter.Router, impl TestService, routerParams ...wrouter.RouteParam) error

RegisterRoutesTestService registers handlers for the TestService endpoints with a witchcraft wrouter. This should typically be called in a witchcraft server's InitFunc. impl provides an implementation of each endpoint, which can assume the request parameters have been parsed in accordance with the Conjure specification.

Types

type CLIConfig

type CLIConfig struct {
	Client httpclient.ClientConfig `yaml:",inline"`
}

type CLITestServiceClientProvider

type CLITestServiceClientProvider interface {
	Get(ctx context.Context, flags *pflag.FlagSet) (TestServiceClient, error)
}

func NewDefaultCLITestServiceClientProvider

func NewDefaultCLITestServiceClientProvider() CLITestServiceClientProvider

type CustomObject

type CustomObject struct {
	Data []byte `json:"data"`
}

func (CustomObject) MarshalYAML

func (o CustomObject) MarshalYAML() (interface{}, error)

func (*CustomObject) UnmarshalYAML

func (o *CustomObject) UnmarshalYAML(unmarshal func(interface{}) error) error

type RidAlias

type RidAlias rid.ResourceIdentifier

func (RidAlias) MarshalText

func (a RidAlias) MarshalText() ([]byte, error)

func (RidAlias) MarshalYAML

func (a RidAlias) MarshalYAML() (interface{}, error)

func (RidAlias) String

func (a RidAlias) String() string

func (*RidAlias) UnmarshalText

func (a *RidAlias) UnmarshalText(data []byte) error

func (*RidAlias) UnmarshalYAML

func (a *RidAlias) UnmarshalYAML(unmarshal func(interface{}) error) error

type StringAlias

type StringAlias string

type TestService

type TestService interface {
	Echo(ctx context.Context) error
	PathParam(ctx context.Context, paramArg string) error
	PathParamAlias(ctx context.Context, paramArg StringAlias) error
	PathParamRid(ctx context.Context, paramArg rid.ResourceIdentifier) error
	PathParamRidAlias(ctx context.Context, paramArg RidAlias) error
	Bytes(ctx context.Context) (CustomObject, error)
	Binary(ctx context.Context) (io.ReadCloser, error)
	MaybeBinary(ctx context.Context) (*io.ReadCloser, error)
	Query(ctx context.Context, queryArg *StringAlias) error
}

type TestServiceCLICommand

type TestServiceCLICommand struct {
	// contains filtered or unexported fields
}

type TestServiceClient

type TestServiceClient interface {
	Echo(ctx context.Context) error
	PathParam(ctx context.Context, paramArg string) error
	PathParamAlias(ctx context.Context, paramArg StringAlias) error
	PathParamRid(ctx context.Context, paramArg rid.ResourceIdentifier) error
	PathParamRidAlias(ctx context.Context, paramArg RidAlias) error
	Bytes(ctx context.Context) (CustomObject, error)
	Binary(ctx context.Context) (io.ReadCloser, error)
	MaybeBinary(ctx context.Context) (*io.ReadCloser, error)
	Query(ctx context.Context, queryArg *StringAlias) error
}

func NewTestServiceClient

func NewTestServiceClient(client httpclient.Client) TestServiceClient