@epilot/entity-client 6.11.0-rc.1 → 6.11.0-rc.3
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 +12 -12
- package/dist/openapi.d.ts +114 -82
- package/dist/openapi.json +86 -65
- package/package.json +1 -1
package/dist/definition.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
(()=>{"use strict";var e={390:function(e,t,a){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var n=r(a(466));t.default=n.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.0.2","info":{"title":"","version":""},"paths":{"/v1/entity/schemas":{"get":{"operationId":"listSchemas","parameters":[{"in":"query","name":"unpublished"}],"responses":{}}},"/v1/entity/schemas/{slug}":{"get":{"operationId":"getSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"id"}],"responses":{}},"put":{"operationId":"putSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"draft"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}],"responses":{}}},"/v1/entity/schemas/{slug}/json/schema":{"get":{"operationId":"getJsonSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"dereference"}],"responses":{}}},"/v1/entity/schemas/{slug}/json/example":{"get":{"operationId":"getSchemaExample","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}],"responses":{}}},"/v1/entity/schemas/{slug}/versions":{"get":{"operationId":"getSchemaVersions","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"versions_from"},{"in":"query","name":"versions_size"},{"in":"query","name":"drafts_from"},{"in":"query","name":"drafts_size"},{"in":"query","name":"fields","required":false,"style":"form","explode":false}],"responses":{}}},"/v1/entity/schemas/{slug}/capabilities/available":{"get":{"operationId":"listAvailableCapabilities","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}],"responses":{}}},"/v1/entity/schemas/blueprints":{"get":{"operationId":"listSchemaBlueprints","responses":{}}},"/v1/entity:search":{"post":{"operationId":"searchEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity:list":{"post":{"operationId":"listEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}":{"post":{"operationId":"createEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}:validate":{"post":{"operationId":"validateEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathPriceParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}:validate":{"post":{"operationId":"validateEntityV2","parameters":[{"$ref":"#/components/parameters/EntitySlugPathPriceParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}:upsert":{"patch":{"operationId":"upsertEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"},{"name":"strict","in":"query","required":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}/{id}":{"get":{"operationId":"getEntityV2","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"in":"query","name":"fields","style":"form","explode":false}],"responses":{}}},"/v1/entity/{slug}/{id}:restore":{"patch":{"operationId":"restoreEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}/{id}:reindex":{"post":{"operationId":"reindexEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}/{id}":{"get":{"operationId":"getEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"}],"responses":{}},"put":{"operationId":"updateEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"patch":{"operationId":"patchEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{}},"delete":{"operationId":"deleteEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"in":"query","name":"purge"}],"responses":{}}},"/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"}],"responses":{}}},"/v1/entity:wipeAllEntities":{"post":{"operationId":"wipeAllEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/activity":{"post":{"operationId":"createActivity","parameters":[{"in":"query","name":"entities","style":"form","explode":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/activity/{id}":{"get":{"operationId":"getActivity","parameters":[{"$ref":"#/components/parameters/ActivityIdPathParam"},{"in":"query","name":"operations_size"},{"in":"query","name":"operations_from"}],"responses":{}}},"/v1/entity/activity/{id}:attach":{"post":{"operationId":"attachActivity","parameters":[{"$ref":"#/components/parameters/ActivityIdPathParam"},{"in":"query","name":"entities","style":"form","explode":false}],"responses":{}}},"/v1/entity/{slug}/{id}/activity":{"get":{"operationId":"getEntityActivityFeed","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"query","name":"after"},{"in":"query","name":"before"},{"in":"query","name":"start_date"},{"in":"query","name":"end_date"},{"in":"query","name":"preset_range"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size"},{"in":"query","name":"type"},{"in":"query","name":"include_relations"},{"in":"query","name":"exclude_activity_groups"}],"responses":{}}},"/v1/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"$ref":"#/components/parameters/IncludeReverseQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size","required":false},{"$ref":"#/components/parameters/IncludeSchemasQueryParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"}],"responses":{}},"post":{"operationId":"addRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"removeRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelationsV2","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"in":"query","name":"query"},{"$ref":"#/components/parameters/IncludeReverseQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size"},{"in":"query","name":"fields"}],"responses":{}}},"/v3/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelationsV3","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"$ref":"#/components/parameters/IncludeReverseDeprecatedQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size","required":false},{"$ref":"#/components/parameters/IncludeSchemasQueryParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"},{"$ref":"#/components/parameters/EntityRelationsModeQueryParam"},{"in":"query","name":"fields"}],"responses":{}}},"/v2/entity/{slug}/{id}/relations/count":{"get":{"operationId":"getRelatedEntitiesCount","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"}],"responses":{}}},"/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}":{"put":{"operationId":"updateRelation","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"path","name":"attribute","required":true},{"in":"path","name":"entity_id","required":true},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteRelation","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"path","name":"attribute","required":true},{"in":"path","name":"entity_id","required":true},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"responses":{}}},"/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":{}}},"responses":{}}},"/v1/entity:import":{"post":{"operationId":"importEntities","parameters":[{"in":"query","name":"job_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity:graph":{"post":{"operationId":"traverseEntityGraph","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/entity/views":{"get":{"operationId":"listSavedViews","parameters":[{"in":"query","name":"slug","required":false},{"in":"query","name":"sort","required":false},{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false},{"in":"query","name":"fields","required":false}],"responses":{}}},"/v1/entity/view":{"post":{"operationId":"createSavedView","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/view/{id}":{"get":{"operationId":"getSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"responses":{}},"put":{"operationId":"updateSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"patch":{"operationId":"patchSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"responses":{}}},"/v1/entity/views/favorites":{"get":{"operationId":"listFavoriteViewsForUser","responses":{}}},"/v1/entity/taxonomies":{"get":{"operationId":"listTaxonomies","parameters":[{"in":"query","name":"include_disabled"},{"in":"query","name":"type"}],"responses":{}},"post":{"operationId":"createTaxonomy","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/taxonomies/{taxonomySlug}":{"get":{"operationId":"getTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"responses":{}},"put":{"operationId":"updateTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"permanent","default":false}],"responses":{}}},"/v1/entity/taxonomies/{taxonomySlug}/classifications":{"post":{"operationId":"updateClassificationsForTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/taxonomies/classifications":{"post":{"operationId":"createTaxonomyClassification","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/taxonomies/classifications/{classificationSlug}":{"get":{"operationId":"getTaxonomyClassification","parameters":[{"$ref":"#/components/parameters/TaxonomyClassificationSlugPathParam"}],"responses":{}},"put":{"operationId":"updateTaxonomyClassification","parameters":[{"$ref":"#/components/parameters/TaxonomyClassificationSlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteTaxonomyClassification","parameters":[{"$ref":"#/components/parameters/TaxonomyClassificationSlugPathParam"}],"responses":{}}},"/v1/entity/taxonomies/{taxonomySlug}:autocomplete":{"get":{"operationId":"taxonomyAutocomplete","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"query"},{"in":"query","name":"size"}],"responses":{}}},"/v1/entity/taxonomies/classifications:search":{"post":{"operationId":"taxonomiesClassificationsSearch","parameters":[{"in":"query","name":"taxonomySlug"},{"in":"query","name":"query"},{"in":"query","name":"archived","deprecated":true},{"in":"query","name":"include_archived"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/{slug}/taxonomy/{taxonomySlug}":{"get":{"operationId":"listTaxonomyClassificationsForSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"query"},{"in":"query","name":"size"}],"responses":{}}},"/v1/entity/taxonomies/bulk-jobs":{"get":{"operationId":"getTaxonomyBulkActionJobs","parameters":[{"in":"query","name":"status"},{"in":"query","name":"size"},{"in":"query","name":"created_after"},{"in":"query","name":"sort_pending_first"},{"in":"query","name":"scope"}],"responses":{}}},"/v1/entity/taxonomies/bulk-jobs/{job_id}":{"get":{"operationId":"getTaxonomyBulkActionJobById","parameters":[{"in":"path","name":"job_id","required":true}],"responses":{}}},"/v1/entity/taxonomies/bulk-jobs/{job_id}/cancel":{"post":{"operationId":"cancelBulkAction","parameters":[{"name":"job_id","in":"path","required":true}],"responses":{}}},"/v1/entity/taxonomies/classifications:move":{"post":{"operationId":"bulkMoveClassifications","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/taxonomies/classifications:merge":{"post":{"operationId":"bulkMergeClassifications","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/taxonomies/classifications:delete":{"post":{"operationId":"bulkDeleteClassifications","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/attributes":{"post":{"operationId":"createSchemaAttribute","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/attributes/{composite_id}":{"get":{"operationId":"getSchemaAttribute","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putSchemaAttribute","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchemaAttribute","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}}},"/v1/entity/schemas/capabilities":{"post":{"operationId":"createSchemaCapability","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/capabilities/{composite_id}":{"get":{"operationId":"getSchemaCapability","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putSchemaCapability","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchemaCapability","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}}},"/v1/entity/schemas/group":{"post":{"operationId":"createSchemaGroup","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/group/{composite_id}":{"get":{"operationId":"getSchemaGroup","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putSchemaGroup","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchemaGroup","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}}},"/v1/entity/schemas/headline":{"post":{"operationId":"createSchemaGroupHeadline","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/headline/{composite_id}":{"get":{"operationId":"getSchemaGroupHeadline","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putSchemaGroupHeadline","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchemaGroupHeadline","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}}}},"components":{"parameters":{"EntityIdPathParam":{"name":"id","in":"path","required":true},"EntitySlugPathParam":{"name":"slug","in":"path","required":true},"EntitySlugPathPriceParam":{"name":"slug","in":"path","required":true},"TaxonomySlugQueryParam":{"name":"taxonomySlug","in":"query","required":true},"TaxonomySlugPathParam":{"name":"taxonomySlug","in":"path","required":true},"TaxonomySlugQueryParamOptional":{"name":"taxonomySlug","in":"query"},"TaxonomyClassificationSlugPathParam":{"name":"classificationSlug","in":"path","required":true},"SavedViewIdPathParam":{"name":"id","in":"path","required":true},"AsyncOperationQueryParam":{"name":"async","in":"query","required":false},"HydrateEntitiesQueryParam":{"name":"hydrate","in":"query"},"ActivityIdQueryParam":{"name":"activity_id","in":"query","required":false},"ActivityIdPathParam":{"name":"id","in":"path","required":true},"FromPageQueryParam":{"name":"from","in":"query"},"IncludeReverseDeprecatedQueryParam":{"name":"include_reverse","in":"query","deprecated":true},"IncludeReverseQueryParam":{"name":"include_reverse","in":"query"},"IncludeSchemasQueryParam":{"name":"include_schemas","in":"query","required":false,"style":"form","explode":false},"ExcludeSchemasQueryParam":{"name":"exclude_schemas","in":"query","required":false,"style":"form","explode":false},"EntityRelationsModeQueryParam":{"name":"mode","in":"query","required":false},"DryRunQueryParam":{"name":"dry_run","in":"query","required":false},"FillActivityQueryParam":{"name":"fill_activity","in":"query","required":false},"ValidateEntityQueryParam":{"name":"validate","in":"query"}},"responses":{"BadRequestError":{"content":{"application/json":{}}},"NotFoundError":{"content":{"application/json":{}}},"TooManyRequestsError":{"headers":{"Retry-After":{}},"content":{"application/json":{}}}}},"servers":[{"url":"https://entity.sls.epilot.io"}]}')}},t={},a=function a(r){var n=t[r];if(void 0!==n)return n.exports;var s=t[r]={exports:{}};return e[r].call(s.exports,s,s.exports,a),s.exports}(390),r=exports;for(var n in a)r[n]=a[n];a.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();
|
|
1
|
+
(()=>{"use strict";var e={390:function(e,t,a){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var n=r(a(466));t.default=n.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.0.2","info":{"title":"","version":""},"paths":{"/v1/entity/schemas":{"get":{"operationId":"listSchemas","parameters":[{"in":"query","name":"unpublished"}],"responses":{}}},"/v1/entity/schemas/{slug}":{"get":{"operationId":"getSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"id"}],"responses":{}},"put":{"operationId":"putSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"draft"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}],"responses":{}}},"/v1/entity/schemas/{slug}/json/schema":{"get":{"operationId":"getJsonSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"dereference"}],"responses":{}}},"/v1/entity/schemas/{slug}/json/example":{"get":{"operationId":"getSchemaExample","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}],"responses":{}}},"/v1/entity/schemas/{slug}/versions":{"get":{"operationId":"getSchemaVersions","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"versions_from"},{"in":"query","name":"versions_size"},{"in":"query","name":"drafts_from"},{"in":"query","name":"drafts_size"},{"in":"query","name":"fields","required":false,"style":"form","explode":false}],"responses":{}}},"/v1/entity/schemas/{slug}/capabilities/available":{"get":{"operationId":"listAvailableCapabilities","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}],"responses":{}}},"/v1/entity/schemas/blueprints":{"get":{"operationId":"listSchemaBlueprints","responses":{}}},"/v1/entity:search":{"post":{"operationId":"searchEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity:list":{"post":{"operationId":"listEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity:graph":{"post":{"operationId":"queryEntityGraph","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}":{"post":{"operationId":"createEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}:validate":{"post":{"operationId":"validateEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathPriceParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}:validate":{"post":{"operationId":"validateEntityV2","parameters":[{"$ref":"#/components/parameters/EntitySlugPathPriceParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}:upsert":{"patch":{"operationId":"upsertEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"},{"name":"strict","in":"query","required":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}/{id}":{"get":{"operationId":"getEntityV2","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"in":"query","name":"fields","style":"form","explode":false}],"responses":{}}},"/v1/entity/{slug}/{id}:restore":{"patch":{"operationId":"restoreEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}/{id}:reindex":{"post":{"operationId":"reindexEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}/{id}":{"get":{"operationId":"getEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"}],"responses":{}},"put":{"operationId":"updateEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"patch":{"operationId":"patchEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{}},"delete":{"operationId":"deleteEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"in":"query","name":"purge"}],"responses":{}}},"/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"}],"responses":{}}},"/v1/entity:wipeAllEntities":{"post":{"operationId":"wipeAllEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/activity":{"post":{"operationId":"createActivity","parameters":[{"in":"query","name":"entities","style":"form","explode":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/activity/{id}":{"get":{"operationId":"getActivity","parameters":[{"$ref":"#/components/parameters/ActivityIdPathParam"},{"in":"query","name":"operations_size"},{"in":"query","name":"operations_from"}],"responses":{}}},"/v1/entity/activity/{id}:attach":{"post":{"operationId":"attachActivity","parameters":[{"$ref":"#/components/parameters/ActivityIdPathParam"},{"in":"query","name":"entities","style":"form","explode":false}],"responses":{}}},"/v1/entity/{slug}/{id}/activity":{"get":{"operationId":"getEntityActivityFeed","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"query","name":"after"},{"in":"query","name":"before"},{"in":"query","name":"start_date"},{"in":"query","name":"end_date"},{"in":"query","name":"preset_range"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size"},{"in":"query","name":"type"},{"in":"query","name":"include_relations"},{"in":"query","name":"exclude_activity_groups"}],"responses":{}}},"/v1/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"$ref":"#/components/parameters/IncludeReverseQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size","required":false},{"$ref":"#/components/parameters/IncludeSchemasQueryParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"}],"responses":{}},"post":{"operationId":"addRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"removeRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelationsV2","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"in":"query","name":"query"},{"$ref":"#/components/parameters/IncludeReverseQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size"},{"in":"query","name":"fields"}],"responses":{}}},"/v3/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelationsV3","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"$ref":"#/components/parameters/IncludeReverseDeprecatedQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size","required":false},{"$ref":"#/components/parameters/IncludeSchemasQueryParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"},{"$ref":"#/components/parameters/EntityRelationsModeQueryParam"},{"in":"query","name":"fields"}],"responses":{}}},"/v2/entity/{slug}/{id}/relations/count":{"get":{"operationId":"getRelatedEntitiesCount","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"}],"responses":{}}},"/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}":{"put":{"operationId":"updateRelation","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"path","name":"attribute","required":true},{"in":"path","name":"entity_id","required":true},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteRelation","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"path","name":"attribute","required":true},{"in":"path","name":"entity_id","required":true},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"responses":{}}},"/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":{}}},"responses":{}}},"/v1/entity:import":{"post":{"operationId":"importEntities","parameters":[{"in":"query","name":"job_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/views":{"get":{"operationId":"listSavedViews","parameters":[{"in":"query","name":"slug","required":false},{"in":"query","name":"sort","required":false},{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false},{"in":"query","name":"fields","required":false}],"responses":{}}},"/v1/entity/view":{"post":{"operationId":"createSavedView","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/view/{id}":{"get":{"operationId":"getSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"responses":{}},"put":{"operationId":"updateSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"patch":{"operationId":"patchSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"responses":{}}},"/v1/entity/views/favorites":{"get":{"operationId":"listFavoriteViewsForUser","responses":{}}},"/v1/entity/taxonomies":{"get":{"operationId":"listTaxonomies","parameters":[{"in":"query","name":"include_disabled"},{"in":"query","name":"type"}],"responses":{}},"post":{"operationId":"createTaxonomy","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/taxonomies/{taxonomySlug}":{"get":{"operationId":"getTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"responses":{}},"put":{"operationId":"updateTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"permanent","default":false}],"responses":{}}},"/v1/entity/taxonomies/{taxonomySlug}/classifications":{"post":{"operationId":"updateClassificationsForTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/taxonomies/classifications":{"post":{"operationId":"createTaxonomyClassification","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/taxonomies/classifications/{classificationSlug}":{"get":{"operationId":"getTaxonomyClassification","parameters":[{"$ref":"#/components/parameters/TaxonomyClassificationSlugPathParam"}],"responses":{}},"put":{"operationId":"updateTaxonomyClassification","parameters":[{"$ref":"#/components/parameters/TaxonomyClassificationSlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteTaxonomyClassification","parameters":[{"$ref":"#/components/parameters/TaxonomyClassificationSlugPathParam"}],"responses":{}}},"/v1/entity/taxonomies/{taxonomySlug}:autocomplete":{"get":{"operationId":"taxonomyAutocomplete","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"query"},{"in":"query","name":"size"}],"responses":{}}},"/v1/entity/taxonomies/classifications:search":{"post":{"operationId":"taxonomiesClassificationsSearch","parameters":[{"in":"query","name":"taxonomySlug"},{"in":"query","name":"query"},{"in":"query","name":"archived","deprecated":true},{"in":"query","name":"include_archived"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/{slug}/taxonomy/{taxonomySlug}":{"get":{"operationId":"listTaxonomyClassificationsForSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"query"},{"in":"query","name":"size"}],"responses":{}}},"/v1/entity/taxonomies/bulk-jobs":{"get":{"operationId":"getTaxonomyBulkActionJobs","parameters":[{"in":"query","name":"status"},{"in":"query","name":"size"},{"in":"query","name":"created_after"},{"in":"query","name":"sort_pending_first"},{"in":"query","name":"scope"}],"responses":{}}},"/v1/entity/taxonomies/bulk-jobs/{job_id}":{"get":{"operationId":"getTaxonomyBulkActionJobById","parameters":[{"in":"path","name":"job_id","required":true}],"responses":{}}},"/v1/entity/taxonomies/bulk-jobs/{job_id}/cancel":{"post":{"operationId":"cancelBulkAction","parameters":[{"name":"job_id","in":"path","required":true}],"responses":{}}},"/v1/entity/taxonomies/classifications:move":{"post":{"operationId":"bulkMoveClassifications","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/taxonomies/classifications:merge":{"post":{"operationId":"bulkMergeClassifications","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/taxonomies/classifications:delete":{"post":{"operationId":"bulkDeleteClassifications","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/attributes":{"post":{"operationId":"createSchemaAttribute","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/attributes/{composite_id}":{"get":{"operationId":"getSchemaAttribute","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putSchemaAttribute","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchemaAttribute","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}}},"/v1/entity/schemas/capabilities":{"post":{"operationId":"createSchemaCapability","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/capabilities/{composite_id}":{"get":{"operationId":"getSchemaCapability","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putSchemaCapability","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchemaCapability","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}}},"/v1/entity/schemas/group":{"post":{"operationId":"createSchemaGroup","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/group/{composite_id}":{"get":{"operationId":"getSchemaGroup","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putSchemaGroup","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchemaGroup","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}}},"/v1/entity/schemas/headline":{"post":{"operationId":"createSchemaGroupHeadline","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/headline/{composite_id}":{"get":{"operationId":"getSchemaGroupHeadline","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putSchemaGroupHeadline","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchemaGroupHeadline","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}}}},"components":{"parameters":{"EntityIdPathParam":{"name":"id","in":"path","required":true},"EntitySlugPathParam":{"name":"slug","in":"path","required":true},"EntitySlugPathPriceParam":{"name":"slug","in":"path","required":true},"TaxonomySlugQueryParam":{"name":"taxonomySlug","in":"query","required":true},"TaxonomySlugPathParam":{"name":"taxonomySlug","in":"path","required":true},"TaxonomySlugQueryParamOptional":{"name":"taxonomySlug","in":"query"},"TaxonomyClassificationSlugPathParam":{"name":"classificationSlug","in":"path","required":true},"SavedViewIdPathParam":{"name":"id","in":"path","required":true},"AsyncOperationQueryParam":{"name":"async","in":"query","required":false},"HydrateEntitiesQueryParam":{"name":"hydrate","in":"query"},"ActivityIdQueryParam":{"name":"activity_id","in":"query","required":false},"ActivityIdPathParam":{"name":"id","in":"path","required":true},"FromPageQueryParam":{"name":"from","in":"query"},"IncludeReverseDeprecatedQueryParam":{"name":"include_reverse","in":"query","deprecated":true},"IncludeReverseQueryParam":{"name":"include_reverse","in":"query"},"IncludeSchemasQueryParam":{"name":"include_schemas","in":"query","required":false,"style":"form","explode":false},"ExcludeSchemasQueryParam":{"name":"exclude_schemas","in":"query","required":false,"style":"form","explode":false},"EntityRelationsModeQueryParam":{"name":"mode","in":"query","required":false},"DryRunQueryParam":{"name":"dry_run","in":"query","required":false},"FillActivityQueryParam":{"name":"fill_activity","in":"query","required":false},"ValidateEntityQueryParam":{"name":"validate","in":"query"}},"responses":{"BadRequestError":{"content":{"application/json":{}}},"NotFoundError":{"content":{"application/json":{}}},"TooManyRequestsError":{"headers":{"Retry-After":{}},"content":{"application/json":{}}}}},"servers":[{"url":"https://entity.sls.epilot.io"}]}')}},t={},a=function a(r){var n=t[r];if(void 0!==n)return n.exports;var s=t[r]={exports:{}};return e[r].call(s.exports,s,s.exports,a),s.exports}(390),r=exports;for(var n in a)r[n]=a[n];a.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();
|
|
@@ -158,6 +158,18 @@
|
|
|
158
158
|
"responses": {}
|
|
159
159
|
}
|
|
160
160
|
},
|
|
161
|
+
"/v1/entity:graph": {
|
|
162
|
+
"post": {
|
|
163
|
+
"operationId": "queryEntityGraph",
|
|
164
|
+
"requestBody": {
|
|
165
|
+
"required": true,
|
|
166
|
+
"content": {
|
|
167
|
+
"application/json": {}
|
|
168
|
+
}
|
|
169
|
+
},
|
|
170
|
+
"responses": {}
|
|
171
|
+
}
|
|
172
|
+
},
|
|
161
173
|
"/v1/entity/{slug}": {
|
|
162
174
|
"post": {
|
|
163
175
|
"operationId": "createEntity",
|
|
@@ -838,18 +850,6 @@
|
|
|
838
850
|
"responses": {}
|
|
839
851
|
}
|
|
840
852
|
},
|
|
841
|
-
"/v1/entity:graph": {
|
|
842
|
-
"post": {
|
|
843
|
-
"operationId": "traverseEntityGraph",
|
|
844
|
-
"requestBody": {
|
|
845
|
-
"required": true,
|
|
846
|
-
"content": {
|
|
847
|
-
"application/json": {}
|
|
848
|
-
}
|
|
849
|
-
},
|
|
850
|
-
"responses": {}
|
|
851
|
-
}
|
|
852
|
-
},
|
|
853
853
|
"/v1/entity/views": {
|
|
854
854
|
"get": {
|
|
855
855
|
"operationId": "listSavedViews",
|
package/dist/openapi.d.ts
CHANGED
|
@@ -4583,15 +4583,18 @@ declare namespace Components {
|
|
|
4583
4583
|
* [
|
|
4584
4584
|
* {
|
|
4585
4585
|
* "id": "portal_user",
|
|
4586
|
-
* "schema": "portal_user"
|
|
4586
|
+
* "schema": "portal_user",
|
|
4587
|
+
* "cardinality": "one"
|
|
4587
4588
|
* },
|
|
4588
4589
|
* {
|
|
4589
4590
|
* "id": "contact",
|
|
4590
|
-
* "schema": "contact"
|
|
4591
|
+
* "schema": "contact",
|
|
4592
|
+
* "cardinality": "one"
|
|
4591
4593
|
* },
|
|
4592
4594
|
* {
|
|
4593
|
-
* "id": "
|
|
4594
|
-
* "schema": "
|
|
4595
|
+
* "id": "billing_accounts",
|
|
4596
|
+
* "schema": "billing_account",
|
|
4597
|
+
* "cardinality": "many"
|
|
4595
4598
|
* }
|
|
4596
4599
|
* ]
|
|
4597
4600
|
*/
|
|
@@ -4602,13 +4605,11 @@ declare namespace Components {
|
|
|
4602
4605
|
* [
|
|
4603
4606
|
* {
|
|
4604
4607
|
* "from": "portal_user",
|
|
4605
|
-
* "to": "contact"
|
|
4606
|
-
* "cardinality": "one"
|
|
4608
|
+
* "to": "contact"
|
|
4607
4609
|
* },
|
|
4608
4610
|
* {
|
|
4609
4611
|
* "from": "contact",
|
|
4610
|
-
* "to": "
|
|
4611
|
-
* "cardinality": "many"
|
|
4612
|
+
* "to": "billing_accounts"
|
|
4612
4613
|
* }
|
|
4613
4614
|
* ]
|
|
4614
4615
|
*/
|
|
@@ -4627,15 +4628,6 @@ declare namespace Components {
|
|
|
4627
4628
|
* billing_account
|
|
4628
4629
|
*/
|
|
4629
4630
|
to: string;
|
|
4630
|
-
/**
|
|
4631
|
-
* Cardinality of the relationship:
|
|
4632
|
-
* - "one": Take the first related entity only
|
|
4633
|
-
* - "many": Take all related entities
|
|
4634
|
-
*
|
|
4635
|
-
* example:
|
|
4636
|
-
* one
|
|
4637
|
-
*/
|
|
4638
|
-
cardinality: "one" | "many";
|
|
4639
4631
|
}
|
|
4640
4632
|
export interface GraphNode {
|
|
4641
4633
|
/**
|
|
@@ -4660,6 +4652,22 @@ declare namespace Components {
|
|
|
4660
4652
|
* one
|
|
4661
4653
|
*/
|
|
4662
4654
|
cardinality?: "one" | "many";
|
|
4655
|
+
/**
|
|
4656
|
+
* Optional array of field names to include in the hydrated entity response for this node.
|
|
4657
|
+
* When specified, only the requested fields plus required internal fields (_id, _schema, _org) will be returned.
|
|
4658
|
+
* Only applies when hydrate=true.
|
|
4659
|
+
*
|
|
4660
|
+
* example:
|
|
4661
|
+
* [
|
|
4662
|
+
* "_id",
|
|
4663
|
+
* "_title",
|
|
4664
|
+
* "first_name",
|
|
4665
|
+
* "account",
|
|
4666
|
+
* "!account.*._files",
|
|
4667
|
+
* "**._product"
|
|
4668
|
+
* ]
|
|
4669
|
+
*/
|
|
4670
|
+
fields?: string[];
|
|
4663
4671
|
}
|
|
4664
4672
|
export interface GraphQueryRequest {
|
|
4665
4673
|
seed: GraphSeed;
|
|
@@ -4680,7 +4688,7 @@ declare namespace Components {
|
|
|
4680
4688
|
* "contact": [
|
|
4681
4689
|
* "550e8400-e29b-41d4-a716-446655440002"
|
|
4682
4690
|
* ],
|
|
4683
|
-
* "
|
|
4691
|
+
* "billing_accounts": [
|
|
4684
4692
|
* "550e8400-e29b-41d4-a716-446655440003",
|
|
4685
4693
|
* "550e8400-e29b-41d4-a716-446655440004"
|
|
4686
4694
|
* ]
|
|
@@ -4694,6 +4702,27 @@ declare namespace Components {
|
|
|
4694
4702
|
* The seed node always returns a single Entity object.
|
|
4695
4703
|
* Other nodes return a single Entity object if they contain exactly one entity, or an array of Entity objects if they contain multiple entities.
|
|
4696
4704
|
*
|
|
4705
|
+
* example:
|
|
4706
|
+
* {
|
|
4707
|
+
* "portal_user": {
|
|
4708
|
+
* "_id": "550e8400-e29b-41d4-a716-446655440001",
|
|
4709
|
+
* "_schema": "portal_user"
|
|
4710
|
+
* },
|
|
4711
|
+
* "contact": {
|
|
4712
|
+
* "_id": "550e8400-e29b-41d4-a716-446655440002",
|
|
4713
|
+
* "_schema": "contact"
|
|
4714
|
+
* },
|
|
4715
|
+
* "billing_accounts": [
|
|
4716
|
+
* {
|
|
4717
|
+
* "_id": "550e8400-e29b-41d4-a716-446655440003",
|
|
4718
|
+
* "_schema": "billing_account"
|
|
4719
|
+
* },
|
|
4720
|
+
* {
|
|
4721
|
+
* "_id": "550e8400-e29b-41d4-a716-446655440004",
|
|
4722
|
+
* "_schema": "billing_account"
|
|
4723
|
+
* }
|
|
4724
|
+
* ]
|
|
4725
|
+
* }
|
|
4697
4726
|
*/
|
|
4698
4727
|
entityNodes?: {
|
|
4699
4728
|
[name: string]: /**
|
|
@@ -4774,13 +4803,11 @@ declare namespace Components {
|
|
|
4774
4803
|
* [
|
|
4775
4804
|
* {
|
|
4776
4805
|
* "from": "portal_user",
|
|
4777
|
-
* "to": "contact"
|
|
4778
|
-
* "cardinality": "one"
|
|
4806
|
+
* "to": "contact"
|
|
4779
4807
|
* },
|
|
4780
4808
|
* {
|
|
4781
4809
|
* "from": "contact",
|
|
4782
|
-
* "to": "
|
|
4783
|
-
* "cardinality": "many"
|
|
4810
|
+
* "to": "billing_accounts"
|
|
4784
4811
|
* }
|
|
4785
4812
|
* ]
|
|
4786
4813
|
*/
|
|
@@ -9135,11 +9162,16 @@ declare namespace Components {
|
|
|
9135
9162
|
*/
|
|
9136
9163
|
kind?: "system" | "user_defined";
|
|
9137
9164
|
/**
|
|
9138
|
-
* Type of taxonomy. Whether it classifies
|
|
9165
|
+
* Type of taxonomy. Whether it classifies:
|
|
9166
|
+
* - entity (default)
|
|
9167
|
+
* - relation (for relations)
|
|
9168
|
+
* - system (for system taxonomies - default for all slugs starting with _system_)
|
|
9169
|
+
* - file_collection (for file collections)
|
|
9170
|
+
*
|
|
9139
9171
|
* example:
|
|
9140
9172
|
* entity
|
|
9141
9173
|
*/
|
|
9142
|
-
type?: "entity" | "relation";
|
|
9174
|
+
type?: "entity" | "relation" | "system" | "file_collection";
|
|
9143
9175
|
/**
|
|
9144
9176
|
* Icon name for the taxonomy (from epilot360/icons icon set)
|
|
9145
9177
|
* example:
|
|
@@ -12084,6 +12116,30 @@ declare namespace Paths {
|
|
|
12084
12116
|
export type $200 = /* a readonly computed ID for the entity group headline including schema slug and the headline ID */ Components.Schemas.GroupHeadlineWithCompositeID;
|
|
12085
12117
|
}
|
|
12086
12118
|
}
|
|
12119
|
+
namespace QueryEntityGraph {
|
|
12120
|
+
export type RequestBody = Components.Schemas.GraphQueryRequest;
|
|
12121
|
+
namespace Responses {
|
|
12122
|
+
export type $200 = Components.Schemas.GraphQueryResponse;
|
|
12123
|
+
export type $400 = /**
|
|
12124
|
+
* A generic error returned by the API
|
|
12125
|
+
* example:
|
|
12126
|
+
* {
|
|
12127
|
+
* "status": 400,
|
|
12128
|
+
* "error": "Bad Request"
|
|
12129
|
+
* }
|
|
12130
|
+
*/
|
|
12131
|
+
Components.Responses.BadRequestError;
|
|
12132
|
+
export type $404 = /**
|
|
12133
|
+
* A generic error returned by the API
|
|
12134
|
+
* example:
|
|
12135
|
+
* {
|
|
12136
|
+
* "status": 404,
|
|
12137
|
+
* "error": "Not Found"
|
|
12138
|
+
* }
|
|
12139
|
+
*/
|
|
12140
|
+
Components.Responses.NotFoundError;
|
|
12141
|
+
}
|
|
12142
|
+
}
|
|
12087
12143
|
namespace ReindexEntity {
|
|
12088
12144
|
namespace Parameters {
|
|
12089
12145
|
export type Id = Components.Schemas.EntityId /* uuid */;
|
|
@@ -12401,30 +12457,6 @@ declare namespace Paths {
|
|
|
12401
12457
|
}
|
|
12402
12458
|
}
|
|
12403
12459
|
}
|
|
12404
|
-
namespace TraverseEntityGraph {
|
|
12405
|
-
export type RequestBody = Components.Schemas.GraphQueryRequest;
|
|
12406
|
-
namespace Responses {
|
|
12407
|
-
export type $200 = Components.Schemas.GraphQueryResponse;
|
|
12408
|
-
export type $400 = /**
|
|
12409
|
-
* A generic error returned by the API
|
|
12410
|
-
* example:
|
|
12411
|
-
* {
|
|
12412
|
-
* "status": 400,
|
|
12413
|
-
* "error": "Bad Request"
|
|
12414
|
-
* }
|
|
12415
|
-
*/
|
|
12416
|
-
Components.Responses.BadRequestError;
|
|
12417
|
-
export type $404 = /**
|
|
12418
|
-
* A generic error returned by the API
|
|
12419
|
-
* example:
|
|
12420
|
-
* {
|
|
12421
|
-
* "status": 404,
|
|
12422
|
-
* "error": "Not Found"
|
|
12423
|
-
* }
|
|
12424
|
-
*/
|
|
12425
|
-
Components.Responses.NotFoundError;
|
|
12426
|
-
}
|
|
12427
|
-
}
|
|
12428
12460
|
namespace UpdateClassificationsForTaxonomy {
|
|
12429
12461
|
namespace Parameters {
|
|
12430
12462
|
export type TaxonomySlug = string;
|
|
@@ -13177,6 +13209,22 @@ export interface OperationMethods {
|
|
|
13177
13209
|
data?: Paths.ListEntities.RequestBody,
|
|
13178
13210
|
config?: AxiosRequestConfig
|
|
13179
13211
|
): OperationResponse<Paths.ListEntities.Responses.$200>
|
|
13212
|
+
/**
|
|
13213
|
+
* queryEntityGraph - queryEntityGraph
|
|
13214
|
+
*
|
|
13215
|
+
* Traverse an entity relationship graph starting from a seed entity.
|
|
13216
|
+
*
|
|
13217
|
+
* Define the shape of the graph using nodes (entity schemas) and edges (relationships with cardinality).
|
|
13218
|
+
* The API will traverse the graph bidirectionally and return all discovered entity IDs.
|
|
13219
|
+
*
|
|
13220
|
+
* Example: Find all entities connected to a contact through portal_user -> contact -> billing_account -> files
|
|
13221
|
+
*
|
|
13222
|
+
*/
|
|
13223
|
+
'queryEntityGraph'(
|
|
13224
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
13225
|
+
data?: Paths.QueryEntityGraph.RequestBody,
|
|
13226
|
+
config?: AxiosRequestConfig
|
|
13227
|
+
): OperationResponse<Paths.QueryEntityGraph.Responses.$200>
|
|
13180
13228
|
/**
|
|
13181
13229
|
* createEntity - createEntity
|
|
13182
13230
|
*
|
|
@@ -13643,22 +13691,6 @@ export interface OperationMethods {
|
|
|
13643
13691
|
data?: Paths.ImportEntities.RequestBody,
|
|
13644
13692
|
config?: AxiosRequestConfig
|
|
13645
13693
|
): OperationResponse<Paths.ImportEntities.Responses.$201>
|
|
13646
|
-
/**
|
|
13647
|
-
* traverseEntityGraph - Traverse Entity Graph
|
|
13648
|
-
*
|
|
13649
|
-
* Traverse an entity relationship graph starting from a seed entity.
|
|
13650
|
-
*
|
|
13651
|
-
* Define the shape of the graph using nodes (entity schemas) and edges (relationships with cardinality).
|
|
13652
|
-
* The API will traverse the graph bidirectionally and return all discovered entity IDs.
|
|
13653
|
-
*
|
|
13654
|
-
* Example: Find all entities connected to a contact through portal_user -> contact -> billing_account -> files
|
|
13655
|
-
*
|
|
13656
|
-
*/
|
|
13657
|
-
'traverseEntityGraph'(
|
|
13658
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
13659
|
-
data?: Paths.TraverseEntityGraph.RequestBody,
|
|
13660
|
-
config?: AxiosRequestConfig
|
|
13661
|
-
): OperationResponse<Paths.TraverseEntityGraph.Responses.$200>
|
|
13662
13694
|
/**
|
|
13663
13695
|
* listSavedViews - listSavedViews
|
|
13664
13696
|
*
|
|
@@ -14296,6 +14328,24 @@ export interface PathsDictionary {
|
|
|
14296
14328
|
config?: AxiosRequestConfig
|
|
14297
14329
|
): OperationResponse<Paths.ListEntities.Responses.$200>
|
|
14298
14330
|
}
|
|
14331
|
+
['/v1/entity:graph']: {
|
|
14332
|
+
/**
|
|
14333
|
+
* queryEntityGraph - queryEntityGraph
|
|
14334
|
+
*
|
|
14335
|
+
* Traverse an entity relationship graph starting from a seed entity.
|
|
14336
|
+
*
|
|
14337
|
+
* Define the shape of the graph using nodes (entity schemas) and edges (relationships with cardinality).
|
|
14338
|
+
* The API will traverse the graph bidirectionally and return all discovered entity IDs.
|
|
14339
|
+
*
|
|
14340
|
+
* Example: Find all entities connected to a contact through portal_user -> contact -> billing_account -> files
|
|
14341
|
+
*
|
|
14342
|
+
*/
|
|
14343
|
+
'post'(
|
|
14344
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
14345
|
+
data?: Paths.QueryEntityGraph.RequestBody,
|
|
14346
|
+
config?: AxiosRequestConfig
|
|
14347
|
+
): OperationResponse<Paths.QueryEntityGraph.Responses.$200>
|
|
14348
|
+
}
|
|
14299
14349
|
['/v1/entity/{slug}']: {
|
|
14300
14350
|
/**
|
|
14301
14351
|
* createEntity - createEntity
|
|
@@ -14804,24 +14854,6 @@ export interface PathsDictionary {
|
|
|
14804
14854
|
config?: AxiosRequestConfig
|
|
14805
14855
|
): OperationResponse<Paths.ImportEntities.Responses.$201>
|
|
14806
14856
|
}
|
|
14807
|
-
['/v1/entity:graph']: {
|
|
14808
|
-
/**
|
|
14809
|
-
* traverseEntityGraph - Traverse Entity Graph
|
|
14810
|
-
*
|
|
14811
|
-
* Traverse an entity relationship graph starting from a seed entity.
|
|
14812
|
-
*
|
|
14813
|
-
* Define the shape of the graph using nodes (entity schemas) and edges (relationships with cardinality).
|
|
14814
|
-
* The API will traverse the graph bidirectionally and return all discovered entity IDs.
|
|
14815
|
-
*
|
|
14816
|
-
* Example: Find all entities connected to a contact through portal_user -> contact -> billing_account -> files
|
|
14817
|
-
*
|
|
14818
|
-
*/
|
|
14819
|
-
'post'(
|
|
14820
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
14821
|
-
data?: Paths.TraverseEntityGraph.RequestBody,
|
|
14822
|
-
config?: AxiosRequestConfig
|
|
14823
|
-
): OperationResponse<Paths.TraverseEntityGraph.Responses.$200>
|
|
14824
|
-
}
|
|
14825
14857
|
['/v1/entity/views']: {
|
|
14826
14858
|
/**
|
|
14827
14859
|
* listSavedViews - listSavedViews
|
package/dist/openapi.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"openapi": "3.0.2",
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "Entity API",
|
|
5
|
-
"version": "2.
|
|
5
|
+
"version": "2.2.0",
|
|
6
6
|
"description": "Flexible data layer for epilot Entities.\n\nUse this API configure and access your business objects like Contacts, Opportunities and Products.\n\n[Feature Documentation](https://docs.epilot.io/docs/entities/flexible-entities)\n"
|
|
7
7
|
},
|
|
8
8
|
"tags": [
|
|
@@ -822,6 +822,44 @@
|
|
|
822
822
|
}
|
|
823
823
|
}
|
|
824
824
|
},
|
|
825
|
+
"/v1/entity:graph": {
|
|
826
|
+
"post": {
|
|
827
|
+
"operationId": "queryEntityGraph",
|
|
828
|
+
"summary": "queryEntityGraph",
|
|
829
|
+
"description": "Traverse an entity relationship graph starting from a seed entity.\n\nDefine the shape of the graph using nodes (entity schemas) and edges (relationships with cardinality).\nThe API will traverse the graph bidirectionally and return all discovered entity IDs.\n\nExample: Find all entities connected to a contact through portal_user -> contact -> billing_account -> files\n",
|
|
830
|
+
"tags": [
|
|
831
|
+
"Entities"
|
|
832
|
+
],
|
|
833
|
+
"requestBody": {
|
|
834
|
+
"required": true,
|
|
835
|
+
"content": {
|
|
836
|
+
"application/json": {
|
|
837
|
+
"schema": {
|
|
838
|
+
"$ref": "#/components/schemas/GraphQueryRequest"
|
|
839
|
+
}
|
|
840
|
+
}
|
|
841
|
+
}
|
|
842
|
+
},
|
|
843
|
+
"responses": {
|
|
844
|
+
"200": {
|
|
845
|
+
"description": "Graph traversal result",
|
|
846
|
+
"content": {
|
|
847
|
+
"application/json": {
|
|
848
|
+
"schema": {
|
|
849
|
+
"$ref": "#/components/schemas/GraphQueryResponse"
|
|
850
|
+
}
|
|
851
|
+
}
|
|
852
|
+
}
|
|
853
|
+
},
|
|
854
|
+
"400": {
|
|
855
|
+
"$ref": "#/components/responses/BadRequestError"
|
|
856
|
+
},
|
|
857
|
+
"404": {
|
|
858
|
+
"$ref": "#/components/responses/NotFoundError"
|
|
859
|
+
}
|
|
860
|
+
}
|
|
861
|
+
}
|
|
862
|
+
},
|
|
825
863
|
"/v1/entity/{slug}": {
|
|
826
864
|
"post": {
|
|
827
865
|
"operationId": "createEntity",
|
|
@@ -2523,44 +2561,6 @@
|
|
|
2523
2561
|
}
|
|
2524
2562
|
}
|
|
2525
2563
|
},
|
|
2526
|
-
"/v1/entity:graph": {
|
|
2527
|
-
"post": {
|
|
2528
|
-
"operationId": "traverseEntityGraph",
|
|
2529
|
-
"summary": "Traverse Entity Graph",
|
|
2530
|
-
"description": "Traverse an entity relationship graph starting from a seed entity.\n\nDefine the shape of the graph using nodes (entity schemas) and edges (relationships with cardinality).\nThe API will traverse the graph bidirectionally and return all discovered entity IDs.\n\nExample: Find all entities connected to a contact through portal_user -> contact -> billing_account -> files\n",
|
|
2531
|
-
"tags": [
|
|
2532
|
-
"Relations"
|
|
2533
|
-
],
|
|
2534
|
-
"requestBody": {
|
|
2535
|
-
"required": true,
|
|
2536
|
-
"content": {
|
|
2537
|
-
"application/json": {
|
|
2538
|
-
"schema": {
|
|
2539
|
-
"$ref": "#/components/schemas/GraphQueryRequest"
|
|
2540
|
-
}
|
|
2541
|
-
}
|
|
2542
|
-
}
|
|
2543
|
-
},
|
|
2544
|
-
"responses": {
|
|
2545
|
-
"200": {
|
|
2546
|
-
"description": "Graph traversal result",
|
|
2547
|
-
"content": {
|
|
2548
|
-
"application/json": {
|
|
2549
|
-
"schema": {
|
|
2550
|
-
"$ref": "#/components/schemas/GraphQueryResponse"
|
|
2551
|
-
}
|
|
2552
|
-
}
|
|
2553
|
-
}
|
|
2554
|
-
},
|
|
2555
|
-
"400": {
|
|
2556
|
-
"$ref": "#/components/responses/BadRequestError"
|
|
2557
|
-
},
|
|
2558
|
-
"404": {
|
|
2559
|
-
"$ref": "#/components/responses/NotFoundError"
|
|
2560
|
-
}
|
|
2561
|
-
}
|
|
2562
|
-
}
|
|
2563
|
-
},
|
|
2564
2564
|
"/v1/entity/views": {
|
|
2565
2565
|
"get": {
|
|
2566
2566
|
"operationId": "listSavedViews",
|
|
@@ -7940,15 +7940,18 @@
|
|
|
7940
7940
|
"example": [
|
|
7941
7941
|
{
|
|
7942
7942
|
"id": "portal_user",
|
|
7943
|
-
"schema": "portal_user"
|
|
7943
|
+
"schema": "portal_user",
|
|
7944
|
+
"cardinality": "one"
|
|
7944
7945
|
},
|
|
7945
7946
|
{
|
|
7946
7947
|
"id": "contact",
|
|
7947
|
-
"schema": "contact"
|
|
7948
|
+
"schema": "contact",
|
|
7949
|
+
"cardinality": "one"
|
|
7948
7950
|
},
|
|
7949
7951
|
{
|
|
7950
|
-
"id": "
|
|
7951
|
-
"schema": "
|
|
7952
|
+
"id": "billing_accounts",
|
|
7953
|
+
"schema": "billing_account",
|
|
7954
|
+
"cardinality": "many"
|
|
7952
7955
|
}
|
|
7953
7956
|
]
|
|
7954
7957
|
},
|
|
@@ -7961,13 +7964,11 @@
|
|
|
7961
7964
|
"example": [
|
|
7962
7965
|
{
|
|
7963
7966
|
"from": "portal_user",
|
|
7964
|
-
"to": "contact"
|
|
7965
|
-
"cardinality": "one"
|
|
7967
|
+
"to": "contact"
|
|
7966
7968
|
},
|
|
7967
7969
|
{
|
|
7968
7970
|
"from": "contact",
|
|
7969
|
-
"to": "
|
|
7970
|
-
"cardinality": "many"
|
|
7971
|
+
"to": "billing_accounts"
|
|
7971
7972
|
}
|
|
7972
7973
|
]
|
|
7973
7974
|
}
|
|
@@ -7998,6 +7999,16 @@
|
|
|
7998
7999
|
],
|
|
7999
8000
|
"description": "Optional cardinality for this node when used with hydrate=true:\n- \"one\": Node can only contain one entity, return single Entity object in entityNodes\n- \"many\": Node can contain multiple entities, return array of Entity objects in entityNodes\nIf not specified, defaults to \"many\" (returns array). The seed node always returns a single entity regardless of this setting.\n",
|
|
8000
8001
|
"example": "one"
|
|
8002
|
+
},
|
|
8003
|
+
"fields": {
|
|
8004
|
+
"allOf": [
|
|
8005
|
+
{
|
|
8006
|
+
"$ref": "#/components/schemas/FieldsParam"
|
|
8007
|
+
},
|
|
8008
|
+
{
|
|
8009
|
+
"description": "Optional array of field names to include in the hydrated entity response for this node.\nWhen specified, only the requested fields plus required internal fields (_id, _schema, _org) will be returned.\nOnly applies when hydrate=true.\n"
|
|
8010
|
+
}
|
|
8011
|
+
]
|
|
8001
8012
|
}
|
|
8002
8013
|
}
|
|
8003
8014
|
},
|
|
@@ -8005,8 +8016,7 @@
|
|
|
8005
8016
|
"type": "object",
|
|
8006
8017
|
"required": [
|
|
8007
8018
|
"from",
|
|
8008
|
-
"to"
|
|
8009
|
-
"cardinality"
|
|
8019
|
+
"to"
|
|
8010
8020
|
],
|
|
8011
8021
|
"properties": {
|
|
8012
8022
|
"from": {
|
|
@@ -8018,15 +8028,6 @@
|
|
|
8018
8028
|
"type": "string",
|
|
8019
8029
|
"description": "Target node ID",
|
|
8020
8030
|
"example": "billing_account"
|
|
8021
|
-
},
|
|
8022
|
-
"cardinality": {
|
|
8023
|
-
"type": "string",
|
|
8024
|
-
"enum": [
|
|
8025
|
-
"one",
|
|
8026
|
-
"many"
|
|
8027
|
-
],
|
|
8028
|
-
"description": "Cardinality of the relationship:\n- \"one\": Take the first related entity only\n- \"many\": Take all related entities\n",
|
|
8029
|
-
"example": "one"
|
|
8030
8031
|
}
|
|
8031
8032
|
}
|
|
8032
8033
|
},
|
|
@@ -8049,7 +8050,7 @@
|
|
|
8049
8050
|
"contact": [
|
|
8050
8051
|
"550e8400-e29b-41d4-a716-446655440002"
|
|
8051
8052
|
],
|
|
8052
|
-
"
|
|
8053
|
+
"billing_accounts": [
|
|
8053
8054
|
"550e8400-e29b-41d4-a716-446655440003",
|
|
8054
8055
|
"550e8400-e29b-41d4-a716-446655440004"
|
|
8055
8056
|
]
|
|
@@ -8070,6 +8071,26 @@
|
|
|
8070
8071
|
}
|
|
8071
8072
|
}
|
|
8072
8073
|
]
|
|
8074
|
+
},
|
|
8075
|
+
"example": {
|
|
8076
|
+
"portal_user": {
|
|
8077
|
+
"_id": "550e8400-e29b-41d4-a716-446655440001",
|
|
8078
|
+
"_schema": "portal_user"
|
|
8079
|
+
},
|
|
8080
|
+
"contact": {
|
|
8081
|
+
"_id": "550e8400-e29b-41d4-a716-446655440002",
|
|
8082
|
+
"_schema": "contact"
|
|
8083
|
+
},
|
|
8084
|
+
"billing_accounts": [
|
|
8085
|
+
{
|
|
8086
|
+
"_id": "550e8400-e29b-41d4-a716-446655440003",
|
|
8087
|
+
"_schema": "billing_account"
|
|
8088
|
+
},
|
|
8089
|
+
{
|
|
8090
|
+
"_id": "550e8400-e29b-41d4-a716-446655440004",
|
|
8091
|
+
"_schema": "billing_account"
|
|
8092
|
+
}
|
|
8093
|
+
]
|
|
8073
8094
|
}
|
|
8074
8095
|
},
|
|
8075
8096
|
"edges": {
|
|
@@ -8081,13 +8102,11 @@
|
|
|
8081
8102
|
"example": [
|
|
8082
8103
|
{
|
|
8083
8104
|
"from": "portal_user",
|
|
8084
|
-
"to": "contact"
|
|
8085
|
-
"cardinality": "one"
|
|
8105
|
+
"to": "contact"
|
|
8086
8106
|
},
|
|
8087
8107
|
{
|
|
8088
8108
|
"from": "contact",
|
|
8089
|
-
"to": "
|
|
8090
|
-
"cardinality": "many"
|
|
8109
|
+
"to": "billing_accounts"
|
|
8091
8110
|
}
|
|
8092
8111
|
]
|
|
8093
8112
|
}
|
|
@@ -8609,9 +8628,11 @@
|
|
|
8609
8628
|
"type": "string",
|
|
8610
8629
|
"enum": [
|
|
8611
8630
|
"entity",
|
|
8612
|
-
"relation"
|
|
8631
|
+
"relation",
|
|
8632
|
+
"system",
|
|
8633
|
+
"file_collection"
|
|
8613
8634
|
],
|
|
8614
|
-
"description": "Type of taxonomy. Whether it classifies
|
|
8635
|
+
"description": "Type of taxonomy. Whether it classifies:\n- entity (default)\n- relation (for relations)\n- system (for system taxonomies - default for all slugs starting with _system_)\n- file_collection (for file collections)\n",
|
|
8615
8636
|
"default": "entity",
|
|
8616
8637
|
"example": "entity"
|
|
8617
8638
|
},
|