@epilot/entity-client 7.0.0-rc.1 → 7.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1 +1 @@
1
- (()=>{"use strict";var e={438(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"},{"in":"query","name":"exclude","style":"form","explode":false},{"in":"query","name":"include","style":"form","explode":false}],"responses":{}}},"/v2/entity/schemas":{"get":{"operationId":"listSchemasV2","parameters":[{"in":"query","name":"full"},{"in":"query","name":"unpublished"},{"in":"query","name":"exclude","style":"form","explode":false},{"in":"query","name":"include","style":"form","explode":false}],"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","style":"form","explode":false},{"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"},{"in":"query","name":"include_deleted","required":false}],"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"}],"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}(438),r=exports;for(var n in a)r[n]=a[n];a.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();
1
+ (()=>{"use strict";var e={330(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","deprecated":true},{"in":"query","name":"latest"},{"in":"query","name":"exclude","style":"form","explode":false},{"in":"query","name":"include","style":"form","explode":false}],"responses":{}}},"/v2/entity/schemas":{"get":{"operationId":"listSchemasV2","parameters":[{"in":"query","name":"full"},{"in":"query","name":"unpublished","deprecated":true},{"in":"query","name":"latest"},{"in":"query","name":"exclude","style":"form","explode":false},{"in":"query","name":"include","style":"form","explode":false}],"responses":{}}},"/v1/entity/schemas/{slug}":{"get":{"operationId":"getSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"id"},{"in":"query","name":"latest"}],"responses":{}},"put":{"operationId":"putSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"draft","deprecated":true}],"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}/freeze":{"post":{"operationId":"freezeSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/{slug}/unfreeze":{"post":{"operationId":"unfreezeSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}],"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","style":"form","explode":false},{"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"},{"in":"query","name":"include_deleted","required":false}],"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"}],"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":[]}')}},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}(330),r=exports;for(var n in a)r[n]=a[n];a.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();
@@ -11,7 +11,12 @@
11
11
  "parameters": [
12
12
  {
13
13
  "in": "query",
14
- "name": "unpublished"
14
+ "name": "unpublished",
15
+ "deprecated": true
16
+ },
17
+ {
18
+ "in": "query",
19
+ "name": "latest"
15
20
  },
16
21
  {
17
22
  "in": "query",
@@ -39,7 +44,12 @@
39
44
  },
40
45
  {
41
46
  "in": "query",
42
- "name": "unpublished"
47
+ "name": "unpublished",
48
+ "deprecated": true
49
+ },
50
+ {
51
+ "in": "query",
52
+ "name": "latest"
43
53
  },
44
54
  {
45
55
  "in": "query",
@@ -67,6 +77,10 @@
67
77
  {
68
78
  "in": "query",
69
79
  "name": "id"
80
+ },
81
+ {
82
+ "in": "query",
83
+ "name": "latest"
70
84
  }
71
85
  ],
72
86
  "responses": {}
@@ -79,7 +93,8 @@
79
93
  },
80
94
  {
81
95
  "in": "query",
82
- "name": "draft"
96
+ "name": "draft",
97
+ "deprecated": true
83
98
  }
84
99
  ],
85
100
  "requestBody": {
@@ -159,6 +174,33 @@
159
174
  "responses": {}
160
175
  }
161
176
  },
177
+ "/v1/entity/schemas/{slug}/freeze": {
178
+ "post": {
179
+ "operationId": "freezeSchema",
180
+ "parameters": [
181
+ {
182
+ "$ref": "#/components/parameters/EntitySlugPathParam"
183
+ }
184
+ ],
185
+ "requestBody": {
186
+ "content": {
187
+ "application/json": {}
188
+ }
189
+ },
190
+ "responses": {}
191
+ }
192
+ },
193
+ "/v1/entity/schemas/{slug}/unfreeze": {
194
+ "post": {
195
+ "operationId": "unfreezeSchema",
196
+ "parameters": [
197
+ {
198
+ "$ref": "#/components/parameters/EntitySlugPathParam"
199
+ }
200
+ ],
201
+ "responses": {}
202
+ }
203
+ },
162
204
  "/v1/entity/schemas/{slug}/capabilities/available": {
163
205
  "get": {
164
206
  "operationId": "listAvailableCapabilities",
@@ -1610,9 +1652,5 @@
1610
1652
  }
1611
1653
  }
1612
1654
  },
1613
- "servers": [
1614
- {
1615
- "url": "https://entity.sls.epilot.io"
1616
- }
1617
- ]
1655
+ "servers": []
1618
1656
  }
package/dist/openapi.d.ts CHANGED
@@ -3884,6 +3884,14 @@ declare namespace Components {
3884
3884
  id?: string;
3885
3885
  type?: string;
3886
3886
  };
3887
+ /**
3888
+ * Indicates this schema is currently frozen. Present when the returned version is the frozen version.
3889
+ */
3890
+ frozen?: boolean;
3891
+ /**
3892
+ * Indicates this is the latest version of the schema. Both frozen and latest can be true if no changes were made since freezing.
3893
+ */
3894
+ latest?: boolean;
3887
3895
  /**
3888
3896
  * Indicates this is a truncated summary schema (attributes trimmed to summary_attributes only, no capabilities or group_settings)
3889
3897
  */
@@ -11224,6 +11232,37 @@ declare namespace Paths {
11224
11232
  Components.Responses.TooManyRequestsError;
11225
11233
  }
11226
11234
  }
11235
+ namespace FreezeSchema {
11236
+ namespace Parameters {
11237
+ export type Slug = /**
11238
+ * URL-friendly identifier for the entity schema
11239
+ * example:
11240
+ * contact
11241
+ */
11242
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
11243
+ }
11244
+ export interface PathParameters {
11245
+ slug: Parameters.Slug;
11246
+ }
11247
+ export interface RequestBody {
11248
+ /**
11249
+ * Freeze to a specific version ID. Defaults to the current version.
11250
+ */
11251
+ version_id?: /* Generated uuid for schema */ Components.Schemas.SchemaId /* uuid */;
11252
+ }
11253
+ namespace Responses {
11254
+ export type $200 = /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem;
11255
+ export type $404 = /**
11256
+ * A generic error returned by the API
11257
+ * example:
11258
+ * {
11259
+ * "status": 404,
11260
+ * "error": "Not Found"
11261
+ * }
11262
+ */
11263
+ Components.Responses.NotFoundError;
11264
+ }
11265
+ }
11227
11266
  namespace GetActivity {
11228
11267
  namespace Parameters {
11229
11268
  export type Id = /**
@@ -12134,6 +12173,7 @@ declare namespace Paths {
12134
12173
  namespace GetSchema {
12135
12174
  namespace Parameters {
12136
12175
  export type Id = /* Generated uuid for schema */ Components.Schemas.SchemaId /* uuid */;
12176
+ export type Latest = boolean;
12137
12177
  export type Slug = /**
12138
12178
  * URL-friendly identifier for the entity schema
12139
12179
  * example:
@@ -12146,6 +12186,7 @@ declare namespace Paths {
12146
12186
  }
12147
12187
  export interface QueryParameters {
12148
12188
  id?: Parameters.Id;
12189
+ latest?: Parameters.Latest;
12149
12190
  }
12150
12191
  namespace Responses {
12151
12192
  export type $200 = /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem;
@@ -12350,6 +12391,10 @@ declare namespace Paths {
12350
12391
  * Pagination: Whether more drafts are available
12351
12392
  */
12352
12393
  drafts_more?: boolean;
12394
+ /**
12395
+ * The version ID that is currently frozen, if any
12396
+ */
12397
+ frozen_version?: /* Generated uuid for schema */ Components.Schemas.SchemaId /* uuid */;
12353
12398
  }
12354
12399
  }
12355
12400
  }
@@ -12588,10 +12633,12 @@ declare namespace Paths {
12588
12633
  namespace Parameters {
12589
12634
  export type Exclude = string[];
12590
12635
  export type Include = string[];
12636
+ export type Latest = boolean;
12591
12637
  export type Unpublished = boolean;
12592
12638
  }
12593
12639
  export interface QueryParameters {
12594
12640
  unpublished?: Parameters.Unpublished;
12641
+ latest?: Parameters.Latest;
12595
12642
  exclude?: Parameters.Exclude;
12596
12643
  include?: Parameters.Include;
12597
12644
  }
@@ -12606,11 +12653,13 @@ declare namespace Paths {
12606
12653
  export type Exclude = string[];
12607
12654
  export type Full = boolean;
12608
12655
  export type Include = string[];
12656
+ export type Latest = boolean;
12609
12657
  export type Unpublished = boolean;
12610
12658
  }
12611
12659
  export interface QueryParameters {
12612
12660
  full?: Parameters.Full;
12613
12661
  unpublished?: Parameters.Unpublished;
12662
+ latest?: Parameters.Latest;
12614
12663
  exclude?: Parameters.Exclude;
12615
12664
  include?: Parameters.Include;
12616
12665
  }
@@ -13244,6 +13293,31 @@ declare namespace Paths {
13244
13293
  }
13245
13294
  }
13246
13295
  }
13296
+ namespace UnfreezeSchema {
13297
+ namespace Parameters {
13298
+ export type Slug = /**
13299
+ * URL-friendly identifier for the entity schema
13300
+ * example:
13301
+ * contact
13302
+ */
13303
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
13304
+ }
13305
+ export interface PathParameters {
13306
+ slug: Parameters.Slug;
13307
+ }
13308
+ namespace Responses {
13309
+ export type $200 = /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem;
13310
+ export type $404 = /**
13311
+ * A generic error returned by the API
13312
+ * example:
13313
+ * {
13314
+ * "status": 404,
13315
+ * "error": "Not Found"
13316
+ * }
13317
+ */
13318
+ Components.Responses.NotFoundError;
13319
+ }
13320
+ }
13247
13321
  namespace UpdateClassificationsForTaxonomy {
13248
13322
  namespace Parameters {
13249
13323
  export type TaxonomySlug = string;
@@ -13846,7 +13920,10 @@ export interface OperationMethods {
13846
13920
  /**
13847
13921
  * getSchema - getSchema
13848
13922
  *
13849
- * By default gets the latest version of the Schema and to get the specific version of schema pass the id.
13923
+ * By default gets the current version of the Schema (frozen version if frozen, otherwise latest).
13924
+ * Pass ?latest=true to get the latest version when the schema is frozen.
13925
+ * Pass ?id= to get a specific version by ID.
13926
+ *
13850
13927
  */
13851
13928
  'getSchema'(
13852
13929
  parameters?: Parameters<Paths.GetSchema.QueryParameters & Paths.GetSchema.PathParameters> | null,
@@ -13856,7 +13933,9 @@ export interface OperationMethods {
13856
13933
  /**
13857
13934
  * putSchema - putSchema
13858
13935
  *
13859
- * Create or update a schema with a new version
13936
+ * Create or update a schema with a new version.
13937
+ * When the schema is frozen, writes update the latest version without affecting the frozen version.
13938
+ *
13860
13939
  */
13861
13940
  'putSchema'(
13862
13941
  parameters?: Parameters<Paths.PutSchema.QueryParameters & Paths.PutSchema.PathParameters> | null,
@@ -13903,6 +13982,30 @@ export interface OperationMethods {
13903
13982
  data?: any,
13904
13983
  config?: AxiosRequestConfig
13905
13984
  ): OperationResponse<Paths.GetSchemaVersions.Responses.$200>
13985
+ /**
13986
+ * freezeSchema - freezeSchema
13987
+ *
13988
+ * Freeze a schema at its current version, or at a specific version.
13989
+ * When frozen, getSchema returns the frozen version by default.
13990
+ * New edits via putSchema update the latest version without affecting the frozen version.
13991
+ *
13992
+ */
13993
+ 'freezeSchema'(
13994
+ parameters?: Parameters<Paths.FreezeSchema.PathParameters> | null,
13995
+ data?: Paths.FreezeSchema.RequestBody,
13996
+ config?: AxiosRequestConfig
13997
+ ): OperationResponse<Paths.FreezeSchema.Responses.$200>
13998
+ /**
13999
+ * unfreezeSchema - unfreezeSchema
14000
+ *
14001
+ * Unfreeze a schema. Promotes the latest version to the current version for all users.
14002
+ *
14003
+ */
14004
+ 'unfreezeSchema'(
14005
+ parameters?: Parameters<Paths.UnfreezeSchema.PathParameters> | null,
14006
+ data?: any,
14007
+ config?: AxiosRequestConfig
14008
+ ): OperationResponse<Paths.UnfreezeSchema.Responses.$200>
13906
14009
  /**
13907
14010
  * listAvailableCapabilities - listAvailableCapabilities
13908
14011
  *
@@ -14965,7 +15068,10 @@ export interface PathsDictionary {
14965
15068
  /**
14966
15069
  * getSchema - getSchema
14967
15070
  *
14968
- * By default gets the latest version of the Schema and to get the specific version of schema pass the id.
15071
+ * By default gets the current version of the Schema (frozen version if frozen, otherwise latest).
15072
+ * Pass ?latest=true to get the latest version when the schema is frozen.
15073
+ * Pass ?id= to get a specific version by ID.
15074
+ *
14969
15075
  */
14970
15076
  'get'(
14971
15077
  parameters?: Parameters<Paths.GetSchema.QueryParameters & Paths.GetSchema.PathParameters> | null,
@@ -14975,7 +15081,9 @@ export interface PathsDictionary {
14975
15081
  /**
14976
15082
  * putSchema - putSchema
14977
15083
  *
14978
- * Create or update a schema with a new version
15084
+ * Create or update a schema with a new version.
15085
+ * When the schema is frozen, writes update the latest version without affecting the frozen version.
15086
+ *
14979
15087
  */
14980
15088
  'put'(
14981
15089
  parameters?: Parameters<Paths.PutSchema.QueryParameters & Paths.PutSchema.PathParameters> | null,
@@ -15029,6 +15137,34 @@ export interface PathsDictionary {
15029
15137
  config?: AxiosRequestConfig
15030
15138
  ): OperationResponse<Paths.GetSchemaVersions.Responses.$200>
15031
15139
  }
15140
+ ['/v1/entity/schemas/{slug}/freeze']: {
15141
+ /**
15142
+ * freezeSchema - freezeSchema
15143
+ *
15144
+ * Freeze a schema at its current version, or at a specific version.
15145
+ * When frozen, getSchema returns the frozen version by default.
15146
+ * New edits via putSchema update the latest version without affecting the frozen version.
15147
+ *
15148
+ */
15149
+ 'post'(
15150
+ parameters?: Parameters<Paths.FreezeSchema.PathParameters> | null,
15151
+ data?: Paths.FreezeSchema.RequestBody,
15152
+ config?: AxiosRequestConfig
15153
+ ): OperationResponse<Paths.FreezeSchema.Responses.$200>
15154
+ }
15155
+ ['/v1/entity/schemas/{slug}/unfreeze']: {
15156
+ /**
15157
+ * unfreezeSchema - unfreezeSchema
15158
+ *
15159
+ * Unfreeze a schema. Promotes the latest version to the current version for all users.
15160
+ *
15161
+ */
15162
+ 'post'(
15163
+ parameters?: Parameters<Paths.UnfreezeSchema.PathParameters> | null,
15164
+ data?: any,
15165
+ config?: AxiosRequestConfig
15166
+ ): OperationResponse<Paths.UnfreezeSchema.Responses.$200>
15167
+ }
15032
15168
  ['/v1/entity/schemas/{slug}/capabilities/available']: {
15033
15169
  /**
15034
15170
  * listAvailableCapabilities - listAvailableCapabilities
package/dist/openapi.json CHANGED
@@ -66,6 +66,16 @@
66
66
  "in": "query",
67
67
  "name": "unpublished",
68
68
  "description": "Return unpublished draft schemas",
69
+ "deprecated": true,
70
+ "schema": {
71
+ "type": "boolean",
72
+ "default": false
73
+ }
74
+ },
75
+ {
76
+ "in": "query",
77
+ "name": "latest",
78
+ "description": "When true, return the latest version instead of the frozen version for frozen schemas.",
69
79
  "schema": {
70
80
  "type": "boolean",
71
81
  "default": false
@@ -142,6 +152,16 @@
142
152
  "in": "query",
143
153
  "name": "unpublished",
144
154
  "description": "Return unpublished draft schemas",
155
+ "deprecated": true,
156
+ "schema": {
157
+ "type": "boolean",
158
+ "default": false
159
+ }
160
+ },
161
+ {
162
+ "in": "query",
163
+ "name": "latest",
164
+ "description": "When true, return the latest version instead of the frozen version for frozen schemas.",
145
165
  "schema": {
146
166
  "type": "boolean",
147
167
  "default": false
@@ -203,7 +223,7 @@
203
223
  "get": {
204
224
  "operationId": "getSchema",
205
225
  "summary": "getSchema",
206
- "description": "By default gets the latest version of the Schema and to get the specific version of schema pass the id.",
226
+ "description": "By default gets the current version of the Schema (frozen version if frozen, otherwise latest).\nPass ?latest=true to get the latest version when the schema is frozen.\nPass ?id= to get a specific version by ID.\n",
207
227
  "tags": [
208
228
  "Schemas"
209
229
  ],
@@ -217,6 +237,15 @@
217
237
  "schema": {
218
238
  "$ref": "#/components/schemas/SchemaId"
219
239
  }
240
+ },
241
+ {
242
+ "in": "query",
243
+ "name": "latest",
244
+ "description": "When true, return the latest version instead of the frozen version for frozen schemas.",
245
+ "schema": {
246
+ "type": "boolean",
247
+ "default": false
248
+ }
220
249
  }
221
250
  ],
222
251
  "responses": {
@@ -238,7 +267,7 @@
238
267
  "put": {
239
268
  "operationId": "putSchema",
240
269
  "summary": "putSchema",
241
- "description": "Create or update a schema with a new version",
270
+ "description": "Create or update a schema with a new version.\nWhen the schema is frozen, writes update the latest version without affecting the frozen version.\n",
242
271
  "tags": [
243
272
  "Schemas"
244
273
  ],
@@ -249,6 +278,7 @@
249
278
  {
250
279
  "in": "query",
251
280
  "name": "draft",
281
+ "deprecated": true,
252
282
  "schema": {
253
283
  "default": false,
254
284
  "type": "boolean"
@@ -746,6 +776,7 @@
746
776
  }
747
777
  },
748
778
  "drafts": {
779
+ "deprecated": true,
749
780
  "type": "array",
750
781
  "items": {
751
782
  "$ref": "#/components/schemas/EntitySchemaItem"
@@ -756,8 +787,13 @@
756
787
  "type": "boolean"
757
788
  },
758
789
  "drafts_more": {
790
+ "deprecated": true,
759
791
  "description": "Pagination: Whether more drafts are available",
760
792
  "type": "boolean"
793
+ },
794
+ "frozen_version": {
795
+ "description": "The version ID that is currently frozen, if any",
796
+ "$ref": "#/components/schemas/SchemaId"
761
797
  }
762
798
  },
763
799
  "required": [
@@ -771,6 +807,81 @@
771
807
  }
772
808
  }
773
809
  },
810
+ "/v1/entity/schemas/{slug}/freeze": {
811
+ "post": {
812
+ "operationId": "freezeSchema",
813
+ "summary": "freezeSchema",
814
+ "description": "Freeze a schema at its current version, or at a specific version.\nWhen frozen, getSchema returns the frozen version by default.\nNew edits via putSchema update the latest version without affecting the frozen version.\n",
815
+ "tags": [
816
+ "Schemas"
817
+ ],
818
+ "parameters": [
819
+ {
820
+ "$ref": "#/components/parameters/EntitySlugPathParam"
821
+ }
822
+ ],
823
+ "requestBody": {
824
+ "content": {
825
+ "application/json": {
826
+ "schema": {
827
+ "type": "object",
828
+ "properties": {
829
+ "version_id": {
830
+ "description": "Freeze to a specific version ID. Defaults to the current version.",
831
+ "$ref": "#/components/schemas/SchemaId"
832
+ }
833
+ }
834
+ }
835
+ }
836
+ }
837
+ },
838
+ "responses": {
839
+ "200": {
840
+ "description": "Schema frozen successfully",
841
+ "content": {
842
+ "application/json": {
843
+ "schema": {
844
+ "$ref": "#/components/schemas/EntitySchemaItem"
845
+ }
846
+ }
847
+ }
848
+ },
849
+ "404": {
850
+ "$ref": "#/components/responses/NotFoundError"
851
+ }
852
+ }
853
+ }
854
+ },
855
+ "/v1/entity/schemas/{slug}/unfreeze": {
856
+ "post": {
857
+ "operationId": "unfreezeSchema",
858
+ "summary": "unfreezeSchema",
859
+ "description": "Unfreeze a schema. Promotes the latest version to the current version for all users.\n",
860
+ "tags": [
861
+ "Schemas"
862
+ ],
863
+ "parameters": [
864
+ {
865
+ "$ref": "#/components/parameters/EntitySlugPathParam"
866
+ }
867
+ ],
868
+ "responses": {
869
+ "200": {
870
+ "description": "Schema unfrozen successfully",
871
+ "content": {
872
+ "application/json": {
873
+ "schema": {
874
+ "$ref": "#/components/schemas/EntitySchemaItem"
875
+ }
876
+ }
877
+ }
878
+ },
879
+ "404": {
880
+ "$ref": "#/components/responses/NotFoundError"
881
+ }
882
+ }
883
+ }
884
+ },
774
885
  "/v1/entity/schemas/{slug}/capabilities/available": {
775
886
  "get": {
776
887
  "operationId": "listAvailableCapabilities",
@@ -4563,6 +4674,7 @@
4563
4674
  "example": false
4564
4675
  },
4565
4676
  "draft": {
4677
+ "deprecated": true,
4566
4678
  "type": "boolean",
4567
4679
  "example": false
4568
4680
  },
@@ -4833,6 +4945,14 @@
4833
4945
  }
4834
4946
  }
4835
4947
  },
4948
+ "frozen": {
4949
+ "description": "Indicates this schema is currently frozen. Present when the returned version is the frozen version.",
4950
+ "type": "boolean"
4951
+ },
4952
+ "latest": {
4953
+ "description": "Indicates this is the latest version of the schema. Both frozen and latest can be true if no changes were made since freezing.",
4954
+ "type": "boolean"
4955
+ },
4836
4956
  "_summary": {
4837
4957
  "description": "Indicates this is a truncated summary schema (attributes trimmed to summary_attributes only, no capabilities or group_settings)",
4838
4958
  "type": "boolean"
@@ -10268,9 +10388,5 @@
10268
10388
  }
10269
10389
  }
10270
10390
  },
10271
- "servers": [
10272
- {
10273
- "url": "https://entity.sls.epilot.io"
10274
- }
10275
- ]
10391
+ "servers": []
10276
10392
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/entity-client",
3
- "version": "7.0.0-rc.1",
3
+ "version": "7.1.0",
4
4
  "description": "JavaScript client library for the epilot Core Entity API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",