{"openapi":"3.1.0","jsonSchemaDialect":"https://json-schema.org/draft/2020-12/schema","info":{"title":"Marlo accessibility checker public API","version":"1.0.0","description":"Anonymous, read-only access to published ACT rule measurements, coverage and routing. The hosted API does not scan URLs or accept page uploads. Run the CLI locally to scan a page."},"servers":[{"url":"https://trymarlo.pages.dev"}],"externalDocs":{"description":"Marlo developer documentation","url":"https://trymarlo.pages.dev/developers/"},"security":[],"paths":{"/api/v1/coverage":{"get":{"operationId":"getCoverage","description":"Read measured coverage and pooled accuracy for each engine.","summary":"Read measured coverage and pooled accuracy for each engine.","security":[],"parameters":[],"responses":{"200":{"description":"Published accessibility measurement metadata.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Coverage"}}}},"400":{"description":"Structured problem details with a stable error code and a resolution hint.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Structured problem details with a stable error code and a resolution hint.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Structured problem details with a stable error code and a resolution hint.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"406":{"description":"Structured problem details with a stable error code and a resolution hint.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/api/v1/rules":{"get":{"operationId":"listRules","description":"List every published ACT rule, including rules Marlo does not implement.","summary":"List every published ACT rule, including rules Marlo does not implement.","security":[],"parameters":[],"responses":{"200":{"description":"Published accessibility measurement metadata.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rules"}}}},"400":{"description":"Structured problem details with a stable error code and a resolution hint.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Structured problem details with a stable error code and a resolution hint.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Structured problem details with a stable error code and a resolution hint.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"406":{"description":"Structured problem details with a stable error code and a resolution hint.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/api/v1/rules/{actRuleId}":{"get":{"operationId":"getRule","description":"Read a rule definition, measured engine results and routing decision.","summary":"Read a rule definition, measured engine results and routing decision.","security":[],"parameters":[{"name":"actRuleId","in":"path","required":true,"description":"Six-character ACT rule identifier.","schema":{"type":"string","pattern":"^[a-z0-9]{6}$"}}],"responses":{"200":{"description":"Published accessibility measurement metadata.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rule"}}}},"400":{"description":"Structured problem details with a stable error code and a resolution hint.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Structured problem details with a stable error code and a resolution hint.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Structured problem details with a stable error code and a resolution hint.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"406":{"description":"Structured problem details with a stable error code and a resolution hint.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/api/v1/calibration":{"get":{"operationId":"getCalibration","description":"Read the complete committed calibration table without changing its measurements.","summary":"Read the complete committed calibration table without changing its measurements.","security":[],"parameters":[],"responses":{"200":{"description":"Published accessibility measurement metadata.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Calibration"}}}},"400":{"description":"Structured problem details with a stable error code and a resolution hint.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Structured problem details with a stable error code and a resolution hint.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"405":{"description":"Structured problem details with a stable error code and a resolution hint.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"406":{"description":"Structured problem details with a stable error code and a resolution hint.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}}},"components":{"schemas":{"Corpus":{"type":"object","properties":{"retrieved":{"type":"string","format":"date"},"rules":{"type":"integer","minimum":1},"rulesWithTestCases":{"type":"integer","minimum":1},"testCases":{"type":"integer","minimum":1}},"required":["retrieved","rules","rulesWithTestCases","testCases"],"additionalProperties":false},"CoverageCounts":{"type":"object","properties":{"implemented":{"type":"integer","minimum":0},"publishedActRules":{"type":"integer","minimum":1},"calibratable":{"type":"integer","minimum":0},"implementedButUnmeasurable":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9]{6}$"}}},"required":["implemented","publishedActRules","calibratable","implementedButUnmeasurable"],"additionalProperties":false},"Aggregate":{"type":"object","properties":{"strictPrecision":{"type":["number","null"],"minimum":0,"maximum":1},"strictRecall":{"type":["number","null"],"minimum":0,"maximum":1},"falsePositiveRate":{"type":["number","null"],"minimum":0,"maximum":1},"sampleSize":{"type":"integer","minimum":0}},"required":["strictPrecision","strictRecall","falsePositiveRate","sampleSize"],"additionalProperties":false},"StrictAccuracy":{"type":"object","properties":{"truePositives":{"type":"integer","minimum":0},"falsePositives":{"type":"integer","minimum":0},"falseNegatives":{"type":"integer","minimum":0},"trueNegatives":{"type":"integer","minimum":0},"cantTellOnFailed":{"type":"integer","minimum":0},"cantTellOnPassed":{"type":"integer","minimum":0},"precision":{"type":["number","null"],"minimum":0,"maximum":1},"recall":{"type":["number","null"],"minimum":0,"maximum":1},"f1":{"type":["number","null"],"minimum":0,"maximum":1},"falsePositiveRate":{"type":["number","null"],"minimum":0,"maximum":1}},"required":["truePositives","falsePositives","falseNegatives","trueNegatives","cantTellOnFailed","cantTellOnPassed","precision","recall","f1","falsePositiveRate"],"additionalProperties":false},"Measurement":{"type":"object","properties":{"actRuleId":{"type":"string","pattern":"^[a-z0-9]{6}$"},"engine":{"type":"string","enum":["marlo","axe-core","alfa","htmlcs"]},"engineVersion":{"type":"string"},"engineRuleIds":{"type":"array","items":{"type":"string"}},"mappingKind":{"type":"string","enum":["exact","partial","superset","none"]},"testCaseCount":{"type":"integer","minimum":0},"matrix":{"type":"object","properties":{"passed":{"type":"object","properties":{"passed":{"type":"integer","minimum":0},"failed":{"type":"integer","minimum":0},"cantTell":{"type":"integer","minimum":0},"inapplicable":{"type":"integer","minimum":0}},"required":["passed","failed","cantTell","inapplicable"],"additionalProperties":false},"failed":{"type":"object","properties":{"passed":{"type":"integer","minimum":0},"failed":{"type":"integer","minimum":0},"cantTell":{"type":"integer","minimum":0},"inapplicable":{"type":"integer","minimum":0}},"required":["passed","failed","cantTell","inapplicable"],"additionalProperties":false},"inapplicable":{"type":"object","properties":{"passed":{"type":"integer","minimum":0},"failed":{"type":"integer","minimum":0},"cantTell":{"type":"integer","minimum":0},"inapplicable":{"type":"integer","minimum":0}},"required":["passed","failed","cantTell","inapplicable"],"additionalProperties":false},"errored":{"type":"integer","minimum":0},"unsupported":{"type":"integer","minimum":0}},"required":["passed","failed","inapplicable","errored","unsupported"],"additionalProperties":false},"act":{"type":"object","properties":{"consistency":{"type":"string","enum":["consistent","partial","incorrect","unmapped"]},"automation":{"type":"string","enum":["automated","semi-automated","not-applicable"]},"disallowed":{"type":"integer","minimum":0}},"required":["consistency","automation","disallowed"],"additionalProperties":false},"strict":{"$ref":"#/components/schemas/StrictAccuracy"},"flatteredByProtocol":{"type":"boolean"}},"required":["actRuleId","engine","engineVersion","engineRuleIds","mappingKind","testCaseCount","matrix","act","strict","flatteredByProtocol"],"additionalProperties":false},"Routing":{"type":"object","properties":{"actRuleId":{"type":"string","pattern":"^[a-z0-9]{6}$"},"chosen":{"type":["string","null"],"enum":["marlo","axe-core","alfa","htmlcs",null]},"reason":{"type":"string","enum":["best-measured","sole-implementer","uncalibrated","no-implementer"]},"candidates":{"type":"array","items":{"type":"object","properties":{"engine":{"type":"string","enum":["marlo","axe-core","alfa","htmlcs"]},"strictRecall":{"type":["number","null"],"minimum":0,"maximum":1},"strictPrecision":{"type":["number","null"],"minimum":0,"maximum":1},"consistency":{"type":"string","enum":["consistent","partial","incorrect","unmapped"]}},"required":["engine","strictRecall","strictPrecision","consistency"],"additionalProperties":false}},"autoFixPermitted":{"type":"boolean"}},"required":["actRuleId","chosen","reason","candidates","autoFixPermitted"],"additionalProperties":false},"Rule":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9]{6}$"},"name":{"type":"string"},"ruleType":{"type":"string","enum":["atomic","composite"]},"requirements":{"type":"array","items":{"type":"string"}},"inputAspects":{"type":"array","items":{"type":"string"}},"testCases":{"type":"object","properties":{"passed":{"type":"integer","minimum":0},"failed":{"type":"integer","minimum":0},"inapplicable":{"type":"integer","minimum":0}},"required":["passed","failed","inapplicable"],"additionalProperties":false},"implemented":{"type":"boolean"},"measurements":{"type":"array","items":{"$ref":"#/components/schemas/Measurement"}},"routing":{"anyOf":[{"$ref":"#/components/schemas/Routing"},{"type":"null"}]}},"required":["id","name","ruleType","requirements","inputAspects","testCases","implemented","measurements","routing"],"additionalProperties":false},"Rules":{"type":"object","properties":{"generated":{"type":"string","format":"date"},"rules":{"type":"array","items":{"$ref":"#/components/schemas/Rule"}}},"required":["generated","rules"],"additionalProperties":false},"Coverage":{"type":"object","properties":{"generated":{"type":"string","format":"date"},"corpus":{"$ref":"#/components/schemas/Corpus"},"coverage":{"$ref":"#/components/schemas/CoverageCounts"},"renderer":{"type":"string","enum":["static","browser"]},"engines":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","enum":["marlo","axe-core","alfa","htmlcs"]},"version":{"type":"string"},"mappedRules":{"type":"integer","minimum":0},"strict":{"$ref":"#/components/schemas/Aggregate"}},"required":["id","version","mappedRules","strict"],"additionalProperties":false}},"limits":{"type":"object","properties":{"readOnly":{"const":true,"type":"boolean"},"hostedScanning":{"const":false,"type":"boolean"},"authentication":{"const":"none","type":"string"}},"required":["readOnly","hostedScanning","authentication"],"additionalProperties":false}},"required":["generated","corpus","coverage","renderer","engines","limits"],"additionalProperties":false},"Calibration":{"type":"object","properties":{"schemaVersion":{"const":1,"type":"integer"},"generated":{"type":"string","format":"date"},"commit":{"type":["string","null"]},"corpus":{"$ref":"#/components/schemas/Corpus"},"engines":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","enum":["marlo","axe-core","alfa","htmlcs"]},"version":{"type":"string"},"mappedRules":{"type":"integer","minimum":0}},"required":["id","version","mappedRules"],"additionalProperties":false}},"renderer":{"type":"string","enum":["static","browser"]},"entries":{"type":"array","items":{"$ref":"#/components/schemas/Measurement"}},"routing":{"type":"array","items":{"$ref":"#/components/schemas/Routing"}},"autoFixThreshold":{"type":"object","properties":{"minStrictPrecision":{"type":"number","minimum":0,"maximum":1},"minSampleSize":{"type":"integer","minimum":1},"rationale":{"type":"string","minLength":1}},"required":["minStrictPrecision","minSampleSize","rationale"],"additionalProperties":false},"coverage":{"$ref":"#/components/schemas/CoverageCounts"},"aggregate":{"$ref":"#/components/schemas/Aggregate"},"realCorpus":{"anyOf":[{"$ref":"#/components/schemas/RealCorpus"},{"type":"null"}]},"heldOutCorpus":{"anyOf":[{"$ref":"#/components/schemas/RealCorpus"},{"type":"null"}]}},"required":["schemaVersion","generated","commit","corpus","engines","renderer","entries","routing","autoFixThreshold","coverage","aggregate","realCorpus","heldOutCorpus"],"additionalProperties":false},"RealCorpus":{"type":"object","properties":{"retrieved":{"type":"string","format":"date"},"pages":{"type":"integer","minimum":1},"categories":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string"},"pages":{"type":"integer","minimum":1}},"required":["category","pages"],"additionalProperties":false}},"adjudication":{"type":"object","properties":{"status":{"type":"string","enum":["awaiting-adjudication","partial","adjudicated"]},"ratedCells":{"type":"integer","minimum":0},"resolvedCells":{"type":"integer","minimum":0},"totalCells":{"type":"integer","minimum":1},"kappa":{"type":["number","null"],"minimum":-1,"maximum":1},"percentAgreement":{"type":["number","null"],"minimum":0,"maximum":1},"raters":{"type":"array","items":{"type":"object","properties":{"rater":{"type":"string","enum":["A","B"]},"kind":{"type":"string","enum":["person","model"]},"model":{"type":["string","null"],"minLength":1}},"required":["rater","kind","model"],"additionalProperties":false}},"resolutions":{"type":"object","properties":{"person":{"type":"integer","minimum":0},"model":{"type":"integer","minimum":0}},"required":["person","model"],"additionalProperties":false}},"required":["status","ratedCells","resolvedCells","totalCells","kappa","percentAgreement","raters","resolutions"],"additionalProperties":false},"entries":{"type":"array","items":{"type":"object","properties":{"actRuleId":{"type":"string","pattern":"^[a-z0-9]{6}$"},"engine":{"type":"string","enum":["marlo","axe-core","alfa","htmlcs"]},"outcomes":{"type":"object","properties":{"passed":{"type":"integer","minimum":0},"failed":{"type":"integer","minimum":0},"cantTell":{"type":"integer","minimum":0},"inapplicable":{"type":"integer","minimum":0}},"required":["passed","failed","cantTell","inapplicable"],"additionalProperties":false},"errored":{"type":"integer","minimum":0},"unsupported":{"type":"integer","minimum":0},"findings":{"type":"integer","minimum":0},"graded":{"type":"object","properties":{"resolvedCells":{"type":"integer","minimum":0},"unresolvedCells":{"type":"integer","minimum":0},"cantTellTruth":{"type":"integer","minimum":0},"strict":{"anyOf":[{"$ref":"#/components/schemas/StrictAccuracy"},{"type":"null"}]}},"required":["resolvedCells","unresolvedCells","cantTellTruth","strict"],"additionalProperties":false}},"required":["actRuleId","engine","outcomes","errored","unsupported","findings","graded"],"additionalProperties":false}},"agreement":{"type":"array","items":{"type":"object","properties":{"actRuleId":{"type":"string","pattern":"^[a-z0-9]{6}$"},"engines":{"type":"array","items":{"type":"string","enum":["marlo","axe-core","alfa","htmlcs"]},"minItems":2,"maxItems":2},"pages":{"type":"integer","minimum":0},"percentAgreement":{"type":["number","null"],"minimum":0,"maximum":1},"kappa":{"type":["number","null"],"minimum":-1,"maximum":1}},"required":["actRuleId","engines","pages","percentAgreement","kappa"],"additionalProperties":false}},"aggregate":{"type":"object","properties":{"findingsPerPage":{"type":"array","items":{"type":"object","properties":{"engine":{"type":"string","enum":["marlo","axe-core","alfa","htmlcs"]},"pages":{"type":"integer","minimum":0},"findings":{"type":"integer","minimum":0},"mean":{"type":["number","null"],"minimum":0}},"required":["engine","pages","findings","mean"],"additionalProperties":false}},"perPage":{"type":"array","items":{"type":"object","properties":{"page":{"type":"string","pattern":"^[a-z]+ \\([0-9a-f]{12}\\)$"},"findings":{"type":"object","properties":{"marlo":{"type":["integer","null"],"minimum":0},"axe-core":{"type":["integer","null"],"minimum":0},"alfa":{"type":["integer","null"],"minimum":0},"htmlcs":{"type":["integer","null"],"minimum":0}},"required":["marlo","axe-core","alfa","htmlcs"],"additionalProperties":false}},"required":["page","findings"],"additionalProperties":false}},"invariant":{"type":"object","properties":{"pages":{"type":"integer","minimum":0},"pagesWhereItWouldFire":{"type":"integer","minimum":0},"fraction":{"type":["number","null"],"minimum":0,"maximum":1},"perRule":{"type":"array","items":{"type":"object","properties":{"actRuleId":{"type":"string","pattern":"^[a-z0-9]{6}$"},"routedTo":{"type":["string","null"],"enum":["marlo","axe-core","alfa","htmlcs",null]},"pagesWhereItWouldFire":{"type":"integer","minimum":0}},"required":["actRuleId","routedTo","pagesWhereItWouldFire"],"additionalProperties":false}}},"required":["pages","pagesWhereItWouldFire","fraction","perRule"],"additionalProperties":false},"accuracy":{"$ref":"#/components/schemas/Aggregate"},"engines":{"type":"array","items":{"type":"object","properties":{"engine":{"type":"string","enum":["marlo","axe-core","alfa","htmlcs"]},"rules":{"type":"integer","minimum":0},"truePositives":{"type":"integer","minimum":0},"falsePositives":{"type":"integer","minimum":0},"falseNegatives":{"type":"integer","minimum":0},"trueNegatives":{"type":"integer","minimum":0},"strictPrecision":{"type":["number","null"],"minimum":0,"maximum":1},"strictRecall":{"type":["number","null"],"minimum":0,"maximum":1},"falsePositiveRate":{"type":["number","null"],"minimum":0,"maximum":1},"sampleSize":{"type":"integer","minimum":0}},"required":["engine","rules","truePositives","falsePositives","falseNegatives","trueNegatives","strictPrecision","strictRecall","falsePositiveRate","sampleSize"],"additionalProperties":false}}},"required":["findingsPerPage","perPage","invariant","accuracy","engines"],"additionalProperties":false}},"required":["retrieved","pages","categories","adjudication","entries","agreement","aggregate"],"additionalProperties":false},"Problem":{"type":"object","properties":{"type":{"type":"string","format":"uri-reference"},"title":{"type":"string"},"status":{"type":"integer","minimum":400,"maximum":599},"detail":{"type":"string"},"instance":{"type":"string","format":"uri-reference"},"code":{"type":"string"},"hint":{"type":"string"},"docs":{"type":"string","format":"uri"}},"required":["type","title","status","detail","instance","code","hint","docs"],"additionalProperties":false}}}}