gateway

Documentation

Index

• type Api
  • func (a Api) Create(ctx context.Context, def *model.APIDefinitionSpec) (*model.Result, error)
  • func (a Api) Delete(ctx context.Context, id string) (*model.Result, error)
  • func (a Api) Get(ctx context.Context, apiID string) (*model.APIDefinitionSpec, error)
  • func (a Api) List(ctx context.Context, options ...model.ListAPIOptions) (*model.APIDefinitionSpecList, error)
  • func (a Api) Update(ctx context.Context, def *model.APIDefinitionSpec) (*model.Result, error)
• type Catalogue
  • func (Catalogue) Create(ctx context.Context, o *model.APICatalogue) (*model.Result, error)
  • func (Catalogue) Get(ctx context.Context) (*model.APICatalogue, error)
  • func (Catalogue) Update(ctx context.Context, o *model.APICatalogue) (*model.Result, error)
• type Client
  • func (c Client) Api() universal.Api
  • func (c Client) Certificate() universal.Certificate
  • func (c Client) HotReload(ctx context.Context) error
  • func (c Client) Portal() universal.Portal
• type Documentation
  • func (Documentation) Delete(ctx context.Context, id string) (*model.Result, error)
  • func (Documentation) Upload(ctx context.Context, o *model.APIDocumentation) (*model.Result, error)
• type Portal
  • func (Portal) Catalogue() universal.Catalogue
  • func (Portal) Documentation() universal.Documentation
  • func (Portal) Policy() universal.Policy
• type ResponseMsg
• type SecurityPolicy
  • func (a SecurityPolicy) All(ctx context.Context) ([]v1.SecurityPolicySpec, error)
  • func (a SecurityPolicy) Create(ctx context.Context, def *v1.SecurityPolicySpec) error
  • func (a SecurityPolicy) Delete(ctx context.Context, namespacedName string) error
  • func (a SecurityPolicy) Get(ctx context.Context, namespacedName string) (*v1.SecurityPolicySpec, error)
  • func (a SecurityPolicy) Update(ctx context.Context, def *v1.SecurityPolicySpec) error

Types

type Api

type Api struct{}

func (Api) Create

func (a Api) Create(ctx context.Context, def *model.APIDefinitionSpec) (*model.Result, error)

func (Api) Delete

func (a Api) Delete(ctx context.Context, id string) (*model.Result, error)

func (Api) Get

func (a Api) Get(ctx context.Context, apiID string) (*model.APIDefinitionSpec, error)

func (Api) List

func (a Api) List(ctx context.Context, options ...model.ListAPIOptions) (*model.APIDefinitionSpecList, error)

func (Api) Update

func (a Api) Update(ctx context.Context, def *model.APIDefinitionSpec) (*model.Result, error)

type Catalogue

type Catalogue struct{}

func (Catalogue) Create

func (Catalogue) Create(ctx context.Context, o *model.APICatalogue) (*model.Result, error)

func (Catalogue) Get

func (Catalogue) Get(ctx context.Context) (*model.APICatalogue, error)

func (Catalogue) Update

func (Catalogue) Update(ctx context.Context, o *model.APICatalogue) (*model.Result, error)

type Client

type Client struct{}

func (Client) Api

func (c Client) Api() universal.Api

func (Client) Certificate

func (c Client) Certificate() universal.Certificate

TODO: Certificate Requires implementation

func (Client) HotReload

func (c Client) HotReload(ctx context.Context) error

func (Client) Portal

func (c Client) Portal() universal.Portal

type Documentation

type Documentation struct{}

func (Documentation) Delete

func (Documentation) Delete(ctx context.Context, id string) (*model.Result, error)

func (Documentation) Upload

func (Documentation) Upload(
	ctx context.Context, o *model.APIDocumentation,
) (*model.Result, error)

type Portal

type Portal struct{}

func (Portal) Catalogue

func (Portal) Catalogue() universal.Catalogue

func (Portal) Documentation

func (Portal) Documentation() universal.Documentation

func (Portal) Policy

func (Portal) Policy() universal.Policy

type ResponseMsg

type ResponseMsg struct {
	Key     string `json:"key"`
	Status  string `json:"status"`
	Action  string `json:"action"`
	Message string `json:"message"`
}

type SecurityPolicy

type SecurityPolicy struct{}

SecurityPolicy provides api for accessing policies on the tyk gateway NOTE: The gateway doesn't provide api for security policy so this is just a placeholder and does nothing except returning universal.ErrTODO on all methods.

func (SecurityPolicy) All

func (a SecurityPolicy) All(ctx context.Context) ([]v1.SecurityPolicySpec, error)

func (SecurityPolicy) Create

func (a SecurityPolicy) Create(ctx context.Context, def *v1.SecurityPolicySpec) error

func (SecurityPolicy) Delete

func (a SecurityPolicy) Delete(ctx context.Context, namespacedName string) error

func (SecurityPolicy) Get

func (a SecurityPolicy) Get(ctx context.Context, namespacedName string) (*v1.SecurityPolicySpec, error)

func (SecurityPolicy) Update

func (a SecurityPolicy) Update(ctx context.Context, def *v1.SecurityPolicySpec) error