-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
1063 lines (1061 loc) · 28.7 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.1.0
servers:
- url: https://sample.cybozu.com
info:
version: 1.0.0
title: Kintone REST API
description: "This is an experimental"
tags:
- name: App
- name: Record
- name: Space
- name: File
- name: Plugin
- name: Apis
security:
- PasswordAuth: []
- SessionAuth: []
- ApiTokenAuth: []
paths:
/k/v1/app.json:
post: # X-HTTP-Method-Overrideを試すためにpostにしてみる
tags:
- App
summary: 1件のアプリの情報を取得する。
description: 1件のアプリの情報を取得する。
operationId: getApp
# parameters:
# - name: id
# in: query
# description: アプリID
# required: true
# schema:
# type: string
requestBody:
description: GetApp Request Body
content:
application/json:
schema:
type: object
required:
- id
properties:
id:
type: string
example:
id: "123"
parameters:
- name: X-HTTP-Method-Override
in: header
description: メソッドをGETにする
schema:
type: string
enum: [GET]
default: GET
example:
X-HTTP-Method-Override: GET
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetAppResponss'
"400":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/KintoneRestApiError'
"500":
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/KintoneRestApiError'
/k/v1/apps.json:
get:
tags:
- App
summary: 複数のアプリの情報を取得する。
description: 複数のアプリの情報を取得する。
operationId: getApps
parameters:
- name: ids
in: query
schema:
type: array
items:
type: string
description: アプリID
- name: codes
in: query
schema:
type: array
items:
type: string
description: アプリコード
- name: name
in: query
schema:
type: string
description: アプリ名
- name: spaceIds
in: query
schema:
type: array
items:
type: string
description: スペースID
- name: offset
in: query
schema:
type: number
default: 0
- name: limit
in: query
schema:
type: number
default: 100
- name: X-HTTP-Method-Override
in: header
nullable: true
description: メソッドをGETにする
schema:
type: string
enum: [GET]
default: GET
example:
X-HTTP-Method-Override: GET
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetAppsRespons'
"400":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/KintoneRestApiError'
"500":
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/KintoneRestApiError'
/k/v1/preview/app.json:
post:
tags:
- App
description: 動作テスト環境にアプリを作成する。
operationId: addApp
requestBody:
description: response body
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AddAppRequest'
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/AddAppResponse'
"400":
description: Bad Request
"500":
description: Internal Server Error
/k/v1/app/settings.json:
get:
tags:
- App
summary: Get general app settings
description: Retrieves the general settings of an app in Kintone.
operationId: getGeneralAppSettings
parameters:
- name: app
in: query
required: true
schema:
type: string
description: The ID of the app.
- name: lang
in: query
schema:
type: string
enum:
- en
- ja
- zh
- user
- default
description: The language of the response.
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/GetGeneralAppSettingsResponse'
'400':
description: Bad request
'401':
description: Unauthorized
'500':
description: Internal server error
/k/v1/preview/app/deploy.json:
get:
tags:
- App
summary: Get app deploy status
description: Retrieves the deployment status of an app in Kintone.
operationId: getAppDeployStatus
parameters:
- name: apps
in: query
required: true
schema:
type: array
items:
type: string
description: The IDs of the apps.
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/GetAppDeployStatusResponse'
'400':
description: Bad request
'401':
description: Unauthorized
'500':
description: Internal server error
post:
tags:
- App
summary: Deploy App Settings
description: Deploys the settings of an app.
operationId: deployApp
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
apps:
type: array
items:
type: object
properties:
app:
type: string
revision:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
apps:
type: array
items:
type: object
properties:
app:
type: string
revision:
type: string
'400':
description: Bad request
content:
application/json:
schema:
type: object
properties:
message:
type: string
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
message:
type: string
'500':
description: Internal server error
content:
application/json:
schema:
type: object
properties:
message:
type: string
/k/v1/apis.json:
get:
tags:
- Apis
description: REST APIの一覧を取得する。
operationId: getApis
responses:
"200":
description: Success
content:
application/json:
schema:
type: object
properties:
baseUrl:
type: string
apis:
type: object
additionalProperties:
type: object
properties:
link:
type: string
/k/v1/apis/{apiId}.json:
get:
tags:
- Apis
description: REST APIの一覧を取得する。
operationId: getApi
parameters:
- in: path
name: apiId
schema:
type: string
required: true
responses:
"200":
description: Success
content:
application/json:
schema:
type: object
properties:
id:
type: string
baseUrl:
type: string
path:
type: string
httpMethod:
type: string
request:
type: object
additionalProperties: {}
response:
type: object
additionalProperties: {}
schemas:
type: object
additionalProperties: {}
/k/v1/app/adminNotes.json:
get:
operationId: getAdminNotes
tags:
- App
summary: Get App Admin Notes
description: Gets notes for app administrators and their settings.
parameters:
- $ref: '#/components/parameters/GetAppAdminNotesRequest'
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/GetAppAdminNotesResponse'
/guest/{SpaceID}/k/v1/app/adminNotes.json:
get:
operationId: getAdminNotesGuest
tags:
- App
parameters:
- $ref: '#/components/parameters/SpaceID'
- $ref: '#/components/parameters/GetAppAdminNotesRequest'
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/GetAppAdminNotesResponse'
/k/v1/preview/app/adminNotes.json:
get:
operationId: getAdminNotesPreview
tags:
- App
summary: Get App Admin Notes
description: Gets notes for app administrators and their settings.
parameters:
- $ref: '#/components/parameters/GetAppAdminNotesRequest'
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/GetAppAdminNotesResponse'
put:
operationId: updateAdminNotes
tags:
- App
summary: Update App Admin Notes
description: Update notes for app administrators and their settings.
requestBody:
description: response body
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateAppAdminNotesRequest'
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateAppAdminNotesResponse'
"400":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/KintoneRestApiError'
"405":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/KintoneRestApiError'
/guest/{SpaceID}/k/v1/preview/app/adminNotes.json:
get:
operationId: getAdminNotesGuestPreview
tags:
- App
parameters:
- $ref: '#/components/parameters/SpaceID'
- $ref: '#/components/parameters/GetAppAdminNotesRequest'
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/GetAppAdminNotesResponse'
put:
operationId: updateAdminNotesPreview
tags:
- App
summary: Update App Admin Notes For Preview
description: Update notes for preview app administrators and their settings.
parameters:
- $ref: '#/components/parameters/SpaceID'
requestBody:
description: response body
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateAppAdminNotesRequest'
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateAppAdminNotesResponse'
/k/v1/file.json:
get:
tags:
- File
summary: Download a file
description: Downloads a file from Kintone.
operationId: downloadFile
parameters:
- name: fileKey
in: query
required: true
schema:
type: string
description: The key of the file to download.
responses:
'200':
description: Successful response
content:
application/octet-stream:
schema:
type: string
format: binary
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: File not found
'500':
description: Internal server error
post:
tags:
- File
summary: Upload a file
description: Uploads a file to Kintone.
operationId: uploadFile
requestBody:
required: true
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/UploadFileRequest'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/UploadFileResponse'
'400':
description: Bad request
'401':
description: Unauthorized
'500':
description: Internal server error
/k/v1/preview/app/form/fields.json:
get:
tags:
- App
summary: Get Form Fields
description: Retrieve the form fields of an app in Kintone
parameters:
- name: app
in: query
required: true
description: The App ID
schema:
type: integer
- name: lang
in: query
required: false
description: The language setting for the response
schema:
type: string
enum: [default, en, ja, zh, user]
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
revision:
type: string
properties:
$ref: '#/components/schemas/FieldProperties'
'400':
description: Bad request
'404':
description: Not found
'500':
description: Internal server error
/k/v1/record.json:
get:
$ref: './openapi/paths/record/record.yaml'
post:
$ref: './openapi/paths/record/record_post.yaml'
put:
$ref: './openapi/paths/record/record_put.yaml'
/k/v1/records.json:
get:
$ref: './openapi/paths/record/records.yaml'
post:
$ref: './openapi/paths/record/records_post.yaml'
put:
$ref: './openapi/paths/record/records_put.yaml'
delete:
$ref: './openapi/paths/record/records_delete.yaml'
/k/v1/records/cursor.json:
get:
$ref: './openapi/paths/record/cursor_get.yaml'
post:
$ref: './openapi/paths/record/cursor_post.yaml'
delete:
$ref: './openapi/paths/record/cursor_delete.yaml'
/k/v1/record/comments.json:
get:
$ref: './openapi/paths/record/comments_get.yaml'
/k/v1/record/comment.json:
post:
$ref: './openapi/paths/record/comment_post.yaml'
delete:
$ref: './openapi/paths/record/comment_delete.yaml'
/k/v1/record/assignees.json:
put:
$ref: './openapi/paths/record/assignees_put.yaml'
/k/v1/record/status.json:
put:
$ref: './openapi/paths/record/record_status_put.yaml'
/k/v1/records/status.json:
put:
$ref: './openapi/paths/record/records_status_put.yaml'
/k/v1/records/acl/evaluate.json:
get:
$ref: './openapi/paths/record/records_acl_evaluate.yaml'
/k/v1/bulkRequest.json:
post:
$ref: './openapi/paths/record/bulk_request_post.yaml'
components:
securitySchemes:
PasswordAuth:
type: apiKey
in: header
name: X-Cybozu-Authorization
description: パスワード認証
ApiTokenAuth:
type: apiKey
in: header
name: X-Cybozu-API-Token
description: APIトークン
SessionAuth:
type: apiKey
in: cookie
name: SESSIONID
description: セッションID
# OAuth:
# type: oauth2
# flows:
# implicit:
# authorizationUrl: 'http://petstore.swagger.io/api/oauth/dialog'
# scopes:
# 'write:pets': modify pets in your account
# 'read:pets': read your pets
parameters:
SpaceID:
name: SpaceID
in: path
description: The Guest Space ID.
required: true
schema:
type: integer
GetAppAdminNotesRequest:
in: query
name: query
style: form
explode: true
description: Get App Admin Notes Request
schema:
type: object
properties:
app:
type: string
description: The App ID.
schemas:
GetAppResponss:
description: Get App Response
type: object
properties:
appId:
type: string
code:
type: string
name:
type: string
description:
type: string
spaceId:
type: string
threadId:
type: string
createdAt:
type: string
creator:
type: object
properties:
code:
type: string
name:
type: string
modifiedAt:
type: string
modifier:
type: object
properties:
code:
type: string
name:
type: string
GetAppsRespons:
title: Get Apps response
type: object
properties:
apps:
type: array
items:
$ref: '#/components/schemas/GetAppResponss'
AdminNotes:
title: App Admin Notes
description: App Admin Notes
type: object
properties:
content:
type: string
includeInTemplateAndDuplicates:
type: boolean
GetAppAdminNotesResponse:
description: Get App Admin Notes Response
allOf:
- $ref: '#/components/schemas/AdminNotes'
- type: object
properties:
revision:
type: string
UpdateAppAdminNotesRequest:
description: Update App Admin Notes Request
type: object
allOf:
- $ref: '#/components/schemas/AdminNotes'
- type: object
properties:
app:
type: string
revision:
type: string
UpdateAppAdminNotesResponse:
description: Update App Admin Notes Response
type: object
properties:
revision:
type: string
AddAppRequest:
description: Add App Request
type: object
properties:
name:
type: string
description: The name of the app.
space:
type: integer
description: The ID of the space where the app will be created.
thread:
type: integer
description: The ID of the thread where the app will be created.
required:
- name
AddAppResponse:
description: Add App Response
type: object
properties:
app:
type: string
description: The ID of the created app.
revision:
type: string
description: The revision number of the app.
DeployAppSettingsRequest:
description: Deploy App Settings Request
type: object
properties:
apps:
type: array
items:
type: object
properties:
app:
type: string
description: The ID of the app.
revision:
type: string
description: The revision number of the app.
required:
- apps
DeployAppSettingsResponse:
description: Deploy App Settings Response
type: object
properties:
apps:
type: array
items:
type: object
properties:
app:
type: string
description: The ID of the app.
status:
type: string
description: The deployment status of the app.
GetGeneralAppSettingsResponse:
description: Get General App Settings Response
type: object
properties:
name:
type: string
description: The name of the app.
description:
type: string
description: The description of the app.
icon:
type: object
properties:
type:
type: string
description: The type of the icon.
key:
type: string
description: The key of the icon.
theme:
type: string
description: The theme of the app.
titleField:
type: object
properties:
selectionMode:
type: string
description: The selection mode of the title field.
enum:
- AUTO
- MANUAL
code:
type: string
description: The code of the title field.
enableThumbnails:
type: boolean
description: Whether to enable thumbnails.
enableBulkDeletion:
type: boolean
description: Whether to enable bulk deletion.
enableComments:
type: boolean
description: Whether to enable comments.
enableDuplicateRecord:
type: boolean
description: Whether to enable duplicate record.
enableInlineRecordEditing:
type: boolean
description: Whether to enable inline record editing.
numberPrecision:
type: object
description: The number precision.
properties:
digits:
type: string
description: The number of digits.
decimalPlaces:
type: string
description: The number of decimal places.
roundingMode:
type: string
description: The rounding mode.
firstMonthOfFiscalYear:
type: string
description: The first month of the fiscal year.
revision:
type: string
description: The revision number of the app.
GetAppDeployStatusResponse:
description: Get App Deploy Status Response
type: object
properties:
apps:
type: array
items:
type: object
properties:
app:
type: string
description: The ID of the app.
status:
type: string
description: The deployment status of the app.
enum:
- PROCESSING
- SUCCESS
- FAIL
- CANCEL
UploadFileRequest:
description: Upload File Request
type: object
properties:
file:
type: string
format: binary
description: The file to upload.
required:
- file
UploadFileResponse:
description: Upload File Response
type: object
properties:
fileKey:
type: string
description: The key of the uploaded file.
FieldProperties:
description: Field Properties
type: object
additionalProperties:
type: object
properties:
"type":
type: string
code:
type: string
label:
type: string
noLabel:
type: boolean
required:
type: boolean
unique:
type: boolean
maxValue:
type: string
minValue:
type: string
maxLength:
type: string
minLength:
type: string
defaultValue:
type: string
defaultNowValue:
type: boolean
align:
type: string
expression:
type: string
hideExpression:
type: boolean
digit:
type: boolean
thumbnailSize:
type: string
protocol:
type: string
format:
type: string
displayScale:
type: string
unit:
type: string
unitPosition:
type: string
entities:
type: array
items:
type: object
properties:
code:
type: string
type:
type: string
referenceTable:
type: object
properties:
relatedApp:
type: object
properties:
app:
type: string
code:
type: string
condition:
type: object
properties:
field:
type: string
relatedField:
type: string
filterCond:
type: string
displayFields:
type: array
items:
type: string
sort:
type: string
size:
type: string
lookup:
type: object
properties:
relatedApp:
type: object
properties:
app:
type: string
code: