-
Notifications
You must be signed in to change notification settings - Fork 1
/
shared.yml
556 lines (550 loc) · 17.4 KB
/
shared.yml
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
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
servers:
- url: http://localhost:4000/
components:
securitySchemes:
Bearer:
description:
Represents Access token that applications use to make API requests on behalf of a user.
The access token represents the authorization of a specific application to access specific parts of a user’s data.
Config service admin API requires you to provide this access token in header.
To know more on how to authenticate and authorize yourself and get access token, refer this https://tmtsoftware.github.io/csw/services/aas.html
type: apiKey
name: Authorization
in: header
parameters:
startTime: # fas cds, sdas
name: startTime
in: query
required: false
description: Only return data that have a timestamp after or equal to this startTime, specified in RFC 3339 format
schema:
type: string
format: date-time
example: 2025-04-12T23:20:50.52Z
startTimeReq: # fas cds, sdas
name: startTime
in: query
required: true
description: Only return data that have a timestamp after or equal to this startTime, specified in RFC 3339 format
schema:
type: string
format: date-time
example: 2025-04-12T23:20:50.52Z
endTime: # fas cds, sdas
name: endTime
in: query
required: false
description: Only return data that have a timestamp before or equal to this endTIme, specified in RFC 3339 format.
schema:
type: string
format: date-time
example: 2025-04-12T23:20:48.00Z
originalFilename: #cds
name: originalFilename
in: query
description: filename of file when submitted to DMS
schema:
type: string
programIdPath: #sdas, sdss
name: programId
in: path
required: true
description: String identifier for the program, in format <YYYY><S>-<XXX>, where <YYYY> is the semester year, <S> is the semester (either A or B), and <XXX> is the three digit program number
example: 2039B-042
schema:
type: string
observationIdPath: #sdas, sdss
name: observationId
in: path
required: true
description: String identifier for an observation, in format <YYYY><S>-<XXX>-<NNN>, where <YYYY> is the semester year, <S> is the semester (either A or B), <XXX> is the three digit program number, and <NNN> is the three digit observation number
example: 2039B-042-123
schema:
type: string
programId: #sdas, sdss
name: programId
in: query
required: false
description: String identifier for the program, in format <YYYY><S>-<XXX>, where <YYYY> is the semester year, <S> is the semester (either A or B), and <XXX> is the three digit program number
example: 2039B-042
schema:
type: string
observationId: #sdas, sdss
name: observationId
in: query
required: false
description: String identifier for an observation, in format <YYYY><S>-<XXX>-<NNN>, where <YYYY> is the semester year, <S> is the semester (either A or B), <XXX> is the three digit program number, and <NNN> is the three digit observation number
example: 2039B-042-123
schema:
type: string
exposureId: #sdas, sdss
name: exposureId
in: path
required: true
description: String identifier for an exposure, in format <OBSID>-<INST>-<CHAN>-<TYP#>-<NNNN>, where <OBSID> is the observation ID, <INST> is the instrument identifier, <CHAN> is the channel identifier, <TYP#> is the image type identifier followed by the calibration level number, and <NNNN> is the four digit exposure number.
example: 2022A-123-044-IRIS-IMG-DRK1-0023
schema:
type: string
observer: #sdas
name: observer
in: query
description: Name of observer or observing team
schema:
type: string
objectName: #sdas
name: object
in: query
description: name of object
schema:
type: string
ra: #sdas
name: ra
in: query
description: Right Ascension of center point of search area in any common format (XX.YYY, AAh BBm CC.DDDs, HH MM SS.XXX)
schema:
type: string
dec: #sdas
name: dec
in: query
description: Declination of center point of search area in any common format (+XX.YYY, +AAd BBm CC.DDDs, +DD MM SS.XXX)
schema:
type: string
radius: #sdas
name: radius
in: query
description: radius of search area in arcsec. `ra` and `dec` parameters are required when using this parameter
schema:
type: number
instrument: #cds, sdas
name: instrument
in: query
description: name of instrument to restrict results
example: IRIS
schema:
type: string
channel: #cds, sdas
name: channel
in: query
description: channel of instrument to restrict results. `instrument` parameter is required when using this parameter
example: imager
schema:
type: string
integrationTime: #cds, sdas
name: itime
in: query
description: Results will only return exposures matching this exact integration time in seconds
schema:
type: number
minimum: 0
coadds: #cds, sdas
name: coadds
in: query
description: Results will only return exposures matching this exact number of coadds
schema:
type: integer
minimum: 1
filter: #cds, sdas
name: filter
in: query
description: Results will only return exposures using this filter
schema:
type: string
scale: #cds, sdas
name: scale
in: query
description: Results will only return exposures in this scale
schema:
type: string
spectralResolution: #cds, sdas
name: res
in: query
description: Results will only return exposures in this exact spectral resolution
schema:
type: string
aoMode: #cds, sdas
name: aoMode
in: query
description: Results will only return exposures taken in this AO Mode
example: MCAO
schema:
type: string
calibrationType: #cds
name: calType
in: query
description: type of calibration file to locate.
schema:
$ref: '#/components/schemas/CalibrationFileType'
calibrationTypeReq: #cds
name: calType
in: query
description: type of calibration file to locate.
required: true
schema:
$ref: '#/components/schemas/CalibrationFileType'
fileType: #sdas
name: fileType
in: query
description: type of file to search for
schema:
$ref: '#/components/schemas/FileType'
outputFormat: #sdas
name: format
in: query
description: format of results
schema:
$ref: '#/components/schemas/OutputFormat'
schemas:
ExposureId: #cds, mas, sdss, sdas
type: string
example: "2022A-123-044-IRIS-IMG-DRK-0023"
ObserveEvent: #mas
type: string
HeaderItem:
type: object
properties:
keyword:
type: string
value:
{}
comment:
type: string
Header: #mas
type: array
items:
$ref: '#/components/schemas/HeaderItem'
DataResponse:
type: object
required:
- dataResponseType
properties:
dataResponseType:
type: string
discriminator:
propertyName: dataResponseType
Subsystem: # eas, ddcs, fss
description: name of subsystem
type: string
enum: [AOESW, APS, CIS, CLN, CRYO, CSW, DMS, DPS, ENC, ESEN, ESW, HNDL, HQ, IRIS, LGSF, M1COAT, M1CS, M1S, M2COAT, M2S, M3S, MODHIS, NFIRAOS, OSS, REFR, SCMS, SER, SOSS, STR, SUM, TCS, TINS, WFOS]
ResampleMethod: #eas
type: string
enum: [interp, last, aggregate]
EventType:
description: type of event
type: string
enum: [boolean, char, byte, short, long, int, float, double, string, utcTime, taiTime]
CalibrationFileType:
description: Type of calibration file
type: string
enum: [ARC, IDP, DRK, MDK, FFD, NFF, BAI, TEL, FLX, SKY, CAL]
FileType:
description: Type of file
type: string
enum: [science, calibration, ancillary]
OutputFormat:
description: Format of results
type: string
enum: [JSON, CSV, VOTABLE, HTML]
PackageType: #eas, sdas
description: type of packing for multiple files
type: string
enum: [tar, zip, gzip]
default: zip
CompressionType: #sdas
description: type of compression
type: string
enum: [gzip, fpack]
EventKey: #eas, mas
type: string
description: name of event parameter including prefix
example: tcs.mount.current.az,tcs.mount.current.el
Tag: #eas, fss, sdas
type: object
properties:
name:
type: string
value:
type: string
required:
- name
- value
AncillaryFileProgramResponse:
type: object
properties:
uri:
type: string
format: uri
example: tio:hq/2039B-042_weatherMap-20391012.fits
timestamp:
type: string
format: date-time
example: 2039-10-12T23:20:50.52Z
programId:
type: string
example: 2039B-042
fileName:
type: string
example: 2039B-042_weatherMap-20391012.fits
fileId:
type: string
format: uuid
example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
AncillaryFileObservationResponse:
type: object
properties:
uri:
type: string
format: uri
example: tio:hq/2039B-042-123_weatherMap-20391012.fits
timestamp:
type: string
format: date-time
example: 2039-10-12T23:20:50.52Z
observationId:
type: string
example: 2039B-042-123
fileName:
type: string
example: 2039B-042-123_weatherMap-20391012.fits
fileId:
type: string
format: uuid
example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
AncillaryFileExposureResponse:
type: object
properties:
uri:
type: string
format: uri
example: tio:hq/2039B-042-123-IRIS-IMG-SCI1-1234_weatherMap-20391012.fits
timestamp:
type: string
format: date-time
example: 2039-10-12T23:20:50.52Z
ExposureId:
type: string
example: 2039B-042-123-IRIS-IMG-SCI1-1234
fileName:
type: string
example: 2039B-042-123-IRIS-IMG-SCI1-1234_weatherMap-20391012.fits
fileId:
type: string
format: uuid
example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
ScienceSearchResultItem: #sdas
type: object
properties:
uri:
type: string
name:
type: string
exposureId:
type: string
date:
type: string
time:
type: string
ra:
type: string
dec:
type: string
instrument:
type: string
channel:
type: string
itime:
type: number
coadds:
type: integer
filter:
type: string
scale:
type: string
res:
type: string
aoMode:
type: string
VOTABLE: #sdas
type: object
properties:
version:
type: number
example: 1.4
xml:
attribute: true
xmlns:
type: string
example: https://www.ivoa.net/xml/VOTable/v1.3
xml:
attribute: true
RESOURCE:
type: object
properties:
name:
type: string
example: myFavouriteGalaxies
xml:
attribute: true
COOSYS:
type: object
properties:
ID:
type: string
example: sys
xml:
attribute: true
equinox:
type: string
example: J2000
xml:
attribute: true
epoch:
type: string
example: J2000
xml:
attribute: true
system:
type: string
example: eq_FK5
xml:
attribute: true
TABLE:
type: object
properties:
name:
type: string
example: results
xml:
attribute: true
DESCRIPTION:
type: string
example: Velocities and Distance estimations
PARAM:
type: object
properties:
name:
type: string
example: Telescope
xml:
attribute: true
datatype:
type: string
example: float
xml:
attribute: true
ucd:
type: string
example: phys.size;instr.tel
xml:
attribute: true
unit:
type: string
example: m
xml:
attribute: true
value:
type: string
example: 3.6
xml:
attribute: true
FIELD:
type: array
items:
type: object
properties:
name:
type: string
xml:
attribute: true
DESCRIPTION:
type: string
ID:
type: string
xml:
attribute: true
ucd:
type: string
xml:
attribute: true
datatype:
type: string
xml:
attribute: true
width:
type: integer
xml:
attribute: true
precision:
type: integer
xml:
attribute: true
unit:
type: string
xml:
attribute: true
ref:
type: string
xml:
attribute: true
example:
- name: "RA"
ID: "col1"
ucd: "pos.eq.ra;meta.main"
datatype: "float"
width: "6"
precision: "2"
unit: "deg"
ref: "sys"
- name: "Dec"
ID: "col2"
ucd: "pos.eq.dec;meta.main"
datatype: "float"
width: "6"
precision: "2"
unit: "deg"
ref: "sys"
- name: "Name"
ID: "col3"
ucd: "meta.id;meta.main"
datatype: "char"
arraysize: "8*"
- name: "RVel"
ID: "col4"
ucd: "spect.dopplerVeloc"
datatype: "int"
width: "5"
unit: "km/s"
- name: "e_RVel"
ID: "col5"
ucd: "stat.error;spect.dopplerVeloc"
datatype: "int"
width: "3"
unit: "km/s"
- name: "R"
ID: "col6"
ucd: "pos.distance;pos.heliocentric"
datatype: "float"
width: "4"
precision: "1"
unit: "Mpc"
DESCRIPTION: Distance of Galaxy, assuming H=75km/s/Mpc
DATA:
type: object
properties:
tabledata:
type: array
items:
type: array
items:
type: string
xml:
name: TD
xml:
name: TR
wrapped: true
xml:
name: TABLEDATA
wrapped: true
example:
- ["010.68","+41.27","N 224","-297","5","0.7"]
- ["287.43","-63.85","N 6744","839","6","10.4"]
- ["023.48","+30.66","N 598","-182","3","0.7"]