From f26990b570a0ddf54fabf49907a42fa8517b8782 Mon Sep 17 00:00:00 2001 From: Galen Guyer Date: Mon, 16 Nov 2020 10:33:39 -0500 Subject: add generated swagger.html --- swagger.html | 349 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 349 insertions(+) create mode 100644 swagger.html (limited to 'swagger.html') diff --git a/swagger.html b/swagger.html new file mode 100644 index 0000000..a2a04cd --- /dev/null +++ b/swagger.html @@ -0,0 +1,349 @@ + + + + RIT COVID Poller + + + +

RIT COVID Poller

+
This is a simple API to retrieve current and historical data from the RIT COVID Dashboard.
+
More information: https://helloreverb.com
+
Contact Info: galen@galenguyer.com
+
Version: 1.0.0
+
BasePath:/api
+
AGPL 3.0
+
https://www.gnu.org/licenses/agpl-3.0.txt
+

Access

+ +

Methods

+ [ Jump to Models ] + +

Table of Contents

+
+

V0

+ + +

V0

+
+
+ Up + 
get /v0/history
+
Gets all historical data (getv0History)
+
Returns data from every day where the dashboard changed
+ + + + + + + +

Return type

+
+ array[Day] + +
+ + + +

Example data

+
Content-Type: application/json
+ 
[ {
+  "beds_available" : 0,
+  "total_staff" : 3,
+  "isolation_on_campus" : 1,
+  "last_updated" : "2000-01-23T04:56:07.000+00:00",
+  "quarantine_on_campus" : 7,
+  "new_staff" : 5,
+  "alert_level" : "green",
+  "test_administered" : 9,
+  "total_students" : 2,
+  "new_students" : 5,
+  "quarantine_off_campus" : 2,
+  "isolation_off_campus" : 6
+}, {
+  "beds_available" : 0,
+  "total_staff" : 3,
+  "isolation_on_campus" : 1,
+  "last_updated" : "2000-01-23T04:56:07.000+00:00",
+  "quarantine_on_campus" : 7,
+  "new_staff" : 5,
+  "alert_level" : "green",
+  "test_administered" : 9,
+  "total_students" : 2,
+  "new_students" : 5,
+  "quarantine_off_campus" : 2,
+  "isolation_off_campus" : 6
+} ]
+ +

Produces

+ This API call produces the following media types according to the Accept request header; + the media type will be conveyed by the Content-Type response header. + + +

Responses

+

200

+ successful operation + +
+
+
+
+ Up + 
get /v0/latest
+
Gets the latest data (getv0Latest)
+
Returns the most recent data from the official dashboard
+ + + + + + + +

Return type

+
+ Day + +
+ + + +

Example data

+
Content-Type: application/json
+ 
{
+  "beds_available" : 0,
+  "total_staff" : 3,
+  "isolation_on_campus" : 1,
+  "last_updated" : "2000-01-23T04:56:07.000+00:00",
+  "quarantine_on_campus" : 7,
+  "new_staff" : 5,
+  "alert_level" : "green",
+  "test_administered" : 9,
+  "total_students" : 2,
+  "new_students" : 5,
+  "quarantine_off_campus" : 2,
+  "isolation_off_campus" : 6
+}
+ +

Produces

+ This API call produces the following media types according to the Accept request header; + the media type will be conveyed by the Content-Type response header. + + +

Responses

+

200

+ successful operation + Day +
+
+ +

Models

+ [ Jump to Methods ] + +

Table of Contents

+
    +
  1. Day -
    2. +
+ +
+

Day - Up

+
+
+
alert_level (optional)
String
+
Enum:
+
green
yellow
orange
red
+
beds_available (optional)
Integer format: int32
+
isolation_off_campus (optional)
Integer format: int32
+
isolation_on_campus (optional)
Integer format: int32
+
last_updated (optional)
Date format: date-time
+
new_staff (optional)
Integer format: int32
+
new_students (optional)
Integer format: int32
+
quarantine_off_campus (optional)
Integer format: int32
+
quarantine_on_campus (optional)
Integer format: int32
+
test_administered (optional)
Integer format: int32
+
total_staff (optional)
Integer format: int32
+
total_students (optional)
Integer format: int32
+
+
+ + -- cgit v1.2.3