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