auditmysite 0.45.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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/casoon/auditmysite/docs/studio-contract.schema.json",
  "title": "auditmysite Studio contract",
  "description": "Data contract between auditmysite (CLI/library) and auditmysite_studio (GUI). Types defined in src/studio/mod.rs.",
  "type": "object",
  "required": [
    "url", "timestamp", "accessibility_score", "overall_score", "grade",
    "certificate", "risk_level", "risk_summary", "legal_flags", "blocking_issues",
    "critical_issues", "high_issues", "medium_issues", "low_issues", "total_issues",
    "module_scores", "findings", "nodes_analyzed", "execution_time_ms",
    "executive_summary", "artifacts", "json_report", "cli_version"
  ],
  "additionalProperties": false,
  "properties": {
    "url": { "type": "string" },
    "timestamp": { "type": "string", "format": "date-time" },
    "accessibility_score": { "type": "integer", "minimum": 0, "maximum": 100 },
    "overall_score": { "type": "integer", "minimum": 0, "maximum": 100 },
    "grade": { "type": "string", "enum": ["A", "B", "C", "D", "F"] },
    "certificate": { "type": "string", "enum": ["SEHR GUT", "GUT", "SOLIDE", "AUSBAUFÄHIG", "UNGENÜGEND"] },
    "risk_level": { "type": "string", "enum": ["low", "medium", "high", "critical"] },
    "risk_summary": { "type": "string" },
    "legal_flags": { "type": "integer", "minimum": 0 },
    "blocking_issues": { "type": "integer", "minimum": 0 },
    "critical_issues": { "type": "integer", "minimum": 0 },
    "high_issues": { "type": "integer", "minimum": 0 },
    "medium_issues": { "type": "integer", "minimum": 0 },
    "low_issues": { "type": "integer", "minimum": 0 },
    "total_issues": { "type": "integer", "minimum": 0 },
    "module_scores": {
      "type": "array",
      "items": { "$ref": "#/$defs/moduleScore" }
    },
    "findings": {
      "type": "array",
      "items": { "$ref": "#/$defs/findingPreview" }
    },
    "nodes_analyzed": { "type": "integer", "minimum": 0 },
    "execution_time_ms": { "type": "integer", "minimum": 0 },
    "executive_summary": { "$ref": "#/$defs/executiveSummary" },
    "artifacts": { "$ref": "#/$defs/reportArtifacts" },
    "json_report": { "type": "string" },
    "cli_version": { "type": "string", "description": "Semver version of the auditmysite CLI that generated this response" }
  },
  "$defs": {
    "moduleScore": {
      "type": "object",
      "required": ["name", "score", "grade", "weight_pct", "contributes_to_overall"],
      "additionalProperties": false,
      "properties": {
        "name": { "type": "string" },
        "score": { "type": "integer", "minimum": 0, "maximum": 100 },
        "grade": { "type": "string" },
        "weight_pct": { "type": "integer", "minimum": 0 },
        "contributes_to_overall": {
          "type": "boolean",
          "description": "True when this module feeds into overall_score. False for supplemental dimensions (UX, Journey)."
        }
      }
    },
    "findingPreview": {
      "type": "object",
      "required": ["rule_id", "title", "severity", "occurrences", "user_impact", "wcag_criterion"],
      "additionalProperties": false,
      "properties": {
        "rule_id": { "type": "string" },
        "title": { "type": "string" },
        "severity": { "type": "string", "enum": ["critical", "high", "medium", "low"] },
        "occurrences": { "type": "integer", "minimum": 0 },
        "user_impact": { "type": "string" },
        "wcag_criterion": { "type": "string" }
      }
    },
    "executiveSummary": {
      "type": "object",
      "required": [
        "executive_lead", "verdict", "benchmark_context", "key_points",
        "top_actions", "overall_impact", "positive_aspects", "next_step"
      ],
      "additionalProperties": false,
      "properties": {
        "executive_lead": { "type": "string" },
        "verdict": { "type": "string" },
        "benchmark_context": { "type": "string" },
        "key_points": {
          "type": "array",
          "items": { "type": "string" }
        },
        "top_actions": {
          "type": "array",
          "items": { "type": "string" }
        },
        "overall_impact": {
          "type": "array",
          "items": {
            "type": "array",
            "minItems": 2,
            "maxItems": 2,
            "items": [
              { "type": "string" },
              { "type": "string" }
            ]
          }
        },
        "positive_aspects": {
          "type": "array",
          "items": { "type": "string" }
        },
        "next_step": { "type": "string" }
      }
    },
    "reportArtifacts": {
      "type": "object",
      "required": ["audit_json_path", "studio_snapshot_path", "pdf_path"],
      "additionalProperties": false,
      "properties": {
        "audit_json_path": { "type": ["string", "null"] },
        "studio_snapshot_path": { "type": ["string", "null"] },
        "pdf_path": { "type": ["string", "null"] }
      }
    },
    "historyEntry": {
      "type": "object",
      "required": [
        "id", "url", "timestamp", "accessibility_score", "overall_score",
        "grade", "certificate", "risk_level", "total_issues", "critical_issues",
        "high_issues", "execution_time_ms", "module_scores", "artifacts"
      ],
      "additionalProperties": false,
      "properties": {
        "id": { "type": "string" },
        "url": { "type": "string" },
        "timestamp": { "type": "string", "format": "date-time" },
        "accessibility_score": { "type": "integer", "minimum": 0, "maximum": 100 },
        "overall_score": { "type": "integer", "minimum": 0, "maximum": 100 },
        "grade": { "type": "string" },
        "certificate": { "type": "string" },
        "risk_level": { "type": "string", "enum": ["low", "medium", "high", "critical"] },
        "total_issues": { "type": "integer", "minimum": 0 },
        "critical_issues": { "type": "integer", "minimum": 0 },
        "high_issues": { "type": "integer", "minimum": 0 },
        "execution_time_ms": { "type": "integer", "minimum": 0 },
        "module_scores": {
          "type": "array",
          "items": { "$ref": "#/$defs/moduleScore" }
        },
        "artifacts": { "$ref": "#/$defs/reportArtifacts" }
      }
    }
  }
}