@epilot/entity-client 4.20.3 → 4.20.4

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,858 @@
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
+ }
18
+ },
19
+ "/v1/entity/schemas/{slug}": {
20
+ "get": {
21
+ "operationId": "getSchema",
22
+ "parameters": [
23
+ {
24
+ "$ref": "#/components/parameters/EntitySlugPathParam"
25
+ },
26
+ {
27
+ "in": "query",
28
+ "name": "id"
29
+ }
30
+ ]
31
+ },
32
+ "put": {
33
+ "operationId": "putSchema",
34
+ "parameters": [
35
+ {
36
+ "$ref": "#/components/parameters/EntitySlugPathParam"
37
+ },
38
+ {
39
+ "in": "query",
40
+ "name": "draft"
41
+ }
42
+ ],
43
+ "requestBody": {
44
+ "content": {
45
+ "application/json": {}
46
+ }
47
+ }
48
+ },
49
+ "delete": {
50
+ "operationId": "deleteSchema",
51
+ "parameters": [
52
+ {
53
+ "$ref": "#/components/parameters/EntitySlugPathParam"
54
+ }
55
+ ]
56
+ }
57
+ },
58
+ "/v1/entity/schemas/{slug}/versions": {
59
+ "get": {
60
+ "operationId": "getSchemaVersions",
61
+ "parameters": [
62
+ {
63
+ "$ref": "#/components/parameters/EntitySlugPathParam"
64
+ },
65
+ {
66
+ "in": "query",
67
+ "name": "versions_from"
68
+ },
69
+ {
70
+ "in": "query",
71
+ "name": "versions_size"
72
+ },
73
+ {
74
+ "in": "query",
75
+ "name": "drafts_from"
76
+ },
77
+ {
78
+ "in": "query",
79
+ "name": "drafts_size"
80
+ },
81
+ {
82
+ "in": "query",
83
+ "name": "fields",
84
+ "required": false,
85
+ "style": "form",
86
+ "explode": false
87
+ }
88
+ ]
89
+ }
90
+ },
91
+ "/v1/entity/schemas/blueprints": {
92
+ "get": {
93
+ "operationId": "listSchemaBlueprints"
94
+ }
95
+ },
96
+ "/v1/entity/schemas/{slug}/taxonomy/{taxonomySlug}": {
97
+ "get": {
98
+ "operationId": "listTaxonomyClassificationsForSchema",
99
+ "parameters": [
100
+ {
101
+ "$ref": "#/components/parameters/EntitySlugPathParam"
102
+ },
103
+ {
104
+ "$ref": "#/components/parameters/TaxonomySlugPathParam"
105
+ },
106
+ {
107
+ "in": "query",
108
+ "name": "query"
109
+ },
110
+ {
111
+ "in": "query",
112
+ "name": "size"
113
+ }
114
+ ]
115
+ }
116
+ },
117
+ "/v1/entity:search": {
118
+ "post": {
119
+ "operationId": "searchEntities",
120
+ "requestBody": {
121
+ "content": {
122
+ "application/json": {}
123
+ }
124
+ }
125
+ }
126
+ },
127
+ "/v1/entity/{slug}": {
128
+ "post": {
129
+ "operationId": "createEntity",
130
+ "parameters": [
131
+ {
132
+ "$ref": "#/components/parameters/EntitySlugPathParam"
133
+ },
134
+ {
135
+ "$ref": "#/components/parameters/ActivityIdQueryParam"
136
+ },
137
+ {
138
+ "$ref": "#/components/parameters/AsyncOperationQueryParam"
139
+ }
140
+ ],
141
+ "requestBody": {
142
+ "content": {
143
+ "application/json": {}
144
+ }
145
+ }
146
+ }
147
+ },
148
+ "/v1/entity/{slug}:validate": {
149
+ "post": {
150
+ "operationId": "validateEntity",
151
+ "parameters": [
152
+ {
153
+ "$ref": "#/components/parameters/EntitySlugPathPriceParam"
154
+ }
155
+ ],
156
+ "requestBody": {
157
+ "content": {
158
+ "application/json": {}
159
+ }
160
+ }
161
+ }
162
+ },
163
+ "/v1/entity/{slug}:upsert": {
164
+ "patch": {
165
+ "operationId": "upsertEntity",
166
+ "parameters": [
167
+ {
168
+ "$ref": "#/components/parameters/EntitySlugPathParam"
169
+ },
170
+ {
171
+ "$ref": "#/components/parameters/ActivityIdQueryParam"
172
+ },
173
+ {
174
+ "$ref": "#/components/parameters/DryRunQueryParam"
175
+ },
176
+ {
177
+ "$ref": "#/components/parameters/AsyncOperationQueryParam"
178
+ }
179
+ ],
180
+ "requestBody": {
181
+ "content": {
182
+ "application/json": {}
183
+ }
184
+ }
185
+ }
186
+ },
187
+ "/v2/entity/{slug}/{id}": {
188
+ "get": {
189
+ "operationId": "getEntityV2",
190
+ "parameters": [
191
+ {
192
+ "$ref": "#/components/parameters/EntityIdPathParam"
193
+ },
194
+ {
195
+ "$ref": "#/components/parameters/EntitySlugPathParam"
196
+ },
197
+ {
198
+ "$ref": "#/components/parameters/HydrateEntitiesQueryParam"
199
+ },
200
+ {
201
+ "in": "query",
202
+ "name": "fields",
203
+ "style": "form",
204
+ "explode": false
205
+ }
206
+ ]
207
+ }
208
+ },
209
+ "/v1/entity/{slug}/{id}": {
210
+ "get": {
211
+ "operationId": "getEntity",
212
+ "parameters": [
213
+ {
214
+ "$ref": "#/components/parameters/EntityIdPathParam"
215
+ },
216
+ {
217
+ "$ref": "#/components/parameters/EntitySlugPathParam"
218
+ },
219
+ {
220
+ "$ref": "#/components/parameters/HydrateEntitiesQueryParam"
221
+ }
222
+ ]
223
+ },
224
+ "put": {
225
+ "operationId": "updateEntity",
226
+ "parameters": [
227
+ {
228
+ "$ref": "#/components/parameters/EntitySlugPathParam"
229
+ },
230
+ {
231
+ "$ref": "#/components/parameters/EntityIdPathParam"
232
+ },
233
+ {
234
+ "$ref": "#/components/parameters/ActivityIdQueryParam"
235
+ },
236
+ {
237
+ "$ref": "#/components/parameters/AsyncOperationQueryParam"
238
+ }
239
+ ],
240
+ "requestBody": {
241
+ "content": {
242
+ "application/json": {}
243
+ }
244
+ }
245
+ },
246
+ "patch": {
247
+ "operationId": "patchEntity",
248
+ "parameters": [
249
+ {
250
+ "$ref": "#/components/parameters/EntitySlugPathParam"
251
+ },
252
+ {
253
+ "$ref": "#/components/parameters/EntityIdPathParam"
254
+ },
255
+ {
256
+ "$ref": "#/components/parameters/ActivityIdQueryParam"
257
+ },
258
+ {
259
+ "$ref": "#/components/parameters/DryRunQueryParam"
260
+ },
261
+ {
262
+ "$ref": "#/components/parameters/AsyncOperationQueryParam"
263
+ }
264
+ ],
265
+ "requestBody": {
266
+ "content": {
267
+ "application/json": {}
268
+ },
269
+ "required": true
270
+ }
271
+ },
272
+ "delete": {
273
+ "operationId": "deleteEntity",
274
+ "parameters": [
275
+ {
276
+ "$ref": "#/components/parameters/EntitySlugPathParam"
277
+ },
278
+ {
279
+ "$ref": "#/components/parameters/EntityIdPathParam"
280
+ },
281
+ {
282
+ "$ref": "#/components/parameters/ActivityIdQueryParam"
283
+ }
284
+ ]
285
+ }
286
+ },
287
+ "/v1/entity:autocomplete": {
288
+ "get": {
289
+ "operationId": "autocomplete",
290
+ "parameters": [
291
+ {
292
+ "name": "input",
293
+ "in": "query"
294
+ },
295
+ {
296
+ "name": "attribute",
297
+ "in": "query",
298
+ "required": true
299
+ },
300
+ {
301
+ "name": "slug",
302
+ "in": "query"
303
+ },
304
+ {
305
+ "name": "size",
306
+ "in": "query"
307
+ }
308
+ ]
309
+ }
310
+ },
311
+ "/v1/entity/activity": {
312
+ "post": {
313
+ "operationId": "createActivity",
314
+ "parameters": [
315
+ {
316
+ "in": "query",
317
+ "name": "entities",
318
+ "style": "form",
319
+ "explode": false
320
+ }
321
+ ],
322
+ "requestBody": {
323
+ "content": {
324
+ "application/json": {}
325
+ }
326
+ }
327
+ }
328
+ },
329
+ "/v1/entity/activity/{id}": {
330
+ "get": {
331
+ "operationId": "getActivity",
332
+ "parameters": [
333
+ {
334
+ "$ref": "#/components/parameters/ActivityIdPathParam"
335
+ },
336
+ {
337
+ "in": "query",
338
+ "name": "operations_size"
339
+ },
340
+ {
341
+ "in": "query",
342
+ "name": "operations_from"
343
+ }
344
+ ]
345
+ }
346
+ },
347
+ "/v1/entity/activity/{id}:attach": {
348
+ "post": {
349
+ "operationId": "attachActivity",
350
+ "parameters": [
351
+ {
352
+ "$ref": "#/components/parameters/ActivityIdPathParam"
353
+ },
354
+ {
355
+ "in": "query",
356
+ "name": "entities",
357
+ "style": "form",
358
+ "explode": false
359
+ }
360
+ ]
361
+ }
362
+ },
363
+ "/v1/entity/{slug}/{id}/activity": {
364
+ "get": {
365
+ "operationId": "getEntityActivityFeed",
366
+ "parameters": [
367
+ {
368
+ "$ref": "#/components/parameters/EntitySlugPathParam"
369
+ },
370
+ {
371
+ "$ref": "#/components/parameters/EntityIdPathParam"
372
+ },
373
+ {
374
+ "in": "query",
375
+ "name": "after"
376
+ },
377
+ {
378
+ "in": "query",
379
+ "name": "before"
380
+ },
381
+ {
382
+ "$ref": "#/components/parameters/FromPageQueryParam"
383
+ },
384
+ {
385
+ "in": "query",
386
+ "name": "size"
387
+ },
388
+ {
389
+ "in": "query",
390
+ "name": "type"
391
+ },
392
+ {
393
+ "in": "query",
394
+ "name": "include_relations"
395
+ }
396
+ ]
397
+ }
398
+ },
399
+ "/v1/entity/{slug}/{id}/relations": {
400
+ "get": {
401
+ "operationId": "getRelations",
402
+ "parameters": [
403
+ {
404
+ "$ref": "#/components/parameters/EntitySlugPathParam"
405
+ },
406
+ {
407
+ "$ref": "#/components/parameters/EntityIdPathParam"
408
+ },
409
+ {
410
+ "$ref": "#/components/parameters/HydrateEntitiesQueryParam"
411
+ },
412
+ {
413
+ "$ref": "#/components/parameters/IncludeReverseQueryParam"
414
+ },
415
+ {
416
+ "$ref": "#/components/parameters/FromPageQueryParam"
417
+ },
418
+ {
419
+ "in": "query",
420
+ "name": "size",
421
+ "required": false
422
+ },
423
+ {
424
+ "$ref": "#/components/parameters/IncludeSchemasQueryParam"
425
+ },
426
+ {
427
+ "$ref": "#/components/parameters/ExcludeSchemasQueryParam"
428
+ }
429
+ ]
430
+ },
431
+ "post": {
432
+ "operationId": "addRelations",
433
+ "parameters": [
434
+ {
435
+ "$ref": "#/components/parameters/EntitySlugPathParam"
436
+ },
437
+ {
438
+ "$ref": "#/components/parameters/EntityIdPathParam"
439
+ },
440
+ {
441
+ "$ref": "#/components/parameters/AsyncOperationQueryParam"
442
+ },
443
+ {
444
+ "$ref": "#/components/parameters/ActivityIdQueryParam"
445
+ }
446
+ ],
447
+ "requestBody": {
448
+ "content": {
449
+ "application/json": {}
450
+ }
451
+ }
452
+ }
453
+ },
454
+ "/v2/entity/{slug}/{id}/relations": {
455
+ "get": {
456
+ "operationId": "getRelationsV2",
457
+ "parameters": [
458
+ {
459
+ "$ref": "#/components/parameters/EntitySlugPathParam"
460
+ },
461
+ {
462
+ "$ref": "#/components/parameters/EntityIdPathParam"
463
+ },
464
+ {
465
+ "$ref": "#/components/parameters/HydrateEntitiesQueryParam"
466
+ },
467
+ {
468
+ "in": "query",
469
+ "name": "query"
470
+ },
471
+ {
472
+ "$ref": "#/components/parameters/IncludeReverseQueryParam"
473
+ },
474
+ {
475
+ "$ref": "#/components/parameters/FromPageQueryParam"
476
+ },
477
+ {
478
+ "in": "query",
479
+ "name": "size"
480
+ },
481
+ {
482
+ "in": "query",
483
+ "name": "fields"
484
+ }
485
+ ]
486
+ }
487
+ },
488
+ "/v3/entity/{slug}/{id}/relations": {
489
+ "get": {
490
+ "operationId": "getRelationsV3",
491
+ "parameters": [
492
+ {
493
+ "$ref": "#/components/parameters/EntitySlugPathParam"
494
+ },
495
+ {
496
+ "$ref": "#/components/parameters/EntityIdPathParam"
497
+ },
498
+ {
499
+ "$ref": "#/components/parameters/HydrateEntitiesQueryParam"
500
+ },
501
+ {
502
+ "$ref": "#/components/parameters/IncludeReverseDeprecatedQueryParam"
503
+ },
504
+ {
505
+ "$ref": "#/components/parameters/FromPageQueryParam"
506
+ },
507
+ {
508
+ "in": "query",
509
+ "name": "size",
510
+ "required": false
511
+ },
512
+ {
513
+ "$ref": "#/components/parameters/IncludeSchemasQueryParam"
514
+ },
515
+ {
516
+ "$ref": "#/components/parameters/ExcludeSchemasQueryParam"
517
+ },
518
+ {
519
+ "$ref": "#/components/parameters/EntityRelationsModeQueryParam"
520
+ }
521
+ ]
522
+ }
523
+ },
524
+ "/v2/entity/{slug}/{id}/relations/count": {
525
+ "get": {
526
+ "operationId": "getRelatedEntitiesCount",
527
+ "parameters": [
528
+ {
529
+ "$ref": "#/components/parameters/EntitySlugPathParam"
530
+ },
531
+ {
532
+ "$ref": "#/components/parameters/EntityIdPathParam"
533
+ },
534
+ {
535
+ "$ref": "#/components/parameters/ExcludeSchemasQueryParam"
536
+ }
537
+ ]
538
+ }
539
+ },
540
+ "/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}": {
541
+ "put": {
542
+ "operationId": "updateRelation",
543
+ "parameters": [
544
+ {
545
+ "$ref": "#/components/parameters/EntitySlugPathParam"
546
+ },
547
+ {
548
+ "$ref": "#/components/parameters/EntityIdPathParam"
549
+ },
550
+ {
551
+ "in": "path",
552
+ "name": "attribute",
553
+ "required": true
554
+ },
555
+ {
556
+ "in": "path",
557
+ "name": "entity_id",
558
+ "required": true
559
+ },
560
+ {
561
+ "$ref": "#/components/parameters/AsyncOperationQueryParam"
562
+ },
563
+ {
564
+ "$ref": "#/components/parameters/ActivityIdQueryParam"
565
+ }
566
+ ],
567
+ "requestBody": {
568
+ "content": {
569
+ "application/json": {}
570
+ }
571
+ }
572
+ },
573
+ "delete": {
574
+ "operationId": "deleteRelation",
575
+ "parameters": [
576
+ {
577
+ "$ref": "#/components/parameters/EntitySlugPathParam"
578
+ },
579
+ {
580
+ "$ref": "#/components/parameters/EntityIdPathParam"
581
+ },
582
+ {
583
+ "in": "path",
584
+ "name": "attribute",
585
+ "required": true
586
+ },
587
+ {
588
+ "in": "path",
589
+ "name": "entity_id",
590
+ "required": true
591
+ },
592
+ {
593
+ "$ref": "#/components/parameters/AsyncOperationQueryParam"
594
+ },
595
+ {
596
+ "$ref": "#/components/parameters/ActivityIdQueryParam"
597
+ }
598
+ ]
599
+ }
600
+ },
601
+ "/v1/entity:export": {
602
+ "post": {
603
+ "operationId": "exportEntities",
604
+ "parameters": [
605
+ {
606
+ "in": "query",
607
+ "name": "job_id"
608
+ },
609
+ {
610
+ "in": "query",
611
+ "name": "is_template"
612
+ },
613
+ {
614
+ "in": "query",
615
+ "name": "language"
616
+ }
617
+ ],
618
+ "requestBody": {
619
+ "content": {
620
+ "application/json": {}
621
+ }
622
+ }
623
+ }
624
+ },
625
+ "/v1/entity:import": {
626
+ "post": {
627
+ "operationId": "importEntities",
628
+ "parameters": [
629
+ {
630
+ "in": "query",
631
+ "name": "job_id"
632
+ }
633
+ ],
634
+ "requestBody": {
635
+ "content": {
636
+ "application/json": {}
637
+ }
638
+ }
639
+ }
640
+ },
641
+ "/v1/entity/views": {
642
+ "get": {
643
+ "operationId": "listSavedViews",
644
+ "parameters": [
645
+ {
646
+ "in": "query",
647
+ "name": "slug",
648
+ "required": false
649
+ }
650
+ ]
651
+ }
652
+ },
653
+ "/v1/entity/view": {
654
+ "post": {
655
+ "operationId": "createSavedView",
656
+ "requestBody": {
657
+ "content": {
658
+ "application/json": {}
659
+ }
660
+ }
661
+ }
662
+ },
663
+ "/v1/entity/view/{id}": {
664
+ "get": {
665
+ "operationId": "getSavedView",
666
+ "parameters": [
667
+ {
668
+ "$ref": "#/components/parameters/SavedViewIdPathParam"
669
+ }
670
+ ]
671
+ },
672
+ "put": {
673
+ "operationId": "updateSavedView",
674
+ "parameters": [
675
+ {
676
+ "$ref": "#/components/parameters/SavedViewIdPathParam"
677
+ }
678
+ ],
679
+ "requestBody": {
680
+ "content": {
681
+ "application/json": {}
682
+ }
683
+ }
684
+ },
685
+ "delete": {
686
+ "operationId": "deleteSavedView",
687
+ "parameters": [
688
+ {
689
+ "$ref": "#/components/parameters/SavedViewIdPathParam"
690
+ }
691
+ ]
692
+ }
693
+ },
694
+ "/v1/entity/views/favorites": {
695
+ "get": {
696
+ "operationId": "listFavoriteViewsForUser"
697
+ }
698
+ },
699
+ "/v1/entity/listTaxonomies": {
700
+ "get": {
701
+ "operationId": "listTaxonomies"
702
+ }
703
+ },
704
+ "/v1/entity/taxonomies/{taxonomySlug}": {
705
+ "get": {
706
+ "operationId": "getTaxonomy",
707
+ "parameters": [
708
+ {
709
+ "$ref": "#/components/parameters/TaxonomySlugPathParam"
710
+ }
711
+ ]
712
+ }
713
+ },
714
+ "/v1/entity/taxonomies/{taxonomySlug}:autocomplete": {
715
+ "get": {
716
+ "operationId": "taxonomyAutocomplete",
717
+ "parameters": [
718
+ {
719
+ "$ref": "#/components/parameters/TaxonomySlugPathParam"
720
+ },
721
+ {
722
+ "in": "query",
723
+ "name": "query"
724
+ },
725
+ {
726
+ "in": "query",
727
+ "name": "size"
728
+ }
729
+ ]
730
+ }
731
+ },
732
+ "/v1/entity/taxonomies/classifications:search": {
733
+ "post": {
734
+ "operationId": "taxonomiesClassificationsSearch",
735
+ "parameters": [
736
+ {
737
+ "$ref": "#/components/parameters/TaxonomySlugQueryParam"
738
+ }
739
+ ],
740
+ "requestBody": {
741
+ "content": {
742
+ "application/json": {}
743
+ }
744
+ }
745
+ }
746
+ },
747
+ "/v1/entity/taxonomies/{taxonomySlug}/classifications": {
748
+ "post": {
749
+ "operationId": "updateClassificationsForTaxonomy",
750
+ "parameters": [
751
+ {
752
+ "$ref": "#/components/parameters/TaxonomySlugPathParam"
753
+ }
754
+ ],
755
+ "requestBody": {
756
+ "content": {
757
+ "application/json": {}
758
+ }
759
+ }
760
+ }
761
+ }
762
+ },
763
+ "components": {
764
+ "parameters": {
765
+ "EntityIdPathParam": {
766
+ "name": "id",
767
+ "in": "path",
768
+ "required": true
769
+ },
770
+ "EntitySlugPathParam": {
771
+ "name": "slug",
772
+ "in": "path",
773
+ "required": true
774
+ },
775
+ "EntitySlugPathPriceParam": {
776
+ "name": "slug",
777
+ "in": "path",
778
+ "required": true
779
+ },
780
+ "TaxonomySlugQueryParam": {
781
+ "name": "taxonomySlug",
782
+ "in": "query",
783
+ "required": true
784
+ },
785
+ "TaxonomySlugPathParam": {
786
+ "name": "taxonomySlug",
787
+ "in": "path",
788
+ "required": true
789
+ },
790
+ "SavedViewIdPathParam": {
791
+ "name": "id",
792
+ "in": "path",
793
+ "required": true
794
+ },
795
+ "AsyncOperationQueryParam": {
796
+ "name": "async",
797
+ "in": "query",
798
+ "required": false
799
+ },
800
+ "HydrateEntitiesQueryParam": {
801
+ "name": "hydrate",
802
+ "in": "query"
803
+ },
804
+ "ActivityIdQueryParam": {
805
+ "name": "activity_id",
806
+ "in": "query",
807
+ "required": false
808
+ },
809
+ "ActivityIdPathParam": {
810
+ "name": "id",
811
+ "in": "path",
812
+ "required": true
813
+ },
814
+ "FromPageQueryParam": {
815
+ "name": "from",
816
+ "in": "query"
817
+ },
818
+ "IncludeReverseDeprecatedQueryParam": {
819
+ "name": "include_reverse",
820
+ "in": "query",
821
+ "deprecated": true
822
+ },
823
+ "IncludeReverseQueryParam": {
824
+ "name": "include_reverse",
825
+ "in": "query"
826
+ },
827
+ "IncludeSchemasQueryParam": {
828
+ "name": "include_schemas",
829
+ "in": "query",
830
+ "required": false,
831
+ "style": "form",
832
+ "explode": false
833
+ },
834
+ "ExcludeSchemasQueryParam": {
835
+ "name": "exclude_schemas",
836
+ "in": "query",
837
+ "required": false,
838
+ "style": "form",
839
+ "explode": false
840
+ },
841
+ "EntityRelationsModeQueryParam": {
842
+ "name": "mode",
843
+ "in": "query",
844
+ "required": false
845
+ },
846
+ "DryRunQueryParam": {
847
+ "name": "dry_run",
848
+ "in": "query",
849
+ "required": false
850
+ }
851
+ }
852
+ },
853
+ "servers": [
854
+ {
855
+ "url": "https://entity.sls.epilot.io"
856
+ }
857
+ ]
858
+ }