feat: Update OpenAPI file replicated from Notehub

openapi.yaml

@@ -1167,6 +1167,13 @@ paths:
  - $ref: "#/components/parameters/endDateParam"
  - $ref: "#/components/parameters/systemFilesOnlyParam"
  - $ref: "#/components/parameters/filesQueryParam"
+ - $ref: "#/components/parameters/formatParam"
+ - $ref: "#/components/parameters/serialNumberFilterParam"
+ - $ref: "#/components/parameters/fleetUIDFilterQueryParam"
+ - $ref: "#/components/parameters/sessionUIDFilterParam"
+ - $ref: "#/components/parameters/eventUIDFilterQueryParam"
+ - $ref: "#/components/parameters/selectFieldsParam"
+
  - name: deviceUIDs
  description: Deprecated.
  in: query
@@ -1253,6 +1260,12 @@ paths:
  - $ref: "#/components/parameters/endDateParam"
  - $ref: "#/components/parameters/systemFilesOnlyParam"
  - $ref: "#/components/parameters/filesQueryParam"
+ - $ref: "#/components/parameters/formatParam"
+ - $ref: "#/components/parameters/serialNumberFilterParam"
+ - $ref: "#/components/parameters/fleetUIDFilterQueryParam"
+ - $ref: "#/components/parameters/sessionUIDFilterParam"
+ - $ref: "#/components/parameters/eventUIDFilterQueryParam"
+ - $ref: "#/components/parameters/selectFieldsParam"
  - name: deviceUIDs
  description: Deprecated.
  in: query
@@ -2223,6 +2236,7 @@ components:
  schema:
  type: integer
  minimum: 1
+ maximum: 10000
  default: 50
 
  pageNumParam:
@@ -2345,6 +2359,56 @@ components:
  type: string
  example: _health.qo, data.qo
 
+ formatParam:
+ name: format
+ in: query
+ required: false
+ schema:
+ type: string
+ enum: [json, csv]
+ default: json
+ description: Response format (JSON or CSV)
+
+ serialNumberFilterParam:
+ name: serialNumber
+ in: query
+ required: false
+ schema:
+ type: string
+ description: Filter by Serial Number
+
+ fleetUIDFilterQueryParam:
+ name: fleetUID
+ in: query
+ required: false
+ schema:
+ type: string
+ description: Filter by Fleet UID
+
+ sessionUIDFilterParam:
+ name: sessionUID
+ in: query
+ required: false
+ schema:
+ type: string
+ description: Filter by Session UID
+
+ eventUIDFilterQueryParam:
+ name: eventUID
+ in: query
+ required: false
+ schema:
+ type: string
+ description: Filter by Event UID
+
+ selectFieldsParam:
+ name: selectFields
+ in: query
+ required: false
+ schema:
+ type: string
+ description: Comma-separated list of fields to select from JSON payload (e.g., "field1,field2.subfield,field3"), this will reflect the columns in the CSV output.
+
  filenameQueryParam:
  name: filename
  in: query
@@ -2419,6 +2483,11 @@ components:
 
  EventsResponse:
  description: The response body from a GET events request.
+ headers:
+ X-Has-More:
+ description: True if there are more events
+ schema:
+ type: boolean
  content:
  application/json:
  schema:
@@ -2431,6 +2500,9 @@ components:
  has_more:
  type: boolean
  description: True if there are more events
+ through:
+ type: string
+ description: The UID of the last event returned
  required:
  - events
  - has_more
@@ -2469,6 +2541,15 @@ components:
  tri_timezone: America/New_York
  tri_points: 6
  has_more: true
+ text/csv:
+ schema:
+ type: string
+ format: binary
+ example: |
+ eventUID,deviceUID,when,best_location_type,best_lat,best_lon,body.temperature,body.humidity
+ e123456-7890-abcd-ef01-234567890abc,dev:000000000000001,1625097600,gps,37.7749,-122.4194,22.5,45.2
+ f234567-8901-bcde-fg12-345678901bcd,dev:000000000000002,1625097660,triangulated,40.7128,-74.0060,24.3,48.7
+ g345678-9012-cdef-gh23-456789012cde,dev:000000000000003,1625097720,tower,51.5074,-0.1278,20.1,52.9
 
  EventsByCursorResponse:
  description: The response body from a GET events by cursor request.