generated

package
v1.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 24, 2025 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Overview

Package generated provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.4.1 DO NOT EDIT.

Package generated provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.4.1 DO NOT EDIT.

Package generated provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.4.1 DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetSwagger

func GetSwagger() (swagger *openapi3.T, err error)

GetSwagger returns the Swagger specification corresponding to the generated code in this file. The external references of Swagger specification are resolved. The logic of resolving external references is tightly connected to "import-mapping" feature. Externally referenced files must be embedded in the corresponding golang packages. Urls can be supported but this task was out of the scope.

func Handler

func Handler(si ServerInterface) http.Handler

Handler creates http.Handler with routing matching OpenAPI spec.

func HandlerFromMux

func HandlerFromMux(si ServerInterface, r chi.Router) http.Handler

HandlerFromMux creates http.Handler with routing matching OpenAPI spec based on the provided mux.

func HandlerFromMuxWithBaseURL

func HandlerFromMuxWithBaseURL(si ServerInterface, r chi.Router, baseURL string) http.Handler

func HandlerWithOptions

func HandlerWithOptions(si ServerInterface, options ChiServerOptions) http.Handler

HandlerWithOptions creates http.Handler with additional options

func PathToRawSpec

func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)

Constructs a synthetic filesystem for resolving external references when loading openapi specifications.

Types

type AnalyzeDependencies200JSONResponse

type AnalyzeDependencies200JSONResponse struct{ PackageNameListJSONResponse }

func (AnalyzeDependencies200JSONResponse) VisitAnalyzeDependenciesResponse

func (response AnalyzeDependencies200JSONResponse) VisitAnalyzeDependenciesResponse(w http.ResponseWriter) error

type AnalyzeDependencies400JSONResponse

type AnalyzeDependencies400JSONResponse struct{ BadRequestJSONResponse }

func (AnalyzeDependencies400JSONResponse) VisitAnalyzeDependenciesResponse

func (response AnalyzeDependencies400JSONResponse) VisitAnalyzeDependenciesResponse(w http.ResponseWriter) error

type AnalyzeDependencies500JSONResponse

type AnalyzeDependencies500JSONResponse struct {
	InternalServerErrorJSONResponse
}

func (AnalyzeDependencies500JSONResponse) VisitAnalyzeDependenciesResponse

func (response AnalyzeDependencies500JSONResponse) VisitAnalyzeDependenciesResponse(w http.ResponseWriter) error

type AnalyzeDependencies502JSONResponse

type AnalyzeDependencies502JSONResponse struct{ BadGatewayJSONResponse }

func (AnalyzeDependencies502JSONResponse) VisitAnalyzeDependenciesResponse

func (response AnalyzeDependencies502JSONResponse) VisitAnalyzeDependenciesResponse(w http.ResponseWriter) error

type AnalyzeDependenciesParams

type AnalyzeDependenciesParams struct {
	// PaginationSpec The pagination configuration for the query.
	//   * 'PageSize' specifies the number of results returned
	//   * 'Cursor' is returned by previous calls and specifies what page to return
	PaginationSpec *PaginationSpec `form:"paginationSpec,omitempty" json:"paginationSpec,omitempty"`

	// Sort The sort order of the packages
	//   * 'frequency' - The packages with the highest number of dependents
	//   * 'scorecard' - The packages with the lowest OpenSSF scorecard score
	Sort AnalyzeDependenciesParamsSort `form:"sort" json:"sort"`
}

AnalyzeDependenciesParams defines parameters for AnalyzeDependencies.

type AnalyzeDependenciesParamsSort

type AnalyzeDependenciesParamsSort string

AnalyzeDependenciesParamsSort defines parameters for AnalyzeDependencies.

const (
	Frequency AnalyzeDependenciesParamsSort = "frequency"
	Scorecard AnalyzeDependenciesParamsSort = "scorecard"
)

Defines values for AnalyzeDependenciesParamsSort.

type AnalyzeDependenciesRequestObject

type AnalyzeDependenciesRequestObject struct {
	Params AnalyzeDependenciesParams
}

type AnalyzeDependenciesResponseObject

type AnalyzeDependenciesResponseObject interface {
	VisitAnalyzeDependenciesResponse(w http.ResponseWriter) error
}

type BadGateway

type BadGateway = Error

BadGateway defines model for BadGateway.

type BadGatewayJSONResponse

type BadGatewayJSONResponse Error

type BadRequest

type BadRequest = Error

BadRequest defines model for BadRequest.

type BadRequestJSONResponse

type BadRequestJSONResponse Error

type ChiServerOptions

type ChiServerOptions struct {
	BaseURL          string
	BaseRouter       chi.Router
	Middlewares      []MiddlewareFunc
	ErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}

type Error

type Error struct {
	Message string `json:"Message"`
}

Error defines model for Error.

type GetArtifactDeps200JSONResponse added in v0.14.0

type GetArtifactDeps200JSONResponse struct{ PurlListJSONResponse }

func (GetArtifactDeps200JSONResponse) VisitGetArtifactDepsResponse added in v0.14.0

func (response GetArtifactDeps200JSONResponse) VisitGetArtifactDepsResponse(w http.ResponseWriter) error

type GetArtifactDeps400JSONResponse added in v0.14.0

type GetArtifactDeps400JSONResponse struct{ BadRequestJSONResponse }

func (GetArtifactDeps400JSONResponse) VisitGetArtifactDepsResponse added in v0.14.0

func (response GetArtifactDeps400JSONResponse) VisitGetArtifactDepsResponse(w http.ResponseWriter) error

type GetArtifactDeps500JSONResponse added in v0.14.0

type GetArtifactDeps500JSONResponse struct {
	InternalServerErrorJSONResponse
}

func (GetArtifactDeps500JSONResponse) VisitGetArtifactDepsResponse added in v0.14.0

func (response GetArtifactDeps500JSONResponse) VisitGetArtifactDepsResponse(w http.ResponseWriter) error

type GetArtifactDeps502JSONResponse added in v0.14.0

type GetArtifactDeps502JSONResponse struct{ BadGatewayJSONResponse }

func (GetArtifactDeps502JSONResponse) VisitGetArtifactDepsResponse added in v0.14.0

func (response GetArtifactDeps502JSONResponse) VisitGetArtifactDepsResponse(w http.ResponseWriter) error

type GetArtifactDepsRequestObject added in v0.14.0

type GetArtifactDepsRequestObject struct {
	Digest string `json:"digest"`
}

type GetArtifactDepsResponseObject added in v0.14.0

type GetArtifactDepsResponseObject interface {
	VisitGetArtifactDepsResponse(w http.ResponseWriter) error
}

type GetArtifactVulns200JSONResponse added in v0.14.0

type GetArtifactVulns200JSONResponse struct{ VulnerabilityListJSONResponse }

func (GetArtifactVulns200JSONResponse) VisitGetArtifactVulnsResponse added in v0.14.0

func (response GetArtifactVulns200JSONResponse) VisitGetArtifactVulnsResponse(w http.ResponseWriter) error

type GetArtifactVulns400JSONResponse added in v0.14.0

type GetArtifactVulns400JSONResponse struct{ BadRequestJSONResponse }

func (GetArtifactVulns400JSONResponse) VisitGetArtifactVulnsResponse added in v0.14.0

func (response GetArtifactVulns400JSONResponse) VisitGetArtifactVulnsResponse(w http.ResponseWriter) error

type GetArtifactVulns500JSONResponse added in v0.14.0

type GetArtifactVulns500JSONResponse struct {
	InternalServerErrorJSONResponse
}

func (GetArtifactVulns500JSONResponse) VisitGetArtifactVulnsResponse added in v0.14.0

func (response GetArtifactVulns500JSONResponse) VisitGetArtifactVulnsResponse(w http.ResponseWriter) error

type GetArtifactVulns502JSONResponse added in v0.14.0

type GetArtifactVulns502JSONResponse struct{ BadGatewayJSONResponse }

func (GetArtifactVulns502JSONResponse) VisitGetArtifactVulnsResponse added in v0.14.0

func (response GetArtifactVulns502JSONResponse) VisitGetArtifactVulnsResponse(w http.ResponseWriter) error

type GetArtifactVulnsRequestObject added in v0.14.0

type GetArtifactVulnsRequestObject struct {
	Digest string `json:"digest"`
}

type GetArtifactVulnsResponseObject added in v0.14.0

type GetArtifactVulnsResponseObject interface {
	VisitGetArtifactVulnsResponse(w http.ResponseWriter) error
}

type GetPackageDeps200JSONResponse added in v0.14.0

type GetPackageDeps200JSONResponse struct{ PurlListJSONResponse }

func (GetPackageDeps200JSONResponse) VisitGetPackageDepsResponse added in v0.14.0

func (response GetPackageDeps200JSONResponse) VisitGetPackageDepsResponse(w http.ResponseWriter) error

type GetPackageDeps400JSONResponse added in v0.14.0

type GetPackageDeps400JSONResponse struct{ BadRequestJSONResponse }

func (GetPackageDeps400JSONResponse) VisitGetPackageDepsResponse added in v0.14.0

func (response GetPackageDeps400JSONResponse) VisitGetPackageDepsResponse(w http.ResponseWriter) error

type GetPackageDeps500JSONResponse added in v0.14.0

type GetPackageDeps500JSONResponse struct {
	InternalServerErrorJSONResponse
}

func (GetPackageDeps500JSONResponse) VisitGetPackageDepsResponse added in v0.14.0

func (response GetPackageDeps500JSONResponse) VisitGetPackageDepsResponse(w http.ResponseWriter) error

type GetPackageDeps502JSONResponse added in v0.14.0

type GetPackageDeps502JSONResponse struct{ BadGatewayJSONResponse }

func (GetPackageDeps502JSONResponse) VisitGetPackageDepsResponse added in v0.14.0

func (response GetPackageDeps502JSONResponse) VisitGetPackageDepsResponse(w http.ResponseWriter) error

type GetPackageDepsRequestObject added in v0.14.0

type GetPackageDepsRequestObject struct {
	Purl string `json:"purl"`
}

type GetPackageDepsResponseObject added in v0.14.0

type GetPackageDepsResponseObject interface {
	VisitGetPackageDepsResponse(w http.ResponseWriter) error
}

type GetPackagePurls200JSONResponse added in v0.14.0

type GetPackagePurls200JSONResponse struct{ PurlListJSONResponse }

func (GetPackagePurls200JSONResponse) VisitGetPackagePurlsResponse added in v0.14.0

func (response GetPackagePurls200JSONResponse) VisitGetPackagePurlsResponse(w http.ResponseWriter) error

type GetPackagePurls400JSONResponse added in v0.14.0

type GetPackagePurls400JSONResponse struct{ BadRequestJSONResponse }

func (GetPackagePurls400JSONResponse) VisitGetPackagePurlsResponse added in v0.14.0

func (response GetPackagePurls400JSONResponse) VisitGetPackagePurlsResponse(w http.ResponseWriter) error

type GetPackagePurls500JSONResponse added in v0.14.0

type GetPackagePurls500JSONResponse struct {
	InternalServerErrorJSONResponse
}

func (GetPackagePurls500JSONResponse) VisitGetPackagePurlsResponse added in v0.14.0

func (response GetPackagePurls500JSONResponse) VisitGetPackagePurlsResponse(w http.ResponseWriter) error

type GetPackagePurls502JSONResponse added in v0.14.0

type GetPackagePurls502JSONResponse struct{ BadGatewayJSONResponse }

func (GetPackagePurls502JSONResponse) VisitGetPackagePurlsResponse added in v0.14.0

func (response GetPackagePurls502JSONResponse) VisitGetPackagePurlsResponse(w http.ResponseWriter) error

type GetPackagePurlsRequestObject added in v0.14.0

type GetPackagePurlsRequestObject struct {
	Purl string `json:"purl"`
}

type GetPackagePurlsResponseObject added in v0.14.0

type GetPackagePurlsResponseObject interface {
	VisitGetPackagePurlsResponse(w http.ResponseWriter) error
}

type GetPackageVulns200JSONResponse added in v0.14.0

type GetPackageVulns200JSONResponse struct{ VulnerabilityListJSONResponse }

func (GetPackageVulns200JSONResponse) VisitGetPackageVulnsResponse added in v0.14.0

func (response GetPackageVulns200JSONResponse) VisitGetPackageVulnsResponse(w http.ResponseWriter) error

type GetPackageVulns400JSONResponse added in v0.14.0

type GetPackageVulns400JSONResponse struct{ BadRequestJSONResponse }

func (GetPackageVulns400JSONResponse) VisitGetPackageVulnsResponse added in v0.14.0

func (response GetPackageVulns400JSONResponse) VisitGetPackageVulnsResponse(w http.ResponseWriter) error

type GetPackageVulns500JSONResponse added in v0.14.0

type GetPackageVulns500JSONResponse struct {
	InternalServerErrorJSONResponse
}

func (GetPackageVulns500JSONResponse) VisitGetPackageVulnsResponse added in v0.14.0

func (response GetPackageVulns500JSONResponse) VisitGetPackageVulnsResponse(w http.ResponseWriter) error

type GetPackageVulns502JSONResponse added in v0.14.0

type GetPackageVulns502JSONResponse struct{ BadGatewayJSONResponse }

func (GetPackageVulns502JSONResponse) VisitGetPackageVulnsResponse added in v0.14.0

func (response GetPackageVulns502JSONResponse) VisitGetPackageVulnsResponse(w http.ResponseWriter) error

type GetPackageVulnsParams added in v0.14.0

type GetPackageVulnsParams struct {
	// IncludeDependencies A flag to include vulnerabilities of the dependencies. If true, the  response will include vulnerabilities for the purl and its dependencies  instead of the vulnerabilities of just the purl.
	IncludeDependencies *bool `form:"includeDependencies,omitempty" json:"includeDependencies,omitempty"`
}

GetPackageVulnsParams defines parameters for GetPackageVulns.

type GetPackageVulnsRequestObject added in v0.14.0

type GetPackageVulnsRequestObject struct {
	Purl   string `json:"purl"`
	Params GetPackageVulnsParams
}

type GetPackageVulnsResponseObject added in v0.14.0

type GetPackageVulnsResponseObject interface {
	VisitGetPackageVulnsResponse(w http.ResponseWriter) error
}

type HealthCheck200JSONResponse

type HealthCheck200JSONResponse string

func (HealthCheck200JSONResponse) VisitHealthCheckResponse

func (response HealthCheck200JSONResponse) VisitHealthCheckResponse(w http.ResponseWriter) error

type HealthCheckRequestObject

type HealthCheckRequestObject struct {
}

type HealthCheckResponseObject

type HealthCheckResponseObject interface {
	VisitHealthCheckResponse(w http.ResponseWriter) error
}

type InternalServerError

type InternalServerError = Error

InternalServerError defines model for InternalServerError.

type InternalServerErrorJSONResponse

type InternalServerErrorJSONResponse Error

type InvalidParamFormatError

type InvalidParamFormatError struct {
	ParamName string
	Err       error
}

func (*InvalidParamFormatError) Error

func (e *InvalidParamFormatError) Error() string

func (*InvalidParamFormatError) Unwrap

func (e *InvalidParamFormatError) Unwrap() error

type MiddlewareFunc

type MiddlewareFunc func(http.Handler) http.Handler

type PackageName added in v0.7.0

type PackageName struct {
	DependentCount int  `json:"DependentCount"`
	Name           Purl `json:"Name"`
}

PackageName defines model for PackageName.

type PackageNameList added in v0.7.0

type PackageNameList = []PackageName

PackageNameList defines model for PackageNameList.

type PackageNameListJSONResponse added in v0.7.0

type PackageNameListJSONResponse []PackageName

type PaginationInfo added in v0.5.1

type PaginationInfo struct {
	NextCursor *string `json:"NextCursor,omitempty"`
	TotalCount *int    `json:"TotalCount,omitempty"`
}

PaginationInfo Contains the cursor to retrieve more pages. If there are no more, NextCursor will be nil.

type PaginationSpec added in v0.5.1

type PaginationSpec struct {
	Cursor   *string `json:"Cursor,omitempty"`
	PageSize *int    `json:"PageSize,omitempty"`
}

PaginationSpec defines model for PaginationSpec.

type Purl

type Purl = string

Purl defines model for Purl.

type PurlList

type PurlList struct {
	// PaginationInfo Contains the cursor to retrieve more pages. If there are no more,  NextCursor will be nil.
	PaginationInfo PaginationInfo `json:"PaginationInfo"`
	PurlList       []Purl         `json:"PurlList"`
}

PurlList defines model for PurlList.

type PurlListJSONResponse

type PurlListJSONResponse struct {
	// PaginationInfo Contains the cursor to retrieve more pages. If there are no more,  NextCursor will be nil.
	PaginationInfo PaginationInfo `json:"PaginationInfo"`
	PurlList       []Purl         `json:"PurlList"`
}

type RequiredHeaderError

type RequiredHeaderError struct {
	ParamName string
	Err       error
}

func (*RequiredHeaderError) Error

func (e *RequiredHeaderError) Error() string

func (*RequiredHeaderError) Unwrap

func (e *RequiredHeaderError) Unwrap() error

type RequiredParamError

type RequiredParamError struct {
	ParamName string
}

func (*RequiredParamError) Error

func (e *RequiredParamError) Error() string

type ScanMetadata added in v0.14.0

type ScanMetadata struct {
	Collector      *string    `json:"collector,omitempty"`
	DbUri          *string    `json:"dbUri,omitempty"`
	DbVersion      *string    `json:"dbVersion,omitempty"`
	Origin         *string    `json:"origin,omitempty"`
	ScannerUri     *string    `json:"scannerUri,omitempty"`
	ScannerVersion *string    `json:"scannerVersion,omitempty"`
	TimeScanned    *time.Time `json:"timeScanned,omitempty"`
}

ScanMetadata defines model for ScanMetadata.

type ServerInterface

type ServerInterface interface {
	// Identify the most important dependencies
	// (GET /analysis/dependencies)
	AnalyzeDependencies(w http.ResponseWriter, r *http.Request, params AnalyzeDependenciesParams)
	// Health check the server
	// (GET /healthz)
	HealthCheck(w http.ResponseWriter, r *http.Request)
	// Get dependencies for an artifact, identified by a digest
	// (GET /v0/artifact/{digest}/dependencies)
	GetArtifactDeps(w http.ResponseWriter, r *http.Request, digest string)
	// Get vulnerabilities for an artifact, identified by a digest
	// (GET /v0/artifact/{digest}/vulns)
	GetArtifactVulns(w http.ResponseWriter, r *http.Request, digest string)
	// Get all purls related to the given purl
	// (GET /v0/package/{purl})
	GetPackagePurls(w http.ResponseWriter, r *http.Request, purl string)
	// Get dependencies for a specific Package URL (purl)
	// (GET /v0/package/{purl}/dependencies)
	GetPackageDeps(w http.ResponseWriter, r *http.Request, purl string)
	// Get vulnerabilities for a Package URL (purl)
	// (GET /v0/package/{purl}/vulns)
	GetPackageVulns(w http.ResponseWriter, r *http.Request, purl string, params GetPackageVulnsParams)
}

ServerInterface represents all server handlers.

func NewStrictHandler

func NewStrictHandler(ssi StrictServerInterface, middlewares []StrictMiddlewareFunc) ServerInterface

func NewStrictHandlerWithOptions

func NewStrictHandlerWithOptions(ssi StrictServerInterface, middlewares []StrictMiddlewareFunc, options StrictHTTPServerOptions) ServerInterface

type ServerInterfaceWrapper

type ServerInterfaceWrapper struct {
	Handler            ServerInterface
	HandlerMiddlewares []MiddlewareFunc
	ErrorHandlerFunc   func(w http.ResponseWriter, r *http.Request, err error)
}

ServerInterfaceWrapper converts contexts to parameters.

func (*ServerInterfaceWrapper) AnalyzeDependencies

func (siw *ServerInterfaceWrapper) AnalyzeDependencies(w http.ResponseWriter, r *http.Request)

AnalyzeDependencies operation middleware

func (*ServerInterfaceWrapper) GetArtifactDeps added in v0.14.0

func (siw *ServerInterfaceWrapper) GetArtifactDeps(w http.ResponseWriter, r *http.Request)

GetArtifactDeps operation middleware

func (*ServerInterfaceWrapper) GetArtifactVulns added in v0.14.0

func (siw *ServerInterfaceWrapper) GetArtifactVulns(w http.ResponseWriter, r *http.Request)

GetArtifactVulns operation middleware

func (*ServerInterfaceWrapper) GetPackageDeps added in v0.14.0

func (siw *ServerInterfaceWrapper) GetPackageDeps(w http.ResponseWriter, r *http.Request)

GetPackageDeps operation middleware

func (*ServerInterfaceWrapper) GetPackagePurls added in v0.14.0

func (siw *ServerInterfaceWrapper) GetPackagePurls(w http.ResponseWriter, r *http.Request)

GetPackagePurls operation middleware

func (*ServerInterfaceWrapper) GetPackageVulns added in v0.14.0

func (siw *ServerInterfaceWrapper) GetPackageVulns(w http.ResponseWriter, r *http.Request)

GetPackageVulns operation middleware

func (*ServerInterfaceWrapper) HealthCheck

func (siw *ServerInterfaceWrapper) HealthCheck(w http.ResponseWriter, r *http.Request)

HealthCheck operation middleware

type StrictHTTPServerOptions

type StrictHTTPServerOptions struct {
	RequestErrorHandlerFunc  func(w http.ResponseWriter, r *http.Request, err error)
	ResponseErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}

type StrictServerInterface

type StrictServerInterface interface {
	// Identify the most important dependencies
	// (GET /analysis/dependencies)
	AnalyzeDependencies(ctx context.Context, request AnalyzeDependenciesRequestObject) (AnalyzeDependenciesResponseObject, error)
	// Health check the server
	// (GET /healthz)
	HealthCheck(ctx context.Context, request HealthCheckRequestObject) (HealthCheckResponseObject, error)
	// Get dependencies for an artifact, identified by a digest
	// (GET /v0/artifact/{digest}/dependencies)
	GetArtifactDeps(ctx context.Context, request GetArtifactDepsRequestObject) (GetArtifactDepsResponseObject, error)
	// Get vulnerabilities for an artifact, identified by a digest
	// (GET /v0/artifact/{digest}/vulns)
	GetArtifactVulns(ctx context.Context, request GetArtifactVulnsRequestObject) (GetArtifactVulnsResponseObject, error)
	// Get all purls related to the given purl
	// (GET /v0/package/{purl})
	GetPackagePurls(ctx context.Context, request GetPackagePurlsRequestObject) (GetPackagePurlsResponseObject, error)
	// Get dependencies for a specific Package URL (purl)
	// (GET /v0/package/{purl}/dependencies)
	GetPackageDeps(ctx context.Context, request GetPackageDepsRequestObject) (GetPackageDepsResponseObject, error)
	// Get vulnerabilities for a Package URL (purl)
	// (GET /v0/package/{purl}/vulns)
	GetPackageVulns(ctx context.Context, request GetPackageVulnsRequestObject) (GetPackageVulnsResponseObject, error)
}

StrictServerInterface represents all server handlers.

type TooManyValuesForParamError

type TooManyValuesForParamError struct {
	ParamName string
	Count     int
}

func (*TooManyValuesForParamError) Error

type UnescapedCookieParamError

type UnescapedCookieParamError struct {
	ParamName string
	Err       error
}

func (*UnescapedCookieParamError) Error

func (e *UnescapedCookieParamError) Error() string

func (*UnescapedCookieParamError) Unwrap

func (e *UnescapedCookieParamError) Unwrap() error

type Unimplemented

type Unimplemented struct{}

func (Unimplemented) AnalyzeDependencies

func (_ Unimplemented) AnalyzeDependencies(w http.ResponseWriter, r *http.Request, params AnalyzeDependenciesParams)

Identify the most important dependencies (GET /analysis/dependencies)

func (Unimplemented) GetArtifactDeps added in v0.14.0

func (_ Unimplemented) GetArtifactDeps(w http.ResponseWriter, r *http.Request, digest string)

Get dependencies for an artifact, identified by a digest (GET /v0/artifact/{digest}/dependencies)

func (Unimplemented) GetArtifactVulns added in v0.14.0

func (_ Unimplemented) GetArtifactVulns(w http.ResponseWriter, r *http.Request, digest string)

Get vulnerabilities for an artifact, identified by a digest (GET /v0/artifact/{digest}/vulns)

func (Unimplemented) GetPackageDeps added in v0.14.0

func (_ Unimplemented) GetPackageDeps(w http.ResponseWriter, r *http.Request, purl string)

Get dependencies for a specific Package URL (purl) (GET /v0/package/{purl}/dependencies)

func (Unimplemented) GetPackagePurls added in v0.14.0

func (_ Unimplemented) GetPackagePurls(w http.ResponseWriter, r *http.Request, purl string)

Get all purls related to the given purl (GET /v0/package/{purl})

func (Unimplemented) GetPackageVulns added in v0.14.0

func (_ Unimplemented) GetPackageVulns(w http.ResponseWriter, r *http.Request, purl string, params GetPackageVulnsParams)

Get vulnerabilities for a Package URL (purl) (GET /v0/package/{purl}/vulns)

func (Unimplemented) HealthCheck

func (_ Unimplemented) HealthCheck(w http.ResponseWriter, r *http.Request)

Health check the server (GET /healthz)

type UnmarshalingParamError

type UnmarshalingParamError struct {
	ParamName string
	Err       error
}

func (*UnmarshalingParamError) Error

func (e *UnmarshalingParamError) Error() string

func (*UnmarshalingParamError) Unwrap

func (e *UnmarshalingParamError) Unwrap() error

type Vulnerability added in v0.14.0

type Vulnerability struct {
	Metadata      ScanMetadata         `json:"metadata"`
	Package       string               `json:"package"`
	Vulnerability VulnerabilityDetails `json:"vulnerability"`
}

Vulnerability defines model for Vulnerability.

type VulnerabilityDetails added in v0.14.0

type VulnerabilityDetails struct {
	Type *string `json:"type,omitempty"`

	// VulnerabilityIDs A list of vulnerability identifiers. These can be CVE IDs or other  formats used to identify vulnerabilities.
	VulnerabilityIDs []string `json:"vulnerabilityIDs"`
}

VulnerabilityDetails defines model for VulnerabilityDetails.

type VulnerabilityList added in v0.14.0

type VulnerabilityList = []Vulnerability

VulnerabilityList defines model for VulnerabilityList.

type VulnerabilityListJSONResponse added in v0.14.0

type VulnerabilityListJSONResponse []Vulnerability

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL