Documentation
¶
Index ¶
- Constants
- Variables
- type OpenSSFScorecardAPI
- type TransportConfig
- func (cfg *TransportConfig) WithBasePath(basePath string) *TransportConfig
- func (cfg *TransportConfig) WithConsumers(consumers map[string]runtime.Consumer) *TransportConfig
- func (cfg *TransportConfig) WithHost(host string) *TransportConfig
- func (cfg *TransportConfig) WithProducers(producers map[string]runtime.Producer) *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.scorecard.dev" // DefaultBasePath is the default BasePath found in Meta (info) section of spec file. DefaultBasePath string = "/" )
Variables ¶
var Default = NewHTTPClient(nil)
Default open SSF scorecard API HTTP client.
var DefaultSchemes = []string{"https"}
DefaultSchemes are the default schemes found in Meta (info) section of spec file.
Functions ¶
This section is empty.
Types ¶
type OpenSSFScorecardAPI ¶
type OpenSSFScorecardAPI struct {
Badge badge.ClientService
Results results.ClientService
Version version.ClientService
Transport runtime.ContextualTransport
}
OpenSSFScorecardAPI is a client for open SSF scorecard API.
func New ¶
func New(transport runtime.ContextualTransport, formats strfmt.Registry) *OpenSSFScorecardAPI
New creates a new open SSF scorecard API client.
func NewHTTPClient ¶
func NewHTTPClient(formats strfmt.Registry) *OpenSSFScorecardAPI
NewHTTPClient creates a new open SSF scorecard API HTTP client.
func NewHTTPClientWithConfig ¶
func NewHTTPClientWithConfig(formats strfmt.Registry, cfg *TransportConfig) *OpenSSFScorecardAPI
NewHTTPClientWithConfig creates a new open SSF scorecard API HTTP client, using a customizable transport config.
func (*OpenSSFScorecardAPI) SetTransport ¶
func (c *OpenSSFScorecardAPI) SetTransport(transport runtime.ContextualTransport)
SetTransport changes the transport on the client and all its subresources.
type TransportConfig ¶
type TransportConfig struct {
Host string
BasePath string
Schemes []string
Producers map[string]runtime.Producer
Consumers map[string]runtime.Consumer
}
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) WithConsumers ¶
func (cfg *TransportConfig) WithConsumers(consumers map[string]runtime.Consumer) *TransportConfig
WithConsumers overrides the default consumers registered by httptransport.Runtime.
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) WithProducers ¶
func (cfg *TransportConfig) WithProducers(producers map[string]runtime.Producer) *TransportConfig
WithProducers overrides the default producers registered by httptransport.Runtime.
func (*TransportConfig) WithSchemes ¶
func (cfg *TransportConfig) WithSchemes(schemes []string) *TransportConfig
WithSchemes overrides the default schemes, provided by the meta section of the spec file.
Source Files
Directories