report

Documentation

Index

• Constants
• func ExportFullReport(ctx context.Context, s *db.Statistics, reportFile string, reportTime time.Time, ...) (fullName string, err error)
• func RenderConsoleReport(s *db.Statistics, reportTime time.Time, wafName string, url string, ...) error
• func SendReportByEmail(ctx context.Context, s *db.Statistics, email string, reportTime time.Time, ...) error
• type ErrorResponse
  • func (e *ErrorResponse) Error() string

Constants

const (
	JsonFormat = "json"
	HtmlFormat = "html"
	PdfFormat  = "pdf"
	NoneFormat = "none"
)

Functions

func ExportFullReport

func ExportFullReport(
	ctx context.Context, s *db.Statistics, reportFile string, reportTime time.Time,
	wafName string, url string, openApiFile string, args []string, ignoreUnresolved bool,
	includePayloads bool, format string,
) (fullName string, err error)

ExportFullReport saves full report on disk in different formats: HTML, PDF, JSON.

func RenderConsoleReport

func RenderConsoleReport(
	s *db.Statistics,
	reportTime time.Time,
	wafName string,
	url string,
	args []string,
	ignoreUnresolved bool,
	format string,
) error

RenderConsoleReport prints a console report in selected format.

func SendReportByEmail

func SendReportByEmail(
	ctx context.Context, s *db.Statistics, email string, reportTime time.Time,
	wafName string, url string, openApiFile string, args []string, ignoreUnresolved bool, includePayloads bool,
) error

Types

type ErrorResponse

type ErrorResponse struct {
	Msg string `json:"msg"`
}

func (*ErrorResponse) Error

func (e *ErrorResponse) Error() string