client

Documentation

Index

• Constants
• Variables
• type SnykAPI
  • func New(transport runtime.ClientTransport, formats strfmt.Registry) *SnykAPI
  • func NewHTTPClient(formats strfmt.Registry) *SnykAPI
  • func NewHTTPClientWithConfig(formats strfmt.Registry, cfg *TransportConfig) *SnykAPI
  • func (c *SnykAPI) SetTransport(transport runtime.ClientTransport)
• type TransportConfig
  • func DefaultTransportConfig() *TransportConfig
  • func (cfg *TransportConfig) WithBasePath(basePath string) *TransportConfig
  • func (cfg *TransportConfig) WithHost(host string) *TransportConfig
  • func (cfg *TransportConfig) WithSchemes(schemes []string) *TransportConfig

Constants

const (
	// DefaultHost is the default Host
	// found in Meta (info) section of spec file
	DefaultHost string = "api.snyk.io"
	// DefaultBasePath is the default BasePath
	// found in Meta (info) section of spec file
	DefaultBasePath string = "/rest"
)

Variables

var Default = NewHTTPClient(nil)

Default snyk API HTTP client.

var DefaultSchemes = []string{"https"}

DefaultSchemes are the default schemes found in Meta (info) section of spec file

Types

type SnykAPI

type SnykAPI struct {
	Apps apps.ClientService

	AuditLogs audit_logs.ClientService

	Collection collection.ClientService

	ContainerImage container_image.ClientService

	CustomBaseImages custom_base_images.ClientService

	IacSettings iac_settings.ClientService

	Invites invites.ClientService

	Issues issues.ClientService

	OpenAPI open_api.ClientService

	Orgs orgs.ClientService

	Projects projects.ClientService

	Sbom s_b_o_m.ClientService

	SastSettings sast_settings.ClientService

	ServiceAccounts service_accounts.ClientService

	Slack slack.ClientService

	SlackSettings slack_settings.ClientService

	Transport runtime.ClientTransport
}

SnykAPI is a client for snyk API

func New

func New(transport runtime.ClientTransport, formats strfmt.Registry) *SnykAPI

New creates a new snyk API client

func NewHTTPClient

func NewHTTPClient(formats strfmt.Registry) *SnykAPI

NewHTTPClient creates a new snyk API HTTP client.

func NewHTTPClientWithConfig

func NewHTTPClientWithConfig(formats strfmt.Registry, cfg *TransportConfig) *SnykAPI

NewHTTPClientWithConfig creates a new snyk API HTTP client, using a customizable transport config.

func (*SnykAPI) SetTransport

func (c *SnykAPI) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client and all its subresources

type TransportConfig

type TransportConfig struct {
	Host     string
	BasePath string
	Schemes  []string
}

TransportConfig contains the transport related info, found in the meta section of the spec file.

func DefaultTransportConfig

func DefaultTransportConfig() *TransportConfig

DefaultTransportConfig creates a TransportConfig with the default settings taken from the meta section of the spec file.

func (*TransportConfig) WithBasePath

func (cfg *TransportConfig) WithBasePath(basePath string) *TransportConfig

WithBasePath overrides the default basePath, provided by the meta section of the spec file.

func (*TransportConfig) WithHost

func (cfg *TransportConfig) WithHost(host string) *TransportConfig

WithHost overrides the default host, provided by the meta section of the spec file.

func (*TransportConfig) WithSchemes

func (cfg *TransportConfig) WithSchemes(schemes []string) *TransportConfig

WithSchemes overrides the default schemes, provided by the meta section of the spec file.