auditmysite 1.3.0

Resource-efficient WCAG 2.1 Accessibility Checker in Rust
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/casoon/auditmysite/docs/json-batch-report.schema.json",
  "title": "auditmysite unified report (batch)",
  "type": "object",
  "required": ["schema_version", "report_type", "metadata", "metric_context", "summary", "pages"],
  "additionalProperties": false,
  "properties": {
    "schema_version": { "type": "string", "const": "2.0" },
    "report_type": { "type": "string", "const": "batch" },
    "tool_version": { "type": "string" },
    "build_id": { "type": "string", "description": "Build-time git short-SHA of the binary that produced this report; \"unknown\" when built without a .git directory." },
    "metadata": { "$ref": "#/$defs/metadata" },
    "audit_scope": { "type": "object" },
    "execution_environment": { "type": "object" },
    "audit_quality": { "$ref": "#/$defs/auditQuality" },
    "metric_context": { "$ref": "#/$defs/metricContext" },
    "summary": { "$ref": "#/$defs/summary" },
    "sample": { "$ref": "#/$defs/sample" },
    "pages": {
      "type": "array",
      "items": { "$ref": "#/$defs/pageEntry" }
    },
    "url_matrix": { "type": "array" },
    "internal_comparison": { "$ref": "#/$defs/internalComparison" },
    "crawl_diagnostics": { "type": ["object", "null"] },
    "sitemap_diagnostics": { "type": ["object", "null"] },
    "site_analysis": { "type": "object" },
    "artifacts": { "type": "array", "items": { "$ref": "#/$defs/artifact" } },
    "errors": { "type": "array" },
    "collection_errors": {
      "description": "Errors raised while serializing the report. Audit and measurement failures are represented separately in module_runs, rule_outcomes, and audit_quality.",
      "type": "array",
      "items": { "$ref": "#/$defs/reportError" }
    },
    "verdict": { "type": "string", "enum": ["pass", "warn", "fail"] },
    "verdict_reasons": { "type": "array", "items": { "type": "string" } }
  },
  "$defs": {
    "artifact": {
      "type": "object",
      "required": ["kind", "media_type", "delivery", "path_template", "status"],
      "additionalProperties": false,
      "properties": {
        "kind": { "type": "string" },
        "media_type": { "type": "string" },
        "delivery": { "type": "string", "enum": ["sidecar"] },
        "path_template": { "type": "string" },
        "status": { "type": "string", "enum": ["completed", "partial", "failed", "skipped", "not_applicable", "not_requested"] }
      }
    },
    "reportError": {
      "type": "object",
      "required": ["module", "error_type", "reason"],
      "additionalProperties": false,
      "properties": {
        "module": { "type": "string" },
        "error_type": { "type": "string" },
        "reason": { "type": "string" }
      }
    },
    "auditQuality": {
      "type": "object",
      "required": ["status", "qualified_results", "failed_rule_checks", "partial_or_failed_modules"],
      "additionalProperties": false,
      "properties": {
        "status": { "type": "string", "enum": ["complete", "partial", "insufficient"] },
        "qualified_results": { "type": "boolean" },
        "failed_rule_checks": { "type": "integer", "minimum": 0 },
        "partial_or_failed_modules": { "type": "integer", "minimum": 0 },
        "reasons": { "type": "array", "items": { "type": "string" } }
      }
    },
    "metricContext": {
      "type": "object",
      "required": ["score_scale", "score_definitions", "count_definitions"],
      "additionalProperties": false,
      "properties": {
        "score_scale": {
          "type": "object",
          "required": ["minimum", "maximum", "higher_is_better"],
          "additionalProperties": false,
          "properties": {
            "minimum": { "type": "integer", "const": 0 },
            "maximum": { "type": "integer", "const": 100 },
            "higher_is_better": { "type": "boolean", "const": true }
          }
        },
        "score_definitions": { "type": "array", "items": { "$ref": "#/$defs/metricDefinition" } },
        "count_definitions": { "type": "array", "items": { "$ref": "#/$defs/metricDefinition" } }
      }
    },
    "metricDefinition": {
      "type": "object",
      "required": ["field", "unit", "meaning"],
      "additionalProperties": false,
      "properties": {
        "field": { "type": "string" },
        "unit": { "type": "string" },
        "meaning": { "type": "string" }
      }
    },
    "sample": {
      "type": "object",
      "required": ["source", "total_discovered", "audited", "selection", "is_sample"],
      "additionalProperties": false,
      "properties": {
        "source": { "type": "string", "enum": ["sitemap", "crawl", "url_file"] },
        "total_discovered": { "type": "integer", "minimum": 0 },
        "audited": { "type": "integer", "minimum": 0 },
        "sample_limit": { "type": "integer", "minimum": 0 },
        "selection": { "type": "string", "enum": ["first_n", "all"] },
        "is_sample": { "type": "boolean" }
      }
    },
    "metadata": {
      "type": "object",
      "required": ["tool", "timestamp", "wcag_level", "execution_time_ms"],
      "additionalProperties": false,
      "properties": {
        "tool": { "type": "string" },
        "timestamp": { "type": "string", "format": "date-time" },
        "wcag_level": { "type": "string" },
        "execution_time_ms": { "type": "integer", "minimum": 0 }
      }
    },
    "summary": {
      "type": "object",
      "required": [
        "url_count",
        "accessibility_score",
        "overall_score",
        "grade",
        "certificate",
        "risk_level",
        "violation_count",
        "finding_count",
        "finding_occurrence_count",
        "severity_counts",
        "severity_counts_scope",
        "occurrence_counts_scope",
        "passed_url_count",
        "failed_url_count",
        "wcag_coverage",
        "accessibility_score_breakdown",
        "management_risks",
        "top_actions"
      ],
      "additionalProperties": false,
      "properties": {
        "url_count": { "type": "integer", "minimum": 0 },
        "accessibility_score": { "type": "integer", "minimum": 0, "maximum": 100 },
        "overall_score": { "type": "integer", "minimum": 0, "maximum": 100 },
        "score": { "type": "integer", "minimum": 0, "maximum": 100 },
        "grade": { "type": "string" },
        "certificate": { "type": "string" },
        "risk_level": { "type": "string", "enum": ["low", "medium", "high", "critical"] },
        "violation_count": { "type": "integer", "minimum": 0 },
        "finding_count": { "type": "integer", "minimum": 0 },
        "finding_occurrence_count": { "type": "integer", "minimum": 0 },
        "severity_counts": { "$ref": "#/$defs/severityCounts" },
        "severity_counts_scope": { "type": "string", "const": "wcag_only" },
        "occurrence_counts": { "$ref": "#/$defs/severityCounts" },
        "occurrence_counts_scope": { "type": "string", "const": "wcag_only" },
        "passed_url_count": { "type": "integer", "minimum": 0 },
        "failed_url_count": { "type": "integer", "minimum": 0 },
        "violated_rule_count": { "type": "integer", "minimum": 0 },
        "top_recurring_rules": { "type": "array" },
        "performance_score": { "type": "integer", "minimum": 0, "maximum": 100 },
        "seo_score": { "type": "integer", "minimum": 0, "maximum": 100 },
        "security_score": { "type": "integer", "minimum": 0, "maximum": 100 },
        "mobile_score": { "type": "integer", "minimum": 0, "maximum": 100 },
        "performance_throttled_avg_score": { "type": "integer", "minimum": 0, "maximum": 100 },
        "wcag_coverage": { "$ref": "#/$defs/wcagCoverageSummary" },
        "accessibility_score_breakdown": {
          "type": "array",
          "items": { "$ref": "#/$defs/accessibilityScoreComponent" }
        },
        "management_risks": {
          "type": "array",
          "items": { "$ref": "#/$defs/managementRisk" }
        },
        "top_actions": {
          "type": "array",
          "items": { "$ref": "#/$defs/decisionAction" }
        },
        "commerce": { "type": ["object", "null"] },
        "en301549_rollup": {
          "type": "array",
          "items": { "$ref": "#/$defs/en301549BatchClauseRollup" }
        }
      }
    },
    "en301549BatchClauseRollup": {
      "type": "object",
      "required": ["en_clause", "wcag", "level", "title", "status", "affected_pages"],
      "additionalProperties": false,
      "properties": {
        "en_clause": { "type": "string" },
        "wcag": { "type": "string" },
        "level": { "type": "string", "enum": ["A", "AA"] },
        "title": { "type": "string" },
        "status": {
          "type": "string",
          "enum": ["violations_found", "no_violations_automated", "manual_review_required", "partial_automated_evaluation", "not_evaluated"]
        },
        "affected_pages": { "type": "integer", "minimum": 0 }
      }
    },
    "pageEntry": {
      "type": "object",
      "required": [
        "url",
        "accessibility_score",
        "overall_score",
        "grade",
        "certificate",
        "violation_count",
        "finding_count",
        "finding_occurrence_count",
        "severity_counts",
        "severity_counts_scope",
        "occurrence_counts_scope",
        "nodes_analyzed",
        "duration_ms",
        "module_scores",
        "risk",
        "principle_coverage",
        "findings"
      ],
      "additionalProperties": true,
      "properties": {
        "url": { "type": "string" },
        "accessibility_score": { "type": "integer", "minimum": 0, "maximum": 100 },
        "overall_score": { "type": "integer", "minimum": 0, "maximum": 100 },
        "grade": { "type": "string" },
        "certificate": { "type": "string" },
        "violation_count": { "type": "integer", "minimum": 0 },
        "finding_count": { "type": "integer", "minimum": 0 },
        "finding_occurrence_count": { "type": "integer", "minimum": 0 },
        "severity_counts": { "$ref": "#/$defs/severityCounts" },
        "severity_counts_scope": { "type": "string", "const": "wcag_only" },
        "occurrence_counts": { "$ref": "#/$defs/severityCounts" },
        "occurrence_counts_scope": { "type": "string", "const": "wcag_only" },
        "nodes_analyzed": { "type": "integer", "minimum": 0 },
        "duration_ms": { "type": "integer", "minimum": 0 },
        "module_scores": {
          "type": "array",
          "items": { "$ref": "#/$defs/moduleScore" }
        },
        "risk": { "$ref": "#/$defs/riskAssessment" },
        "principle_coverage": { "$ref": "#/$defs/principleCoverage" },
        "findings": { "type": "array" },
        "audit_flags": { "type": "array" },
        "audit_quality": { "$ref": "#/$defs/auditQuality" },
        "module_runs": { "type": "array" },
        "rule_outcomes": { "type": "array" },
        "accessibility_assessments": { "type": "array" },
        "navigation": { "type": "object" },
        "consent": { "type": "object" },
        "content_profile": { "type": "object" }
      }
    },
    "principleCoverage": {
      "type": "object",
      "required": ["perceivable", "operable", "understandable", "robust"],
      "additionalProperties": false,
      "properties": {
        "perceivable": { "$ref": "#/$defs/coverageRatio" },
        "operable": { "$ref": "#/$defs/coverageRatio" },
        "understandable": { "$ref": "#/$defs/coverageRatio" },
        "robust": { "$ref": "#/$defs/coverageRatio" }
      }
    },
    "coverageRatio": {
      "type": "object",
      "required": ["passed", "total", "ratio"],
      "additionalProperties": false,
      "properties": {
        "passed": { "type": "integer", "minimum": 0 },
        "total": { "type": "integer", "minimum": 0 },
        "ratio": { "type": "number", "minimum": 0, "maximum": 1 }
      }
    },
    "severityCounts": {
      "type": "object",
      "required": ["critical", "high", "medium", "low", "total"],
      "additionalProperties": false,
      "properties": {
        "critical": { "type": "integer", "minimum": 0 },
        "high": { "type": "integer", "minimum": 0 },
        "medium": { "type": "integer", "minimum": 0 },
        "low": { "type": "integer", "minimum": 0 },
        "total": { "type": "integer", "minimum": 0 }
      }
    },
    "moduleScore": {
      "type": "object",
      "required": ["name", "score", "grade", "weight_pct", "contributes_to_overall", "measurement_type"],
      "additionalProperties": false,
      "properties": {
        "name": { "type": "string" },
        "score": { "type": "integer", "minimum": 0, "maximum": 100 },
        "grade": { "type": "string" },
        "weight_pct": { "type": "integer", "minimum": 0, "maximum": 100 },
        "contributes_to_overall": { "type": "boolean" },
        "measurement_type": { "type": "string", "enum": ["measured", "heuristic", "optional"] }
      }
    },
    "riskAssessment": {
      "type": "object",
      "required": ["level", "score", "threshold", "driven_by", "critical_issues", "high_issues", "legal_flags", "blocking_issues", "interactive_critical_issues", "interactive_high_issues", "summary"],
      "additionalProperties": false,
      "properties": {
        "level": { "type": "string", "enum": ["low", "medium", "high", "critical"] },
        "score": { "type": "integer", "minimum": 0, "maximum": 100 },
        "threshold": { "type": "integer", "minimum": 0 },
        "driven_by": { "type": "string" },
        "critical_issues": { "type": "integer", "minimum": 0 },
        "high_issues": { "type": "integer", "minimum": 0 },
        "legal_flags": { "type": "integer", "minimum": 0 },
        "blocking_issues": { "type": "integer", "minimum": 0 },
        "interactive_critical_issues": { "type": "integer", "minimum": 0 },
        "interactive_high_issues": { "type": "integer", "minimum": 0 },
        "summary": { "type": "string" }
      }
    },
    "wcagCoverageSummary": {
      "type": "object",
      "required": ["level", "automated_criteria", "manual_review_criteria", "total_wcag_aa_criteria", "note"],
      "additionalProperties": false,
      "properties": {
        "level": { "type": "string" },
        "automated_criteria": { "type": "integer", "minimum": 0 },
        "manual_review_criteria": { "type": "integer", "minimum": 0 },
        "total_wcag_aa_criteria": { "type": "integer", "minimum": 0 },
        "note": { "type": "string" }
      }
    },
    "accessibilityScoreComponent": {
      "type": "object",
      "required": ["area", "score", "weight_pct", "estimated_lost_points", "main_driver"],
      "additionalProperties": false,
      "properties": {
        "area": { "type": "string" },
        "score": { "type": "integer", "minimum": 0, "maximum": 100 },
        "weight_pct": { "type": "integer", "minimum": 0, "maximum": 100 },
        "estimated_lost_points": { "type": "integer", "minimum": 0 },
        "main_driver": { "type": "string" }
      }
    },
    "managementRisk": {
      "type": "object",
      "required": ["dimension", "level", "rationale"],
      "additionalProperties": false,
      "properties": {
        "dimension": { "type": "string" },
        "level": { "type": "string" },
        "rationale": { "type": "string" }
      }
    },
    "decisionAction": {
      "type": "object",
      "required": ["title", "risk", "priority", "complexity", "occurrence_count", "root_cause", "expected_impact"],
      "additionalProperties": false,
      "properties": {
        "title": { "type": "string" },
        "risk": { "type": "string" },
        "priority": { "type": "string" },
        "complexity": { "type": "string" },
        "occurrence_count": { "type": "integer", "minimum": 0 },
        "root_cause": { "type": "string" },
        "expected_impact": { "type": "string" }
      }
    },
    "internalComparison": {
      "type": "object",
      "required": ["module_extremes", "outlier_urls", "root_causes"],
      "additionalProperties": false,
      "properties": {
        "module_extremes": { "type": "array", "items": { "$ref": "#/$defs/moduleExtreme" } },
        "outlier_urls": { "type": "array", "items": { "$ref": "#/$defs/urlOutlier" } },
        "root_causes": { "type": "array", "items": { "$ref": "#/$defs/rootCauseSummary" } }
      }
    },
    "moduleExtreme": {
      "type": "object",
      "required": ["module", "best_url", "best_score", "worst_url", "worst_score"],
      "additionalProperties": false,
      "properties": {
        "module": { "type": "string" },
        "best_url": { "type": "string" },
        "best_score": { "type": "integer", "minimum": 0, "maximum": 100 },
        "worst_url": { "type": "string" },
        "worst_score": { "type": "integer", "minimum": 0, "maximum": 100 }
      }
    },
    "urlOutlier": {
      "type": "object",
      "required": ["url", "accessibility_score", "batch_average", "delta_points", "reason"],
      "additionalProperties": false,
      "properties": {
        "url": { "type": "string" },
        "accessibility_score": { "type": "integer", "minimum": 0, "maximum": 100 },
        "batch_average": { "type": "integer", "minimum": 0, "maximum": 100 },
        "delta_points": { "type": "integer" },
        "reason": { "type": "string" }
      }
    },
    "rootCauseSummary": {
      "type": "object",
      "required": ["title", "occurrence_count", "affected_urls", "classification"],
      "additionalProperties": false,
      "properties": {
        "title": { "type": "string" },
        "occurrence_count": { "type": "integer", "minimum": 0 },
        "affected_urls": { "type": "integer", "minimum": 0 },
        "classification": { "type": "string" }
      }
    }
  }
}