@epilot/entity-client 4.15.5 → 4.15.6
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.
- package/dist/definition.js +1 -1
- package/dist/openapi-runtime.json +48 -0
- package/dist/openapi.d.ts +74 -0
- package/dist/openapi.json +110 -0
- package/package.json +1 -1
package/dist/definition.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
(()=>{"use strict";var e={914:function(e,t,i){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var a=r(i(240));t.default=a.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.0.2","info":{"title":"","version":""},"paths":{"/v1/entity/schemas":{"get":{"operationId":"listSchemas","parameters":[{"in":"query","name":"unpublished"}]}},"/v1/entity/schemas/{slug}":{"get":{"operationId":"getSchema","parameters":[{"in":"path","name":"slug","required":true},{"in":"query","name":"id"}]},"put":{"operationId":"putSchema","parameters":[{"in":"path","name":"slug","required":true},{"in":"query","name":"draft"}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteSchema","parameters":[{"in":"path","name":"slug","required":true}]}},"/v1/entity/schemas/{slug}/versions":{"get":{"operationId":"getSchemaVersions","parameters":[{"in":"path","name":"slug","required":true},{"in":"query","name":"versions_from"},{"in":"query","name":"versions_size"},{"in":"query","name":"drafts_from"},{"in":"query","name":"drafts_size"}]}},"/v1/entity/schemas/blueprints":{"get":{"operationId":"listSchemaBlueprints"}},"/v1/entity/schemas/{slug}/taxonomy/{taxonomySlug}":{"get":{"operationId":"listTaxonomyClassificationsForSchema","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"taxonomySlug","required":true},{"in":"query","name":"query"},{"in":"query","name":"size"}]}},"/v1/entity:search":{"post":{"operationId":"searchEntities","requestBody":{"content":{"application/json":{}}}}},"/v1/entity/{slug}":{"post":{"operationId":"createEntity","parameters":[{"in":"path","name":"slug","required":true},{"in":"query","name":"activity_id","required":false},{"in":"query","name":"async","required":false}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/{slug}:upsert":{"patch":{"operationId":"upsertEntity","parameters":[{"in":"path","name":"slug","required":true},{"in":"query","name":"activity_id","required":false},{"in":"query","name":"dry_run","required":false},{"in":"query","name":"async","required":false}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/{slug}/{id}":{"get":{"operationId":"getEntity","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"hydrate"}]},"put":{"operationId":"updateEntity","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"activity_id","required":false},{"in":"query","name":"async","required":false}],"requestBody":{"content":{"application/json":{}}}},"patch":{"operationId":"patchEntity","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"activity_id","required":false},{"in":"query","name":"dry_run","required":false},{"in":"query","name":"async","required":false}],"requestBody":{"content":{"application/json":{}},"required":true}},"delete":{"operationId":"deleteEntity","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"activity_id","required":false}]}},"/v1/entity:autocomplete":{"get":{"operationId":"autocomplete","parameters":[{"name":"input","in":"query"},{"name":"attribute","in":"query","required":true},{"name":"slug","in":"query"},{"name":"size","in":"query"}]}},"/v1/entity/activity":{"post":{"operationId":"createActivity","parameters":[{"in":"query","name":"entities","style":"form","explode":false}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/activity/{id}":{"get":{"operationId":"getActivity","parameters":[{"in":"path","name":"id","required":true},{"in":"query","name":"operations_size"},{"in":"query","name":"operations_from"}]}},"/v1/entity/activity/{id}:attach":{"post":{"operationId":"attachActivity","parameters":[{"in":"path","name":"id","required":true},{"in":"query","name":"entities","style":"form","explode":false}]}},"/v1/entity/{slug}/{id}/activity":{"get":{"operationId":"getEntityActivityFeed","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"after"},{"in":"query","name":"before"},{"in":"query","name":"from"},{"in":"query","name":"size"},{"in":"query","name":"type"},{"in":"query","name":"include_relations"}]}},"/v1/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelations","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"hydrate"},{"in":"query","name":"include_reverse"},{"in":"query","name":"from"},{"in":"query","name":"size","required":false},{"in":"query","name":"include_schemas","required":false,"style":"form","explode":false},{"in":"query","name":"exclude_schemas","required":false,"style":"form","explode":false}]},"post":{"operationId":"addRelations","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"async","required":false},{"in":"query","name":"activity_id","required":false}],"requestBody":{"content":{"application/json":{}}}}},"/v2/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelationsV2","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"hydrate"},{"in":"query","name":"query"},{"in":"query","name":"include_reverse"},{"in":"query","name":"from"},{"in":"query","name":"size"},{"in":"query","name":"fields"}]}},"/v2/entity/{slug}/{id}/relations/count":{"get":{"operationId":"getRelatedEntitiesCount","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"exclude_schemas","required":false,"style":"form","explode":false}]}},"/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}":{"put":{"operationId":"updateRelation","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"path","name":"attribute","required":true},{"in":"path","name":"entity_id","required":true},{"in":"query","name":"async","required":false},{"in":"query","name":"activity_id","required":false}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteRelation","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"path","name":"attribute","required":true},{"in":"path","name":"entity_id","required":true},{"in":"query","name":"async","required":false},{"in":"query","name":"activity_id","required":false}]}},"/v1/entity:export":{"post":{"operationId":"exportEntities","parameters":[{"in":"query","name":"job_id"},{"in":"query","name":"is_template"},{"in":"query","name":"language"}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity:import":{"post":{"operationId":"importEntities","parameters":[{"in":"query","name":"job_id"}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/views":{"get":{"operationId":"listSavedViews"}},"/v1/entity/view":{"post":{"operationId":"createSavedView","requestBody":{"content":{"application/json":{}}}}},"/v1/entity/view/{id}":{"get":{"operationId":"getSavedView","parameters":[{"in":"path","name":"id","required":true}]},"put":{"operationId":"updateSavedView","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteSavedView","parameters":[{"in":"path","name":"id","required":true}]}},"/v1/entity/views/favorites":{"get":{"operationId":"listFavoriteViewsForUser"}},"/v1/entity/listTaxonomies":{"get":{"operationId":"listTaxonomies"}},"/v1/entity/taxonomies/{taxonomySlug}":{"get":{"operationId":"getTaxonomy","parameters":[{"in":"path","name":"taxonomySlug","required":true}]}},"/v1/entity/taxonomies/{taxonomySlug}:autocomplete":{"get":{"operationId":"taxonomyAutocomplete","parameters":[{"in":"path","name":"taxonomySlug","required":true},{"in":"query","name":"query"},{"in":"query","name":"size"}]}},"/v1/entity/taxonomies/classifications:search":{"post":{"operationId":"taxonomiesClassificationsSearch","parameters":[{"in":"query","name":"taxonomySlug","required":true}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/taxonomies/{taxonomySlug}/classifications":{"post":{"operationId":"updateClassificationsForTaxonomy","parameters":[{"in":"path","name":"taxonomySlug","required":true}],"requestBody":{"content":{"application/json":{}}}}}},"components":{},"servers":[{"url":"https://entity.sls.epilot.io"}]}')}},t={},i=function i(r){var a=t[r];if(void 0!==a)return a.exports;var n=t[r]={exports:{}};return e[r].call(n.exports,n,n.exports,i),n.exports}(914),r=exports;for(var a in i)r[a]=i[a];i.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();
|
|
1
|
+
(()=>{"use strict";var e={914:function(e,t,i){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var a=r(i(240));t.default=a.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.0.2","info":{"title":"","version":""},"paths":{"/v1/entity/schemas":{"get":{"operationId":"listSchemas","parameters":[{"in":"query","name":"unpublished"}]}},"/v1/entity/schemas/{slug}":{"get":{"operationId":"getSchema","parameters":[{"in":"path","name":"slug","required":true},{"in":"query","name":"id"}]},"put":{"operationId":"putSchema","parameters":[{"in":"path","name":"slug","required":true},{"in":"query","name":"draft"}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteSchema","parameters":[{"in":"path","name":"slug","required":true}]}},"/v1/entity/schemas/{slug}/versions":{"get":{"operationId":"getSchemaVersions","parameters":[{"in":"path","name":"slug","required":true},{"in":"query","name":"versions_from"},{"in":"query","name":"versions_size"},{"in":"query","name":"drafts_from"},{"in":"query","name":"drafts_size"}]}},"/v1/entity/schemas/blueprints":{"get":{"operationId":"listSchemaBlueprints"}},"/v1/entity/schemas/{slug}/taxonomy/{taxonomySlug}":{"get":{"operationId":"listTaxonomyClassificationsForSchema","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"taxonomySlug","required":true},{"in":"query","name":"query"},{"in":"query","name":"size"}]}},"/v1/entity:search":{"post":{"operationId":"searchEntities","requestBody":{"content":{"application/json":{}}}}},"/v1/entity/{slug}":{"post":{"operationId":"createEntity","parameters":[{"in":"path","name":"slug","required":true},{"in":"query","name":"activity_id","required":false},{"in":"query","name":"async","required":false}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/{slug}:upsert":{"patch":{"operationId":"upsertEntity","parameters":[{"in":"path","name":"slug","required":true},{"in":"query","name":"activity_id","required":false},{"in":"query","name":"dry_run","required":false},{"in":"query","name":"async","required":false}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/{slug}/{id}":{"get":{"operationId":"getEntity","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"hydrate"}]},"put":{"operationId":"updateEntity","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"activity_id","required":false},{"in":"query","name":"async","required":false}],"requestBody":{"content":{"application/json":{}}}},"patch":{"operationId":"patchEntity","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"activity_id","required":false},{"in":"query","name":"dry_run","required":false},{"in":"query","name":"async","required":false}],"requestBody":{"content":{"application/json":{}},"required":true}},"delete":{"operationId":"deleteEntity","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"activity_id","required":false}]}},"/v1/entity:autocomplete":{"get":{"operationId":"autocomplete","parameters":[{"name":"input","in":"query"},{"name":"attribute","in":"query","required":true},{"name":"slug","in":"query"},{"name":"size","in":"query"}]}},"/v1/entity/activity":{"post":{"operationId":"createActivity","parameters":[{"in":"query","name":"entities","style":"form","explode":false}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/activity/{id}":{"get":{"operationId":"getActivity","parameters":[{"in":"path","name":"id","required":true},{"in":"query","name":"operations_size"},{"in":"query","name":"operations_from"}]}},"/v1/entity/activity/{id}:attach":{"post":{"operationId":"attachActivity","parameters":[{"in":"path","name":"id","required":true},{"in":"query","name":"entities","style":"form","explode":false}]}},"/v1/entity/{slug}/{id}/activity":{"get":{"operationId":"getEntityActivityFeed","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"after"},{"in":"query","name":"before"},{"in":"query","name":"from"},{"in":"query","name":"size"},{"in":"query","name":"type"},{"in":"query","name":"include_relations"}]}},"/v1/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelations","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"hydrate"},{"in":"query","name":"include_reverse"},{"in":"query","name":"from"},{"in":"query","name":"size","required":false},{"in":"query","name":"include_schemas","required":false,"style":"form","explode":false},{"in":"query","name":"exclude_schemas","required":false,"style":"form","explode":false}]},"post":{"operationId":"addRelations","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"async","required":false},{"in":"query","name":"activity_id","required":false}],"requestBody":{"content":{"application/json":{}}}}},"/v2/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelationsV2","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"hydrate"},{"in":"query","name":"query"},{"in":"query","name":"include_reverse"},{"in":"query","name":"from"},{"in":"query","name":"size"},{"in":"query","name":"fields"}]}},"/v2/entity/{slug}/{id}/relations/count":{"get":{"operationId":"getRelatedEntitiesCount","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"exclude_schemas","required":false,"style":"form","explode":false}]}},"/v3/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelationsV3","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"hydrate"},{"in":"query","name":"include_reverse"},{"in":"query","name":"from"},{"in":"query","name":"size","required":false},{"in":"query","name":"include_schemas","required":false,"style":"form","explode":false},{"in":"query","name":"exclude_schemas","required":false,"style":"form","explode":false}]}},"/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}":{"put":{"operationId":"updateRelation","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"path","name":"attribute","required":true},{"in":"path","name":"entity_id","required":true},{"in":"query","name":"async","required":false},{"in":"query","name":"activity_id","required":false}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteRelation","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"path","name":"attribute","required":true},{"in":"path","name":"entity_id","required":true},{"in":"query","name":"async","required":false},{"in":"query","name":"activity_id","required":false}]}},"/v1/entity:export":{"post":{"operationId":"exportEntities","parameters":[{"in":"query","name":"job_id"},{"in":"query","name":"is_template"},{"in":"query","name":"language"}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity:import":{"post":{"operationId":"importEntities","parameters":[{"in":"query","name":"job_id"}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/views":{"get":{"operationId":"listSavedViews"}},"/v1/entity/view":{"post":{"operationId":"createSavedView","requestBody":{"content":{"application/json":{}}}}},"/v1/entity/view/{id}":{"get":{"operationId":"getSavedView","parameters":[{"in":"path","name":"id","required":true}]},"put":{"operationId":"updateSavedView","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteSavedView","parameters":[{"in":"path","name":"id","required":true}]}},"/v1/entity/views/favorites":{"get":{"operationId":"listFavoriteViewsForUser"}},"/v1/entity/listTaxonomies":{"get":{"operationId":"listTaxonomies"}},"/v1/entity/taxonomies/{taxonomySlug}":{"get":{"operationId":"getTaxonomy","parameters":[{"in":"path","name":"taxonomySlug","required":true}]}},"/v1/entity/taxonomies/{taxonomySlug}:autocomplete":{"get":{"operationId":"taxonomyAutocomplete","parameters":[{"in":"path","name":"taxonomySlug","required":true},{"in":"query","name":"query"},{"in":"query","name":"size"}]}},"/v1/entity/taxonomies/classifications:search":{"post":{"operationId":"taxonomiesClassificationsSearch","parameters":[{"in":"query","name":"taxonomySlug","required":true}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/taxonomies/{taxonomySlug}/classifications":{"post":{"operationId":"updateClassificationsForTaxonomy","parameters":[{"in":"path","name":"taxonomySlug","required":true}],"requestBody":{"content":{"application/json":{}}}}}},"components":{},"servers":[{"url":"https://entity.sls.epilot.io"}]}')}},t={},i=function i(r){var a=t[r];if(void 0!==a)return a.exports;var n=t[r]={exports:{}};return e[r].call(n.exports,n,n.exports,i),n.exports}(914),r=exports;for(var a in i)r[a]=i[a];i.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();
|
|
@@ -559,6 +559,54 @@
|
|
|
559
559
|
]
|
|
560
560
|
}
|
|
561
561
|
},
|
|
562
|
+
"/v3/entity/{slug}/{id}/relations": {
|
|
563
|
+
"get": {
|
|
564
|
+
"operationId": "getRelationsV3",
|
|
565
|
+
"parameters": [
|
|
566
|
+
{
|
|
567
|
+
"in": "path",
|
|
568
|
+
"name": "slug",
|
|
569
|
+
"required": true
|
|
570
|
+
},
|
|
571
|
+
{
|
|
572
|
+
"in": "path",
|
|
573
|
+
"name": "id",
|
|
574
|
+
"required": true
|
|
575
|
+
},
|
|
576
|
+
{
|
|
577
|
+
"in": "query",
|
|
578
|
+
"name": "hydrate"
|
|
579
|
+
},
|
|
580
|
+
{
|
|
581
|
+
"in": "query",
|
|
582
|
+
"name": "include_reverse"
|
|
583
|
+
},
|
|
584
|
+
{
|
|
585
|
+
"in": "query",
|
|
586
|
+
"name": "from"
|
|
587
|
+
},
|
|
588
|
+
{
|
|
589
|
+
"in": "query",
|
|
590
|
+
"name": "size",
|
|
591
|
+
"required": false
|
|
592
|
+
},
|
|
593
|
+
{
|
|
594
|
+
"in": "query",
|
|
595
|
+
"name": "include_schemas",
|
|
596
|
+
"required": false,
|
|
597
|
+
"style": "form",
|
|
598
|
+
"explode": false
|
|
599
|
+
},
|
|
600
|
+
{
|
|
601
|
+
"in": "query",
|
|
602
|
+
"name": "exclude_schemas",
|
|
603
|
+
"required": false,
|
|
604
|
+
"style": "form",
|
|
605
|
+
"explode": false
|
|
606
|
+
}
|
|
607
|
+
]
|
|
608
|
+
}
|
|
609
|
+
},
|
|
562
610
|
"/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}": {
|
|
563
611
|
"put": {
|
|
564
612
|
"operationId": "updateRelation",
|
package/dist/openapi.d.ts
CHANGED
|
@@ -6492,6 +6492,48 @@ declare namespace Paths {
|
|
|
6492
6492
|
export type $200 = Components.Schemas.GetRelationsRespWithPagination;
|
|
6493
6493
|
}
|
|
6494
6494
|
}
|
|
6495
|
+
namespace GetRelationsV3 {
|
|
6496
|
+
namespace Parameters {
|
|
6497
|
+
export type ExcludeSchemas = /**
|
|
6498
|
+
* URL-friendly identifier for the entity schema
|
|
6499
|
+
* example:
|
|
6500
|
+
* contact
|
|
6501
|
+
*/
|
|
6502
|
+
Components.Schemas.EntitySlug[];
|
|
6503
|
+
export type From = number;
|
|
6504
|
+
export type Hydrate = boolean;
|
|
6505
|
+
export type Id = Components.Schemas.EntityId /* uuid */;
|
|
6506
|
+
export type IncludeReverse = boolean;
|
|
6507
|
+
export type IncludeSchemas = /**
|
|
6508
|
+
* URL-friendly identifier for the entity schema
|
|
6509
|
+
* example:
|
|
6510
|
+
* contact
|
|
6511
|
+
*/
|
|
6512
|
+
Components.Schemas.EntitySlug[];
|
|
6513
|
+
export type Size = number;
|
|
6514
|
+
export type Slug = /**
|
|
6515
|
+
* URL-friendly identifier for the entity schema
|
|
6516
|
+
* example:
|
|
6517
|
+
* contact
|
|
6518
|
+
*/
|
|
6519
|
+
Components.Schemas.EntitySlug;
|
|
6520
|
+
}
|
|
6521
|
+
export interface PathParameters {
|
|
6522
|
+
slug: Parameters.Slug;
|
|
6523
|
+
id: Parameters.Id;
|
|
6524
|
+
}
|
|
6525
|
+
export interface QueryParameters {
|
|
6526
|
+
hydrate?: Parameters.Hydrate;
|
|
6527
|
+
include_reverse?: Parameters.IncludeReverse;
|
|
6528
|
+
from?: Parameters.From;
|
|
6529
|
+
size?: Parameters.Size;
|
|
6530
|
+
include_schemas?: Parameters.IncludeSchemas;
|
|
6531
|
+
exclude_schemas?: Parameters.ExcludeSchemas;
|
|
6532
|
+
}
|
|
6533
|
+
namespace Responses {
|
|
6534
|
+
export type $200 = Components.Schemas.GetRelationsRespWithPagination;
|
|
6535
|
+
}
|
|
6536
|
+
}
|
|
6495
6537
|
namespace GetSavedView {
|
|
6496
6538
|
namespace Parameters {
|
|
6497
6539
|
export type Id = /* Generated uuid for a saved view */ Components.Schemas.SavedViewId /* uuid */;
|
|
@@ -7627,6 +7669,21 @@ export interface OperationMethods {
|
|
|
7627
7669
|
data?: any,
|
|
7628
7670
|
config?: AxiosRequestConfig
|
|
7629
7671
|
): OperationResponse<Paths.GetRelatedEntitiesCount.Responses.$200>
|
|
7672
|
+
/**
|
|
7673
|
+
* getRelationsV3 - getRelationsV3
|
|
7674
|
+
*
|
|
7675
|
+
* Returns 1st level direct relations for an entity with pagination.
|
|
7676
|
+
*
|
|
7677
|
+
* You can control whether to return the full entity or just the relation item with the `?hydrate` query param.
|
|
7678
|
+
*
|
|
7679
|
+
* Reverse relations i.e. entities referring to this entity are included with the `?include_reverse` query param.
|
|
7680
|
+
*
|
|
7681
|
+
*/
|
|
7682
|
+
'getRelationsV3'(
|
|
7683
|
+
parameters?: Parameters<Paths.GetRelationsV3.PathParameters & Paths.GetRelationsV3.QueryParameters> | null,
|
|
7684
|
+
data?: any,
|
|
7685
|
+
config?: AxiosRequestConfig
|
|
7686
|
+
): OperationResponse<Paths.GetRelationsV3.Responses.$200>
|
|
7630
7687
|
/**
|
|
7631
7688
|
* updateRelation - updateRelation
|
|
7632
7689
|
*
|
|
@@ -8283,6 +8340,23 @@ export interface PathsDictionary {
|
|
|
8283
8340
|
config?: AxiosRequestConfig
|
|
8284
8341
|
): OperationResponse<Paths.GetRelatedEntitiesCount.Responses.$200>
|
|
8285
8342
|
}
|
|
8343
|
+
['/v3/entity/{slug}/{id}/relations']: {
|
|
8344
|
+
/**
|
|
8345
|
+
* getRelationsV3 - getRelationsV3
|
|
8346
|
+
*
|
|
8347
|
+
* Returns 1st level direct relations for an entity with pagination.
|
|
8348
|
+
*
|
|
8349
|
+
* You can control whether to return the full entity or just the relation item with the `?hydrate` query param.
|
|
8350
|
+
*
|
|
8351
|
+
* Reverse relations i.e. entities referring to this entity are included with the `?include_reverse` query param.
|
|
8352
|
+
*
|
|
8353
|
+
*/
|
|
8354
|
+
'get'(
|
|
8355
|
+
parameters?: Parameters<Paths.GetRelationsV3.PathParameters & Paths.GetRelationsV3.QueryParameters> | null,
|
|
8356
|
+
data?: any,
|
|
8357
|
+
config?: AxiosRequestConfig
|
|
8358
|
+
): OperationResponse<Paths.GetRelationsV3.Responses.$200>
|
|
8359
|
+
}
|
|
8286
8360
|
['/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}']: {
|
|
8287
8361
|
/**
|
|
8288
8362
|
* updateRelation - updateRelation
|
package/dist/openapi.json
CHANGED
|
@@ -1587,6 +1587,116 @@
|
|
|
1587
1587
|
}
|
|
1588
1588
|
}
|
|
1589
1589
|
},
|
|
1590
|
+
"/v3/entity/{slug}/{id}/relations": {
|
|
1591
|
+
"get": {
|
|
1592
|
+
"operationId": "getRelationsV3",
|
|
1593
|
+
"summary": "getRelationsV3",
|
|
1594
|
+
"description": "Returns 1st level direct relations for an entity with pagination.\n\nYou can control whether to return the full entity or just the relation item with the `?hydrate` query param.\n\nReverse relations i.e. entities referring to this entity are included with the `?include_reverse` query param.\n",
|
|
1595
|
+
"tags": [
|
|
1596
|
+
"Relations"
|
|
1597
|
+
],
|
|
1598
|
+
"parameters": [
|
|
1599
|
+
{
|
|
1600
|
+
"in": "path",
|
|
1601
|
+
"name": "slug",
|
|
1602
|
+
"description": "Entity Type",
|
|
1603
|
+
"required": true,
|
|
1604
|
+
"schema": {
|
|
1605
|
+
"$ref": "#/components/schemas/EntitySlug"
|
|
1606
|
+
}
|
|
1607
|
+
},
|
|
1608
|
+
{
|
|
1609
|
+
"in": "path",
|
|
1610
|
+
"name": "id",
|
|
1611
|
+
"description": "Entity id",
|
|
1612
|
+
"required": true,
|
|
1613
|
+
"schema": {
|
|
1614
|
+
"$ref": "#/components/schemas/EntityId"
|
|
1615
|
+
}
|
|
1616
|
+
},
|
|
1617
|
+
{
|
|
1618
|
+
"in": "query",
|
|
1619
|
+
"name": "hydrate",
|
|
1620
|
+
"description": "When true, expand relation items with full blown entities.",
|
|
1621
|
+
"schema": {
|
|
1622
|
+
"default": false,
|
|
1623
|
+
"type": "boolean"
|
|
1624
|
+
}
|
|
1625
|
+
},
|
|
1626
|
+
{
|
|
1627
|
+
"in": "query",
|
|
1628
|
+
"name": "include_reverse",
|
|
1629
|
+
"description": "When true, includes reverse relations in response (other entities pointing to this entity)",
|
|
1630
|
+
"schema": {
|
|
1631
|
+
"default": false,
|
|
1632
|
+
"type": "boolean"
|
|
1633
|
+
}
|
|
1634
|
+
},
|
|
1635
|
+
{
|
|
1636
|
+
"in": "query",
|
|
1637
|
+
"name": "from",
|
|
1638
|
+
"description": "Starting page number",
|
|
1639
|
+
"schema": {
|
|
1640
|
+
"type": "integer",
|
|
1641
|
+
"minimum": 0,
|
|
1642
|
+
"default": 0
|
|
1643
|
+
}
|
|
1644
|
+
},
|
|
1645
|
+
{
|
|
1646
|
+
"in": "query",
|
|
1647
|
+
"name": "size",
|
|
1648
|
+
"description": "Number of results to return per page",
|
|
1649
|
+
"required": false,
|
|
1650
|
+
"schema": {
|
|
1651
|
+
"type": "integer",
|
|
1652
|
+
"minimum": 1,
|
|
1653
|
+
"maximum": 1000,
|
|
1654
|
+
"default": 100
|
|
1655
|
+
}
|
|
1656
|
+
},
|
|
1657
|
+
{
|
|
1658
|
+
"in": "query",
|
|
1659
|
+
"name": "include_schemas",
|
|
1660
|
+
"description": "Filter results to only include schemas",
|
|
1661
|
+
"required": false,
|
|
1662
|
+
"style": "form",
|
|
1663
|
+
"explode": false,
|
|
1664
|
+
"schema": {
|
|
1665
|
+
"type": "array",
|
|
1666
|
+
"items": {
|
|
1667
|
+
"$ref": "#/components/schemas/EntitySlug"
|
|
1668
|
+
}
|
|
1669
|
+
}
|
|
1670
|
+
},
|
|
1671
|
+
{
|
|
1672
|
+
"in": "query",
|
|
1673
|
+
"name": "exclude_schemas",
|
|
1674
|
+
"description": "Filter results to exclude schemas",
|
|
1675
|
+
"required": false,
|
|
1676
|
+
"style": "form",
|
|
1677
|
+
"explode": false,
|
|
1678
|
+
"schema": {
|
|
1679
|
+
"type": "array",
|
|
1680
|
+
"items": {
|
|
1681
|
+
"$ref": "#/components/schemas/EntitySlug"
|
|
1682
|
+
}
|
|
1683
|
+
}
|
|
1684
|
+
}
|
|
1685
|
+
],
|
|
1686
|
+
"responses": {
|
|
1687
|
+
"200": {
|
|
1688
|
+
"description": "Success",
|
|
1689
|
+
"content": {
|
|
1690
|
+
"application/json": {
|
|
1691
|
+
"schema": {
|
|
1692
|
+
"$ref": "#/components/schemas/GetRelationsRespWithPagination"
|
|
1693
|
+
}
|
|
1694
|
+
}
|
|
1695
|
+
}
|
|
1696
|
+
}
|
|
1697
|
+
}
|
|
1698
|
+
}
|
|
1699
|
+
},
|
|
1590
1700
|
"/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}": {
|
|
1591
1701
|
"put": {
|
|
1592
1702
|
"operationId": "updateRelation",
|