-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathopenapi.yaml
More file actions
2186 lines (2108 loc) · 53.3 KB
/
openapi.yaml
File metadata and controls
2186 lines (2108 loc) · 53.3 KB
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.3
info:
title: NocoDB API
description: |
NocoDB REST API спецификация.
NocoDB - это open-source Airtable альтернатива, которая превращает любую базу данных в умную электронную таблицу.
version: 2.0.0
contact:
name: NocoDB
url: https://nocodb.com
license:
name: AGPL-3.0
url: https://github.com/nocodb/nocodb/blob/master/LICENSE
servers:
- url: http://localhost:8080
description: Локальный сервер разработки
- url: https://api.nocodb.com
description: Production сервер
tags:
- name: Auth
description: Аутентификация и авторизация
- name: Bases
description: Управление базами данных (проектами)
- name: Tables
description: Управление таблицами
- name: Columns
description: Управление колонками таблиц
- name: Data
description: Операции с данными
- name: Views
description: Управление представлениями (views)
- name: Filters
description: Управление фильтрами
- name: Sorts
description: Управление сортировками
- name: Hooks
description: Управление веб-хуками
- name: Users
description: Управление пользователями
- name: Base Users
description: Управление пользователями базы
- name: Sources
description: Управление источниками данных
- name: Forms
description: Управление формами
- name: Grids
description: Управление grid представлениями
- name: Galleries
description: Управление gallery представлениями
- name: Kanbans
description: Управление kanban представлениями
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
apiToken:
type: apiKey
in: header
name: xc-token
schemas:
Error:
type: object
properties:
msg:
type: string
error:
type: string
PagedResponse:
type: object
properties:
list:
type: array
items: {}
pageInfo:
type: object
properties:
totalRows:
type: integer
page:
type: integer
pageSize:
type: integer
isFirstPage:
type: boolean
isLastPage:
type: boolean
Base:
type: object
properties:
id:
type: string
title:
type: string
prefix:
type: string
status:
type: string
description:
type: string
meta:
type: object
color:
type: string
deleted:
type: boolean
order:
type: number
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
BaseInfo:
type: object
properties:
Node:
type: string
Arch:
type: string
Platform:
type: string
Docker:
type: boolean
RootDB:
type: string
PackageVersion:
type: string
Table:
type: object
properties:
id:
type: string
base_id:
type: string
source_id:
type: string
table_name:
type: string
title:
type: string
type:
type: string
enum: [table, view]
enabled:
type: boolean
meta:
type: object
columns:
type: array
items:
$ref: '#/components/schemas/Column'
Column:
type: object
properties:
id:
type: string
base_id:
type: string
fk_model_id:
type: string
title:
type: string
column_name:
type: string
uidt:
type: string
dt:
type: string
np:
type: string
ns:
type: string
clen:
type: string
cop:
type: string
pk:
type: boolean
pv:
type: boolean
rqd:
type: boolean
un:
type: boolean
ct:
type: string
ai:
type: boolean
unique:
type: boolean
cdf:
type: string
cc:
type: string
csn:
type: string
dtx:
type: string
dtxp:
type: string
dtxs:
type: string
au:
type: boolean
validate:
type: object
meta:
type: object
system:
type: boolean
order:
type: number
View:
type: object
properties:
id:
type: string
title:
type: string
type:
type: string
enum: [grid, form, gallery, kanban, calendar, map]
is_default:
type: boolean
show_system_fields:
type: boolean
lock_type:
type: string
uuid:
type: string
password:
type: string
show:
type: boolean
order:
type: number
meta:
type: object
Filter:
type: object
properties:
id:
type: string
fk_view_id:
type: string
fk_hook_id:
type: string
fk_column_id:
type: string
logical_op:
type: string
enum: [and, or]
comparison_op:
type: string
value:
type: string
fk_parent_id:
type: string
is_group:
type: boolean
Sort:
type: object
properties:
id:
type: string
fk_view_id:
type: string
fk_column_id:
type: string
direction:
type: string
enum: [asc, desc]
order:
type: number
Hook:
type: object
properties:
id:
type: string
title:
type: string
description:
type: string
env:
type: string
type:
type: string
event:
type: string
operation:
type: string
async:
type: boolean
payload:
type: object
url:
type: string
headers:
type: array
items:
type: object
condition:
type: boolean
notification:
type: object
retries:
type: integer
retry_interval:
type: integer
timeout:
type: integer
active:
type: boolean
User:
type: object
properties:
id:
type: string
email:
type: string
firstname:
type: string
lastname:
type: string
roles:
type: string
invite_token:
type: string
invite_token_expires:
type: string
format: date-time
Source:
type: object
properties:
id:
type: string
base_id:
type: string
alias:
type: string
type:
type: string
is_meta:
type: boolean
is_local:
type: boolean
is_schema_readonly:
type: boolean
is_data_readonly:
type: boolean
config:
type: object
inflection_column:
type: string
inflection_table:
type: string
order:
type: number
enabled:
type: boolean
security:
- bearerAuth: []
- apiToken: []
paths:
# ==================== AUTH ====================
/api/v2/auth/user/signup:
post:
tags:
- Auth
summary: Регистрация нового пользователя
operationId: signup
security: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- email
- password
properties:
email:
type: string
format: email
password:
type: string
format: password
firstname:
type: string
lastname:
type: string
responses:
'200':
description: Успешная регистрация
content:
application/json:
schema:
type: object
properties:
token:
type: string
'400':
description: Неверные данные
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/api/v2/auth/user/signin:
post:
tags:
- Auth
summary: Вход в систему
operationId: signin
security: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- email
- password
properties:
email:
type: string
format: email
password:
type: string
format: password
responses:
'200':
description: Успешный вход
content:
application/json:
schema:
type: object
properties:
token:
type: string
'401':
description: Неверные учетные данные
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/api/v2/auth/user/signout:
post:
tags:
- Auth
summary: Выход из системы
operationId: signout
responses:
'200':
description: Успешный выход
content:
application/json:
schema:
type: object
properties:
msg:
type: string
/api/v2/auth/token/refresh:
post:
tags:
- Auth
summary: Обновление токена
operationId: refreshToken
security: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
refresh_token:
type: string
responses:
'200':
description: Токен обновлен
content:
application/json:
schema:
type: object
properties:
token:
type: string
# ==================== BASES ====================
/api/v2/meta/bases:
get:
tags:
- Bases
summary: Получить список баз
operationId: baseList
parameters:
- name: limit
in: query
schema:
type: integer
- name: offset
in: query
schema:
type: integer
responses:
'200':
description: Список баз
content:
application/json:
schema:
$ref: '#/components/schemas/PagedResponse'
/api/v2/meta/bases/{baseId}:
get:
tags:
- Bases
summary: Получить информацию о базе
operationId: baseGet
parameters:
- name: baseId
in: path
required: true
schema:
type: string
responses:
'200':
description: Информация о базе
content:
application/json:
schema:
$ref: '#/components/schemas/Base'
'404':
description: База не найдена
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
patch:
tags:
- Bases
summary: Обновить базу
operationId: baseUpdate
parameters:
- name: baseId
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
title:
type: string
color:
type: string
meta:
type: object
responses:
'200':
description: База обновлена
content:
application/json:
schema:
$ref: '#/components/schemas/Base'
/api/v2/meta/bases/{baseId}/info:
get:
tags:
- Bases
summary: Получить системную информацию о базе
operationId: baseInfoGet
parameters:
- name: baseId
in: path
required: true
schema:
type: string
responses:
'200':
description: Системная информация
content:
application/json:
schema:
$ref: '#/components/schemas/BaseInfo'
# ==================== TABLES ====================
/api/v2/meta/bases/{baseId}/tables:
get:
tags:
- Tables
summary: Получить список таблиц
operationId: tableList
parameters:
- name: baseId
in: path
required: true
schema:
type: string
- name: includeM2M
in: query
schema:
type: boolean
responses:
'200':
description: Список таблиц
content:
application/json:
schema:
$ref: '#/components/schemas/PagedResponse'
post:
tags:
- Tables
summary: Создать таблицу
operationId: tableCreate
parameters:
- name: baseId
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- table_name
- title
properties:
table_name:
type: string
title:
type: string
columns:
type: array
items:
type: object
responses:
'200':
description: Таблица создана
content:
application/json:
schema:
$ref: '#/components/schemas/Table'
/api/v2/meta/bases/{baseId}/{sourceId}/tables:
get:
tags:
- Tables
summary: Получить список таблиц источника
operationId: tableListBySource
parameters:
- name: baseId
in: path
required: true
schema:
type: string
- name: sourceId
in: path
required: true
schema:
type: string
- name: includeM2M
in: query
schema:
type: boolean
responses:
'200':
description: Список таблиц
content:
application/json:
schema:
$ref: '#/components/schemas/PagedResponse'
post:
tags:
- Tables
summary: Создать таблицу в источнике
operationId: tableCreateInSource
parameters:
- name: baseId
in: path
required: true
schema:
type: string
- name: sourceId
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- table_name
- title
properties:
table_name:
type: string
title:
type: string
columns:
type: array
items:
type: object
responses:
'200':
description: Таблица создана
content:
application/json:
schema:
$ref: '#/components/schemas/Table'
/api/v2/meta/tables/{tableId}:
get:
tags:
- Tables
summary: Получить информацию о таблице
operationId: tableGet
parameters:
- name: tableId
in: path
required: true
schema:
type: string
responses:
'200':
description: Информация о таблице
content:
application/json:
schema:
$ref: '#/components/schemas/Table'
patch:
tags:
- Tables
summary: Обновить таблицу
operationId: tableUpdate
parameters:
- name: tableId
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
title:
type: string
table_name:
type: string
meta:
type: object
responses:
'200':
description: Таблица обновлена
content:
application/json:
schema:
$ref: '#/components/schemas/Table'
# ==================== COLUMNS ====================
/api/v2/meta/tables/{tableId}/columns:
post:
tags:
- Columns
summary: Добавить колонку
operationId: columnAdd
parameters:
- name: tableId
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- column_name
- title
- uidt
properties:
column_name:
type: string
title:
type: string
uidt:
type: string
description: UI Data Type
dt:
type: string
description: Database Type
pk:
type: boolean
rqd:
type: boolean
un:
type: boolean
ai:
type: boolean
responses:
'200':
description: Колонка добавлена
content:
application/json:
schema:
$ref: '#/components/schemas/Column'
/api/v2/meta/columns/{columnId}:
get:
tags:
- Columns
summary: Получить информацию о колонке
operationId: columnGet
parameters:
- name: columnId
in: path
required: true
schema:
type: string
responses:
'200':
description: Информация о колонке
content:
application/json:
schema:
$ref: '#/components/schemas/Column'
patch:
tags:
- Columns
summary: Обновить колонку
operationId: columnUpdate
parameters:
- name: columnId
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
title:
type: string
column_name:
type: string
uidt:
type: string
responses:
'200':
description: Колонка обновлена
content:
application/json:
schema:
$ref: '#/components/schemas/Column'
delete:
tags:
- Columns
summary: Удалить колонку
operationId: columnDelete
parameters:
- name: columnId
in: path
required: true
schema:
type: string
responses:
'200':
description: Колонка удалена
content:
application/json:
schema:
type: object
properties:
msg:
type: string
/api/v2/meta/columns/{columnId}/primary:
post:
tags:
- Columns
summary: Установить колонку как первичную
operationId: columnSetAsPrimary
parameters:
- name: columnId
in: path
required: true
schema:
type: string
responses:
'200':
description: Колонка установлена как первичная
content:
application/json:
schema:
type: object
properties:
msg:
type: string
# ==================== DATA ====================
/data/{viewId}:
get:
tags:
- Data
summary: Получить список данных по представлению
operationId: dataList
parameters:
- name: viewId
in: path
required: true
schema:
type: string
- name: limit
in: query
schema:
type: integer
- name: offset
in: query
schema:
type: integer
- name: where
in: query
schema:
type: string
- name: sort
in: query
schema:
type: string
responses:
'200':
description: Список данных
content:
application/json:
schema:
$ref: '#/components/schemas/PagedResponse'
/data/{viewId}/{rowId}/mm/{colId}:
get:
tags:
- Data
summary: Получить связанные данные many-to-many
operationId: mmList
parameters:
- name: viewId
in: path
required: true
schema:
type: string
- name: rowId
in: path
required: true
schema: