Documentation
¶
Overview ¶
Package api provides the REST API server for the accessibility audit service.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AuditEngine ¶
type AuditEngine interface {
RunAudit(ctx context.Context, cfg *config.Config) (*audit.AuditResult, error)
}
AuditEngine is the interface for running audits.
type AuditJob ¶
type AuditJob struct {
ID string `json:"id"`
Status string `json:"status"` // pending, running, completed, failed
Config *config.Config `json:"config"`
Result *audit.AuditResult `json:"result,omitempty"`
Error string `json:"error,omitempty"`
StartTime time.Time `json:"startTime"`
EndTime time.Time `json:"endTime,omitempty"`
Progress int `json:"progress"` // 0-100
}
AuditJob represents a running or completed audit job.
type CreateAuditRequest ¶
type CreateAuditRequest struct {
URL string `json:"url"`
Config map[string]interface{} `json:"config,omitempty"`
Journey *config.JourneyRef `json:"journey,omitempty"`
}
CreateAuditRequest is the request body for creating an audit.
type CreateAuditResponse ¶
CreateAuditResponse is the response for creating an audit.
Click to show internal directories.
Click to hide internal directories.