Documentation
¶
Overview ¶
Package http defines the HTTP client used to interact with the Snyk Code API.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶ added in v1.0.0
type Config interface {
// Organization is the Snyk organization in which code SAST is being run.
// Permissions may be granted in the context of an organization. Reports
// are also stored in the context of an owning organization.
Organization() string
// IsFedramp indicates whether the code SAST is being run in the context of FedRAMP.
IsFedramp() bool
// SnykCodeApi returns the Snyk Code API URL configured to run against, which could be
// the one used by the Local Code Engine.
SnykCodeApi() string
}
Config defines the configurable options for the HTTP client.
type HTTPClient ¶
type HTTPClient interface {
Config() Config
DoCall(ctx context.Context,
method string,
path string,
requestBody []byte,
) (responseBody []byte, err error)
FormatCodeApiURL() (string, error)
}
func NewHTTPClient ¶
func NewHTTPClient( logger *zerolog.Logger, config Config, clientFactory func() *http.Client, instrumentor observability.Instrumentor, errorReporter observability.ErrorReporter, ) HTTPClient
Click to show internal directories.
Click to hide internal directories.