github_standards

Documentation

Index

• func ListHandler(server *api.ApiServer, w http.ResponseWriter, r *http.Request)
• func Register(mux *http.ServeMux, apiServer *api.ApiServer)
• type CountValues
• type Counters
• type GHSResponse
  • func NewResponse() *GHSResponse

Functions

func ListHandler

func ListHandler(server *api.ApiServer, 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(mux *http.ServeMux, apiServer *api.ApiServer)

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 {
	*response.Response
	Counters     *Counters              `json:"counters,omitempty"`
	QueryFilters map[string]interface{} `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