accessibility-quickscan/openapi.yaml at main · volta-npo/accessibility-quickscan · GitHub

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
openapi: 3.1.0
info:
  title: "Accessibility QuickScan API"
  version: "1.1.0"
  description: "Optional backend API for A plain-English accessibility triage checklist for small-business websites."
servers:
  - url: http://127.0.0.1:8788
    description: Rust backend
paths:
  /health:
    get:
      summary: Health check
      responses:
        '200':
          description: Product identity and health status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
  /score:
    get:
      summary: Score deterministic sample gates
      responses:
        '200':
          description: Release score, warnings, artifacts, and fingerprint
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScoreResponse'
components:
  schemas:
    HealthResponse:
      type: object
      required: [ok, product, title]
      properties:
        ok:
          type: boolean
        product:
          type: string
        title:
          type: string
    EvidencePayload:
      type: object
      properties:
        rows:
          type: array
          items:
            type: object
            properties:
              label: { type: string }
              score: { type: number, minimum: 0, maximum: 100 }
              evidence: { type: string }
              owner: { type: string }
              approved: { type: boolean }
    ScoreResponse:
      type: object
      properties:
        product:
          type: object
        score:
          type: object
        artifacts:
          type: array
          items: { type: string }
        release_hash:
          type: string
        fingerprint:
          type: string