audit

Documentation

Index

• func Audit(auditMgr *audit.AuditManager) http.HandlerFunc
• func Score(auditMgr *audit.AuditManager) http.HandlerFunc
• type Payload

Functions

func Audit

func Audit(auditMgr *audit.AuditManager) http.HandlerFunc

Audit returns an HTTP handler function that performs auditing of manifest data. It utilizes an AuditManager to execute the audit logic.

@Summary AuditHandler audits the provided manifest. @Description This endpoint audits the provided manifest for issues. @Tags audit @Accept plain @Accept json @Produce json @Param request body Payload true "Manifest data to audit (either plain text or JSON format)" @Success 200 {array} scanner.Issue "Audit results" @Failure 400 {object} string "Bad Request" @Failure 401 {object} string "Unauthorized" @Failure 429 {object} string "Too Many Requests" @Failure 404 {object} string "Not Found" @Failure 500 {object} string "Internal Server Error" @Router /api/v1/audit [post]

func Score

func Score(auditMgr *audit.AuditManager) http.HandlerFunc

Score returns an HTTP handler function that calculates a score for the audited manifest. It utilizes an AuditManager to compute the score based on detected issues.

@Summary ScoreHandler calculates a score for the audited manifest. @Description This endpoint calculates a score for the provided manifest based on the number and severity of issues detected during the audit. @Tags audit @Accept text/plain @Accept application/json @Produce json @Param request body Payload true "Manifest data to calculate score for (either plain text or JSON format)" @Success 200 {object} audit.ScoreData "Score calculation result" @Failure 400 {object} string "Bad Request" @Failure 401 {object} string "Unauthorized" @Failure 429 {object} string "Too Many Requests" @Failure 404 {object} string "Not Found" @Failure 500 {object} string "Internal Server Error" @Router /api/v1/audit/score [post]

Types

type Payload

type Payload struct {
	Manifest string `json:"manifest"` // Manifest is the content to be audited.
}

Payload represents the structure for audit request data. It includes the manifest which is typically a string containing declarative configuration data that needs to be audited.