@epilot/entity-client 4.18.1-rc.1 → 4.18.1-rc.2

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.
@@ -21,9 +21,7 @@
21
21
  "operationId": "getSchema",
22
22
  "parameters": [
23
23
  {
24
- "in": "path",
25
- "name": "slug",
26
- "required": true
24
+ "$ref": "#/components/parameters/EntitySlugPathParam"
27
25
  },
28
26
  {
29
27
  "in": "query",
@@ -35,9 +33,7 @@
35
33
  "operationId": "putSchema",
36
34
  "parameters": [
37
35
  {
38
- "in": "path",
39
- "name": "slug",
40
- "required": true
36
+ "$ref": "#/components/parameters/EntitySlugPathParam"
41
37
  },
42
38
  {
43
39
  "in": "query",
@@ -54,9 +50,7 @@
54
50
  "operationId": "deleteSchema",
55
51
  "parameters": [
56
52
  {
57
- "in": "path",
58
- "name": "slug",
59
- "required": true
53
+ "$ref": "#/components/parameters/EntitySlugPathParam"
60
54
  }
61
55
  ]
62
56
  }
@@ -66,9 +60,7 @@
66
60
  "operationId": "getSchemaVersions",
67
61
  "parameters": [
68
62
  {
69
- "in": "path",
70
- "name": "slug",
71
- "required": true
63
+ "$ref": "#/components/parameters/EntitySlugPathParam"
72
64
  },
73
65
  {
74
66
  "in": "query",
@@ -99,14 +91,10 @@
99
91
  "operationId": "listTaxonomyClassificationsForSchema",
100
92
  "parameters": [
101
93
  {
102
- "in": "path",
103
- "name": "slug",
104
- "required": true
94
+ "$ref": "#/components/parameters/EntitySlugPathParam"
105
95
  },
106
96
  {
107
- "in": "path",
108
- "name": "taxonomySlug",
109
- "required": true
97
+ "$ref": "#/components/parameters/TaxonomySlugPathParam"
110
98
  },
111
99
  {
112
100
  "in": "query",
@@ -134,19 +122,13 @@
134
122
  "operationId": "createEntity",
135
123
  "parameters": [
136
124
  {
137
- "in": "path",
138
- "name": "slug",
139
- "required": true
125
+ "$ref": "#/components/parameters/EntitySlugPathParam"
140
126
  },
141
127
  {
142
- "in": "query",
143
- "name": "activity_id",
144
- "required": false
128
+ "$ref": "#/components/parameters/ActivityIdQueryParam"
145
129
  },
146
130
  {
147
- "in": "query",
148
- "name": "async",
149
- "required": false
131
+ "$ref": "#/components/parameters/AsyncOperationQueryParam"
150
132
  }
151
133
  ],
152
134
  "requestBody": {
@@ -161,24 +143,16 @@
161
143
  "operationId": "upsertEntity",
162
144
  "parameters": [
163
145
  {
164
- "in": "path",
165
- "name": "slug",
166
- "required": true
146
+ "$ref": "#/components/parameters/EntitySlugPathParam"
167
147
  },
168
148
  {
169
- "in": "query",
170
- "name": "activity_id",
171
- "required": false
149
+ "$ref": "#/components/parameters/ActivityIdQueryParam"
172
150
  },
173
151
  {
174
- "in": "query",
175
- "name": "dry_run",
176
- "required": false
152
+ "$ref": "#/components/parameters/DryRunQueryParam"
177
153
  },
178
154
  {
179
- "in": "query",
180
- "name": "async",
181
- "required": false
155
+ "$ref": "#/components/parameters/AsyncOperationQueryParam"
182
156
  }
183
157
  ],
184
158
  "requestBody": {
@@ -193,18 +167,13 @@
193
167
  "operationId": "getEntity",
194
168
  "parameters": [
195
169
  {
196
- "in": "path",
197
- "name": "slug",
198
- "required": true
170
+ "$ref": "#/components/parameters/EntityIdPathParam"
199
171
  },
200
172
  {
201
- "in": "path",
202
- "name": "id",
203
- "required": true
173
+ "$ref": "#/components/parameters/EntitySlugPathParam"
204
174
  },
205
175
  {
206
- "in": "query",
207
- "name": "hydrate"
176
+ "$ref": "#/components/parameters/HydrateEntitiesQueryParam"
208
177
  }
209
178
  ]
210
179
  },
@@ -212,24 +181,16 @@
212
181
  "operationId": "updateEntity",
213
182
  "parameters": [
214
183
  {
215
- "in": "path",
216
- "name": "slug",
217
- "required": true
184
+ "$ref": "#/components/parameters/EntitySlugPathParam"
218
185
  },
219
186
  {
220
- "in": "path",
221
- "name": "id",
222
- "required": true
187
+ "$ref": "#/components/parameters/EntityIdPathParam"
223
188
  },
224
189
  {
225
- "in": "query",
226
- "name": "activity_id",
227
- "required": false
190
+ "$ref": "#/components/parameters/ActivityIdQueryParam"
228
191
  },
229
192
  {
230
- "in": "query",
231
- "name": "async",
232
- "required": false
193
+ "$ref": "#/components/parameters/AsyncOperationQueryParam"
233
194
  }
234
195
  ],
235
196
  "requestBody": {
@@ -242,29 +203,19 @@
242
203
  "operationId": "patchEntity",
243
204
  "parameters": [
244
205
  {
245
- "in": "path",
246
- "name": "slug",
247
- "required": true
206
+ "$ref": "#/components/parameters/EntitySlugPathParam"
248
207
  },
249
208
  {
250
- "in": "path",
251
- "name": "id",
252
- "required": true
209
+ "$ref": "#/components/parameters/EntityIdPathParam"
253
210
  },
254
211
  {
255
- "in": "query",
256
- "name": "activity_id",
257
- "required": false
212
+ "$ref": "#/components/parameters/ActivityIdQueryParam"
258
213
  },
259
214
  {
260
- "in": "query",
261
- "name": "dry_run",
262
- "required": false
215
+ "$ref": "#/components/parameters/DryRunQueryParam"
263
216
  },
264
217
  {
265
- "in": "query",
266
- "name": "async",
267
- "required": false
218
+ "$ref": "#/components/parameters/AsyncOperationQueryParam"
268
219
  }
269
220
  ],
270
221
  "requestBody": {
@@ -278,19 +229,13 @@
278
229
  "operationId": "deleteEntity",
279
230
  "parameters": [
280
231
  {
281
- "in": "path",
282
- "name": "slug",
283
- "required": true
232
+ "$ref": "#/components/parameters/EntitySlugPathParam"
284
233
  },
285
234
  {
286
- "in": "path",
287
- "name": "id",
288
- "required": true
235
+ "$ref": "#/components/parameters/EntityIdPathParam"
289
236
  },
290
237
  {
291
- "in": "query",
292
- "name": "activity_id",
293
- "required": false
238
+ "$ref": "#/components/parameters/ActivityIdQueryParam"
294
239
  }
295
240
  ]
296
241
  }
@@ -342,9 +287,7 @@
342
287
  "operationId": "getActivity",
343
288
  "parameters": [
344
289
  {
345
- "in": "path",
346
- "name": "id",
347
- "required": true
290
+ "$ref": "#/components/parameters/ActivityIdPathParam"
348
291
  },
349
292
  {
350
293
  "in": "query",
@@ -362,9 +305,7 @@
362
305
  "operationId": "attachActivity",
363
306
  "parameters": [
364
307
  {
365
- "in": "path",
366
- "name": "id",
367
- "required": true
308
+ "$ref": "#/components/parameters/ActivityIdPathParam"
368
309
  },
369
310
  {
370
311
  "in": "query",
@@ -380,14 +321,10 @@
380
321
  "operationId": "getEntityActivityFeed",
381
322
  "parameters": [
382
323
  {
383
- "in": "path",
384
- "name": "slug",
385
- "required": true
324
+ "$ref": "#/components/parameters/EntitySlugPathParam"
386
325
  },
387
326
  {
388
- "in": "path",
389
- "name": "id",
390
- "required": true
327
+ "$ref": "#/components/parameters/EntityIdPathParam"
391
328
  },
392
329
  {
393
330
  "in": "query",
@@ -398,8 +335,7 @@
398
335
  "name": "before"
399
336
  },
400
337
  {
401
- "in": "query",
402
- "name": "from"
338
+ "$ref": "#/components/parameters/FromPageQueryParam"
403
339
  },
404
340
  {
405
341
  "in": "query",
@@ -421,26 +357,19 @@
421
357
  "operationId": "getRelations",
422
358
  "parameters": [
423
359
  {
424
- "in": "path",
425
- "name": "slug",
426
- "required": true
360
+ "$ref": "#/components/parameters/EntitySlugPathParam"
427
361
  },
428
362
  {
429
- "in": "path",
430
- "name": "id",
431
- "required": true
363
+ "$ref": "#/components/parameters/EntityIdPathParam"
432
364
  },
433
365
  {
434
- "in": "query",
435
- "name": "hydrate"
366
+ "$ref": "#/components/parameters/HydrateEntitiesQueryParam"
436
367
  },
437
368
  {
438
- "in": "query",
439
- "name": "include_reverse"
369
+ "$ref": "#/components/parameters/IncludeReverseQueryParam"
440
370
  },
441
371
  {
442
- "in": "query",
443
- "name": "from"
372
+ "$ref": "#/components/parameters/FromPageQueryParam"
444
373
  },
445
374
  {
446
375
  "in": "query",
@@ -448,18 +377,10 @@
448
377
  "required": false
449
378
  },
450
379
  {
451
- "in": "query",
452
- "name": "include_schemas",
453
- "required": false,
454
- "style": "form",
455
- "explode": false
380
+ "$ref": "#/components/parameters/IncludeSchemasQueryParam"
456
381
  },
457
382
  {
458
- "in": "query",
459
- "name": "exclude_schemas",
460
- "required": false,
461
- "style": "form",
462
- "explode": false
383
+ "$ref": "#/components/parameters/ExcludeSchemasQueryParam"
463
384
  }
464
385
  ]
465
386
  },
@@ -467,24 +388,16 @@
467
388
  "operationId": "addRelations",
468
389
  "parameters": [
469
390
  {
470
- "in": "path",
471
- "name": "slug",
472
- "required": true
391
+ "$ref": "#/components/parameters/EntitySlugPathParam"
473
392
  },
474
393
  {
475
- "in": "path",
476
- "name": "id",
477
- "required": true
394
+ "$ref": "#/components/parameters/EntityIdPathParam"
478
395
  },
479
396
  {
480
- "in": "query",
481
- "name": "async",
482
- "required": false
397
+ "$ref": "#/components/parameters/AsyncOperationQueryParam"
483
398
  },
484
399
  {
485
- "in": "query",
486
- "name": "activity_id",
487
- "required": false
400
+ "$ref": "#/components/parameters/ActivityIdQueryParam"
488
401
  }
489
402
  ],
490
403
  "requestBody": {
@@ -499,30 +412,23 @@
499
412
  "operationId": "getRelationsV2",
500
413
  "parameters": [
501
414
  {
502
- "in": "path",
503
- "name": "slug",
504
- "required": true
415
+ "$ref": "#/components/parameters/EntitySlugPathParam"
505
416
  },
506
417
  {
507
- "in": "path",
508
- "name": "id",
509
- "required": true
418
+ "$ref": "#/components/parameters/EntityIdPathParam"
510
419
  },
511
420
  {
512
- "in": "query",
513
- "name": "hydrate"
421
+ "$ref": "#/components/parameters/HydrateEntitiesQueryParam"
514
422
  },
515
423
  {
516
424
  "in": "query",
517
425
  "name": "query"
518
426
  },
519
427
  {
520
- "in": "query",
521
- "name": "include_reverse"
428
+ "$ref": "#/components/parameters/IncludeReverseQueryParam"
522
429
  },
523
430
  {
524
- "in": "query",
525
- "name": "from"
431
+ "$ref": "#/components/parameters/FromPageQueryParam"
526
432
  },
527
433
  {
528
434
  "in": "query",
@@ -540,26 +446,19 @@
540
446
  "operationId": "getRelationsV3",
541
447
  "parameters": [
542
448
  {
543
- "in": "path",
544
- "name": "slug",
545
- "required": true
449
+ "$ref": "#/components/parameters/EntitySlugPathParam"
546
450
  },
547
451
  {
548
- "in": "path",
549
- "name": "id",
550
- "required": true
452
+ "$ref": "#/components/parameters/EntityIdPathParam"
551
453
  },
552
454
  {
553
- "in": "query",
554
- "name": "hydrate"
455
+ "$ref": "#/components/parameters/HydrateEntitiesQueryParam"
555
456
  },
556
457
  {
557
- "in": "query",
558
- "name": "include_reverse"
458
+ "$ref": "#/components/parameters/IncludeReverseQueryParam"
559
459
  },
560
460
  {
561
- "in": "query",
562
- "name": "from"
461
+ "$ref": "#/components/parameters/FromPageQueryParam"
563
462
  },
564
463
  {
565
464
  "in": "query",
@@ -567,18 +466,13 @@
567
466
  "required": false
568
467
  },
569
468
  {
570
- "in": "query",
571
- "name": "include_schemas",
572
- "required": false,
573
- "style": "form",
574
- "explode": false
469
+ "$ref": "#/components/parameters/IncludeSchemasQueryParam"
575
470
  },
576
471
  {
577
- "in": "query",
578
- "name": "exclude_schemas",
579
- "required": false,
580
- "style": "form",
581
- "explode": false
472
+ "$ref": "#/components/parameters/ExcludeSchemasQueryParam"
473
+ },
474
+ {
475
+ "$ref": "#/components/parameters/EntityRelationsModeQueryParam"
582
476
  }
583
477
  ]
584
478
  }
@@ -588,21 +482,13 @@
588
482
  "operationId": "getRelatedEntitiesCount",
589
483
  "parameters": [
590
484
  {
591
- "in": "path",
592
- "name": "slug",
593
- "required": true
485
+ "$ref": "#/components/parameters/EntitySlugPathParam"
594
486
  },
595
487
  {
596
- "in": "path",
597
- "name": "id",
598
- "required": true
488
+ "$ref": "#/components/parameters/EntityIdPathParam"
599
489
  },
600
490
  {
601
- "in": "query",
602
- "name": "exclude_schemas",
603
- "required": false,
604
- "style": "form",
605
- "explode": false
491
+ "$ref": "#/components/parameters/ExcludeSchemasQueryParam"
606
492
  }
607
493
  ]
608
494
  }
@@ -612,14 +498,10 @@
612
498
  "operationId": "updateRelation",
613
499
  "parameters": [
614
500
  {
615
- "in": "path",
616
- "name": "slug",
617
- "required": true
501
+ "$ref": "#/components/parameters/EntitySlugPathParam"
618
502
  },
619
503
  {
620
- "in": "path",
621
- "name": "id",
622
- "required": true
504
+ "$ref": "#/components/parameters/EntityIdPathParam"
623
505
  },
624
506
  {
625
507
  "in": "path",
@@ -632,14 +514,10 @@
632
514
  "required": true
633
515
  },
634
516
  {
635
- "in": "query",
636
- "name": "async",
637
- "required": false
517
+ "$ref": "#/components/parameters/AsyncOperationQueryParam"
638
518
  },
639
519
  {
640
- "in": "query",
641
- "name": "activity_id",
642
- "required": false
520
+ "$ref": "#/components/parameters/ActivityIdQueryParam"
643
521
  }
644
522
  ],
645
523
  "requestBody": {
@@ -652,14 +530,10 @@
652
530
  "operationId": "deleteRelation",
653
531
  "parameters": [
654
532
  {
655
- "in": "path",
656
- "name": "slug",
657
- "required": true
533
+ "$ref": "#/components/parameters/EntitySlugPathParam"
658
534
  },
659
535
  {
660
- "in": "path",
661
- "name": "id",
662
- "required": true
536
+ "$ref": "#/components/parameters/EntityIdPathParam"
663
537
  },
664
538
  {
665
539
  "in": "path",
@@ -672,14 +546,10 @@
672
546
  "required": true
673
547
  },
674
548
  {
675
- "in": "query",
676
- "name": "async",
677
- "required": false
549
+ "$ref": "#/components/parameters/AsyncOperationQueryParam"
678
550
  },
679
551
  {
680
- "in": "query",
681
- "name": "activity_id",
682
- "required": false
552
+ "$ref": "#/components/parameters/ActivityIdQueryParam"
683
553
  }
684
554
  ]
685
555
  }
@@ -744,9 +614,7 @@
744
614
  "operationId": "getSavedView",
745
615
  "parameters": [
746
616
  {
747
- "in": "path",
748
- "name": "id",
749
- "required": true
617
+ "$ref": "#/components/parameters/SavedViewIdPathParam"
750
618
  }
751
619
  ]
752
620
  },
@@ -754,9 +622,7 @@
754
622
  "operationId": "updateSavedView",
755
623
  "parameters": [
756
624
  {
757
- "in": "path",
758
- "name": "id",
759
- "required": true
625
+ "$ref": "#/components/parameters/SavedViewIdPathParam"
760
626
  }
761
627
  ],
762
628
  "requestBody": {
@@ -769,9 +635,7 @@
769
635
  "operationId": "deleteSavedView",
770
636
  "parameters": [
771
637
  {
772
- "in": "path",
773
- "name": "id",
774
- "required": true
638
+ "$ref": "#/components/parameters/SavedViewIdPathParam"
775
639
  }
776
640
  ]
777
641
  }
@@ -791,9 +655,7 @@
791
655
  "operationId": "getTaxonomy",
792
656
  "parameters": [
793
657
  {
794
- "in": "path",
795
- "name": "taxonomySlug",
796
- "required": true
658
+ "$ref": "#/components/parameters/TaxonomySlugPathParam"
797
659
  }
798
660
  ]
799
661
  }
@@ -803,9 +665,7 @@
803
665
  "operationId": "taxonomyAutocomplete",
804
666
  "parameters": [
805
667
  {
806
- "in": "path",
807
- "name": "taxonomySlug",
808
- "required": true
668
+ "$ref": "#/components/parameters/TaxonomySlugPathParam"
809
669
  },
810
670
  {
811
671
  "in": "query",
@@ -823,9 +683,7 @@
823
683
  "operationId": "taxonomiesClassificationsSearch",
824
684
  "parameters": [
825
685
  {
826
- "in": "query",
827
- "name": "taxonomySlug",
828
- "required": true
686
+ "$ref": "#/components/parameters/TaxonomySlugQueryParam"
829
687
  }
830
688
  ],
831
689
  "requestBody": {
@@ -840,9 +698,7 @@
840
698
  "operationId": "updateClassificationsForTaxonomy",
841
699
  "parameters": [
842
700
  {
843
- "in": "path",
844
- "name": "taxonomySlug",
845
- "required": true
701
+ "$ref": "#/components/parameters/TaxonomySlugPathParam"
846
702
  }
847
703
  ],
848
704
  "requestBody": {
@@ -853,7 +709,86 @@
853
709
  }
854
710
  }
855
711
  },
856
- "components": {},
712
+ "components": {
713
+ "parameters": {
714
+ "EntityIdPathParam": {
715
+ "name": "id",
716
+ "in": "path",
717
+ "required": true
718
+ },
719
+ "EntitySlugPathParam": {
720
+ "name": "slug",
721
+ "in": "path",
722
+ "required": true
723
+ },
724
+ "TaxonomySlugQueryParam": {
725
+ "name": "taxonomySlug",
726
+ "in": "query",
727
+ "required": true
728
+ },
729
+ "TaxonomySlugPathParam": {
730
+ "name": "taxonomySlug",
731
+ "in": "path",
732
+ "required": true
733
+ },
734
+ "SavedViewIdPathParam": {
735
+ "name": "id",
736
+ "in": "path",
737
+ "required": true
738
+ },
739
+ "AsyncOperationQueryParam": {
740
+ "name": "async",
741
+ "in": "query",
742
+ "required": false
743
+ },
744
+ "HydrateEntitiesQueryParam": {
745
+ "name": "hydrate",
746
+ "in": "query"
747
+ },
748
+ "ActivityIdQueryParam": {
749
+ "name": "activity_id",
750
+ "in": "query",
751
+ "required": false
752
+ },
753
+ "ActivityIdPathParam": {
754
+ "name": "id",
755
+ "in": "path",
756
+ "required": true
757
+ },
758
+ "FromPageQueryParam": {
759
+ "name": "from",
760
+ "in": "query"
761
+ },
762
+ "IncludeReverseQueryParam": {
763
+ "name": "include_reverse",
764
+ "in": "query"
765
+ },
766
+ "IncludeSchemasQueryParam": {
767
+ "name": "include_schemas",
768
+ "in": "query",
769
+ "required": false,
770
+ "style": "form",
771
+ "explode": false
772
+ },
773
+ "ExcludeSchemasQueryParam": {
774
+ "name": "exclude_schemas",
775
+ "in": "query",
776
+ "required": false,
777
+ "style": "form",
778
+ "explode": false
779
+ },
780
+ "EntityRelationsModeQueryParam": {
781
+ "name": "mode",
782
+ "in": "query",
783
+ "required": false
784
+ },
785
+ "DryRunQueryParam": {
786
+ "name": "dry_run",
787
+ "in": "query",
788
+ "required": false
789
+ }
790
+ }
791
+ },
857
792
  "servers": [
858
793
  {
859
794
  "url": "https://entity.sls.epilot.io"