technical-challenge/spec.yaml at main · ctrl-hub/technical-challenge · 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
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
openapi: 3.1.0
info:
  version: 1.0.0
  title: Equipment Exposure Service
paths:
  /exposure:
    get:
      summary: Retrieve a collection of exposure resources
      operationId: getExposures
      responses:
        "200":
          description: The collection of exposure resources
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/Exposure"
    post:
      summary: Record an exposure
      operationId: recordExposure
      requestBody:
        $ref: "#/components/requestBodies/ExposurePost"
      responses:
        "201":
          description: The created exposure resource
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Exposure"

  /exposure/{exposureId}:
    get:
      summary: Retrieve an exposure resource
      operationId: getExposure
      parameters:
        - name: exposureId
          required: true
          in: path
          schema:
            type: string
            format: uuid
            examples:
              - "e8f7b50c-cc18-42f9-a275-0b4ead73f806"
      responses:
        "201":
          description: The matching exposure resource
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Exposure"

  /users/{userId}/exposure-summary:
    get:
      summary: Retrieve the exposure summary for a user
      operationId: getUserExposureSummary
      parameters:
        - name: userId
          required: true
          in: path
          schema:
            type: string
            format: uuid
            examples:
              - "713be58e-0d79-4df2-a85c-9f44ca513a7d"
        - name: starting_at
          required: false
          in: query
          schema:
            type: string
            format: date
            examples:
              - "2025-01-01T00:00:00Z"
        - name: ending_at
          required: false
          in: query
          schema:
            type: string
            format: date
            examples:
              - "2025-01-31T23:59:59Z"
      responses:
        "200":
          description: The summary payload
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ExposureSummary"

components:
  requestBodies:
    ExposurePost:
      required: true
      content:
        application/json:
          schema:
            type: object
            properties:
              equipment_id:
                type: string
                format: uuid
                examples:
                  - "2e85d43d-dd9b-4e8d-b2ce-97b8d7d69d49"
              duration:
                type: integer
                description: The duration of the exposure (in minutes)
                examples:
                  - 5
              user_id:
                type: string
                format: uuid
                examples:
                  - "713be58e-0d79-4df2-a85c-9f44ca513a7d"
  schemas:
    Exposure:
      type: object
      properties:
        id:
          type: string
          format: uuid
          examples:
            - "e8f7b50c-cc18-42f9-a275-0b4ead73f806"
        equipment:
          $ref: "#/components/schemas/EquipmentItem"
        duration:
          type: integer
          description: The duration of the exposure (in minutes)
          examples:
            - 5
        a8:
          type: number
          description: The A8 value for the exposure
          examples:
            - 1.25
        points:
          type: number
          description: The partial exposure of points
          examples:
            - 25.1
        user:
          $ref: "#/components/schemas/User"
    ExposureSummary:
      type: object
      properties:
        a8:
          type: number
          description: The A8 value for the exposure
          examples:
            - 1.25
        points:
          type: number
          description: The partial exposure of points
          examples:
            - 25.1
        user:
          $ref: "#/components/schemas/User"
    User:
      type: object
      properties:
        id:
          type: string
          format: uuid
          examples:
            - "713be58e-0d79-4df2-a85c-9f44ca513a7d"
        name:
          type: string
          examples:
            - "Bobby Tables"
    EquipmentItem:
      type: object
      properties:
        id:
          type: string
          format: uuid
          examples:
            - "2e85d43d-dd9b-4e8d-b2ce-97b8d7d69d49"
            - "36603447-2f30-41b1-a908-526c0b6f1755"
        name:
          type: string
          examples:
            - "AirCat - Drill - 4337"
            - "JCB - Hydraulic Breaker - CEJCBHM25"
        vibration_magnitude:
          type: number
          examples:
            - 2.1
            - 4.0