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 harbor.Error)
• type MimeType
  • func (mt MimeType) String() string
• 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"
)

Variables

var MimeTypeDockerImageManifest = MimeType{Type: "application", Subtype: "vnd.docker.distribution.manifest.v2+json"}

var MimeTypeError = MimeType{Type: "application", Subtype: "vnd.scanner.adapter.error", Params: MimeTypeVersion}

var MimeTypeHarborVulnerabilityReport = MimeType{Type: "application", Subtype: "vnd.scanner.adapter.vuln.report.harbor+json", Params: MimeTypeVersion}

var MimeTypeMetadata = MimeType{Type: "application", Subtype: "vnd.scanner.adapter.metadata+json", Params: MimeTypeVersion}

var MimeTypeOCIImageManifest = MimeType{Type: "application", Subtype: "vnd.oci.image.manifest.v1+json"}

var MimeTypeScanResponse = MimeType{Type: "application", Subtype: "vnd.scanner.adapter.scan.response+json", Params: MimeTypeVersion}

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

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 harbor.Error)

type MimeType

type MimeType struct {
	Type    string
	Subtype string
	Params  MimeTypeParams
}

func (MimeType) String

func (mt MimeType) String() 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()