api

Documentation

Index

• Constants
• Variables
• type BaseHandler
  • func (h *BaseHandler) SendInternalServerError(res http.ResponseWriter)
  • func (h *BaseHandler) WriteJSON(res http.ResponseWriter, data interface{}, mimeType MIMEType, statusCode int)
  • func (h *BaseHandler) WriteJSONError(res http.ResponseWriter, err Error)
• type Error
• type MIMEType
  • func (mt *MIMEType) Equal(other MIMEType) bool
  • func (mt MIMEType) MarshalJSON() ([]byte, error)
  • func (mt *MIMEType) Parse(value string) error
  • func (mt *MIMEType) String() string
  • func (mt *MIMEType) UnmarshalJSON(b []byte) error
• type MediaType
• type MimeTypeParams
• type Server
  • func NewServer(config etc.API, handler http.Handler) (server *Server, err error)
  • func (s *Server) ListenAndServe()
  • func (s *Server) Shutdown()

Constants

const (
	HeaderContentType = "Content-Type"
	HeaderAccept      = "Accept"
)

Variables

var (
	MimeTypeVersion = map[string]string{"version": "1.0"}

	MimeTypeOCIImageManifest = MIMEType{
		Type:    "application",
		Subtype: "vnd.oci.image.manifest.v1+json",
	}
	MimeTypeDockerImageManifestV2 = MIMEType{
		Type:    "application",
		Subtype: "vnd.docker.distribution.manifest.v2+json",
	}
	MimeTypeScanResponse = MIMEType{
		Type:    "application",
		Subtype: "vnd.scanner.adapter.scan.response+json",
		Params:  MimeTypeVersion,
	}
	MimeTypeSecurityVulnerabilityReport = MIMEType{
		Type:    "application",
		Subtype: "vnd.security.vulnerability.report",
		Params:  map[string]string{"version": "1.1"},
	}
	MimeTypeSecuritySBOMReport = MIMEType{
		Type:    "application",
		Subtype: "vnd.security.sbom.report+json",
		Params:  map[string]string{"version": "1.0"},
	}
	MimeTypeMetadata = MIMEType{
		Type:    "application",
		Subtype: "vnd.scanner.adapter.metadata+json",
		Params:  MimeTypeVersion,
	}
	MimeTypeError = MIMEType{
		Type:    "application",
		Subtype: "vnd.scanner.adapter.error",
		Params:  MimeTypeVersion,
	}

	MediaTypeSPDX      MediaType = "application/spdx+json"
	MediaTypeCycloneDX MediaType = "application/vnd.cyclonedx+json"
)

Types

type BaseHandler

type BaseHandler struct {
}

func (*BaseHandler) SendInternalServerError

func (h *BaseHandler) SendInternalServerError(res http.ResponseWriter)

func (*BaseHandler) WriteJSON

func (h *BaseHandler) WriteJSON(res http.ResponseWriter, data interface{}, mimeType MIMEType, statusCode int)

func (*BaseHandler) WriteJSONError

func (h *BaseHandler) WriteJSONError(res http.ResponseWriter, err Error)

type Error

type Error struct {
	HTTPCode int    `json:"-"`
	Message  string `json:"message"`
}

Error holds the information about an error, including metadata about its JSON structure.

type MIMEType

type MIMEType struct {
	Type    string
	Subtype string
	Params  MimeTypeParams
}

func (*MIMEType) Equal

func (mt *MIMEType) Equal(other MIMEType) bool

func (MIMEType) MarshalJSON

func (mt MIMEType) MarshalJSON() ([]byte, error)

func (*MIMEType) Parse

func (mt *MIMEType) Parse(value string) error

func (*MIMEType) String

func (mt *MIMEType) String() string

func (*MIMEType) UnmarshalJSON

func (mt *MIMEType) UnmarshalJSON(b []byte) error

type MediaType

type MediaType string

type MimeTypeParams

type MimeTypeParams map[string]string

type Server

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

func NewServer

func NewServer(config etc.API, handler http.Handler) (server *Server, err error)

func (*Server) ListenAndServe

func (s *Server) ListenAndServe()

func (*Server) Shutdown

func (s *Server) Shutdown()