-
Notifications
You must be signed in to change notification settings - Fork 0
/
saibaru.yaml
844 lines (844 loc) · 25.7 KB
/
saibaru.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
openapi: 3.0.0
info:
description: "農業サポートシステム「SAIBARU」のAPIです。"
version: "1.0.0"
title: "SAIBARU API"
contact:
name: "APIサポートはこちら"
url: http://saibaru.cloud/contact/
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://sa01.saibaru.cloud/v1/production/
- url: https://sa02.saibaru.cloud/v1/production/
- url: https://sa03.saibaru.cloud/v1/production/
- description: SwaggerHub API Auto Mocking
url: https://virtserver.swaggerhub.com/koki-iwaizumi/saibaru/1.0.0
paths:
/token:
post:
tags:
- token
summary: APIトークンの取得
description: APIを取得するためのAPIトークンを取得します。APIトークンはAPI使用時、必須のパラメーターになります。レスポンスには有効期限も含まれています。有効期限まで、取得したAPIは使用可能です。※アクセストークンはマイページで確認できます。
parameters:
- $ref: '#/components/parameters/Contenttype'
requestBody:
content:
application/json:
schema:
type: object
properties:
accesstoken:
type: string
description: アクセストークン
example: test_accesstoken
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TokenSet'
"400":
description: 不正なリクエストです。
content:
application/json:
schema:
$ref: '#/components/schemas/TokenSet'
example:
messages:
- "invalid request"
apitoken: ""
expires: ""
get:
tags:
- token
summary: APIトークンの確認
description: APIトークンが使用可能か確認します。使用可能な場合はレスポンスに有効期限も含まれます。
parameters:
- $ref: '#/components/parameters/Token'
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TokenSet'
"400":
description: 不正なリクエストです。
content:
application/json:
schema:
$ref: '#/components/schemas/TokenSet'
example:
messages:
- "invalid request"
apitoken: ""
expires: ""
"404":
description: 有効なAPIトークンではありません。
content:
application/json:
schema:
$ref: '#/components/schemas/TokenSet'
example:
messages:
- "not found"
apitoken: ""
expires: ""
/module:
get:
tags:
- module
summary: モジュールの取得
description: 登録済みのモジュール一覧を取得します。
parameters:
- $ref: '#/components/parameters/Token'
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ModuleSet'
"400":
description: 不正なリクエストです。
content:
application/json:
schema:
$ref: '#/components/schemas/ModuleSet'
example:
messages:
- "invalid request"
modules: null
post:
tags:
- module
summary: モジュールの編集
description: 指定したuuidのモジュールの設定値を編集します。intervaltimeは60,3600,7200,86400[s]から選択します。※upperlimit,lowerlimitは文字列（例："3.5"）で送信します。
parameters:
- $ref: '#/components/parameters/Token'
- $ref: '#/components/parameters/Contenttype'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Module'
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Messages'
"400":
description: 不正なリクエストです。
content:
application/json:
schema:
$ref: '#/components/schemas/Messages'
example:
messages:
- "invalid request"
"404":
description: 指定されたuuidのモジュールがありません。
content:
application/json:
schema:
$ref: '#/components/schemas/Messages'
example:
messages:
- "not found uuid"
/alertemail:
get:
tags:
- alertemail
summary: アラートメールの取得
description: 登録済みのアラートメール一覧を取得します。
parameters:
- $ref: '#/components/parameters/Token'
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AlertemailSet'
"400":
description: 不正なリクエストです。
content:
application/json:
schema:
$ref: '#/components/schemas/AlertemailSet'
example:
messages:
- "invalid request"
alertemails: null
post:
tags:
- alertemail
summary: アラートメールの登録及び編集
description: 複数のアラートメールを登録します。既に登録されたメールアドレスがある場合、上書き保存されます。（最大登録数:10）
parameters:
- $ref: '#/components/parameters/Token'
- $ref: '#/components/parameters/Contenttype'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Alertemails'
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Messages'
"400":
description: 不正なリクエストです。
content:
application/json:
schema:
$ref: '#/components/schemas/Messages'
example:
messages:
- "invalid request"
delete:
tags:
- alertemail
summary: アラートメールの削除
description: アラートメールを削除します。
parameters:
- $ref: '#/components/parameters/Token'
- name: email
in: query
description: メール
required: true
schema:
type: string
format: email
example: [email protected]
responses:
"200":
description: アラートメールが削除されました。
content:
application/json:
schema:
$ref: '#/components/schemas/Messages'
"400":
description: 不正なリクエストです。
content:
application/json:
schema:
$ref: '#/components/schemas/Messages'
example:
messages:
- "invalid request"
"404":
description: 指定されたアラートメールがありません。
content:
application/json:
schema:
$ref: '#/components/schemas/Messages'
example:
messages:
- "not found email"
/alertemail/test:
post:
tags:
- alertemail
summary: アラートメールのテスト送信
description: 登録したメールアドレスで、ステータスが有効なものにテスト送信します。
parameters:
- $ref: '#/components/parameters/Token'
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Messages'
example:
messages:
- "[email protected]: メール送信に成功しました。"
- "test finish"
"400":
description: 不正なリクエストです。
content:
application/json:
schema:
$ref: '#/components/schemas/Messages'
example:
messages:
- "invalid request"
/datalog:
get:
tags:
- datalog
summary: データログの取得
description: 指定したuuidのparameterのモジュールのデータログ一覧を取得します。最大取得数を超えた場合はpageを指定すると取得データがオフセットされます。
parameters:
- $ref: '#/components/parameters/Token'
- $ref: '#/components/parameters/Uuid'
- $ref: '#/components/parameters/Parameter'
- $ref: '#/components/parameters/Per_page'
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/From'
- $ref: '#/components/parameters/To'
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DatalogSet'
"400":
description: 不正なリクエストです。
content:
application/json:
schema:
$ref: '#/components/schemas/DatalogSet'
example:
messages:
- "invalid request"
total: 0
page: 0
per_page: 0
uuid: ""
parameter: ""
to: ""
from: ""
datalogs: null
"404":
description: 指定されたuuidがありません。
content:
application/json:
schema:
$ref: '#/components/schemas/DatalogSet'
example:
messages:
- "not found uuid"
total: 0
page: 0
per_page: 0
uuid: ""
parameter: ""
to: ""
from: ""
datalogs: null
/alertlog:
get:
tags:
- alertlog
summary: アラートログの取得
description: 指定したuuidのparameterのモジュールのアラートログ一覧を取得します。最大取得数を超えた場合はpageを指定すると取得データがオフセットされます。
parameters:
- $ref: '#/components/parameters/Token'
- $ref: '#/components/parameters/Uuid'
- $ref: '#/components/parameters/Parameter'
- $ref: '#/components/parameters/Per_page'
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/From'
- $ref: '#/components/parameters/To'
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AlertlogSet'
"400":
description: 不正なリクエストです。
content:
application/json:
schema:
$ref: '#/components/schemas/AlertlogSet'
example:
messages:
- "invalid request"
total: 0
page: 0
per_page: 0
uuid: ""
parameter: ""
to: ""
from: ""
alertlogs: null
"404":
description: 指定されたuuidがありません。
content:
application/json:
schema:
$ref: '#/components/schemas/AlertlogSet'
example:
messages:
- "not found uuid"
total: 0
page: 0
per_page: 0
uuid: ""
parameter: ""
to: ""
from: ""
alertlogs: null
/webhook:
get:
tags:
- webhook
summary: webhook用エンドポイントの取得
description: webhook用のエンドポイント一覧を取得します。
parameters:
- $ref: '#/components/parameters/Token'
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookSet'
"400":
description: 不正なリクエストです。
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookSet'
example:
messages:
- "invalid request"
webhooks: null
post:
tags:
- webhook
summary: webhook用エンドポイントの登録及び編集
description: 複数のエンドポイントを登録します。既に登録されたエンドポイントがある場合、上書き保存されます。（最大登録数:2）
parameters:
- $ref: '#/components/parameters/Token'
- $ref: '#/components/parameters/Contenttype'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Webhooks'
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Messages'
"400":
description: 不正なリクエストです。
content:
application/json:
schema:
$ref: '#/components/schemas/Messages'
example:
messages:
- "invalid request"
delete:
tags:
- webhook
summary: webhook用エンドポイントの削除
description: webhook用エンドポイントを削除します。
parameters:
- $ref: '#/components/parameters/Token'
- name: url
in: query
description: webhook用エンドポイントURL
required: true
schema:
type: string
format: url
example: "http://cloudhard.jp/api/"
responses:
"200":
description: webhook用エンドポイントが削除されました。
content:
application/json:
schema:
$ref: '#/components/schemas/Messages'
"400":
description: 不正なリクエストです。
content:
application/json:
schema:
$ref: '#/components/schemas/Messages'
example:
messages:
- "invalid request"
"404":
description: 指定されたwebhook用エンドポイントがありません。
content:
application/json:
schema:
$ref: '#/components/schemas/Messages'
example:
messages:
- "not found url"
/webhook/datatest:
post:
tags:
- webhook
summary: webhookのデータ受信時 テスト送信
description: 登録したwebhookで、ステータスが有効、かつ、イベント条件がデータ受信時のURLにテスト送信します。
parameters:
- $ref: '#/components/parameters/Token'
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Messages'
example:
messages:
- "https://test.endpointURL/: テスト送信完了しました。 ステータスコード: 200"
- "test finish"
"400":
description: 不正なリクエストです。
content:
application/json:
schema:
$ref: '#/components/schemas/Messages'
example:
messages:
- "invalid request"
/webhook/alerttest:
post:
tags:
- webhook
summary: webhookのアラート発生時 テスト送信
description: 登録したwebhookで、ステータスが有効、かつ、イベント条件がアラート発生時のURLにテスト送信します。
parameters:
- $ref: '#/components/parameters/Token'
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Messages'
example:
messages:
- "https://test.endpointURL/: テスト送信完了しました。 ステータスコード: 200"
- "test finish"
"400":
description: 不正なリクエストです。
content:
application/json:
schema:
$ref: '#/components/schemas/Messages'
example:
messages:
- "invalid request"
components:
schemas:
Messages:
type: object
properties:
messages:
type: array
items:
type: string
example:
- "success"
Uuid:
type: string
minLength: 16
maxLength: 16
example: "5JT0010000000000"
Status:
type: string
enum: ["無効", "有効"]
example: "有効"
Parameter:
type: string
enum: ["temperature", "humidity", "illumination", "co2", "battery", "watertemperature", "thermocouple", "accelerationx", "accelerationy", "accelerationz", "gyrox", "gyroy", "gyroz", "atmospressure", "ec"]
example: "temperature"
Page:
type: integer
default: 1
example: 1
Per_page:
type: integer
default: 200
maximum: 400
example: 200
Event:
type: string
enum: ["アラート発生時", "データ受信時", "データ受信・アラート発生時"]
example: "アラート発生時"
default: "アラート発生時"
TokenSet:
allOf:
- $ref: '#/components/schemas/Messages'
- type: object
properties:
apitoken:
type: string
example: "test_token"
expires:
type: string
example: "2013-10-17T10:00:00"
Module:
type: object
properties:
uuid:
$ref: '#/components/schemas/Uuid'
status:
$ref: '#/components/schemas/Status'
memo:
type: string
example: "memo"
alert:
type: array
items:
$ref: '#/components/schemas/Alert'
example:
- parameter: "temperature"
intervaltime: 3600
upperlimit: "80"
lowerlimit: "未設定"
- parameter: "humidity"
intervaltime: 60
upperlimit: "未設定"
lowerlimit: "未設定"
- parameter: "battery"
intervaltime: 7200
upperlimit: "未設定"
lowerlimit: "3.5"
ModuleSet:
allOf:
- $ref: '#/components/schemas/Messages'
- type: object
properties:
modules:
type: array
items:
$ref: '#/components/schemas/Module'
Alert:
type: object
properties:
parameter:
$ref: '#/components/schemas/Parameter'
intervaltime:
type: integer
enum: [60, 3600, 7200, 86400]
example: 3600
upperlimit:
type: string
example: "未設定"
lowerlimit:
type: string
example: "未設定"
Alertemail:
type: object
properties:
email:
type: string
example: "[email protected]"
format: email
status:
$ref: '#/components/schemas/Status'
Alertemails:
type: object
properties:
alertemails:
type: array
items:
$ref: '#/components/schemas/Alertemail'
example:
- email: [email protected]
status: "有効"
- email: [email protected]
status: "無効"
AlertemailSet:
allOf:
- $ref: '#/components/schemas/Messages'
- $ref: '#/components/schemas/Alertemails'
Datalog:
type: object
properties:
value:
type: number
example: 10.0
format: double
gettime:
type: string
example: "2013-10-17T10:00:00"
Pager:
type: object
properties:
total:
type: integer
example: 2
page:
$ref: '#/components/schemas/Page'
per_page:
$ref: '#/components/schemas/Per_page'
DatalogSet:
allOf:
- $ref: '#/components/schemas/Messages'
- $ref: '#/components/schemas/Pager'
- $ref: '#/components/schemas/Time'
- type: object
properties:
uuid:
$ref: '#/components/schemas/Uuid'
parameter:
$ref: '#/components/schemas/Parameter'
parameter_name:
$ref: '#/components/schemas/Parameter_name'
unit:
$ref: '#/components/schemas/Unit'
datalogs:
type: array
items:
$ref: '#/components/schemas/Datalog'
example:
- value: 25.65487
gettime: "2019-06-02T10:00:00"
- value: 26.59875
gettime: "2019-06-02T10:10:00"
Alertlog:
allOf:
- $ref: '#/components/schemas/Datalog'
- type: object
properties:
limitstatus:
type: string
example: "上限"
enum: ["上限","下限"]
limitvalue:
type: string
example: "10.0"
AlertlogSet:
allOf:
- $ref: '#/components/schemas/Messages'
- $ref: '#/components/schemas/Pager'
- $ref: '#/components/schemas/Time'
- type: object
properties:
uuid:
$ref: '#/components/schemas/Uuid'
parameter:
$ref: '#/components/schemas/Parameter'
parameter_name:
$ref: '#/components/schemas/Parameter_name'
unit:
$ref: '#/components/schemas/Unit'
alertlogs:
type: array
items:
$ref: '#/components/schemas/Alertlog'
example:
- value: 80.65487
gettime: "2019-06-02T10:56:42"
limitstatus: "上限"
limitvalue: "80.0"
- value: -1.59875
gettime: "2019-06-05T02:14:10"
limitstatus: "下限"
limitvalue: "0.0"
Webhook:
type: object
properties:
uri:
type: string
format: url
event:
$ref: '#/components/schemas/Event'
status:
$ref: '#/components/schemas/Status'
Webhooks:
type: object
properties:
webhooks:
type: array
items:
$ref: '#/components/schemas/Webhook'
example:
- url: "https://jinto.cloud/api/"
event: "アラート発生時"
status: "有効"
- url: "http://cloudhard.jp/api/"
event: "データ受信・アラート発生時"
status: "無効"
WebhookSet:
allOf:
- $ref: '#/components/schemas/Messages'
- $ref: '#/components/schemas/Webhooks'
Time:
type: object
properties:
to:
type: string
example: "2019-06-15T10:00:00"
from:
type: string
example: "2019-06-02T10:00:00"
Parameter_name:
type: string
example: "気温"
Unit:
type: string
example: "°C"
parameters:
Token:
name: X-Cloud-Token
in: header
schema:
type: string
required: true
description: APIトークン
example: test_token
Contenttype:
name: Content-Type
in: header
schema:
type: string
required: true
description: application/json
example: application/json
Uuid:
name: uuid
in: query
description: UUID
required: true
schema:
$ref: '#/components/schemas/Uuid'
Parameter:
name: parameter
in: query
required: true
description: パラメーター
schema:
$ref: '#/components/schemas/Parameter'
Per_page:
name: per_page
in: query
schema:
$ref: '#/components/schemas/Per_page'
description: 取得数(最大:400)
Page:
name: page
in: query
description: ページ
schema:
$ref: '#/components/schemas/Page'
From:
name: from
in: query
description: 開始時間(デフォルト：7日前) ※日本時間
schema:
type: string
example: "2019-06-02T10:00:00"
To:
name: to
in: query
description: 終了時間(デフォルト：現在日時) ※日本時間
schema:
type: string
example: "2019-06-15T10:00:00"