universal

Documentation

Index

• type Api
• type Catalogue
• type Certificate
• type Client
• type Configuration
• type Documentation
• type Policy
• type Portal

Types

type Api

type Api interface {
	Create(ctx context.Context, def *model.APIDefinitionSpec) (*model.Result, error)
	Get(ctx context.Context, id string) (*model.APIDefinitionSpec, error)
	Update(ctx context.Context, spec *model.APIDefinitionSpec) (*model.Result, error)
	Delete(ctx context.Context, id string) (*model.Result, error)
	List(ctx context.Context, options ...model.ListAPIOptions) (*model.APIDefinitionSpecList, error)
}

type Catalogue

type Catalogue interface {
	Get(ctx context.Context) (*model.APICatalogue, error)
	Create(ctx context.Context, o *model.APICatalogue) (*model.Result, error)
	Update(ctx context.Context, o *model.APICatalogue) (*model.Result, error)
}

type Certificate

type Certificate interface {
	All(ctx context.Context) ([]string, error)
	Upload(ctx context.Context, key, crt []byte) (id string, err error)
	Delete(ctx context.Context, id string) error
	// Exists returns true if a certificate with id exists
	Exists(ctx context.Context, id string) bool
}

type Client

type Client interface {
	HotReload(context.Context) error
	Api() Api
	Portal() Portal
	Certificate() Certificate
}

type Configuration

type Configuration interface {
	Get(ctx context.Context) (*model.PortalModelPortalConfig, error)
	Create(
		ctx context.Context, o *model.PortalModelPortalConfig,
	) (*model.Result, error)
	Update(
		ctx context.Context, o *model.PortalModelPortalConfig,
	) (*model.Result, error)
}

type Documentation

type Documentation interface {
	Upload(
		ctx context.Context, o *model.APIDocumentation,
	) (*model.Result, error)
	Delete(ctx context.Context, id string) (*model.Result, error)
}

type Policy

type Policy interface {
	All(ctx context.Context) ([]v1alpha1.SecurityPolicySpec, error)
	// Get returns the policy with the given id.
	Get(ctx context.Context, id string) (*v1alpha1.SecurityPolicySpec, error)
	// Create creates a new def and updates id and other fields. It is up to the
	// caller to update any fields that will be set after the policy has been
	// created for instance _id
	Create(ctx context.Context, def *v1alpha1.SecurityPolicySpec) error
	// Update this will update an existing policy
	Update(ctx context.Context, def *v1alpha1.SecurityPolicySpec) error
	// Delete deletes policy id id
	Delete(ctx context.Context, id string) error
}

type Portal

type Portal interface {
	Policy() Policy
	Documentation() Documentation
	Catalogue() Catalogue
	Configuration() Configuration
}