/
openapi.yaml
90 lines (87 loc) · 2.89 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
openapi: 3.0.2
info:
title: i-sense flu backend
description: Backend API for the i-sense flu web app
version: v1.0
paths:
/:
get:
summary: Returns the scores for the default flu model
responses:
'200':
$ref: 'components/responses.yaml#/modelsAndMetadata'
'404':
description: No public model scores available
'503':
description: Resource unavailable
/models:
get:
summary: Returns a list of public models
responses:
'200':
$ref: 'components/responses.yaml#/modelList'
'404':
description: No public models available
'503':
description: Resource unavailable
/plink:
get:
summary: Returns the scores and metadata for one or more models in a specific time window
parameters:
- $ref: 'components/parameters.yaml#/idRef'
required: true
- $ref: 'components/parameters.yaml#/startDateRef'
required: true
- $ref: 'components/parameters.yaml#/endDateRef'
required: true
- $ref: 'components/parameters.yaml#/resolutionRef'
required: true
- $ref: 'components/parameters.yaml#/smoothingRef'
required: true
responses:
'200':
$ref: 'components/responses.yaml#/modelsAndMetadata'
'404':
description: Not found. Model data no longer available
'503':
description: Resource unavailable
/scores:
get:
summary: Returns the scores for one or more models in a specific time window
parameters:
- $ref: 'components/parameters.yaml#/idRef'
required: true
- $ref: 'components/parameters.yaml#/startDateRef'
required: true
- $ref: 'components/parameters.yaml#/endDateRef'
required: true
- $ref: 'components/parameters.yaml#/resolutionRef'
- $ref: 'components/parameters.yaml#/smoothingRef'
responses:
'200':
$ref: 'components/responses.yaml#/modelDataAndScores'
'404':
description: No scores found
'503':
description: Resource unavailable
/twlink:
get:
summary: Returns the scores and metadata for a model linked from Twitter
parameters:
- $ref: 'components/parameters.yaml#/legacyIdRef'
required: true
- $ref: 'components/parameters.yaml#/startDateRef'
required: true
- $ref: 'components/parameters.yaml#/endDateRef'
required: true
- $ref: 'components/parameters.yaml#/resolutionRef'
required: true
- $ref: 'components/parameters.yaml#/smoothingRef'
required: true
responses:
'200':
$ref: 'components/responses.yaml#/modelsAndMetadata'
'404':
description: Not found. Model data no longer available
'503':
description: Resource unavailable