scorecard

Documentation

Index

• Constants
• func NewClient(rawURL string, opts ...Option) (scorecard.Client, error)
• type Client
  • func (c *Client) GetResult(ctx context.Context, repository string) (*models.ScorecardResult, error)
  • func (c *Client) Name() string
• type Option
  • func WithTimeout(timeout time.Duration) Option

Constants

const (
	// DefaultURL is the default base url for the scorecard API
	DefaultURL = "https://api.securityscorecards.dev"

	// DefaultTimeout is the default timeout for HTTP requests
	DefaultTimeout = time.Second * 30
)

const ClientName = "api"

ClientName is the name of the client

Functions

func NewClient

func NewClient(rawURL string, opts ...Option) (scorecard.Client, error)

NewClient returns a client that fetches scores from the scorecard API

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client retrieves scores from the scorecard API

func (*Client) GetResult

func (c *Client) GetResult(ctx context.Context, repository string) (*models.ScorecardResult, error)

GetResult fetches a scorecard result from the public scorecard API

func (*Client) Name

func (c *Client) Name() string

Name returns the client name

type Option

type Option func(c *Client)

Option is a functional option that configures the scorecard API client

func WithTimeout

func WithTimeout(timeout time.Duration) Option

WithTimeout is a functional option that configures the timeout duration for HTTP requests