1
0
Fork 0
Browse Source

add get latest (all) device status to YAML (A.P.I.) file.

stable
Craig Oates 4 years ago
parent
commit
e7e4923330
  1. 3
      app/api.py
  2. 25
      app/swagger.yml

3
app/api.py

@ -32,3 +32,6 @@ def get_all_status_log(device):
def get_all_status_logs_for_every_device():
return get_services.get_all_status_changes_from_database()
def get_current_status_for_all_devices():
return get_services.get_latest_status_for_all_devices()

25
app/swagger.yml

@ -413,3 +413,28 @@ paths:
schema:
type: object
additionalProperties: True
/status/latest:
get:
operationId: api.get_current_status_for_all_devices
tags:
- Request Device Status
summary: >-
Returns the last recorded status change of every device in the
database.
description: >-
Use this U.R.L. to retrieve the last recorded status change of
every device used in this project. There is no example of the
data returned because I can't seem to replicate it as a YAML
schema which is understood by Swagger. Because of this. the
return type is registered as a free-form object. To see what
the data looks like when it is returned, I recommend you use
the "Try it out!" button to see a working example.
responses:
200:
description: >-
The last recorded status change of every device in this
project was retrieved successfully.
schema:
type: object
additionalProperties: True