deaf-first-platform/Services/pinksync/openapi/openapi.yaml at develop · Pmaster-dev/deaf-first-platform · 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
69
70
71
72
73
74
75
76
77
openapi: 3.1.0
info:
  title: PinkSync - Accessibility Engine
  version: 1.0.0
  description: Real-time accessibility preference sync for MBTQ Universe.

servers:
  - url: https://api.mbtquniverse.com/sync

security:
  - DeafAuthToken: []

components:
  securitySchemes:
    DeafAuthToken:
      type: http
      scheme: bearer

  schemas:
    Preferences:
      type: object
      properties:
        captions: { type: boolean }
        aslMode: { type: boolean }
        contrast: { type: string }
        fontSize: { type: string }

    Feature:
      type: object
      properties:
        id: { type: string }
        name: { type: string }
        description: { type: string }

paths:
  /status:
    get:
      tags: [Sync]
      summary: Check PinkSync status
      responses:
        "200":
          description: Sync status
          content:
            application/json:
              schema:
                type: object
                properties:
                  online: { type: boolean }
                  latencyMs: { type: number }

  /preferences:
    post:
      tags: [Preferences]
      summary: Update accessibility preferences
      requestBody:
        content:
          application/json:
            schema: { $ref: "#/components/schemas/Preferences" }
      responses:
        "200":
          description: Updated preferences
          content:
            application/json:
              schema: { $ref: "#/components/schemas/Preferences" }

  /features:
    get:
      tags: [Features]
      summary: List available accessibility features
      responses:
        "200":
          description: List of features
          content:
            application/json:
              schema:
                type: array
                items: { $ref: "#/components/schemas/Feature" }