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 Cert
  • func (c Cert) All(ctx context.Context) ([]string, error)
  • func (c Cert) Delete(ctx context.Context, id string) error
  • func (c Cert) Exists(ctx context.Context, id string) bool
  • func (c Cert) Upload(ctx context.Context, key, crt []byte) (id string, err error)
• type CertResponse
• type CertificateList
• 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 Configuration
  • func (Configuration) Create(ctx context.Context, o *model.PortalModelPortalConfig) (*model.Result, error)
  • func (Configuration) Get(ctx context.Context) (*model.PortalModelPortalConfig, error)
  • func (Configuration) Update(ctx context.Context, o *model.PortalModelPortalConfig) (*model.Result, error)
• 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 PoliciesResponse
• type Portal
  • func (Portal) Catalogue() universal.Catalogue
  • func (Portal) Configuration() universal.Configuration
  • 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, id string) error
  • func (a SecurityPolicy) Get(ctx context.Context, id 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 Cert

type Cert struct{}

func (Cert) All

func (c Cert) All(ctx context.Context) ([]string, error)

All returns a list of all certificates ID's

func (Cert) Delete

func (c Cert) Delete(ctx context.Context, id string) error

func (Cert) Exists

func (c Cert) Exists(ctx context.Context, id string) bool

func (Cert) Upload

func (c Cert) Upload(ctx context.Context, key, crt []byte) (id string, err error)

type CertResponse

type CertResponse struct {
	Id      string `json:"id"`
	Message string `json:"message"`
	Status  string `json:"status"`
}

type CertificateList

type CertificateList struct {
	CertIDs []string `json:"certs"`
}

type Client

type Client struct{}

func (Client) Api

func (c Client) Api() universal.Api

func (Client) Certificate

func (c Client) Certificate() universal.Certificate

func (Client) HotReload

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

func (Client) Portal

func (c Client) Portal() universal.Portal

type Configuration

type Configuration struct{}

func (Configuration) Create

func (Configuration) Create(
	ctx context.Context, o *model.PortalModelPortalConfig,
) (*model.Result, error)

func (Configuration) Get

func (Configuration) Get(ctx context.Context) (*model.PortalModelPortalConfig, error)

func (Configuration) Update

func (Configuration) Update(
	ctx context.Context, o *model.PortalModelPortalConfig,
) (*model.Result, error)

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 PoliciesResponse

type PoliciesResponse struct {
	Policies []v1.SecurityPolicySpec `json:"data"`
	Pages    int                     `json:"pages"`
}

type Portal

type Portal struct{}

func (Portal) Catalogue

func (Portal) Catalogue() universal.Catalogue

func (Portal) Configuration

func (Portal) Configuration() universal.Configuration

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

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, id string) error

func (SecurityPolicy) Get

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

func (SecurityPolicy) Update

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