-
Notifications
You must be signed in to change notification settings - Fork 9
/
openapi.yaml
1223 lines (1216 loc) · 37 KB
/
openapi.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
info:
title: Tissue API
description: |
夜のライフログサービス Tissue の公開API仕様です。
全てのAPIのURLは `https://shikorism.net/api` から始まります。
一部APIではドキュメントに無いプロパティを応答する場合がありますが、これは正式な仕様ではありません。
予告なく削除する可能性がありますので**使用しないでください**。
version: 2023.12.3
servers:
- url: 'https://shikorism.net/api'
tags:
- name: webhook
description: Incoming Webhookに関する仕様
- name: users
description: ユーザー情報に関する操作
- name: checkin
description: チェックインに関する操作
- name: collection
description: コレクションに関する操作
- name: user-stats
description: ユーザーの統計情報
paths:
/webhooks/checkin/{id}:
post:
summary: チェックイン
description: Webhook IDを発行したユーザで新規チェックインを行います。
tags:
- webhook
parameters:
- name: id
in: path
required: true
description: Webhook管理ページで発行したID
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCheckin'
examples:
simple:
description: 何も指定しなければ、現在時刻で公開チェックインをおこないます。
value: {}
complete:
value:
checked_in_at: 2020-07-21T19:19:19+0900
note: すごく出た
link: http://example.com
tags:
- Example
- Example_2
is_private: false
is_too_sensitive: false
discard_elapsed_time: false
responses:
200:
description: チェックイン成功
content:
application/json:
schema:
type: object
required:
- status
- checkin
properties:
status:
type: number
description: HTTPステータスコードと同じ値
example: 200
checkin:
$ref: '#/components/schemas/Checkin'
404:
description: 無効なWebhook ID
content:
application/json:
schema:
type: object
required:
- status
- error
properties:
status:
type: number
description: HTTPステータスコードと同じ値
example: 404
error:
type: object
description: エラーデータ
required:
- message
properties:
message:
type: string
description: エラーの概要
example: The webhook is unavailable
422:
description: バリデーションエラー
content:
application/json:
schema:
type: object
required:
- status
- error
properties:
status:
type: number
description: HTTPステータスコードと同じ値
example: 422
error:
type: object
description: エラーデータ
required:
- message
properties:
message:
type: string
description: エラーの概要
example: Validation failed
violations:
type: array
items:
type: string
description: エラーが発生した各フィールドについてのメッセージ
example:
- Checkin already exists in this time
/v1/me:
get:
summary: 自分のユーザー情報の取得
description: 自分自身のユーザー情報を取得します。
tags:
- users
responses:
200:
description: 成功
content:
application/json:
schema:
$ref: '#/components/schemas/User'
/v1/users/{name}:
get:
summary: ユーザー情報の取得
description: 指定したユーザーの情報を取得します。
tags:
- users
parameters:
- name: name
in: path
required: true
description: ユーザー名
schema:
type: string
responses:
200:
description: 成功
content:
application/json:
schema:
$ref: '#/components/schemas/User'
404:
description: 存在しないユーザー
/v1/users/{name}/checkins:
get:
summary: チェックイン一覧の取得
description: 指定したユーザーのチェックイン一覧を取得します。
tags:
- users
parameters:
- name: name
in: path
required: true
description: ユーザー名
schema:
type: string
- name: page
in: query
description: ページ番号
schema:
type: integer
default: 1
- name: per_page
in: query
description: 1ページあたりのアイテム数
schema:
type: integer
default: 20
minimum: 10
maximum: 100
- name: has_link
in: query
description: オカズリンクを含むチェックインのみ取得
schema:
type: boolean
default: false
responses:
200:
description: 成功
headers:
X-Total-Count:
description: 全体のアイテム数
schema:
type: integer
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Checkin'
403:
description: ユーザーがチェックイン履歴を公開していない場合
404:
description: 存在しないユーザー
/v1/users/{name}/collections:
get:
summary: コレクション一覧の取得
description: 指定したユーザーのコレクション一覧を取得します。
tags:
- users
parameters:
- name: name
in: path
required: true
description: ユーザー名
schema:
type: string
- name: page
in: query
description: ページ番号
schema:
type: integer
default: 1
- name: per_page
in: query
description: 1ページあたりのアイテム数
schema:
type: integer
default: 20
minimum: 10
maximum: 100
responses:
200:
description: 成功
headers:
X-Total-Count:
description: 全体のアイテム数
schema:
type: integer
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Collection'
403:
description: ユーザーがチェックイン履歴を公開していない場合
404:
description: 存在しないユーザー
/v1/users/{name}/stats/checkin/daily:
get:
summary: 日毎のチェックイン数
description: 指定したユーザーのチェックイン数を日毎に合計した情報を取得します。
tags:
- user-stats
parameters:
- name: name
in: path
required: true
description: ユーザー名
schema:
type: string
- name: since
in: query
description: 集計範囲の開始日
required: false
schema:
type: string
format: date
example: 2020-07-21
- name: until
in: query
description: 集計範囲の終了日
required: false
schema:
type: string
format: date
example: 2021-07-21
responses:
200:
description: 成功
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DailyCheckinSummary'
403:
description: ユーザーがチェックイン履歴を公開していない場合
404:
description: 存在しないユーザー
/v1/users/{name}/stats/checkin/hourly:
get:
summary: 時間毎のチェックイン数
description: 指定したユーザーのチェックイン数を時間毎に合計した情報を取得します。
tags:
- user-stats
parameters:
- name: name
in: path
required: true
description: ユーザー名
schema:
type: string
- name: since
in: query
description: 集計範囲の開始日
required: false
schema:
type: string
format: date
example: 2020-07-21
- name: until
in: query
description: 集計範囲の終了日
required: false
schema:
type: string
format: date
example: 2021-07-21
responses:
200:
description: 成功
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/HourlyCheckinSummary'
403:
description: ユーザーがチェックイン履歴を公開していない場合
404:
description: 存在しないユーザー
/v1/users/{name}/stats/tags:
get:
summary: 最も使用したタグ
description: 指定したユーザーが期間内に最も使用したタグの上位10件を取得します。
tags:
- user-stats
parameters:
- name: name
in: path
required: true
description: ユーザー名
schema:
type: string
- name: since
in: query
description: 集計範囲の開始日
required: false
schema:
type: string
format: date
example: 2020-07-21
- name: until
in: query
description: 集計範囲の終了日
required: false
schema:
type: string
format: date
example: 2021-07-21
responses:
200:
description: 成功
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MostlyUsedCheckinTag'
403:
description: ユーザーがチェックイン履歴を公開していない場合
404:
description: 存在しないユーザー
/v1/users/{name}/stats/links:
get:
summary: 最も使用したオカズ
description: |
指定したユーザーが期間内に最も使用したオカズの上位10件を取得します。
### 範囲指定について
負荷を抑えるため、集計範囲を最大1年分に制限しています。
`since` のみを指定した場合はその日から1年分、`until` のみを指定した場合はその日までの1年分を集計します。
両方指定した場合で1年以上の範囲を指定すると `since` から1年分までに制限して集計します。
どちらも指定しなかった場合は、今年1年分のデータを集計します。
tags:
- user-stats
parameters:
- name: name
in: path
required: true
description: ユーザー名
schema:
type: string
- name: since
in: query
description: 集計範囲の開始日
required: false
schema:
type: string
format: date
example: 2020-07-21
- name: until
in: query
description: 集計範囲の終了日
required: false
schema:
type: string
format: date
example: 2021-07-21
responses:
200:
description: 成功
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MostlyUsedLink'
403:
description: ユーザーがチェックイン履歴を公開していない場合
404:
description: 存在しないユーザー
/v1/checkins:
post:
summary: チェックインの作成
description: 新規チェックインを行います。
tags:
- checkin
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCheckin'
examples:
simple:
description: 全てのプロパティは省略可能です。何も指定しなければ、現在時刻で公開チェックインをおこないます。
value: {}
complete:
value:
checked_in_at: 2020-07-21T19:19:19+0900
note: すごく出た
link: http://example.com
tags:
- Example
- Example_2
is_private: false
is_too_sensitive: false
discard_elapsed_time: false
responses:
200:
description: 成功
content:
application/json:
schema:
$ref: '#/components/schemas/Checkin'
422:
description: バリデーションエラー
content:
application/json:
schema:
type: object
required:
- status
- error
properties:
status:
type: number
description: HTTPステータスコードと同じ値
example: 422
error:
$ref: '#/components/schemas/ValidationError'
/v1/checkins/{id}:
get:
summary: チェックインの取得
description: 指定したIDのチェックインの情報を取得します。
tags:
- checkin
parameters:
- name: id
in: path
required: true
description: チェックインID
schema:
type: integer
format: int64
responses:
200:
description: 成功
content:
application/json:
schema:
$ref: '#/components/schemas/Checkin'
403:
description: アクセス権の無いチェックイン (ユーザーがチェックイン履歴を公開していない、またはチェックインが非公開設定)
404:
description: 存在しない場合
patch:
summary: チェックインの編集
description: |
指定したIDのチェックインの情報を編集します。
リクエスト内の項目は全て省略可能であり、更新したい項目のみを送信することができます。
tags:
- checkin
parameters:
- name: id
in: path
required: true
description: チェックインID
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateCheckin'
responses:
200:
description: 成功
content:
application/json:
schema:
$ref: '#/components/schemas/Checkin'
403:
description: 自分以外のチェックインに対して操作を試みた場合
404:
description: 存在しない場合
422:
description: バリデーションエラー
content:
application/json:
schema:
type: object
required:
- status
- error
properties:
status:
type: number
description: HTTPステータスコードと同じ値
example: 422
error:
$ref: '#/components/schemas/ValidationError'
delete:
summary: チェックインの削除
description: 指定したIDのチェックインを削除します。
tags:
- checkin
parameters:
- name: id
in: path
required: true
description: チェックインID
schema:
type: integer
format: int64
responses:
204:
description: 成功、または既に存在しない場合
403:
description: 自分以外のチェックインに対して操作を試みた場合
/v1/collections:
post:
summary: コレクションの作成
description: 新規コレクションを作成します。
tags:
- collection
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCollection'
responses:
200:
description: 成功
content:
application/json:
schema:
$ref: '#/components/schemas/Collection'
422:
description: バリデーションエラー
content:
application/json:
schema:
type: object
required:
- status
- error
properties:
status:
type: number
description: HTTPステータスコードと同じ値
example: 422
error:
$ref: '#/components/schemas/ValidationError'
/v1/collections/{collection_id}:
get:
summary: コレクションの取得
description: 指定したIDのコレクションの情報を取得します。
tags:
- collection
parameters:
- name: collection_id
in: path
required: true
description: コレクションID
schema:
type: integer
format: int64
responses:
200:
description: 成功
content:
application/json:
schema:
$ref: '#/components/schemas/Collection'
404:
description: 存在しない、またはアクセス権の無いコレクションの場合 (ユーザーがチェックイン履歴を公開していない、またはコレクションが非公開設定)
put:
summary: コレクションの編集
description: 指定したIDのコレクションの情報を編集します。
tags:
- collection
parameters:
- name: collection_id
in: path
required: true
description: コレクションID
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateCollection'
responses:
200:
description: 成功
content:
application/json:
schema:
$ref: '#/components/schemas/Collection'
403:
description: 自分以外が作成したコレクションに対して操作を試みた場合
404:
description: 存在しない場合
422:
description: バリデーションエラー
content:
application/json:
schema:
type: object
required:
- status
- error
properties:
status:
type: number
description: HTTPステータスコードと同じ値
example: 422
error:
$ref: '#/components/schemas/ValidationError'
delete:
summary: コレクションの削除
description: |
指定したIDのコレクションを削除します。
### 注意
実装上の都合で、Checkin APIと異なり**応答がべき等ではありません**。既に削除されている場合は404エラーになりますので、ご注意ください。
tags:
- collection
parameters:
- name: collection_id
in: path
required: true
description: コレクションID
schema:
type: integer
format: int64
responses:
204:
description: 成功
403:
description: 自分以外が作成したコレクションに対して操作を試みた場合
404:
description: 存在しない場合
/v1/collections/{collection_id}/items:
get:
summary: コレクション内アイテム一覧の取得
description: 指定したコレクションに含まれるアイテムの一覧を取得します。
tags:
- collection
parameters:
- name: collection_id
in: path
required: true
description: コレクションID
schema:
type: integer
format: int64
- name: page
in: query
description: ページ番号
schema:
type: integer
default: 1
- name: per_page
in: query
description: 1ページあたりのアイテム数
schema:
type: integer
default: 20
minimum: 10
maximum: 100
responses:
200:
description: 成功
headers:
X-Total-Count:
description: 全体のアイテム数
schema:
type: integer
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CollectionItem'
404:
description: コレクションが存在しない、またはアクセス権の無いコレクションの場合 (ユーザーがチェックイン履歴を公開していない、またはコレクションが非公開設定)
post:
summary: コレクションにアイテムを追加
description: 指定したコレクションに新しいアイテムを追加します。
tags:
- collection
parameters:
- name: collection_id
in: path
required: true
description: コレクションID
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCollectionItem'
responses:
200:
description: 成功
content:
application/json:
schema:
$ref: '#/components/schemas/CollectionItem'
422:
description: バリデーションエラー
content:
application/json:
schema:
type: object
required:
- status
- error
properties:
status:
type: number
description: HTTPステータスコードと同じ値
example: 422
error:
$ref: '#/components/schemas/ValidationError'
/v1/collections/{collection_id}/items/{collection_item_id}:
patch:
summary: コレクションアイテムの更新
description: |
指定したIDのコレクションアイテムの情報を更新します。
リクエスト内の項目は全て省略可能であり、更新したい項目のみを送信することができます。
tags:
- collection
parameters:
- name: collection_id
in: path
required: true
description: コレクションID
schema:
type: integer
format: int64
- name: collection_item_id
in: path
required: true
description: コレクションアイテムID
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateCollectionItem'
responses:
200:
description: 成功
content:
application/json:
schema:
$ref: '#/components/schemas/CollectionItem'
403:
description: 自分以外が作成したコレクションに対して操作を試みた場合
404:
description: 存在しない場合
422:
description: バリデーションエラー
content:
application/json:
schema:
type: object
required:
- status
- error
properties:
status:
type: number
description: HTTPステータスコードと同じ値
example: 422
error:
$ref: '#/components/schemas/ValidationError'
delete:
summary: コレクションからアイテムを削除
description: |
コレクションから、指定したIDのコレクションアイテムを削除します。
### 注意
実装上の都合で、Checkin APIと異なり**応答がべき等ではありません**。既に削除されている場合は404エラーになりますので、ご注意ください。
tags:
- collection
parameters:
- name: collection_id
in: path
required: true
description: コレクションID
schema:
type: integer
format: int64
- name: collection_item_id
in: path
required: true
description: コレクションアイテムID
schema:
type: integer
format: int64
responses:
204:
description: 成功
403:
description: 自分以外が作成したコレクションに対して操作を試みた場合
404:
description: 存在しない場合
components:
schemas:
User:
type: object
description: ユーザーデータ
required:
- name
- display_name
- is_protected
- private_likes
properties:
name:
type: string
maxLength: 15
description: ユーザー名 (多くの画面では先頭に @ を付けて表示されますが、ここでは含まれません)
display_name:
type: string
maxLength: 20
description: 名前
is_protected:
type: boolean
description: チェックイン履歴の非公開フラグ
private_likes:
type: boolean
description: いいね一覧の非公開フラグ
bio:
type: string
maxLength: 160
description: 自己紹介文
url:
type: string
format: uri
description: プロフィール上に掲載するURL
checkin_summary:
$ref: '#/components/schemas/CheckinSummary'
CheckinSummary:
type: object
description: チェックインの概況
required:
- current_session_elapsed
- total_checkins
- total_times
- average_interval
- longest_interval
- shortest_interval
properties:
current_session_elapsed:
type: integer
format: int64
description: 最後のチェックインからの経過秒数 (現在のセッション)
total_checkins:
type: integer
format: int64
description: 合計チェックイン回数
total_times:
type: integer
format: int64
description: 合計時間 (秒)
average_interval:
type: integer
format: int64
description: 平均チェックイン間隔 (秒)
longest_interval:
type: integer
format: int64
description: 最長チェックイン間隔 (秒)
shortest_interval:
type: integer
format: int64
description: 最短チェックイン間隔 (秒)
Checkin:
type: object
description: チェックインデータ
properties:
id:
type: integer
format: int64
description: チェックインID
checked_in_at:
type: string
format: date-time
description: チェックイン日時
example: 2020-07-21T19:19:19+0900
tags:
type: array
items:
type: string
maxLength: 255
description: タグ
example:
- Example
- Example_2
link:
type: string
maxLength: 2000
description: オカズリンク (http, https)
example: http://example.com
note:
type: string
maxLength: 500
description: ノート
example: すごく出た
is_private:
type: boolean
default: false
description: 非公開チェックインとして設定
is_too_sensitive:
type: boolean
default: false
description: チェックイン対象のオカズをより過激なオカズとして設定
discard_elapsed_time:
type: boolean
default: false
description: 前回チェックインからの経過時間を記録しない
source:
type: string
description: チェックインの登録元
enum:
- web
- csv
- webhook
- api
example: api
UpdateCheckin:
type: object
properties: