@epilot/entity-client 4.20.3 → 4.21.0-rc.1

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