api

package

v0.0.0-...-5a6b2d2 Latest Latest Go to latest Published: Dec 11, 2023 License: Apache-2.0 Imports: 10 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func TenantIDInterceptor(ctx context.Context, req *http.Request) error

TenantIDInterceptor is a client intercept that try to inject tenant id into request header. only support string and int type.

type File struct {
	*file.APIClient
	// contains filtered or unexported fields
}

func NewFile() *File

func (f *File) Apply(sdk *SDK, cnf *conf.Configuration) error

type Msg struct {
	*msg.APIClient
	// contains filtered or unexported fields
}

func NewMsg() *Msg

func (f *Msg) Apply(sdk *SDK, cnf *conf.Configuration) error

type Plugin interface {
	Apply(*SDK, *conf.Configuration) error
}

Plugin is the knockout service client plugin interface.

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

SDK is the knockout service client SDK.

func NewSDK(cnf *conf.Configuration) (sdk *SDK, err error)

NewSDK creates a new SDK.

func (sdk *SDK) File() *File

File returns the file plugin.

func (sdk *SDK) GetPlugin(name string) (Plugin, bool)

GetPlugin returns a plugin by name.

func (sdk *SDK) Msg() *Msg

Msg returns the msg plugin.

func (sdk *SDK) RegisterPlugin(name string, cnf *conf.Configuration) error

RegisterPlugin registers a plugin. Plugins are used to extend the SDK.

Path	Synopsis
file
msg