generated from peter-evans/swagger-github-pages
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathswagger.yaml
222 lines (219 loc) · 9.06 KB
/
swagger.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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
openapi: 3.0.0
info:
version: 0.0.1
title: VENTURA Manchester Model API
description: VENTURA API
servers:
# - url: https://e96kri69.pythonanywhere.com/
# description: Development server November 2022
- url: https://bingfield.drawscapes.com/
description: Live Server run by Ed after migrading from V server
paths:
# /vdr_send:
# post:
# summary: runs the model
# description: runs the model using your parama
# operationId: vdr_send
# tags:
# - Eduardo
# requestBody:
# content:
# application/json:
# schema:
# type: string
# items:
# type: integer
# example:
# [
# '3,5',
# '0.9,0.7',
# '4,6,7',
# '0.5,10,0',
# '2012-01-30',
# '2012-01-31',
# ]
# responses:
# default:
# description: Default error sample response
# content:
# application/json:
# examples:
# sample response:
# value: >-
# TBC
# /vdr_send2:
# post:
# summary: runs the model
# description: runs the model using your parama
# operationId: vdr_send2
# tags:
# - Eduardo
# requestBody:
# content:
# application/json:
# schema:
# type: string
# items:
# type: integer
# example:
# [
# '3,5',
# '0.9,0.7',
# '4,6,7',
# '0.5,10,0',
# '2012-01-30',
# '2012-01-31',
# ]
# responses:
# default:
# description: Default error sample response
# content:
# application/json:
# examples:
# sample response:
# value: >-
# TBC
# /vdr_SendDict:
# post:
# summary: runs the model
# description: runs the model using your parama
# operationId: vdr_SendDict
# tags:
# - Vladimir
# requestBody:
# content:
# application/json:
# schema:
# type: string
# items:
# type: integer
# example: "{'catchmentN4populationChange': [4, 6, 7], 'PopulationChange': [0.5, 10, 0], 'StartDate': '2012-01-30', 'EndDate': '2012-02-09','nodes_numbers_to_change': [3, 5], 'RC_to_change': [0.9, 0.7]}"
# responses:
# default:
# description: Default error sample response
# content:
# application/json:
# examples:
# sample response:
# value: >-
# TBC
/vdr_SendDict2:
post:
summary: runs the model
description: |
| VARIABLE | DESCRIPTION | FORMAT | EXAMPLE |
|---|---|---|---|
| nodes_numbers_to_change | List of catchments where RC is changing | List of integers to strings (0-43) | 3,5 |
| RC_to_change | New RC for requested catchments | List of float to strings (0-1.0), NB should be same size as above | 0.9,0.7 |
| catchmentN4populationChange | List of catchments where population is changing | List of integers to strings (0-43) | 4,6,7 |
| PopulationChange | New population ratio multipliers for requested catchments | List of float to strings , NB should be same size as above | 0.9,0.7,1.1 |
| StartDate | Start date for the simulation | yyyy-mm-dd | 12/11/2011 |
| EndDate | End date for the simulation | yyyy-mm-dd | 15/11/2011 |
| PopulationGrowth | Value of overall population increase multiplier (e.g. for 2,037 and 2,050) | string generated from a float, e.g. str(1.2) | 1.2 |
| RainfallMultiplier | Value of overall rainfall increase multipliers linked to CC (for 2,037 and 2,050) | string generated from a float, e.g. str(1.2) | 1.1 |
| catchmentN4wiltPointChange | List of catchments where attenuation volume is changing | List of integers to strings (0-43) | 4,6,7 |
| newWiltPointMultiplier | New Attenuation depth multipliers (Wilt) for requested catchments | List of float to strings, NB should be same size as above | 0.9,0.7,1.1 |
| catchmentN4demandChange | List of catchments where Demand is changing | List of integers to strings (0-43) | 3,5 |
| NewPerCapitaDemand | New demand_per_capita values for requested catchments | List of float to strings , NB should be same size as above | 90,85 |
| days2delete | Number of days to be deleted (i.e. effectively the run-in period). When the days2delete variable is bigger than the number of days between the (EndDate-MinSimLength) and the beginning of the available climatic dataset (currently 1 Jan 2011), it will be trimed accordingly | integer | 100 |
| MinSimLength | Minimum length of the time period returned by the API | integer | 2 |
operationId: vdr_SendDict2
tags:
- Eduardo
requestBody:
content:
application/json:
schema:
type: string
example: "{'nodes_numbers_to_change': [], 'RC_to_change': [], 'catchmentN4populationChange': [], 'PopulationChange': [], 'StartDate': '2011-11-30', 'EndDate': '2012-01-30', 'RainfallMultiplier': 1, 'PopulationGrowth': 1, 'catchmentN4wiltPointChange': [], 'newWiltPointMultiplier': [], 'catchmentN4demandChange': [], 'NewPerCapitaDemand': [], 'days2delete': 100, 'MinSimLength': 2}"
responses:
200:
description: Response from the WSIMod
content:
application/json:
schema:
type: object
properties:
ManExcessWater:
type: array
items:
type: number
example: [24505.5299089307, 57244.324997593314]
ManFlowsDemand2foul:
type: array
items:
type: number
example: [136054.683, 184582.3193]
ManNitrate:
type: array
items:
type: number
example: [0.02, 0.02]
ManFoulToStormFlows:
type: array
items:
type: number
example: [0.00008660074350406832, 0.00007748620241704489]
ManAmmonia:
type: array
items:
type: number
example: [0.0007499999999999999, 0.0007499999999999999]
ManRiverP:
type: array
items:
type: number
example: [0.009509415862330723, 0.009509415862330723]
tanks:
type: array
items:
type: string
example:
[
'Birkin Brook - Mobberley Brook to River Bollin (including Rostherne Brook)-gw',
'Mon, 30 Jan 2012 00:00:00 GMT',
0,
]
ManRiverFlows:
type: array
items:
type: number
example: [775725.867773827, 313430.4267159084]
ManWWTPdischargeFlows:
type: array
items:
type: number
example: [2505262.956387399, 876619.144462528]
ManSewerFlows:
type: array
items:
type: number
example: [2583277.9504922656, 903917.4514977605]
ManStormdischargeFlows:
type: array
items:
type: number
example: [136054.683, 184582.3193]
ManRiverDFcolumns:
type: array
items:
type: string
example:
[
'Birkin Brook - Mobberley Brook to River Bollin (including Rostherne Brook)-to-Bollin (Ashley Mill to Manchester Ship Canal)',
'Birkin Brook - Source to Mobberley Brook-to-Birkin Brook - Mobberley Brook to River Bollin (including Rostherne Brook)',
]
ManWWTPdischargeDFcolumns:
type: array
items:
type: number
example: [136054.683, 184582.3193]
ManSewerDFcolumns:
type: array
items:
type: string
example:
[
'centralised_sewer-to-WHALEY BRIDGE STW',
'centralised_sewer-to-WILMSLOW STW',
]