github_standards

Documentation

Index

• func ListHandler(w http.ResponseWriter, r *http.Request)
• func Register(ctx context.Context, mux *http.ServeMux, dbPath string) (err error)
• func SetCtx(ctx context.Context)
• func SetDBPath(path string)
• type CountValues
• type Counters
• type GHSResponse
  • func NewResponse() *GHSResponse

Functions

func ListHandler

func ListHandler(w http.ResponseWriter, r *http.Request)

ListHandler is configure to handler the `listRoute` url requests and will report a GHSResponse.

• Connects to sql db via `apiDbPath`
• Gets result data dependant on the `archived` and `team` get parameters
• Generates compliance counters for the data set and overall
• Finds the run date of the report

Sample urls:

• /v1/github-standards/
• /v1/github-standards/?archived=false
• /v1/github-standards/?archived=false&team=<team>

func Register

func Register(ctx context.Context, mux *http.ServeMux, dbPath string) (err error)

Register sets the local context and database paths to the values passed and then attaches the local handles to the url patterns supported by the api

func SetCtx

func SetCtx(ctx context.Context)

func SetDBPath

func SetDBPath(path string)

Types

type CountValues

type CountValues struct {
	Count             int `json:"count"`
	CompliantBaseline int `json:"compliant_baseline"`
	CompliantExtended int `json:"compliant_extended"`
}

CountValues covers the counters we want to return for the github standards data

type Counters

type Counters struct {
	Totals *CountValues `json:"totals"`
	This   *CountValues `json:"current"`
}

Counters covers Total and This data where Total is for the overal database and This is for the current query

type GHSResponse

type GHSResponse struct {
	*apiresponse.Response
	Counters     *Counters            `json:"counters,omitempty"`
	QueryFilters map[string]string    `json:"query_filters,omitempty"`
	Result       []ghs.GithubStandard `json:"result"`
}

GHSResponse uses base response and adds additional data to capture counters, passed query filters and the result data

func NewResponse

func NewResponse() *GHSResponse