pollutri
/
res_levis_backend
1
0
Vork 0
Code Kwesties 9 Pull-aanvragen 0 Publicaties 0 Wiki Activiteit
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.
427 Commits
3 Branches
268 MiB
 
 
 
 
Tree: 34cadb4cec
Branches Labels
${ item.name }
Maak branch ${ searchTerm }
van '34cadb4cec'
${ noResults }
res_levis_backend/api/openapi.yaml

822 regels
22 KiB
Ruw Blame Geschiedenis 

  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 (or tracker ID depending on usage)

  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.     delete:

  564.       summary: Delete alert by ID

  565.       operationId: deleteAlert

  566.       tags: [Alerts]

  567.       parameters:

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

  569.       responses:

  570.         '200':

  571.           description: Alert deleted

  572.           content:

  573.             application/json:

  574.               schema:

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

  576.         '500':

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

  578. 

  579.   # --- Tracks ---

  580.   /reslevis/getTracks/{id}:

  581.     get:

  582.       summary: List tracks for a tracker UUID

  583.       operationId: getTracks

  584.       tags: [Tracks]

  585.       parameters:

  586.         - name: id

  587.           in: path

  588.           required: true

  589.           description: Tracker UUID

  590.           schema:

  591.             type: string

  592.         - name: limit

  593.           in: query

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

  595.           schema:

  596.             type: integer

  597.             default: 10

  598.         - name: from

  599.           in: query

  600.           description: Start time (RFC3339)

  601.           schema:

  602.             type: string

  603.             format: date-time

  604.         - name: to

  605.           in: query

  606.           description: End time (RFC3339)

  607.           schema:

  608.             type: string

  609.             format: date-time

  610.       responses:

  611.         '200':

  612.           description: List of tracks

  613.           content:

  614.             application/json:

  615.               schema:

  616.                 type: array

  617.                 items:

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

  619.         '500':

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

  621. 

  622. components:

  623.   parameters:

  624.     PathId:

  625.       name: id

  626.       in: path

  627.       required: true

  628.       description: Resource ID

  629.       schema:

  630.         type: string

  631. 

  632.   responses:

  633.     BadRequest:

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

  635.       content:

  636.         application/json:

  637.           schema:

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

  639.           example:

  640.             error: bad_request

  641.             message: invalid request body

  642.     NotFound:

  643.       description: Resource not found

  644.       content:

  645.         application/json:

  646.           schema:

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

  648.           example:

  649.             error: not_found

  650.             message: resource not found

  651.     InternalError:

  652.       description: Internal server error

  653.       content:

  654.         application/json:

  655.           schema:

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

  657.           example:

  658.             error: internal_error

  659.             message: failed to complete operation

  660.     ServiceUnavailable:

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

  662.       content:

  663.         application/json:

  664.           schema:

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

  666.           example:

  667.             error: not_ready

  668.             message: database not available

  669. 

  670.   schemas:

  671.     Error:

  672.       type: object

  673.       required: [error]

  674.       properties:

  675.         error:

  676.           type: string

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

  678.         message:

  679.           type: string

  680.           description: Human-readable message

  681. 

  682.     StatusCreated:

  683.       type: object

  684.       properties:

  685.         status:

  686.           type: string

  687.           example: created

  688.     StatusUpdated:

  689.       type: object

  690.       properties:

  691.         status:

  692.           type: string

  693.           example: updated

  694.     StatusDeleted:

  695.       type: object

  696.       properties:

  697.         status:

  698.           type: string

  699.           example: deleted

  700. 

  701.     Gateway:

  702.       type: object

  703.       properties:

  704.         id: { type: string }

  705.         name: { type: string }

  706.         mac: { type: string }

  707.         status: { type: string }

  708.         model: { type: string }

  709.         ip: { type: string }

  710.         position: { type: string }

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

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

  713.         notes: { type: string }

  714.         floor: { type: string }

  715.         building: { type: string }

  716. 

  717.     Zone:

  718.       type: object

  719.       properties:

  720.         id: { type: string }

  721.         name: { type: string }

  722.         groups:

  723.           type: array

  724.           items: { type: string }

  725.         floor: { type: string }

  726.         building: { type: string }

  727. 

  728.     TrackerZone:

  729.       type: object

  730.       properties:

  731.         id: { type: string }

  732.         zoneList:

  733.           type: array

  734.           items: { type: string }

  735.         tracker: { type: string }

  736.         days: { type: string }

  737.         time: { type: string }

  738. 

  739.     Tracker:

  740.       type: object

  741.       properties:

  742.         id: { type: string }

  743.         name: { type: string }

  744.         mac: { type: string }

  745.         status: { type: string }

  746.         model: { type: string }

  747.         ip: { type: string }

  748.         position: { type: string }

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

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

  751.         notes: { type: string }

  752.         floor: { type: string }

  753.         building: { type: string }

  754.         battery: { type: integer }

  755.         batteryThreshold: { type: integer }

  756.         temperature: { type: integer }

  757. 

  758.     ParserConfig:

  759.       type: object

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

  761.       properties:

  762.         name: { type: string }

  763.         min: { type: integer }

  764.         max: { type: integer }

  765.         pattern:

  766.           type: array

  767.           items: { type: string }

  768.         configs:

  769.           type: object

  770.           additionalProperties:

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

  772. 

  773.     ParserConfigEntry:

  774.       type: object

  775.       properties:

  776.         length: { type: integer }

  777.         offset: { type: integer }

  778.         order: { type: string }

  779. 

  780.     Settings:

  781.       type: object

  782.       properties:

  783.         ID: { type: integer }

  784.         current_algorithm: { type: string }

  785.         location_confidence: { type: integer }

  786.         last_seen_threshold: { type: integer }

  787.         beacon_metric_size: { type: integer }

  788.         HA_send_interval: { type: integer }

  789.         HA_send_changes_only: { type: boolean }

  790.         RSSI_enforce_threshold: { type: boolean }

  791.         RSSI_min_threshold: { type: integer }

  792. 

  793.     SettingsUpdate:

  794.       type: object

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

  796.       additionalProperties: true

  797. 

  798.     Alert:

  799.       type: object

  800.       properties:

  801.         id: { type: string }

  802.         tracker_id: { type: string }

  803.         type: { type: string }

  804.         value: { type: string }

  805. 

  806.     Track:

  807.       type: object

  808.       properties:

  809.         id: { type: string }

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

  811.         type: { type: string }

  812.         status: { type: string }

  813.         gateway: { type: string }

  814.         gatewayMac: { type: string }

  815.         tracker: { type: string }

  816.         trackerMac: { type: string }

  817.         subject: { type: string }

  818.         subjectName: { type: string }

  819.         floor: { type: string }

  820.         signal: { type: integer }

  821.         building: { type: string }