client

Documentation

Index

• type APIInsightsClient
  • func NewAPIInsightsClient(conf *config.Config) APIInsightsClient

Types

type APIInsightsClient

type APIInsightsClient interface {
	AnalyzeAPISpec(ctx context.Context, req *model.SpecAnalysisRequest) (*model.SpecAnalysisResponse, error)

	ListServices(ctx context.Context) (model.ServiceList, error)
	GetService(ctx context.Context, id string) (*model.Service, error)
	CreateService(ctx context.Context, s *model.Service) (*model.Service, error)
	DeleteService(ctx context.Context, id string) error
	GetLatestSpec(ctx context.Context, serviceID string) (*model.Spec, error)
	GetServiceSpec(ctx context.Context, serviceID string, queries map[string]string) (*model.Spec, error)
	UploadSpec(ctx context.Context, serviceID string, spec *model.Spec) (*model.Spec, error)

	ListSpecs(ctx context.Context, serviceID string) (model.SpecList, error)
	GetSpec(ctx context.Context, serviceID, id string) (*model.Spec, error)

	ListSpecAnalyses(ctx context.Context, serviceID, specID string) (model.SpecAnalysisList, error)

	Diff(ctx context.Context, req *model.SpecDiffRequest) (*model.SpecDiff, error)

	ListAnalyzers(ctx context.Context, queries map[string]string) (model.AnalyzerList, error)
	GetAnalyzer(ctx context.Context, id string) (*model.Analyzer, error)

	ListAnalyzerRules(ctx context.Context, analyzerID string, queries map[string]string) (model.AnalyzerRuleList, error)
	GetAnalyzerRule(ctx context.Context, analyzerID string, id string) (*model.AnalyzerRule, error)
	ImportAnalyzerRules(ctx context.Context, analyzerID string, ars []*model.AnalyzerRule) error
}

func NewAPIInsightsClient

func NewAPIInsightsClient(conf *config.Config) APIInsightsClient

NewAPIInsightsClient creates a new client for API Insights service.