@epilot/entity-client 6.4.1 → 6.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,1554 @@
1
+ {
2
+ "openapi": "3.0.2",
3
+ "info": {
4
+ "title": "",
5
+ "version": ""
6
+ },
7
+ "paths": {
8
+ "/v1/entity/schemas": {
9
+ "get": {
10
+ "operationId": "listSchemas",
11
+ "parameters": [
12
+ {
13
+ "in": "query",
14
+ "name": "unpublished"
15
+ }
16
+ ],
17
+ "responses": {}
18
+ }
19
+ },
20
+ "/v1/entity/schemas/{slug}": {
21
+ "get": {
22
+ "operationId": "getSchema",
23
+ "parameters": [
24
+ {
25
+ "$ref": "#/components/parameters/EntitySlugPathParam"
26
+ },
27
+ {
28
+ "in": "query",
29
+ "name": "id"
30
+ }
31
+ ],
32
+ "responses": {}
33
+ },
34
+ "put": {
35
+ "operationId": "putSchema",
36
+ "parameters": [
37
+ {
38
+ "$ref": "#/components/parameters/EntitySlugPathParam"
39
+ },
40
+ {
41
+ "in": "query",
42
+ "name": "draft"
43
+ }
44
+ ],
45
+ "requestBody": {
46
+ "content": {
47
+ "application/json": {}
48
+ }
49
+ },
50
+ "responses": {}
51
+ },
52
+ "delete": {
53
+ "operationId": "deleteSchema",
54
+ "parameters": [
55
+ {
56
+ "$ref": "#/components/parameters/EntitySlugPathParam"
57
+ }
58
+ ],
59
+ "responses": {}
60
+ }
61
+ },
62
+ "/v1/entity/schemas/{slug}/json/schema": {
63
+ "get": {
64
+ "operationId": "getJsonSchema",
65
+ "parameters": [
66
+ {
67
+ "$ref": "#/components/parameters/EntitySlugPathParam"
68
+ },
69
+ {
70
+ "in": "query",
71
+ "name": "dereference"
72
+ }
73
+ ],
74
+ "responses": {}
75
+ }
76
+ },
77
+ "/v1/entity/schemas/{slug}/json/example": {
78
+ "get": {
79
+ "operationId": "getSchemaExample",
80
+ "parameters": [
81
+ {
82
+ "$ref": "#/components/parameters/EntitySlugPathParam"
83
+ }
84
+ ],
85
+ "responses": {}
86
+ }
87
+ },
88
+ "/v1/entity/schemas/{slug}/versions": {
89
+ "get": {
90
+ "operationId": "getSchemaVersions",
91
+ "parameters": [
92
+ {
93
+ "$ref": "#/components/parameters/EntitySlugPathParam"
94
+ },
95
+ {
96
+ "in": "query",
97
+ "name": "versions_from"
98
+ },
99
+ {
100
+ "in": "query",
101
+ "name": "versions_size"
102
+ },
103
+ {
104
+ "in": "query",
105
+ "name": "drafts_from"
106
+ },
107
+ {
108
+ "in": "query",
109
+ "name": "drafts_size"
110
+ },
111
+ {
112
+ "in": "query",
113
+ "name": "fields",
114
+ "required": false,
115
+ "style": "form",
116
+ "explode": false
117
+ }
118
+ ],
119
+ "responses": {}
120
+ }
121
+ },
122
+ "/v1/entity/schemas/{slug}/capabilities/available": {
123
+ "get": {
124
+ "operationId": "listAvailableCapabilities",
125
+ "parameters": [
126
+ {
127
+ "$ref": "#/components/parameters/EntitySlugPathParam"
128
+ }
129
+ ],
130
+ "responses": {}
131
+ }
132
+ },
133
+ "/v1/entity/schemas/blueprints": {
134
+ "get": {
135
+ "operationId": "listSchemaBlueprints",
136
+ "responses": {}
137
+ }
138
+ },
139
+ "/v1/entity:search": {
140
+ "post": {
141
+ "operationId": "searchEntities",
142
+ "requestBody": {
143
+ "content": {
144
+ "application/json": {}
145
+ }
146
+ },
147
+ "responses": {}
148
+ }
149
+ },
150
+ "/v1/entity:list": {
151
+ "post": {
152
+ "operationId": "listEntities",
153
+ "requestBody": {
154
+ "content": {
155
+ "application/json": {}
156
+ }
157
+ },
158
+ "responses": {}
159
+ }
160
+ },
161
+ "/v1/entity/{slug}": {
162
+ "post": {
163
+ "operationId": "createEntity",
164
+ "parameters": [
165
+ {
166
+ "$ref": "#/components/parameters/EntitySlugPathParam"
167
+ },
168
+ {
169
+ "$ref": "#/components/parameters/ActivityIdQueryParam"
170
+ },
171
+ {
172
+ "$ref": "#/components/parameters/FillActivityQueryParam"
173
+ },
174
+ {
175
+ "$ref": "#/components/parameters/AsyncOperationQueryParam"
176
+ },
177
+ {
178
+ "$ref": "#/components/parameters/ValidateEntityQueryParam"
179
+ }
180
+ ],
181
+ "requestBody": {
182
+ "content": {
183
+ "application/json": {}
184
+ }
185
+ },
186
+ "responses": {}
187
+ }
188
+ },
189
+ "/v1/entity/{slug}:validate": {
190
+ "post": {
191
+ "operationId": "validateEntity",
192
+ "parameters": [
193
+ {
194
+ "$ref": "#/components/parameters/EntitySlugPathPriceParam"
195
+ }
196
+ ],
197
+ "requestBody": {
198
+ "content": {
199
+ "application/json": {}
200
+ }
201
+ },
202
+ "responses": {}
203
+ }
204
+ },
205
+ "/v2/entity/{slug}:validate": {
206
+ "post": {
207
+ "operationId": "validateEntityV2",
208
+ "parameters": [
209
+ {
210
+ "$ref": "#/components/parameters/EntitySlugPathPriceParam"
211
+ }
212
+ ],
213
+ "requestBody": {
214
+ "content": {
215
+ "application/json": {}
216
+ }
217
+ },
218
+ "responses": {}
219
+ }
220
+ },
221
+ "/v1/entity/{slug}:upsert": {
222
+ "patch": {
223
+ "operationId": "upsertEntity",
224
+ "parameters": [
225
+ {
226
+ "$ref": "#/components/parameters/EntitySlugPathParam"
227
+ },
228
+ {
229
+ "$ref": "#/components/parameters/ActivityIdQueryParam"
230
+ },
231
+ {
232
+ "$ref": "#/components/parameters/FillActivityQueryParam"
233
+ },
234
+ {
235
+ "$ref": "#/components/parameters/DryRunQueryParam"
236
+ },
237
+ {
238
+ "$ref": "#/components/parameters/AsyncOperationQueryParam"
239
+ },
240
+ {
241
+ "$ref": "#/components/parameters/ValidateEntityQueryParam"
242
+ },
243
+ {
244
+ "name": "strict",
245
+ "in": "query",
246
+ "required": false
247
+ }
248
+ ],
249
+ "requestBody": {
250
+ "content": {
251
+ "application/json": {}
252
+ }
253
+ },
254
+ "responses": {}
255
+ }
256
+ },
257
+ "/v2/entity/{slug}/{id}": {
258
+ "get": {
259
+ "operationId": "getEntityV2",
260
+ "parameters": [
261
+ {
262
+ "$ref": "#/components/parameters/EntityIdPathParam"
263
+ },
264
+ {
265
+ "$ref": "#/components/parameters/EntitySlugPathParam"
266
+ },
267
+ {
268
+ "$ref": "#/components/parameters/HydrateEntitiesQueryParam"
269
+ },
270
+ {
271
+ "in": "query",
272
+ "name": "fields",
273
+ "style": "form",
274
+ "explode": false
275
+ }
276
+ ],
277
+ "responses": {}
278
+ }
279
+ },
280
+ "/v1/entity/{slug}/{id}:restore": {
281
+ "patch": {
282
+ "operationId": "restoreEntity",
283
+ "parameters": [
284
+ {
285
+ "$ref": "#/components/parameters/EntityIdPathParam"
286
+ },
287
+ {
288
+ "$ref": "#/components/parameters/EntitySlugPathParam"
289
+ },
290
+ {
291
+ "$ref": "#/components/parameters/ActivityIdQueryParam"
292
+ }
293
+ ],
294
+ "requestBody": {
295
+ "content": {
296
+ "application/json": {}
297
+ }
298
+ },
299
+ "responses": {}
300
+ }
301
+ },
302
+ "/v1/entity/{slug}/{id}:reindex": {
303
+ "post": {
304
+ "operationId": "reindexEntity",
305
+ "parameters": [
306
+ {
307
+ "$ref": "#/components/parameters/EntityIdPathParam"
308
+ },
309
+ {
310
+ "$ref": "#/components/parameters/EntitySlugPathParam"
311
+ }
312
+ ],
313
+ "requestBody": {
314
+ "content": {
315
+ "application/json": {}
316
+ }
317
+ },
318
+ "responses": {}
319
+ }
320
+ },
321
+ "/v1/entity/{slug}/{id}": {
322
+ "get": {
323
+ "operationId": "getEntity",
324
+ "parameters": [
325
+ {
326
+ "$ref": "#/components/parameters/EntityIdPathParam"
327
+ },
328
+ {
329
+ "$ref": "#/components/parameters/EntitySlugPathParam"
330
+ },
331
+ {
332
+ "$ref": "#/components/parameters/HydrateEntitiesQueryParam"
333
+ }
334
+ ],
335
+ "responses": {}
336
+ },
337
+ "put": {
338
+ "operationId": "updateEntity",
339
+ "parameters": [
340
+ {
341
+ "$ref": "#/components/parameters/EntitySlugPathParam"
342
+ },
343
+ {
344
+ "$ref": "#/components/parameters/EntityIdPathParam"
345
+ },
346
+ {
347
+ "$ref": "#/components/parameters/ActivityIdQueryParam"
348
+ },
349
+ {
350
+ "$ref": "#/components/parameters/FillActivityQueryParam"
351
+ },
352
+ {
353
+ "$ref": "#/components/parameters/AsyncOperationQueryParam"
354
+ },
355
+ {
356
+ "$ref": "#/components/parameters/ValidateEntityQueryParam"
357
+ }
358
+ ],
359
+ "requestBody": {
360
+ "content": {
361
+ "application/json": {}
362
+ }
363
+ },
364
+ "responses": {}
365
+ },
366
+ "patch": {
367
+ "operationId": "patchEntity",
368
+ "parameters": [
369
+ {
370
+ "$ref": "#/components/parameters/EntitySlugPathParam"
371
+ },
372
+ {
373
+ "$ref": "#/components/parameters/EntityIdPathParam"
374
+ },
375
+ {
376
+ "$ref": "#/components/parameters/ActivityIdQueryParam"
377
+ },
378
+ {
379
+ "$ref": "#/components/parameters/FillActivityQueryParam"
380
+ },
381
+ {
382
+ "$ref": "#/components/parameters/DryRunQueryParam"
383
+ },
384
+ {
385
+ "$ref": "#/components/parameters/AsyncOperationQueryParam"
386
+ },
387
+ {
388
+ "$ref": "#/components/parameters/ValidateEntityQueryParam"
389
+ }
390
+ ],
391
+ "requestBody": {
392
+ "content": {
393
+ "application/json": {}
394
+ },
395
+ "required": true
396
+ },
397
+ "responses": {}
398
+ },
399
+ "delete": {
400
+ "operationId": "deleteEntity",
401
+ "parameters": [
402
+ {
403
+ "$ref": "#/components/parameters/EntitySlugPathParam"
404
+ },
405
+ {
406
+ "$ref": "#/components/parameters/EntityIdPathParam"
407
+ },
408
+ {
409
+ "$ref": "#/components/parameters/ActivityIdQueryParam"
410
+ },
411
+ {
412
+ "in": "query",
413
+ "name": "purge"
414
+ }
415
+ ],
416
+ "responses": {}
417
+ }
418
+ },
419
+ "/v1/entity:autocomplete": {
420
+ "get": {
421
+ "operationId": "autocomplete",
422
+ "parameters": [
423
+ {
424
+ "name": "input",
425
+ "in": "query"
426
+ },
427
+ {
428
+ "name": "attribute",
429
+ "in": "query",
430
+ "required": true
431
+ },
432
+ {
433
+ "name": "slug",
434
+ "in": "query"
435
+ },
436
+ {
437
+ "name": "size",
438
+ "in": "query"
439
+ }
440
+ ],
441
+ "responses": {}
442
+ }
443
+ },
444
+ "/v1/entity:wipeAllEntities": {
445
+ "post": {
446
+ "operationId": "wipeAllEntities",
447
+ "requestBody": {
448
+ "content": {
449
+ "application/json": {}
450
+ }
451
+ },
452
+ "responses": {}
453
+ }
454
+ },
455
+ "/v1/entity/activity": {
456
+ "post": {
457
+ "operationId": "createActivity",
458
+ "parameters": [
459
+ {
460
+ "in": "query",
461
+ "name": "entities",
462
+ "style": "form",
463
+ "explode": false
464
+ }
465
+ ],
466
+ "requestBody": {
467
+ "content": {
468
+ "application/json": {}
469
+ }
470
+ },
471
+ "responses": {}
472
+ }
473
+ },
474
+ "/v1/entity/activity/{id}": {
475
+ "get": {
476
+ "operationId": "getActivity",
477
+ "parameters": [
478
+ {
479
+ "$ref": "#/components/parameters/ActivityIdPathParam"
480
+ },
481
+ {
482
+ "in": "query",
483
+ "name": "operations_size"
484
+ },
485
+ {
486
+ "in": "query",
487
+ "name": "operations_from"
488
+ }
489
+ ],
490
+ "responses": {}
491
+ }
492
+ },
493
+ "/v1/entity/activity/{id}:attach": {
494
+ "post": {
495
+ "operationId": "attachActivity",
496
+ "parameters": [
497
+ {
498
+ "$ref": "#/components/parameters/ActivityIdPathParam"
499
+ },
500
+ {
501
+ "in": "query",
502
+ "name": "entities",
503
+ "style": "form",
504
+ "explode": false
505
+ }
506
+ ],
507
+ "responses": {}
508
+ }
509
+ },
510
+ "/v1/entity/{slug}/{id}/activity": {
511
+ "get": {
512
+ "operationId": "getEntityActivityFeed",
513
+ "parameters": [
514
+ {
515
+ "$ref": "#/components/parameters/EntitySlugPathParam"
516
+ },
517
+ {
518
+ "$ref": "#/components/parameters/EntityIdPathParam"
519
+ },
520
+ {
521
+ "in": "query",
522
+ "name": "after"
523
+ },
524
+ {
525
+ "in": "query",
526
+ "name": "before"
527
+ },
528
+ {
529
+ "in": "query",
530
+ "name": "start_date"
531
+ },
532
+ {
533
+ "in": "query",
534
+ "name": "end_date"
535
+ },
536
+ {
537
+ "in": "query",
538
+ "name": "preset_range"
539
+ },
540
+ {
541
+ "$ref": "#/components/parameters/FromPageQueryParam"
542
+ },
543
+ {
544
+ "in": "query",
545
+ "name": "size"
546
+ },
547
+ {
548
+ "in": "query",
549
+ "name": "type"
550
+ },
551
+ {
552
+ "in": "query",
553
+ "name": "include_relations"
554
+ },
555
+ {
556
+ "in": "query",
557
+ "name": "exclude_activity_groups"
558
+ }
559
+ ],
560
+ "responses": {}
561
+ }
562
+ },
563
+ "/v1/entity/{slug}/{id}/relations": {
564
+ "get": {
565
+ "operationId": "getRelations",
566
+ "parameters": [
567
+ {
568
+ "$ref": "#/components/parameters/EntitySlugPathParam"
569
+ },
570
+ {
571
+ "$ref": "#/components/parameters/EntityIdPathParam"
572
+ },
573
+ {
574
+ "$ref": "#/components/parameters/HydrateEntitiesQueryParam"
575
+ },
576
+ {
577
+ "$ref": "#/components/parameters/IncludeReverseQueryParam"
578
+ },
579
+ {
580
+ "$ref": "#/components/parameters/FromPageQueryParam"
581
+ },
582
+ {
583
+ "in": "query",
584
+ "name": "size",
585
+ "required": false
586
+ },
587
+ {
588
+ "$ref": "#/components/parameters/IncludeSchemasQueryParam"
589
+ },
590
+ {
591
+ "$ref": "#/components/parameters/ExcludeSchemasQueryParam"
592
+ }
593
+ ],
594
+ "responses": {}
595
+ },
596
+ "post": {
597
+ "operationId": "addRelations",
598
+ "parameters": [
599
+ {
600
+ "$ref": "#/components/parameters/EntitySlugPathParam"
601
+ },
602
+ {
603
+ "$ref": "#/components/parameters/EntityIdPathParam"
604
+ },
605
+ {
606
+ "$ref": "#/components/parameters/AsyncOperationQueryParam"
607
+ },
608
+ {
609
+ "$ref": "#/components/parameters/ActivityIdQueryParam"
610
+ }
611
+ ],
612
+ "requestBody": {
613
+ "content": {
614
+ "application/json": {}
615
+ }
616
+ },
617
+ "responses": {}
618
+ },
619
+ "delete": {
620
+ "operationId": "removeRelations",
621
+ "parameters": [
622
+ {
623
+ "$ref": "#/components/parameters/EntitySlugPathParam"
624
+ },
625
+ {
626
+ "$ref": "#/components/parameters/EntityIdPathParam"
627
+ },
628
+ {
629
+ "$ref": "#/components/parameters/AsyncOperationQueryParam"
630
+ },
631
+ {
632
+ "$ref": "#/components/parameters/ActivityIdQueryParam"
633
+ }
634
+ ],
635
+ "requestBody": {
636
+ "content": {
637
+ "application/json": {}
638
+ }
639
+ },
640
+ "responses": {}
641
+ }
642
+ },
643
+ "/v2/entity/{slug}/{id}/relations": {
644
+ "get": {
645
+ "operationId": "getRelationsV2",
646
+ "parameters": [
647
+ {
648
+ "$ref": "#/components/parameters/EntitySlugPathParam"
649
+ },
650
+ {
651
+ "$ref": "#/components/parameters/EntityIdPathParam"
652
+ },
653
+ {
654
+ "$ref": "#/components/parameters/HydrateEntitiesQueryParam"
655
+ },
656
+ {
657
+ "in": "query",
658
+ "name": "query"
659
+ },
660
+ {
661
+ "$ref": "#/components/parameters/IncludeReverseQueryParam"
662
+ },
663
+ {
664
+ "$ref": "#/components/parameters/FromPageQueryParam"
665
+ },
666
+ {
667
+ "in": "query",
668
+ "name": "size"
669
+ },
670
+ {
671
+ "in": "query",
672
+ "name": "fields"
673
+ }
674
+ ],
675
+ "responses": {}
676
+ }
677
+ },
678
+ "/v3/entity/{slug}/{id}/relations": {
679
+ "get": {
680
+ "operationId": "getRelationsV3",
681
+ "parameters": [
682
+ {
683
+ "$ref": "#/components/parameters/EntitySlugPathParam"
684
+ },
685
+ {
686
+ "$ref": "#/components/parameters/EntityIdPathParam"
687
+ },
688
+ {
689
+ "$ref": "#/components/parameters/HydrateEntitiesQueryParam"
690
+ },
691
+ {
692
+ "$ref": "#/components/parameters/IncludeReverseDeprecatedQueryParam"
693
+ },
694
+ {
695
+ "$ref": "#/components/parameters/FromPageQueryParam"
696
+ },
697
+ {
698
+ "in": "query",
699
+ "name": "size",
700
+ "required": false
701
+ },
702
+ {
703
+ "$ref": "#/components/parameters/IncludeSchemasQueryParam"
704
+ },
705
+ {
706
+ "$ref": "#/components/parameters/ExcludeSchemasQueryParam"
707
+ },
708
+ {
709
+ "$ref": "#/components/parameters/EntityRelationsModeQueryParam"
710
+ },
711
+ {
712
+ "in": "query",
713
+ "name": "fields"
714
+ }
715
+ ],
716
+ "responses": {}
717
+ }
718
+ },
719
+ "/v2/entity/{slug}/{id}/relations/count": {
720
+ "get": {
721
+ "operationId": "getRelatedEntitiesCount",
722
+ "parameters": [
723
+ {
724
+ "$ref": "#/components/parameters/EntitySlugPathParam"
725
+ },
726
+ {
727
+ "$ref": "#/components/parameters/EntityIdPathParam"
728
+ },
729
+ {
730
+ "$ref": "#/components/parameters/ExcludeSchemasQueryParam"
731
+ }
732
+ ],
733
+ "responses": {}
734
+ }
735
+ },
736
+ "/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}": {
737
+ "put": {
738
+ "operationId": "updateRelation",
739
+ "parameters": [
740
+ {
741
+ "$ref": "#/components/parameters/EntitySlugPathParam"
742
+ },
743
+ {
744
+ "$ref": "#/components/parameters/EntityIdPathParam"
745
+ },
746
+ {
747
+ "in": "path",
748
+ "name": "attribute",
749
+ "required": true
750
+ },
751
+ {
752
+ "in": "path",
753
+ "name": "entity_id",
754
+ "required": true
755
+ },
756
+ {
757
+ "$ref": "#/components/parameters/AsyncOperationQueryParam"
758
+ },
759
+ {
760
+ "$ref": "#/components/parameters/ActivityIdQueryParam"
761
+ }
762
+ ],
763
+ "requestBody": {
764
+ "content": {
765
+ "application/json": {}
766
+ }
767
+ },
768
+ "responses": {}
769
+ },
770
+ "delete": {
771
+ "operationId": "deleteRelation",
772
+ "parameters": [
773
+ {
774
+ "$ref": "#/components/parameters/EntitySlugPathParam"
775
+ },
776
+ {
777
+ "$ref": "#/components/parameters/EntityIdPathParam"
778
+ },
779
+ {
780
+ "in": "path",
781
+ "name": "attribute",
782
+ "required": true
783
+ },
784
+ {
785
+ "in": "path",
786
+ "name": "entity_id",
787
+ "required": true
788
+ },
789
+ {
790
+ "$ref": "#/components/parameters/AsyncOperationQueryParam"
791
+ },
792
+ {
793
+ "$ref": "#/components/parameters/ActivityIdQueryParam"
794
+ }
795
+ ],
796
+ "responses": {}
797
+ }
798
+ },
799
+ "/v1/entity:export": {
800
+ "post": {
801
+ "operationId": "exportEntities",
802
+ "parameters": [
803
+ {
804
+ "in": "query",
805
+ "name": "job_id"
806
+ },
807
+ {
808
+ "in": "query",
809
+ "name": "is_template"
810
+ },
811
+ {
812
+ "in": "query",
813
+ "name": "language"
814
+ }
815
+ ],
816
+ "requestBody": {
817
+ "content": {
818
+ "application/json": {}
819
+ }
820
+ },
821
+ "responses": {}
822
+ }
823
+ },
824
+ "/v1/entity:import": {
825
+ "post": {
826
+ "operationId": "importEntities",
827
+ "parameters": [
828
+ {
829
+ "in": "query",
830
+ "name": "job_id"
831
+ }
832
+ ],
833
+ "requestBody": {
834
+ "content": {
835
+ "application/json": {}
836
+ }
837
+ },
838
+ "responses": {}
839
+ }
840
+ },
841
+ "/v1/entity/views": {
842
+ "get": {
843
+ "operationId": "listSavedViews",
844
+ "parameters": [
845
+ {
846
+ "in": "query",
847
+ "name": "slug",
848
+ "required": false
849
+ },
850
+ {
851
+ "in": "query",
852
+ "name": "sort",
853
+ "required": false
854
+ },
855
+ {
856
+ "in": "query",
857
+ "name": "from",
858
+ "required": false
859
+ },
860
+ {
861
+ "in": "query",
862
+ "name": "size",
863
+ "required": false
864
+ },
865
+ {
866
+ "in": "query",
867
+ "name": "fields",
868
+ "required": false
869
+ }
870
+ ],
871
+ "responses": {}
872
+ }
873
+ },
874
+ "/v1/entity/view": {
875
+ "post": {
876
+ "operationId": "createSavedView",
877
+ "requestBody": {
878
+ "content": {
879
+ "application/json": {}
880
+ }
881
+ },
882
+ "responses": {}
883
+ }
884
+ },
885
+ "/v1/entity/view/{id}": {
886
+ "get": {
887
+ "operationId": "getSavedView",
888
+ "parameters": [
889
+ {
890
+ "$ref": "#/components/parameters/SavedViewIdPathParam"
891
+ }
892
+ ],
893
+ "responses": {}
894
+ },
895
+ "put": {
896
+ "operationId": "updateSavedView",
897
+ "parameters": [
898
+ {
899
+ "$ref": "#/components/parameters/SavedViewIdPathParam"
900
+ }
901
+ ],
902
+ "requestBody": {
903
+ "content": {
904
+ "application/json": {}
905
+ }
906
+ },
907
+ "responses": {}
908
+ },
909
+ "patch": {
910
+ "operationId": "patchSavedView",
911
+ "parameters": [
912
+ {
913
+ "$ref": "#/components/parameters/SavedViewIdPathParam"
914
+ }
915
+ ],
916
+ "requestBody": {
917
+ "content": {
918
+ "application/json": {}
919
+ }
920
+ },
921
+ "responses": {}
922
+ },
923
+ "delete": {
924
+ "operationId": "deleteSavedView",
925
+ "parameters": [
926
+ {
927
+ "$ref": "#/components/parameters/SavedViewIdPathParam"
928
+ }
929
+ ],
930
+ "responses": {}
931
+ }
932
+ },
933
+ "/v1/entity/views/favorites": {
934
+ "get": {
935
+ "operationId": "listFavoriteViewsForUser",
936
+ "responses": {}
937
+ }
938
+ },
939
+ "/v1/entity/taxonomies": {
940
+ "get": {
941
+ "operationId": "listTaxonomies",
942
+ "parameters": [
943
+ {
944
+ "in": "query",
945
+ "name": "include_disabled"
946
+ },
947
+ {
948
+ "in": "query",
949
+ "name": "type"
950
+ }
951
+ ],
952
+ "responses": {}
953
+ },
954
+ "post": {
955
+ "operationId": "createTaxonomy",
956
+ "requestBody": {
957
+ "content": {
958
+ "application/json": {}
959
+ }
960
+ },
961
+ "responses": {}
962
+ }
963
+ },
964
+ "/v1/entity/taxonomies/{taxonomySlug}": {
965
+ "get": {
966
+ "operationId": "getTaxonomy",
967
+ "parameters": [
968
+ {
969
+ "$ref": "#/components/parameters/TaxonomySlugPathParam"
970
+ }
971
+ ],
972
+ "responses": {}
973
+ },
974
+ "put": {
975
+ "operationId": "updateTaxonomy",
976
+ "parameters": [
977
+ {
978
+ "$ref": "#/components/parameters/TaxonomySlugPathParam"
979
+ }
980
+ ],
981
+ "requestBody": {
982
+ "content": {
983
+ "application/json": {}
984
+ }
985
+ },
986
+ "responses": {}
987
+ },
988
+ "delete": {
989
+ "operationId": "deleteTaxonomy",
990
+ "parameters": [
991
+ {
992
+ "$ref": "#/components/parameters/TaxonomySlugPathParam"
993
+ },
994
+ {
995
+ "in": "query",
996
+ "name": "permanent"
997
+ }
998
+ ],
999
+ "responses": {}
1000
+ }
1001
+ },
1002
+ "/v1/entity/taxonomies/{taxonomySlug}/classifications": {
1003
+ "post": {
1004
+ "operationId": "updateClassificationsForTaxonomy",
1005
+ "parameters": [
1006
+ {
1007
+ "$ref": "#/components/parameters/TaxonomySlugPathParam"
1008
+ }
1009
+ ],
1010
+ "requestBody": {
1011
+ "content": {
1012
+ "application/json": {}
1013
+ }
1014
+ },
1015
+ "responses": {}
1016
+ }
1017
+ },
1018
+ "/v2/entity/taxonomies/classifications": {
1019
+ "post": {
1020
+ "operationId": "createTaxonomyClassification",
1021
+ "requestBody": {
1022
+ "content": {
1023
+ "application/json": {}
1024
+ }
1025
+ },
1026
+ "responses": {}
1027
+ }
1028
+ },
1029
+ "/v2/entity/taxonomies/classifications/{classificationSlug}": {
1030
+ "get": {
1031
+ "operationId": "getTaxonomyClassification",
1032
+ "parameters": [
1033
+ {
1034
+ "$ref": "#/components/parameters/TaxonomyClassificationSlugPathParam"
1035
+ }
1036
+ ],
1037
+ "responses": {}
1038
+ },
1039
+ "put": {
1040
+ "operationId": "updateTaxonomyClassification",
1041
+ "parameters": [
1042
+ {
1043
+ "$ref": "#/components/parameters/TaxonomyClassificationSlugPathParam"
1044
+ }
1045
+ ],
1046
+ "requestBody": {
1047
+ "content": {
1048
+ "application/json": {}
1049
+ }
1050
+ },
1051
+ "responses": {}
1052
+ },
1053
+ "delete": {
1054
+ "operationId": "deleteTaxonomyClassification",
1055
+ "parameters": [
1056
+ {
1057
+ "$ref": "#/components/parameters/TaxonomyClassificationSlugPathParam"
1058
+ }
1059
+ ],
1060
+ "responses": {}
1061
+ }
1062
+ },
1063
+ "/v1/entity/taxonomies/{taxonomySlug}:autocomplete": {
1064
+ "get": {
1065
+ "operationId": "taxonomyAutocomplete",
1066
+ "parameters": [
1067
+ {
1068
+ "$ref": "#/components/parameters/TaxonomySlugPathParam"
1069
+ },
1070
+ {
1071
+ "in": "query",
1072
+ "name": "query"
1073
+ },
1074
+ {
1075
+ "in": "query",
1076
+ "name": "size"
1077
+ }
1078
+ ],
1079
+ "responses": {}
1080
+ }
1081
+ },
1082
+ "/v1/entity/taxonomies/classifications:search": {
1083
+ "post": {
1084
+ "operationId": "taxonomiesClassificationsSearch",
1085
+ "parameters": [
1086
+ {
1087
+ "in": "query",
1088
+ "name": "taxonomySlug"
1089
+ },
1090
+ {
1091
+ "in": "query",
1092
+ "name": "query"
1093
+ },
1094
+ {
1095
+ "in": "query",
1096
+ "name": "archived",
1097
+ "deprecated": true
1098
+ },
1099
+ {
1100
+ "in": "query",
1101
+ "name": "include_archived"
1102
+ }
1103
+ ],
1104
+ "requestBody": {
1105
+ "content": {
1106
+ "application/json": {}
1107
+ }
1108
+ },
1109
+ "responses": {}
1110
+ }
1111
+ },
1112
+ "/v1/entity/schemas/{slug}/taxonomy/{taxonomySlug}": {
1113
+ "get": {
1114
+ "operationId": "listTaxonomyClassificationsForSchema",
1115
+ "parameters": [
1116
+ {
1117
+ "$ref": "#/components/parameters/EntitySlugPathParam"
1118
+ },
1119
+ {
1120
+ "$ref": "#/components/parameters/TaxonomySlugPathParam"
1121
+ },
1122
+ {
1123
+ "in": "query",
1124
+ "name": "query"
1125
+ },
1126
+ {
1127
+ "in": "query",
1128
+ "name": "size"
1129
+ }
1130
+ ],
1131
+ "responses": {}
1132
+ }
1133
+ },
1134
+ "/v1/entity/taxonomies/bulk-jobs": {
1135
+ "get": {
1136
+ "operationId": "getTaxonomyBulkActionJobs",
1137
+ "parameters": [
1138
+ {
1139
+ "in": "query",
1140
+ "name": "status"
1141
+ },
1142
+ {
1143
+ "in": "query",
1144
+ "name": "size"
1145
+ },
1146
+ {
1147
+ "in": "query",
1148
+ "name": "created_after"
1149
+ },
1150
+ {
1151
+ "in": "query",
1152
+ "name": "sort_pending_first"
1153
+ },
1154
+ {
1155
+ "in": "query",
1156
+ "name": "scope"
1157
+ }
1158
+ ],
1159
+ "responses": {}
1160
+ }
1161
+ },
1162
+ "/v1/entity/taxonomies/bulk-jobs/{job_id}": {
1163
+ "get": {
1164
+ "operationId": "getTaxonomyBulkActionJobById",
1165
+ "parameters": [
1166
+ {
1167
+ "in": "path",
1168
+ "name": "job_id",
1169
+ "required": true
1170
+ }
1171
+ ],
1172
+ "responses": {}
1173
+ }
1174
+ },
1175
+ "/v1/entity/taxonomies/bulk-jobs/{job_id}/cancel": {
1176
+ "post": {
1177
+ "operationId": "cancelBulkAction",
1178
+ "parameters": [
1179
+ {
1180
+ "name": "job_id",
1181
+ "in": "path",
1182
+ "required": true
1183
+ }
1184
+ ],
1185
+ "responses": {}
1186
+ }
1187
+ },
1188
+ "/v1/entity/taxonomies/classifications:move": {
1189
+ "post": {
1190
+ "operationId": "bulkMoveClassifications",
1191
+ "requestBody": {
1192
+ "content": {
1193
+ "application/json": {}
1194
+ }
1195
+ },
1196
+ "responses": {}
1197
+ }
1198
+ },
1199
+ "/v1/entity/taxonomies/classifications:merge": {
1200
+ "post": {
1201
+ "operationId": "bulkMergeClassifications",
1202
+ "requestBody": {
1203
+ "content": {
1204
+ "application/json": {}
1205
+ }
1206
+ },
1207
+ "responses": {}
1208
+ }
1209
+ },
1210
+ "/v1/entity/taxonomies/classifications:delete": {
1211
+ "post": {
1212
+ "operationId": "bulkDeleteClassifications",
1213
+ "requestBody": {
1214
+ "content": {
1215
+ "application/json": {}
1216
+ }
1217
+ },
1218
+ "responses": {}
1219
+ }
1220
+ },
1221
+ "/v1/entity/schemas/attributes": {
1222
+ "post": {
1223
+ "operationId": "createSchemaAttribute",
1224
+ "requestBody": {
1225
+ "content": {
1226
+ "application/json": {}
1227
+ }
1228
+ },
1229
+ "responses": {}
1230
+ }
1231
+ },
1232
+ "/v1/entity/schemas/attributes/{composite_id}": {
1233
+ "get": {
1234
+ "operationId": "getSchemaAttribute",
1235
+ "parameters": [
1236
+ {
1237
+ "name": "composite_id",
1238
+ "in": "path",
1239
+ "required": true
1240
+ }
1241
+ ],
1242
+ "responses": {}
1243
+ },
1244
+ "put": {
1245
+ "operationId": "putSchemaAttribute",
1246
+ "parameters": [
1247
+ {
1248
+ "name": "composite_id",
1249
+ "in": "path",
1250
+ "required": true
1251
+ }
1252
+ ],
1253
+ "requestBody": {
1254
+ "content": {
1255
+ "application/json": {}
1256
+ }
1257
+ },
1258
+ "responses": {}
1259
+ },
1260
+ "delete": {
1261
+ "operationId": "deleteSchemaAttribute",
1262
+ "parameters": [
1263
+ {
1264
+ "name": "composite_id",
1265
+ "in": "path",
1266
+ "required": true
1267
+ }
1268
+ ],
1269
+ "responses": {}
1270
+ }
1271
+ },
1272
+ "/v1/entity/schemas/capabilities": {
1273
+ "post": {
1274
+ "operationId": "createSchemaCapability",
1275
+ "requestBody": {
1276
+ "content": {
1277
+ "application/json": {}
1278
+ }
1279
+ },
1280
+ "responses": {}
1281
+ }
1282
+ },
1283
+ "/v1/entity/schemas/capabilities/{composite_id}": {
1284
+ "get": {
1285
+ "operationId": "getSchemaCapability",
1286
+ "parameters": [
1287
+ {
1288
+ "name": "composite_id",
1289
+ "in": "path",
1290
+ "required": true
1291
+ }
1292
+ ],
1293
+ "responses": {}
1294
+ },
1295
+ "put": {
1296
+ "operationId": "putSchemaCapability",
1297
+ "parameters": [
1298
+ {
1299
+ "name": "composite_id",
1300
+ "in": "path",
1301
+ "required": true
1302
+ }
1303
+ ],
1304
+ "requestBody": {
1305
+ "content": {
1306
+ "application/json": {}
1307
+ }
1308
+ },
1309
+ "responses": {}
1310
+ },
1311
+ "delete": {
1312
+ "operationId": "deleteSchemaCapability",
1313
+ "parameters": [
1314
+ {
1315
+ "name": "composite_id",
1316
+ "in": "path",
1317
+ "required": true
1318
+ }
1319
+ ],
1320
+ "responses": {}
1321
+ }
1322
+ },
1323
+ "/v1/entity/schemas/group": {
1324
+ "post": {
1325
+ "operationId": "createSchemaGroup",
1326
+ "requestBody": {
1327
+ "content": {
1328
+ "application/json": {}
1329
+ }
1330
+ },
1331
+ "responses": {}
1332
+ }
1333
+ },
1334
+ "/v1/entity/schemas/group/{composite_id}": {
1335
+ "get": {
1336
+ "operationId": "getSchemaGroup",
1337
+ "parameters": [
1338
+ {
1339
+ "name": "composite_id",
1340
+ "in": "path",
1341
+ "required": true
1342
+ }
1343
+ ],
1344
+ "responses": {}
1345
+ },
1346
+ "put": {
1347
+ "operationId": "putSchemaGroup",
1348
+ "parameters": [
1349
+ {
1350
+ "name": "composite_id",
1351
+ "in": "path",
1352
+ "required": true
1353
+ }
1354
+ ],
1355
+ "requestBody": {
1356
+ "content": {
1357
+ "application/json": {}
1358
+ }
1359
+ },
1360
+ "responses": {}
1361
+ },
1362
+ "delete": {
1363
+ "operationId": "deleteSchemaGroup",
1364
+ "parameters": [
1365
+ {
1366
+ "name": "composite_id",
1367
+ "in": "path",
1368
+ "required": true
1369
+ }
1370
+ ],
1371
+ "responses": {}
1372
+ }
1373
+ },
1374
+ "/v1/entity/schemas/headline": {
1375
+ "post": {
1376
+ "operationId": "createSchemaGroupHeadline",
1377
+ "requestBody": {
1378
+ "content": {
1379
+ "application/json": {}
1380
+ }
1381
+ },
1382
+ "responses": {}
1383
+ }
1384
+ },
1385
+ "/v1/entity/schemas/headline/{composite_id}": {
1386
+ "get": {
1387
+ "operationId": "getSchemaGroupHeadline",
1388
+ "parameters": [
1389
+ {
1390
+ "name": "composite_id",
1391
+ "in": "path",
1392
+ "required": true
1393
+ }
1394
+ ],
1395
+ "responses": {}
1396
+ },
1397
+ "put": {
1398
+ "operationId": "putSchemaGroupHeadline",
1399
+ "parameters": [
1400
+ {
1401
+ "name": "composite_id",
1402
+ "in": "path",
1403
+ "required": true
1404
+ }
1405
+ ],
1406
+ "requestBody": {
1407
+ "content": {
1408
+ "application/json": {}
1409
+ }
1410
+ },
1411
+ "responses": {}
1412
+ },
1413
+ "delete": {
1414
+ "operationId": "deleteSchemaGroupHeadline",
1415
+ "parameters": [
1416
+ {
1417
+ "name": "composite_id",
1418
+ "in": "path",
1419
+ "required": true
1420
+ }
1421
+ ],
1422
+ "responses": {}
1423
+ }
1424
+ }
1425
+ },
1426
+ "components": {
1427
+ "parameters": {
1428
+ "EntityIdPathParam": {
1429
+ "name": "id",
1430
+ "in": "path",
1431
+ "required": true
1432
+ },
1433
+ "EntitySlugPathParam": {
1434
+ "name": "slug",
1435
+ "in": "path",
1436
+ "required": true
1437
+ },
1438
+ "EntitySlugPathPriceParam": {
1439
+ "name": "slug",
1440
+ "in": "path",
1441
+ "required": true
1442
+ },
1443
+ "TaxonomySlugQueryParam": {
1444
+ "name": "taxonomySlug",
1445
+ "in": "query",
1446
+ "required": true
1447
+ },
1448
+ "TaxonomySlugPathParam": {
1449
+ "name": "taxonomySlug",
1450
+ "in": "path",
1451
+ "required": true
1452
+ },
1453
+ "TaxonomySlugQueryParamOptional": {
1454
+ "name": "taxonomySlug",
1455
+ "in": "query"
1456
+ },
1457
+ "TaxonomyClassificationSlugPathParam": {
1458
+ "name": "classificationSlug",
1459
+ "in": "path",
1460
+ "required": true
1461
+ },
1462
+ "SavedViewIdPathParam": {
1463
+ "name": "id",
1464
+ "in": "path",
1465
+ "required": true
1466
+ },
1467
+ "AsyncOperationQueryParam": {
1468
+ "name": "async",
1469
+ "in": "query",
1470
+ "required": false
1471
+ },
1472
+ "HydrateEntitiesQueryParam": {
1473
+ "name": "hydrate",
1474
+ "in": "query"
1475
+ },
1476
+ "ActivityIdQueryParam": {
1477
+ "name": "activity_id",
1478
+ "in": "query",
1479
+ "required": false
1480
+ },
1481
+ "ActivityIdPathParam": {
1482
+ "name": "id",
1483
+ "in": "path",
1484
+ "required": true
1485
+ },
1486
+ "FromPageQueryParam": {
1487
+ "name": "from",
1488
+ "in": "query"
1489
+ },
1490
+ "IncludeReverseDeprecatedQueryParam": {
1491
+ "name": "include_reverse",
1492
+ "in": "query",
1493
+ "deprecated": true
1494
+ },
1495
+ "IncludeReverseQueryParam": {
1496
+ "name": "include_reverse",
1497
+ "in": "query"
1498
+ },
1499
+ "IncludeSchemasQueryParam": {
1500
+ "name": "include_schemas",
1501
+ "in": "query",
1502
+ "required": false,
1503
+ "style": "form",
1504
+ "explode": false
1505
+ },
1506
+ "ExcludeSchemasQueryParam": {
1507
+ "name": "exclude_schemas",
1508
+ "in": "query",
1509
+ "required": false,
1510
+ "style": "form",
1511
+ "explode": false
1512
+ },
1513
+ "EntityRelationsModeQueryParam": {
1514
+ "name": "mode",
1515
+ "in": "query",
1516
+ "required": false
1517
+ },
1518
+ "DryRunQueryParam": {
1519
+ "name": "dry_run",
1520
+ "in": "query",
1521
+ "required": false
1522
+ },
1523
+ "FillActivityQueryParam": {
1524
+ "name": "fill_activity",
1525
+ "in": "query",
1526
+ "required": false
1527
+ },
1528
+ "ValidateEntityQueryParam": {
1529
+ "name": "validate",
1530
+ "in": "query"
1531
+ }
1532
+ },
1533
+ "responses": {
1534
+ "NotFoundError": {
1535
+ "content": {
1536
+ "application/json": {}
1537
+ }
1538
+ },
1539
+ "TooManyRequestsError": {
1540
+ "headers": {
1541
+ "Retry-After": {}
1542
+ },
1543
+ "content": {
1544
+ "application/json": {}
1545
+ }
1546
+ }
1547
+ }
1548
+ },
1549
+ "servers": [
1550
+ {
1551
+ "url": "https://entity.sls.epilot.io"
1552
+ }
1553
+ ]
1554
+ }