pollutri
/
res_levis_backend
1
0
Fork 0
Koodi Ongelmat 9 Pull-pyynnöt 0 Julkaisut 0 Wiki Toiminta
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
435 Commitit
3 Branchit
268 MiB
 
 
 
 
Haara: master
Branchit Tagit
${ item.name }
Create branch ${ searchTerm }
from 'master'
${ noResults }
res_levis_backend/api/openapi.yaml

918 rivejä
24 KiB
Raaka Pysyvä linkki Blame Historia 

  1. openapi: 3.0.3

  2. info:

  3.   title: Presence API

  4.   description: API for gateways, zones, trackers, parser configs, settings, alerts, and tracks.

  5.   version: 1.0.0

  6. 

  7. servers:

  8.   - url: /

  9.     description: Default server

  10. 

  11. paths:

  12.   # --- Health ---

  13.   /health:

  14.     get:

  15.       summary: Liveness check

  16.       operationId: health

  17.       tags: [Health]

  18.       responses:

  19.         '200':

  20.           description: Service is alive

  21.           content:

  22.             application/json:

  23.               schema:

  24.                 type: object

  25.                 properties:

  26.                   status:

  27.                     type: string

  28.                     example: ok

  29. 

  30.   /ready:

  31.     get:

  32.       summary: Readiness check (DB connectivity)

  33.       operationId: ready

  34.       tags: [Health]

  35.       responses:

  36.         '200':

  37.           description: Service is ready

  38.           content:

  39.             application/json:

  40.               schema:

  41.                 type: object

  42.                 properties:

  43.                   status:

  44.                     type: string

  45.                     example: ready

  46.         '503':

  47.           $ref: '#/components/responses/ServiceUnavailable'

  48. 

  49.   # --- Gateways ---

  50.   /reslevis/getGateways:

  51.     get:

  52.       summary: List all gateways

  53.       operationId: getGateways

  54.       tags: [Gateways]

  55.       responses:

  56.         '200':

  57.           description: List of gateways

  58.           content:

  59.             application/json:

  60.               schema:

  61.                 type: array

  62.                 items:

  63.                   $ref: '#/components/schemas/Gateway'

  64.         '500':

  65.           $ref: '#/components/responses/InternalError'

  66. 

  67.   /reslevis/postGateway:

  68.     post:

  69.       summary: Create a gateway

  70.       operationId: postGateway

  71.       tags: [Gateways]

  72.       requestBody:

  73.         required: true

  74.         content:

  75.           application/json:

  76.             schema:

  77.               $ref: '#/components/schemas/Gateway'

  78.       responses:

  79.         '201':

  80.           description: Gateway created

  81.           content:

  82.             application/json:

  83.               schema:

  84.                 $ref: '#/components/schemas/StatusCreated'

  85.         '400':

  86.           $ref: '#/components/responses/BadRequest'

  87.         '500':

  88.           $ref: '#/components/responses/InternalError'

  89. 

  90.   /reslevis/removeGateway/{id}:

  91.     delete:

  92.       summary: Delete a gateway by ID

  93.       operationId: removeGateway

  94.       tags: [Gateways]

  95.       parameters:

  96.         - $ref: '#/components/parameters/PathId'

  97.       responses:

  98.         '200':

  99.           description: Gateway deleted

  100.           content:

  101.             application/json:

  102.               schema:

  103.                 $ref: '#/components/schemas/StatusDeleted'

  104.         '404':

  105.           $ref: '#/components/responses/NotFound'

  106.         '500':

  107.           $ref: '#/components/responses/InternalError'

  108. 

  109.   /reslevis/updateGateway/{id}:

  110.     put:

  111.       summary: Update a gateway by ID

  112.       operationId: updateGateway

  113.       tags: [Gateways]

  114.       parameters:

  115.         - $ref: '#/components/parameters/PathId'

  116.       requestBody:

  117.         required: true

  118.         content:

  119.           application/json:

  120.             schema:

  121.               $ref: '#/components/schemas/Gateway'

  122.       responses:

  123.         '200':

  124.           description: Gateway updated

  125.           content:

  126.             application/json:

  127.               schema:

  128.                 $ref: '#/components/schemas/StatusUpdated'

  129.         '400':

  130.           $ref: '#/components/responses/BadRequest'

  131.         '404':

  132.           $ref: '#/components/responses/NotFound'

  133.         '500':

  134.           $ref: '#/components/responses/InternalError'

  135. 

  136.   # --- Zones ---

  137.   /reslevis/getZones:

  138.     get:

  139.       summary: List all zones

  140.       operationId: getZones

  141.       tags: [Zones]

  142.       responses:

  143.         '200':

  144.           description: List of zones

  145.           content:

  146.             application/json:

  147.               schema:

  148.                 type: array

  149.                 items:

  150.                   $ref: '#/components/schemas/Zone'

  151.         '500':

  152.           $ref: '#/components/responses/InternalError'

  153. 

  154.   /reslevis/postZone:

  155.     post:

  156.       summary: Create a zone

  157.       operationId: postZone

  158.       tags: [Zones]

  159.       requestBody:

  160.         required: true

  161.         content:

  162.           application/json:

  163.             schema:

  164.               $ref: '#/components/schemas/Zone'

  165.       responses:

  166.         '201':

  167.           description: Zone created

  168.           content:

  169.             application/json:

  170.               schema:

  171.                 $ref: '#/components/schemas/StatusCreated'

  172.         '400':

  173.           $ref: '#/components/responses/BadRequest'

  174.         '500':

  175.           $ref: '#/components/responses/InternalError'

  176. 

  177.   /reslevis/removeZone/{id}:

  178.     delete:

  179.       summary: Delete a zone by ID

  180.       operationId: removeZone

  181.       tags: [Zones]

  182.       parameters:

  183.         - $ref: '#/components/parameters/PathId'

  184.       responses:

  185.         '200':

  186.           description: Zone deleted

  187.           content:

  188.             application/json:

  189.               schema:

  190.                 $ref: '#/components/schemas/StatusDeleted'

  191.         '404':

  192.           $ref: '#/components/responses/NotFound'

  193.         '500':

  194.           $ref: '#/components/responses/InternalError'

  195. 

  196.   /reslevis/updateZone:

  197.     put:

  198.       summary: Update a zone

  199.       operationId: updateZone

  200.       tags: [Zones]

  201.       requestBody:

  202.         required: true

  203.         content:

  204.           application/json:

  205.             schema:

  206.               $ref: '#/components/schemas/Zone'

  207.       responses:

  208.         '200':

  209.           description: Zone updated

  210.           content:

  211.             application/json:

  212.               schema:

  213.                 $ref: '#/components/schemas/StatusUpdated'

  214.         '400':

  215.           $ref: '#/components/responses/BadRequest'

  216.         '404':

  217.           $ref: '#/components/responses/NotFound'

  218.         '500':

  219.           $ref: '#/components/responses/InternalError'

  220. 

  221.   # --- Tracker zones ---

  222.   /reslevis/getTrackerZones:

  223.     get:

  224.       summary: List all tracker zones

  225.       operationId: getTrackerZones

  226.       tags: [TrackerZones]

  227.       responses:

  228.         '200':

  229.           description: List of tracker zones

  230.           content:

  231.             application/json:

  232.               schema:

  233.                 type: array

  234.                 items:

  235.                   $ref: '#/components/schemas/TrackerZone'

  236.         '500':

  237.           $ref: '#/components/responses/InternalError'

  238. 

  239.   /reslevis/postTrackerZone:

  240.     post:

  241.       summary: Create a tracker zone

  242.       operationId: postTrackerZone

  243.       tags: [TrackerZones]

  244.       requestBody:

  245.         required: true

  246.         content:

  247.           application/json:

  248.             schema:

  249.               $ref: '#/components/schemas/TrackerZone'

  250.       responses:

  251.         '201':

  252.           description: Tracker zone created

  253.           content:

  254.             application/json:

  255.               schema:

  256.                 $ref: '#/components/schemas/StatusCreated'

  257.         '400':

  258.           $ref: '#/components/responses/BadRequest'

  259.         '500':

  260.           $ref: '#/components/responses/InternalError'

  261. 

  262.   /reslevis/removeTrackerZone/{id}:

  263.     delete:

  264.       summary: Delete a tracker zone by ID

  265.       operationId: removeTrackerZone

  266.       tags: [TrackerZones]

  267.       parameters:

  268.         - $ref: '#/components/parameters/PathId'

  269.       responses:

  270.         '200':

  271.           description: Tracker zone deleted

  272.           content:

  273.             application/json:

  274.               schema:

  275.                 $ref: '#/components/schemas/StatusDeleted'

  276.         '404':

  277.           $ref: '#/components/responses/NotFound'

  278.         '500':

  279.           $ref: '#/components/responses/InternalError'

  280. 

  281.   /reslevis/updateTrackerZone:

  282.     put:

  283.       summary: Update a tracker zone

  284.       operationId: updateTrackerZone

  285.       tags: [TrackerZones]

  286.       requestBody:

  287.         required: true

  288.         content:

  289.           application/json:

  290.             schema:

  291.               $ref: '#/components/schemas/TrackerZone'

  292.       responses:

  293.         '200':

  294.           description: Tracker zone updated

  295.           content:

  296.             application/json:

  297.               schema:

  298.                 $ref: '#/components/schemas/StatusUpdated'

  299.         '400':

  300.           $ref: '#/components/responses/BadRequest'

  301.         '404':

  302.           $ref: '#/components/responses/NotFound'

  303.         '500':

  304.           $ref: '#/components/responses/InternalError'

  305. 

  306.   # --- Trackers ---

  307.   /reslevis/getTrackers:

  308.     get:

  309.       summary: List all trackers

  310.       operationId: getTrackers

  311.       tags: [Trackers]

  312.       responses:

  313.         '200':

  314.           description: List of trackers

  315.           content:

  316.             application/json:

  317.               schema:

  318.                 type: array

  319.                 items:

  320.                   $ref: '#/components/schemas/Tracker'

  321.         '500':

  322.           $ref: '#/components/responses/InternalError'

  323. 

  324.   /reslevis/postTracker:

  325.     post:

  326.       summary: Create a tracker

  327.       operationId: postTracker

  328.       tags: [Trackers]

  329.       requestBody:

  330.         required: true

  331.         content:

  332.           application/json:

  333.             schema:

  334.               $ref: '#/components/schemas/Tracker'

  335.       responses:

  336.         '201':

  337.           description: Tracker created

  338.           content:

  339.             application/json:

  340.               schema:

  341.                 $ref: '#/components/schemas/StatusCreated'

  342.         '400':

  343.           $ref: '#/components/responses/BadRequest'

  344.         '500':

  345.           $ref: '#/components/responses/InternalError'

  346. 

  347.   /reslevis/removeTracker/{id}:

  348.     delete:

  349.       summary: Delete a tracker by ID

  350.       operationId: removeTracker

  351.       tags: [Trackers]

  352.       parameters:

  353.         - $ref: '#/components/parameters/PathId'

  354.       responses:

  355.         '200':

  356.           description: Tracker deleted

  357.           content:

  358.             application/json:

  359.               schema:

  360.                 $ref: '#/components/schemas/StatusDeleted'

  361.         '404':

  362.           $ref: '#/components/responses/NotFound'

  363.         '500':

  364.           $ref: '#/components/responses/InternalError'

  365. 

  366.   /reslevis/updateTracker:

  367.     put:

  368.       summary: Update a tracker

  369.       operationId: updateTracker

  370.       tags: [Trackers]

  371.       requestBody:

  372.         required: true

  373.         content:

  374.           application/json:

  375.             schema:

  376.               $ref: '#/components/schemas/Tracker'

  377.       responses:

  378.         '200':

  379.           description: Tracker updated

  380.           content:

  381.             application/json:

  382.               schema:

  383.                 $ref: '#/components/schemas/StatusUpdated'

  384.         '400':

  385.           $ref: '#/components/responses/BadRequest'

  386.         '404':

  387.           $ref: '#/components/responses/NotFound'

  388.         '500':

  389.           $ref: '#/components/responses/InternalError'

  390. 

  391.   # --- Parser configs (beacons) ---

  392.   /configs/beacons:

  393.     get:

  394.       summary: List all beacon parser configs

  395.       operationId: listParserConfigs

  396.       tags: [ParserConfigs]

  397.       responses:

  398.         '200':

  399.           description: List of parser configs

  400.           content:

  401.             application/json:

  402.               schema:

  403.                 type: array

  404.                 items:

  405.                   $ref: '#/components/schemas/ParserConfig'

  406.         '500':

  407.           $ref: '#/components/responses/InternalError'

  408. 

  409.     post:

  410.       summary: Create a beacon parser config

  411.       operationId: addParserConfig

  412.       tags: [ParserConfigs]

  413.       requestBody:

  414.         required: true

  415.         content:

  416.           application/json:

  417.             schema:

  418.               $ref: '#/components/schemas/ParserConfig'

  419.       responses:

  420.         '201':

  421.           description: Parser config created

  422.           content:

  423.             application/json:

  424.               schema:

  425.                 $ref: '#/components/schemas/StatusCreated'

  426.         '400':

  427.           $ref: '#/components/responses/BadRequest'

  428.         '500':

  429.           $ref: '#/components/responses/InternalError'

  430. 

  431.   /configs/beacons/{id}:

  432.     put:

  433.       summary: Update a beacon parser config by name (id)

  434.       operationId: updateParserConfig

  435.       tags: [ParserConfigs]

  436.       parameters:

  437.         - name: id

  438.           in: path

  439.           required: true

  440.           description: Config name (identifier)

  441.           schema:

  442.             type: string

  443.       requestBody:

  444.         required: true

  445.         content:

  446.           application/json:

  447.             schema:

  448.               $ref: '#/components/schemas/ParserConfig'

  449.       responses:

  450.         '200':

  451.           description: Parser config updated

  452.           content:

  453.             application/json:

  454.               schema:

  455.                 $ref: '#/components/schemas/StatusUpdated'

  456.         '400':

  457.           $ref: '#/components/responses/BadRequest'

  458.         '404':

  459.           $ref: '#/components/responses/NotFound'

  460.         '500':

  461.           $ref: '#/components/responses/InternalError'

  462. 

  463.     delete:

  464.       summary: Delete a beacon parser config by name (id)

  465.       operationId: deleteParserConfig

  466.       tags: [ParserConfigs]

  467.       parameters:

  468.         - name: id

  469.           in: path

  470.           required: true

  471.           description: Config name (identifier)

  472.           schema:

  473.             type: string

  474.       responses:

  475.         '200':

  476.           description: Parser config deleted

  477.           content:

  478.             application/json:

  479.               schema:

  480.                 $ref: '#/components/schemas/StatusDeleted'

  481.         '404':

  482.           $ref: '#/components/responses/NotFound'

  483.         '500':

  484.           $ref: '#/components/responses/InternalError'

  485. 

  486.   # --- Settings ---

  487.   /reslevis/settings:

  488.     get:

  489.       summary: List settings

  490.       operationId: getSettings

  491.       tags: [Settings]

  492.       responses:

  493.         '200':

  494.           description: List of settings (typically one row)

  495.           content:

  496.             application/json:

  497.               schema:

  498.                 type: array

  499.                 items:

  500.                   $ref: '#/components/schemas/Settings'

  501.         '500':

  502.           $ref: '#/components/responses/InternalError'

  503. 

  504.     patch:

  505.       summary: Partially update settings

  506.       operationId: updateSettings

  507.       tags: [Settings]

  508.       requestBody:

  509.         required: true

  510.         content:

  511.           application/json:

  512.             schema:

  513.               $ref: '#/components/schemas/SettingsUpdate'

  514.       responses:

  515.         '200':

  516.           description: Settings updated

  517.           content:

  518.             application/json:

  519.               schema:

  520.                 $ref: '#/components/schemas/StatusUpdated'

  521.         '400':

  522.           $ref: '#/components/responses/BadRequest'

  523.         '500':

  524.           $ref: '#/components/responses/InternalError'

  525. 

  526.   # --- Alerts ---

  527.   /reslevis/alerts:

  528.     get:

  529.       summary: List all alerts

  530.       operationId: listAlerts

  531.       tags: [Alerts]

  532.       responses:

  533.         '200':

  534.           description: List of alerts

  535.           content:

  536.             application/json:

  537.               schema:

  538.                 type: array

  539.                 items:

  540.                   $ref: '#/components/schemas/Alert'

  541.         '500':

  542.           $ref: '#/components/responses/InternalError'

  543. 

  544.   /reslevis/alerts/{id}:

  545.     get:

  546.       summary: Get alert by ID

  547.       operationId: getAlertById

  548.       tags: [Alerts]

  549.       parameters:

  550.         - $ref: '#/components/parameters/PathId'

  551.       responses:

  552.         '200':

  553.           description: Single alert

  554.           content:

  555.             application/json:

  556.               schema:

  557.                 $ref: '#/components/schemas/Alert'

  558.         '404':

  559.           $ref: '#/components/responses/NotFound'

  560.         '500':

  561.           $ref: '#/components/responses/InternalError'

  562. 

  563.     patch:

  564.       summary: Update alert status

  565.       operationId: updateAlertStatus

  566.       tags: [Alerts]

  567.       parameters:

  568.         - $ref: '#/components/parameters/PathId'

  569.       requestBody:

  570.         required: true

  571.         content:

  572.           application/json:

  573.             schema:

  574.               $ref: '#/components/schemas/AlertStatusUpdate'

  575.       responses:

  576.         '200':

  577.           description: Alert status updated

  578.           content:

  579.             application/json:

  580.               schema:

  581.                 $ref: '#/components/schemas/StatusUpdated'

  582.         '400':

  583.           $ref: '#/components/responses/BadRequest'

  584.         '404':

  585.           $ref: '#/components/responses/NotFound'

  586.         '500':

  587.           $ref: '#/components/responses/InternalError'

  588. 

  589.     delete:

  590.       summary: Delete alert by ID

  591.       operationId: deleteAlert

  592.       tags: [Alerts]

  593.       parameters:

  594.         - $ref: '#/components/parameters/PathId'

  595.       responses:

  596.         '200':

  597.           description: Alert deleted

  598.           content:

  599.             application/json:

  600.               schema:

  601.                 $ref: '#/components/schemas/StatusDeleted'

  602.         '500':

  603.           $ref: '#/components/responses/InternalError'

  604. 

  605.   # --- Aggregated health (location, decoder, bridge, kafka, database) ---

  606.   /reslevis/health:

  607.     get:

  608.       summary: Aggregated health status

  609.       description: Returns health from location, decoder, bridge services plus server-checked Kafka and database status.

  610.       operationId: getAggregatedHealth

  611.       tags: [Health]

  612.       responses:

  613.         '200':

  614.           description: Aggregated health (location, decoder, bridge, kafka, database)

  615.           content:

  616.             application/json:

  617.               schema:

  618.                 $ref: '#/components/schemas/AggregatedHealth'

  619.         '500':

  620.           $ref: '#/components/responses/InternalError'

  621. 

  622.   # --- Tracks ---

  623.   /reslevis/getTracks/{id}:

  624.     get:

  625.       summary: List tracks for a tracker UUID

  626.       operationId: getTracks

  627.       tags: [Tracks]

  628.       parameters:

  629.         - name: id

  630.           in: path

  631.           required: true

  632.           description: Tracker UUID

  633.           schema:

  634.             type: string

  635.         - name: limit

  636.           in: query

  637.           description: Max number of tracks to return (default 10)

  638.           schema:

  639.             type: integer

  640.             default: 10

  641.         - name: from

  642.           in: query

  643.           description: Start time (RFC3339)

  644.           schema:

  645.             type: string

  646.             format: date-time

  647.         - name: to

  648.           in: query

  649.           description: End time (RFC3339)

  650.           schema:

  651.             type: string

  652.             format: date-time

  653.       responses:

  654.         '200':

  655.           description: List of tracks

  656.           content:

  657.             application/json:

  658.               schema:

  659.                 type: array

  660.                 items:

  661.                   $ref: '#/components/schemas/Track'

  662.         '500':

  663.           $ref: '#/components/responses/InternalError'

  664. 

  665. components:

  666.   parameters:

  667.     PathId:

  668.       name: id

  669.       in: path

  670.       required: true

  671.       description: Resource ID

  672.       schema:

  673.         type: string

  674. 

  675.   responses:

  676.     BadRequest:

  677.       description: Invalid request (e.g. invalid JSON)

  678.       content:

  679.         application/json:

  680.           schema:

  681.             $ref: '#/components/schemas/Error'

  682.           example:

  683.             error: bad_request

  684.             message: invalid request body

  685.     NotFound:

  686.       description: Resource not found

  687.       content:

  688.         application/json:

  689.           schema:

  690.             $ref: '#/components/schemas/Error'

  691.           example:

  692.             error: not_found

  693.             message: resource not found

  694.     InternalError:

  695.       description: Internal server error

  696.       content:

  697.         application/json:

  698.           schema:

  699.             $ref: '#/components/schemas/Error'

  700.           example:

  701.             error: internal_error

  702.             message: failed to complete operation

  703.     ServiceUnavailable:

  704.       description: Service not ready (e.g. DB unavailable)

  705.       content:

  706.         application/json:

  707.           schema:

  708.             $ref: '#/components/schemas/Error'

  709.           example:

  710.             error: not_ready

  711.             message: database not available

  712. 

  713.   schemas:

  714.     Error:

  715.       type: object

  716.       required: [error]

  717.       properties:

  718.         error:

  719.           type: string

  720.           description: Error code (bad_request, not_found, internal_error, not_ready)

  721.         message:

  722.           type: string

  723.           description: Human-readable message

  724. 

  725.     StatusCreated:

  726.       type: object

  727.       properties:

  728.         status:

  729.           type: string

  730.           example: created

  731.     StatusUpdated:

  732.       type: object

  733.       properties:

  734.         status:

  735.           type: string

  736.           example: updated

  737.     StatusDeleted:

  738.       type: object

  739.       properties:

  740.         status:

  741.           type: string

  742.           example: deleted

  743. 

  744.     Gateway:

  745.       type: object

  746.       properties:

  747.         id: { type: string }

  748.         name: { type: string }

  749.         mac: { type: string }

  750.         status: { type: string }

  751.         model: { type: string }

  752.         ip: { type: string }

  753.         position: { type: string }

  754.         x: { type: number, format: float }

  755.         y: { type: number, format: float }

  756.         notes: { type: string }

  757.         floor: { type: string }

  758.         building: { type: string }

  759. 

  760.     Zone:

  761.       type: object

  762.       properties:

  763.         id: { type: string }

  764.         name: { type: string }

  765.         groups:

  766.           type: array

  767.           items: { type: string }

  768.         floor: { type: string }

  769.         building: { type: string }

  770. 

  771.     TrackerZone:

  772.       type: object

  773.       properties:

  774.         id: { type: string }

  775.         zoneList:

  776.           type: array

  777.           items: { type: string }

  778.         tracker: { type: string }

  779.         days: { type: string }

  780.         time: { type: string }

  781. 

  782.     Tracker:

  783.       type: object

  784.       properties:

  785.         id: { type: string }

  786.         name: { type: string }

  787.         mac: { type: string }

  788.         status: { type: string }

  789.         model: { type: string }

  790.         ip: { type: string }

  791.         position: { type: string }

  792.         x: { type: number, format: float }

  793.         y: { type: number, format: float }

  794.         notes: { type: string }

  795.         floor: { type: string }

  796.         building: { type: string }

  797.         battery: { type: integer }

  798.         batteryThreshold: { type: integer }

  799.         temperature: { type: integer }

  800. 

  801.     ParserConfig:

  802.       type: object

  803.       description: Beacon parser configuration (name is the primary key)

  804.       properties:

  805.         name: { type: string }

  806.         min: { type: integer }

  807.         max: { type: integer }

  808.         pattern:

  809.           type: array

  810.           items: { type: string }

  811.         configs:

  812.           type: object

  813.           additionalProperties:

  814.             $ref: '#/components/schemas/ParserConfigEntry'

  815. 

  816.     ParserConfigEntry:

  817.       type: object

  818.       properties:

  819.         length: { type: integer }

  820.         offset: { type: integer }

  821.         order: { type: string }

  822. 

  823.     Settings:

  824.       type: object

  825.       properties:

  826.         ID: { type: integer }

  827.         current_algorithm: { type: string }

  828.         location_confidence: { type: integer }

  829.         last_seen_threshold: { type: integer }

  830.         beacon_metric_size: { type: integer }

  831.         HA_send_interval: { type: integer }

  832.         HA_send_changes_only: { type: boolean }

  833.         RSSI_enforce_threshold: { type: boolean }

  834.         RSSI_min_threshold: { type: integer }

  835. 

  836.     SettingsUpdate:

  837.       type: object

  838.       description: Partial update; only provided fields are updated

  839.       additionalProperties: true

  840. 

  841.     Alert:

  842.       type: object

  843.       properties:

  844.         id: { type: string }

  845.         tracker_id: { type: string }

  846.         type: { type: string }

  847.         status: { type: string }

  848.         timestamp: { type: string, format: date-time }

  849. 

  850.     AlertStatusUpdate:

  851.       type: object

  852.       required: [status]

  853.       properties:

  854.         status:

  855.           type: string

  856.           description: New status (e.g. resolved, acknowledged)

  857. 

  858.     ServiceStatus:

  859.       type: object

  860.       description: Health of an external service (e.g. Kafka, database)

  861.       properties:

  862.         status:

  863.           type: string

  864.           enum: [up, down, unknown]

  865.         message:

  866.           type: string

  867.           description: Error detail when status is down

  868. 

  869.     BaseHealth:

  870.       type: object

  871.       properties:

  872.         uptime: { type: string, description: Duration string }

  873.         activeReaders: { type: array, items: { type: string } }

  874.         activeWriters: { type: array, items: { type: string } }

  875.         activeBeacons: { type: array, items: { type: string } }

  876. 

  877.     LocationHealth:

  878.       allOf:

  879.         - $ref: '#/components/schemas/BaseHealth'

  880.         - type: object

  881.           properties:

  882.             activeSettings: { type: array, items: { type: object } }

  883. 

  884.     DecoderHealth:

  885.       allOf:

  886.         - $ref: '#/components/schemas/BaseHealth'

  887. 

  888.     BridgeHealth:

  889.       allOf:

  890.         - $ref: '#/components/schemas/BaseHealth'

  891. 

  892.     AggregatedHealth:

  893.       type: object

  894.       description: Health from location, decoder, bridge (via Kafka) plus server-checked Kafka and database

  895.       properties:

  896.         location: { $ref: '#/components/schemas/LocationHealth' }

  897.         decoder: { $ref: '#/components/schemas/DecoderHealth' }

  898.         bridge: { $ref: '#/components/schemas/BridgeHealth' }

  899.         kafka: { $ref: '#/components/schemas/ServiceStatus' }

  900.         database: { $ref: '#/components/schemas/ServiceStatus' }

  901. 

  902.     Track:

  903.       type: object

  904.       properties:

  905.         id: { type: string }

  906.         timestamp: { type: string, format: date-time }

  907.         type: { type: string }

  908.         status: { type: string }

  909.         gateway: { type: string }

  910.         gatewayMac: { type: string }

  911.         tracker: { type: string }

  912.         trackerMac: { type: string }

  913.         subject: { type: string }

  914.         subjectName: { type: string }

  915.         floor: { type: string }

  916.         signal: { type: integer }

  917.         building: { type: string }