-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathswagger-dmsp.json
324 lines (322 loc) · 10.8 KB
/
swagger-dmsp.json
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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
{
"swagger": "2.0",
"info": {
"version": "1.0.0",
"title": "GeoWS UnFunded DMSP",
"description": "A demonstration service showing access to NGDC DMSP files via a GeoWS style web service.",
"termsOfService": "TBD",
"contact": {
"name": "GeoWS Building Block",
"email": "geows@iris.washington.edu"
},
"license": {
"name": "Data provided under GNU Lesser General Public License",
"url": "http://www.gnu.org/licenses/"
}
},
"host": "geows.ds.iris.edu",
"basePath": "/geows-uf",
"schemes": [
"http"
],
"paths": {
"/dmsp/1/query": {
"get": {
"tags": [
"NGDC next-web DMSP File Request"
],
"summary": "Get DMSP file list, extents, or data request",
"description": "<p>The <strong>dmsp</strong> service provides query access to the DMSP catalog service using content type of files or extents. After determining the desired data from a catalog query, a request to prepare the data for download can be made by changing the content type to data.</p> <p>This web service can provide catalog data in a text format like the web application at <a href='http://www.ngdc.noaa.gov/next-web/docs/guide/catalog.html#dmspCatalog'>NGDC DMSP Catalog Service</a></p><p>When ready to order data, set the content type to data and this service will place an order as described here <a href='http://www.ngdc.noaa.gov/next-web/docs/guide/ordering.html'>NGDC Ordering Data API</a></p>",
"operationId": "getData",
"produces": [
"text/plain"
],
"parameters": [
{
"name": "email",
"in": "query",
"description": "required for data download - indicates the recipient for messages from NGDC next-web REST ordering service",
"required": true,
"type": "string",
"default": ""
},
{
"name": "content",
"in": "query",
"description": "<strong>files</strong> provides a list of files that may be retrieved with the respective query parameters. <strong>extents</strong> provides an estimate of total size for the respective query parameters. <strong>data</strong> will cause a request to be made for the respective query parameters",
"required": true,
"type": "string",
"default": "files",
"enum": [
"files",
"extents",
"data"
]
},
{
"name": "starttime",
"in": "query",
"description": "start time for desired coverage",
"required": true,
"type": "string",
"default": "1999-01-01T00:00:00"
},
{
"name": "endtime",
"in": "query",
"description": "end time for desired coverage",
"required": true,
"type": "string",
"default": "1999-01-02T05:00:00"
},
{
"name": "satellite",
"in": "query",
"description": "Case sensitive ID, e.g. F12 or F13, etc.",
"required": false,
"type": "string",
"default": "F13"
},
{
"name": "longitude",
"in": "query",
"description": "A point of desired coverage",
"required": false,
"type": "number",
"default": "0",
"maximum": 180,
"exclusiveMaximum": true,
"minimum": -180,
"exclusiveMinimum": true
},
{
"name": "latitude",
"in": "query",
"description": "A point of desired coverage",
"required": false,
"type": "number",
"default": "-10",
"maximum": 90,
"exclusiveMaximum": true,
"minimum": -90,
"exclusiveMinimum": true
}
],
"responses": {
"200": {
"description": "Successful"
},
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request, and error messages releated to client interaction with WebServiceShell"
},
"404": {
"description": "Not Found"
},
"406": {
"description": "Not Acceptable"
},
"500": {
"description": "Internal Server Error, and error messages related to handler operation or WebServiceShell configuration"
}
},
"security": [
{
"TBD_auth": [
"write:writeTBD",
"read:readTBD"
]
}
]
},
"head": {
"tags": [
"NGDC next-web DMSP File Request"
],
"summary": "Get DMSP file list, extents, or data request",
"description": "<p>The <strong>dmsp</strong> service provides query access to the DMSP catalog service using content type of files or extents. After determining the desired data from a catalog query, a request to prepare the data for download can be made by changing the content type to data.</p> <p>This web service can provide catalog data in a text format like the web application at <a href='http://www.ngdc.noaa.gov/next-web/docs/guide/catalog.html#dmspCatalog'>NGDC DMSP Catalog Service</a></p><p>When ready to order data, set the content type to data and this service will place an order as described here <a href='http://www.ngdc.noaa.gov/next-web/docs/guide/ordering.html'>NGDC Ordering Data API</a></p>",
"operationId": "getData",
"produces": [
"text/plain"
],
"parameters": [
{
"name": "email",
"in": "query",
"description": "required for data download - indicates the recipient for messages from NGDC next-web REST ordering service",
"required": true,
"type": "string",
"default": ""
},
{
"name": "content",
"in": "query",
"description": "<strong>files</strong> provides a list of files that may be retrieved with the respective query parameters. <strong>extents</strong> provides an estimate of total size for the respective query parameters. <strong>data</strong> will cause a request to be made for the respective query parameters",
"required": true,
"type": "string",
"default": "files",
"enum": [
"files",
"extents",
"data"
]
},
{
"name": "starttime",
"in": "query",
"description": "start time for desired coverage",
"required": true,
"type": "string",
"default": "1999-01-01T00:00:00"
},
{
"name": "endtime",
"in": "query",
"description": "end time for desired coverage",
"required": true,
"type": "string",
"default": "1999-01-02T05:00:00"
},
{
"name": "satellite",
"in": "query",
"description": "Case sensitive ID, e.g. F12 or F13, etc.",
"required": false,
"type": "string",
"default": "F13"
},
{
"name": "longitude",
"in": "query",
"description": "A point of desired coverage",
"required": false,
"type": "number",
"default": "0",
"maximum": 180,
"exclusiveMaximum": true,
"minimum": -180,
"exclusiveMinimum": true
},
{
"name": "latitude",
"in": "query",
"description": "A point of desired coverage",
"required": false,
"type": "number",
"default": "-10",
"maximum": 90,
"exclusiveMaximum": true,
"minimum": -90,
"exclusiveMinimum": true
}
],
"responses": {
"200": {
"description": "Successful"
},
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request, and error messages releated to client interaction with WebServiceShell"
},
"404": {
"description": "Not Found"
},
"406": {
"description": "Not Acceptable"
},
"500": {
"description": "Internal Server Error, and error messages related to handler operation or WebServiceShell configuration"
}
},
"security": [
{
"TBD_auth": [
"write:writeTBD",
"read:readTBD"
]
}
]
}
},
"/dmsp/1/version": {
"get": {
"tags": [
"NGDC next-web DMSP File Request"
],
"summary": "Get version of service",
"description": "<p>The <strong>wssversion</strong> service provides the version number of this service)",
"operationId": "getVersion",
"produces": [
"text/plain"
],
"responses": {
"200": {
"description": "Successful"
},
"406": {
"description": "Not Acceptable - look at Accept headers, WebServiceShell only returns text/plain here"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"TBD_auth": [
"write:writeTBD",
"read:readTBD"
]
}
]
}
},
"/dmsp/1/wssversion": {
"get": {
"tags": [
"NGDC next-web DMSP File Request"
],
"summary": "Get version of WebServiceShell",
"description": "<p>The <strong>wssversion</strong> service provides the version number of this WebServiceShell (WSS))",
"operationId": "getWssVersion",
"produces": [
"text/plain"
],
"responses": {
"200": {
"description": "Successful"
},
"406": {
"description": "Not Acceptable - look at Accept headers, WebServiceShell only returns text/plain here"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"TBD_auth": [
"write:writeTBD",
"read:readTBD"
]
}
]
}
}
},
"securityDefinitions": {
"api_key": {
"type": "apiKey",
"name": "api_key",
"in": "header"
},
"TBD_auth": {
"type": "oauth2",
"authorizationUrl": "http://TBD/api/oauth/dialog",
"flow": "implicit"
}
}
}