forked from nightscout/cgm-remote-monitor
/
swagger.yaml
executable file
·1078 lines (1066 loc) · 32.2 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
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
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
servers:
- url: /api/v1
info:
title: Nightscout API
description: Own your DData with the Nightscout API
version: 14.0.7
license:
name: AGPL 3
url: 'https://www.gnu.org/licenses/agpl.txt'
security:
- api_secret: []
token_in_url: []
jwtoken: []
paths:
'/entries/{spec}':
get:
summary: All Entries matching query
description: |
The Entries endpoint returns information about the
Nightscout entries.
parameters:
- name: spec
in: path
description: |
entry id, such as `55cf81bc436037528ec75fa5` or a type filter such
as `sgv`, `mbg`, etc.
required: true
schema:
type: string
default: sgv
- name: find
in: query
description: |
The query used to find entries, support nested query syntax, for
example `find[dateString][$gte]=2015-08-27`. All find parameters
are interpreted as strings.
required: false
schema:
type: string
- name: count
in: query
description: Number of entries to return.
required: false
schema:
type: number
tags:
- Entries
responses:
'200':
description: An array of entries
content:
application/json:
schema:
$ref: '#/components/schemas/Entries'
default:
description: Entries
content:
application/json:
schema:
$ref: '#/components/schemas/Entries'
'/slice/{storage}/{field}/{type}/{prefix}/{regex}':
get:
summary: All Entries matching query
description: The Entries endpoint returns information about the Nightscout entries.
parameters:
- name: storage
in: path
description: >-
Prefix to use in constructing a prefix-based regex, default is
`entries`.
required: true
schema:
type: string
default: entries
- name: field
in: path
description: >-
Name of the field to use Regex against in query object, default is
`dateString`.
required: true
schema:
type: string
default: dateString
- name: type
in: path
description: 'The type field to search against, default is sgv.'
required: true
schema:
type: string
default: sgv
- name: prefix
in: path
description: Prefix to use in constructing a prefix-based regex.
required: true
schema:
type: string
default: '2015'
- name: regex
in: path
description: >
Tail part of regexp to use in expanding/construccting a query
object.
Regexp also has bash-style brace and glob expansion applied to it,
creating ways to search for modal times of day, perhaps using
something like this syntax: `T{15..17}:.*`, this would search for
all records from 3pm to 5pm.
required: true
schema:
type: string
default: .*
- name: find
in: query
description: |
The query used to find entries, support nested query syntax, for
example `find[dateString][$gte]=2015-08-27`. All find parameters
are interpreted as strings.
required: false
schema:
type: string
- name: count
in: query
description: Number of entries to return.
required: false
schema:
type: number
tags:
- Entries
responses:
'200':
description: An array of entries
content:
application/json:
schema:
$ref: '#/components/schemas/Entries'
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'/echo/{storage}/{spec}':
get:
summary: View generated Mongo Query object
description: |
Information about the mongo query object created by the query.
parameters:
- name: storage
in: path
description: |
`entries`, or `treatments` to select the storage layer.
required: true
schema:
type: string
default: sgv
- name: spec
in: path
description: |
entry id, such as `55cf81bc436037528ec75fa5` or a type filter such
as `sgv`, `mbg`, etc.
This parameter is optional.
required: true
schema:
type: string
default: sgv
- name: find
in: query
description: |
The query used to find entries, support nested query syntax, for
example `find[dateString][$gte]=2015-08-27`. All find parameters
are interpreted as strings.
required: false
schema:
type: string
- name: count
in: query
description: Number of entries to return.
required: false
schema:
type: number
tags:
- Entries
- Debug
responses:
'200':
description: An array of entries
content:
application/json:
schema:
$ref: '#/components/schemas/MongoQuery'
'/times/echo/{prefix}/{regex}':
get:
summary: Echo the query object to be used.
description: Echo debug information about the query object constructed.
parameters:
- name: prefix
in: path
description: Prefix to use in constructing a prefix-based regex.
required: true
schema:
type: string
- name: regex
in: path
description: >
Tail part of regexp to use in expanding/construccting a query
object.
Regexp also has bash-style brace and glob expansion applied to it,
creating ways to search for modal times of day, perhaps using
something like this syntax: `T{15..17}:.*`, this would search for
all records from 3pm to 5pm.
required: true
schema:
type: string
- name: find
in: query
description: >-
The query used to find entries, support nested query syntax, for
example `find[dateString][$gte]=2015-08-27`. All find parameters
are interpreted as strings.
required: false
schema:
type: string
- name: count
in: query
description: Number of entries to return.
required: false
schema:
type: number
tags:
- Entries
- Debug
responses:
'200':
description: An array of entries
content:
application/json:
schema:
$ref: '#/components/schemas/MongoQuery'
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'/times/{prefix}/{regex}':
get:
summary: All Entries matching query
description: The Entries endpoint returns information about the Nightscout entries.
parameters:
- name: prefix
in: path
description: Prefix to use in constructing a prefix-based regex.
required: true
schema:
type: string
- name: regex
in: path
description: >
Tail part of regexp to use in expanding/construccting a query
object.
Regexp also has bash-style brace and glob expansion applied to it,
creating ways to search for modal times of day, perhaps using
something like this syntax: `T{15..17}:.*`, this would search for
all records from 3pm to 5pm.
required: true
schema:
type: string
- name: find
in: query
description: >-
The query used to find entries, support nested query syntax, for
example `find[dateString][$gte]=2015-08-27`. All find parameters
are interpreted as strings.
required: false
schema:
type: string
- name: count
in: query
description: Number of entries to return.
required: false
schema:
type: number
tags:
- Entries
responses:
'200':
description: An array of entries
content:
application/json:
schema:
$ref: '#/components/schemas/Entries'
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/entries:
get:
summary: All Entries matching query
description: The Entries endpoint returns information about the Nightscout entries.
parameters:
- name: find
in: query
description: >-
The query used to find entries, support nested query syntax, for
example `find[dateString][$gte]=2015-08-27`. All find parameters
are interpreted as strings.
required: false
schema:
type: string
- name: count
in: query
description: Number of entries to return.
required: false
schema:
type: number
tags:
- Entries
responses:
'200':
description: An array of entries
content:
application/json:
schema:
$ref: '#/components/schemas/Entries'
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
post:
tags:
- Entries
summary: Add new entries.
description: ''
operationId: addEntries
responses:
'200':
description: Rejected list of entries. Empty list is success.
'405':
description: Invalid input
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Entries'
text/plain:
schema:
$ref: '#/components/schemas/Entries'
description: Entries to be uploaded.
required: true
delete:
tags:
- Entries
summary: Delete entries matching query.
description: 'Remove entries, same search syntax as GET.'
operationId: remove
parameters:
- name: find
in: query
description: >-
The query used to find entries, support nested query syntax, for
example `find[dateString][$gte]=2015-08-27`. All find parameters
are interpreted as strings.
required: false
schema:
type: string
- name: count
in: query
description: Number of entries to return.
required: false
schema:
type: number
responses:
'200':
description: Empty list is success.
/treatments:
get:
summary: Treatments
description: >-
The Treatments endpoint returns information about the Nightscout
treatments.
tags:
- Treatments
parameters:
- name: find
in: query
description: >-
The query used to find entries, supports nested query syntax.
Examples `find[insulin][$gte]=3` `find[carb][$gte]=100`
`find[eventType]=Correction+Bolus` All find parameters are
interpreted as strings.
required: false
schema:
type: string
- name: count
in: query
description: Number of entries to return.
required: false
schema:
type: number
responses:
'200':
description: An array of treatments
content:
application/json:
schema:
$ref: '#/components/schemas/Treatments'
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
post:
tags:
- Treatments
summary: Add new treatments.
description: ''
operationId: addTreatments
responses:
'200':
description: Rejected list of treatments. Empty list is success.
'405':
description: Invalid input
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Treatments'
description: Treatments to be uploaded.
required: true
delete:
tags:
- Treatments
summary: Delete treatments matching query.
description: 'Remove treatments, same search syntax as GET.'
operationId: remove
parameters:
- name: find
in: query
description: >-
The query used to find treatments to delete,
support nested query syntax, for example `find[insulin][$gte]=3`.
All find parameters are interpreted as strings.
required: false
schema:
type: string
- name: count
in: query
description: Number of entries to return.
required: false
schema:
type: number
responses:
'200':
description: Empty list is success.
'/treatments/{spec}':
delete:
summary: Delete treatments record with id provided in spec
description: |
The Treatments endpoint returns information about the
Nightscout devicestatus records.
parameters:
- name: spec
in: path
description: |
treatment id, such as `55cf81bc436037528ec75fa5`
required: true
schema:
type: string
tags:
- Treatments
responses:
'200':
description: A status record of the delete.
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteStatus'
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/profile:
get:
summary: Profile
description: >-
The Profile endpoint returns information about the Nightscout Treatment
Profiles.
tags:
- Profile
responses:
'200':
description: An array of treatments
content:
application/json:
schema:
$ref: '#/components/schemas/Profile'
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/status:
get:
summary: Status
description: 'Server side status, default settings and capabilities.'
tags:
- Status
responses:
'200':
description: Server capabilities and status.
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/devicestatus/:
get:
summary: All Devicestatuses matching query
description: >-
The Devicestatus endpoint returns information about the Nightscout
devicestatus records.
parameters:
- name: find
in: query
description: >-
The query used to find entries, support nested query syntax, for
example `find[dateString][$gte]=2015-08-27`. All find parameters
are interpreted as strings.
required: false
schema:
type: string
- name: count
in: query
description: Number of devicestatus records to return.
required: false
schema:
type: number
tags:
- Devicestatus
responses:
'200':
description: An array of devicestatus entries
content:
application/json:
schema:
$ref: '#/components/schemas/Devicestatuses'
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
post:
tags:
- Devicestatus
summary: Add new devicestatus records.
description: ''
operationId: addDevicestatuses
responses:
'200':
description: Rejected list of device statuses. Empty list is success.
'405':
description: Invalid input
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Devicestatuses'
description: Device statuses to be uploaded.
required: true
delete:
summary: Delete all Devicestatus records matching query
description: |
The Devicestatus endpoint returns information about the
Nightscout devicestatus records.
parameters:
- name: find
in: query
description: |
The query used to find entries, support nested query syntax, for
example `find[created_at][$gte]=2015-08-27`. All find parameters
are interpreted as strings.
required: false
schema:
type: string
tags:
- Devicestatus
responses:
'200':
description: A status record of the delete.
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteStatus'
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'/devicestatus/{spec}':
delete:
summary: Delete devicestatus record with id provided in spec
description: |
The Devicestatus endpoint returns information about the
Nightscout devicestatus records.
parameters:
- name: spec
in: path
description: |
entry id, such as `55cf81bc436037528ec75fa5`
required: true
schema:
type: string
tags:
- Devicestatus
responses:
'200':
description: A status record of the delete.
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteStatus'
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
securitySchemes:
api_secret:
type: apiKey
name: api_secret
in: header
description: The hash of the API_SECRET env var
token_in_url:
type: apiKey
name: token
in: query
description: >-
Add token as query item in the URL. You can manage access Token in
`/admin`. This uses json webtokens.
jwtoken:
type: http
scheme: bearer
description: Use this if you know the temporary json webtoken.
bearerFormat: JWT
schemas:
Entry:
properties:
type:
type: string
description: 'sgv, mbg, cal, etc'
dateString:
type: string
description: 'dateString, MUST be ISO `8601` format date parseable by Javascript Date()'
date:
type: number
description: Epoch
sgv:
type: number
description: The glucose reading. (only available for sgv types)
direction:
type: string
description: >-
Direction of glucose trend reported by CGM. (only available for sgv
types)
noise:
type: number
description: Noise level at time of reading. (only available for sgv types)
filtered:
type: number
description: >-
The raw filtered value directly from CGM transmitter. (only
available for sgv types)
unfiltered:
type: number
description: >-
The raw unfiltered value directly from CGM transmitter. (only
available for sgv types)
rssi:
type: number
description: >-
The signal strength from CGM transmitter. (only available for sgv
types)
Entries:
type: array
items:
$ref: '#/components/schemas/Entry'
Devicestatus:
required:
- device
- created_at
properties:
device:
type: string
description: 'Device type and hostname for example openaps://hostname'
created_at:
type: string
description: 'dateString, MUST be ISO `8601` format date parseable by Javascript Date()'
openaps:
type: string
description: 'OpenAPS devicestatus record - TODO: Fill Out Details'
loop:
type: string
description: 'Loop devicestatus record - TODO: Fill Out Details'
pump:
$ref: '#/components/schemas/pump'
uploader:
$ref: '#/components/schemas/uploader'
xdripjs:
$ref: '#/components/schemas/xdripjs'
Devicestatuses:
type: array
items:
$ref: '#/components/schemas/Devicestatus'
pump:
properties:
clock:
type: string
description: 'dateString, MUST be ISO `8601` format date parseable by Javascript Date()'
battery:
$ref: '#/components/schemas/pumpbattery'
reservoir:
type: number
description: Amount of insulin remaining in pump reservoir
status:
$ref: '#/components/schemas/pumpstatus'
pumpbattery:
properties:
status:
type: string
description: Pump Battery Status String
voltage:
type: number
description: Pump Battery Voltage Level
pumpstatus:
properties:
status:
type: string
description: Pump Status String
bolusing:
type: boolean
description: Is Pump Bolusing
suspended:
type: boolean
description: Is Pump Suspended
timestamp:
type: string
description: 'dateString, MUST be ISO `8601` format date parseable by Javascript Date()'
uploader:
properties:
batteryVoltage:
type: number
description: Uploader Device Battery Voltage
battery:
type: number
description: Uploader Device Battery Percentage Charge Remaining
xdripjs:
properties:
state:
type: number
description: CGM Sensor Session State Code
stateString:
type: string
description: CGM Sensor Session State String
stateStringShort:
type: string
description: CGM Sensor Session State Short String
txId:
type: string
description: CGM Transmitter ID
txStatus:
type: number
description: CGM Transmitter Status
txStatusString:
type: string
description: CGM Transmitter Status String
txStatusStringShort:
type: string
description: CGM Transmitter Status Short String
txActivation:
type: number
description: CGM Transmitter Activation Milliseconds After Epoch
mode:
type: string
description: 'Mode xdrip-js Application Operationg: expired, not expired, etc.'
timestamp:
type: number
description: Last Update Milliseconds After Epoch
rssi:
type: number
description: Receive Signal Strength of Transmitter
unfiltered:
type: number
description: Most Recent Raw Unfiltered Glucose
filtered:
type: number
description: Most Recent Raw Filtered Glucose
noise:
type: number
description: 'Calculated Noise Value - 1=Clean, 2=Light, 3=Medium, 4=Heavy'
noiseString:
type: number
description: Noise Value String
slope:
type: number
description: Calibration Slope Value
intercept:
type: number
description: Calibration Intercept Value
calType:
type: string
description: Algorithm Used to Calculate Calibration Values
lastCalibrationDate:
type: number
description: Most Recent Calibration Milliseconds After Epoch
sessionStart:
type: number
description: Sensor Session Start Milliseconds After Epoch
batteryTimestamp:
type: number
description: Most Recent Batter Status Read Milliseconds After Epoch
voltagea:
type: number
description: Voltage of Battery A
voltageb:
type: number
description: Voltage of Battery B
temperature:
type: number
description: Transmitter Temperature
resistance:
type: number
description: Sensor Resistance
Treatment:
properties:
_id:
type: string
description: Internally assigned id.
eventType:
type: string
description: The type of treatment event.
created_at:
type: string
description: 'The date of the event, might be set retroactively .'
glucose:
type: string
description: Current glucose.
glucoseType:
type: string
description: 'Method used to obtain glucose, Finger or Sensor.'
carbs:
type: number
description: Amount of carbs consumed in grams.
protein:
type: number
description: Amount of protein consumed in grams.
fat:
type: number
description: Amount of fat consumed in grams.
insulin:
type: number
description: 'Amount of insulin, if any.'
units:
type: string
description: 'The units for the glucose value, mg/dl or mmol.'
notes:
type: string
description: Description/notes of treatment.
enteredBy:
type: string
description: Who entered the treatment.
Treatments:
type: array
items:
$ref: '#/components/schemas/Treatment'
Profile:
properties:
sens:
type: integer
description: Internally assigned id
dia:
type: integer
description: Internally assigned id
carbratio:
type: integer
description: Internally assigned id
carbs_hr:
type: integer
description: Internally assigned id
_id:
type: string
description: Internally assigned id
Status:
properties:
apiEnabled:
type: boolean
description: Whether or not the REST API is enabled.
careportalEnabled:
type: boolean
description: Whether or not the careportal is enabled in the API.
head:
type: string
description: The git identifier for the running instance of the app.
name:
type: string
description: Nightscout (static)
version:
type: string
description: The version label of the app.
settings:
$ref: '#/components/schemas/Settings'
extendedSettings:
$ref: '#/components/schemas/ExtendedSettings'
Settings:
properties:
units:
type: string
description: Default units for glucose measurements across the server.
timeFormat:
type: string
description: Default time format
enum:
- 12
- 24
customTitle:
type: string
description: Default custom title to be displayed system wide.
nightMode:
type: boolean
description: Should Night mode be enabled by default?
theme:
type: string
description: >-
Default theme to be displayed system wide, `default`, `colors`,
`colorblindfriendly`.
language:
type: string
description: Default language code to be used system wide
showPlugins:
type: string
description: Plugins that should be shown by default
showRawbg:
type: string
description: >-
If Raw BG is enabled when should it be shown? `never`, `always`,
`noise`
alarmTypes:
type: array
items:
type: string
enum:
- simple
- predict
description: 'Enabled alarm types, can be multiple'
alarmUrgentHigh:
type: boolean
description: >-
Enable/Disable client-side Urgent High alarms by default, for use
with `simple` alarms.
alarmHigh:
type: boolean
description: >-
Enable/Disable client-side High alarms by default, for use with
`simple` alarms.
alarmLow:
type: boolean
description: >-
Enable/Disable client-side Low alarms by default, for use with
`simple` alarms.
alarmUrgentLow:
type: boolean
description: >-