@epilot/entity-client 4.32.0 → 4.33.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.
- package/dist/definition.js +1 -1
- package/dist/openapi-runtime.json +73 -27
- package/dist/openapi.d.ts +201 -56
- package/dist/openapi.json +290 -90
- package/package.json +1 -1
package/dist/definition.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
(()=>{"use strict";var e={914: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(240));t.default=n.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.0.2","info":{"title":"","version":""},"paths":{"/v1/entity/schemas":{"get":{"operationId":"listSchemas","parameters":[{"in":"query","name":"unpublished"}],"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"}],"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/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}":{"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","default":false}],"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/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"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size"},{"in":"query","name":"type"},{"in":"query","name":"include_relations"}],"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"}],"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":{}},"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"}],"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}: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":[{"$ref":"#/components/parameters/TaxonomySlugQueryParamOptional"},{"in":"query","name":"query"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/taxonomies/{taxonomySlug}/classifications":{"post":{"operationId":"updateClassificationsForTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"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":{}}},"/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/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"}}},"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}(914),r=exports;for(var n in a)r[n]=a[n];a.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();
|
|
1
|
+
(()=>{"use strict";var e={914: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(240));t.default=n.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.0.2","info":{"title":"","version":""},"paths":{"/v1/entity/schemas":{"get":{"operationId":"listSchemas","parameters":[{"in":"query","name":"unpublished"}],"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"}],"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/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}":{"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","default":false}],"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/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"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size"},{"in":"query","name":"type"},{"in":"query","name":"include_relations"}],"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"}],"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":{}},"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"}],"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/{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":[{"$ref":"#/components/parameters/TaxonomySlugQueryParamOptional"},{"in":"query","name":"query"}],"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/jobs":{"get":{"operationId":"getJobs","parameters":[{"in":"query","name":"status"}],"responses":{}}},"/v1/entity/taxonomies/classifications:move":{"post":{"operationId":"bulkMoveClassifications","parameters":[{"in":"query","name":"target_taxonomy"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/taxonomies/classifications:delete":{"post":{"operationId":"bulkDeleteClassifications","parameters":[{"in":"query","name":"permanent"}],"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"}}},"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}(914),r=exports;for(var n in a)r[n]=a[n];a.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();
|
|
@@ -917,6 +917,56 @@
|
|
|
917
917
|
"responses": {}
|
|
918
918
|
}
|
|
919
919
|
},
|
|
920
|
+
"/v1/entity/taxonomies/{taxonomySlug}/classifications": {
|
|
921
|
+
"post": {
|
|
922
|
+
"operationId": "updateClassificationsForTaxonomy",
|
|
923
|
+
"parameters": [
|
|
924
|
+
{
|
|
925
|
+
"$ref": "#/components/parameters/TaxonomySlugPathParam"
|
|
926
|
+
}
|
|
927
|
+
],
|
|
928
|
+
"requestBody": {
|
|
929
|
+
"content": {
|
|
930
|
+
"application/json": {}
|
|
931
|
+
}
|
|
932
|
+
},
|
|
933
|
+
"responses": {}
|
|
934
|
+
}
|
|
935
|
+
},
|
|
936
|
+
"/v2/entity/taxonomies/classifications/{classificationSlug}": {
|
|
937
|
+
"get": {
|
|
938
|
+
"operationId": "getTaxonomyClassification",
|
|
939
|
+
"parameters": [
|
|
940
|
+
{
|
|
941
|
+
"$ref": "#/components/parameters/TaxonomyClassificationSlugPathParam"
|
|
942
|
+
}
|
|
943
|
+
],
|
|
944
|
+
"responses": {}
|
|
945
|
+
},
|
|
946
|
+
"put": {
|
|
947
|
+
"operationId": "updateTaxonomyClassification",
|
|
948
|
+
"parameters": [
|
|
949
|
+
{
|
|
950
|
+
"$ref": "#/components/parameters/TaxonomyClassificationSlugPathParam"
|
|
951
|
+
}
|
|
952
|
+
],
|
|
953
|
+
"requestBody": {
|
|
954
|
+
"content": {
|
|
955
|
+
"application/json": {}
|
|
956
|
+
}
|
|
957
|
+
},
|
|
958
|
+
"responses": {}
|
|
959
|
+
},
|
|
960
|
+
"delete": {
|
|
961
|
+
"operationId": "deleteTaxonomyClassification",
|
|
962
|
+
"parameters": [
|
|
963
|
+
{
|
|
964
|
+
"$ref": "#/components/parameters/TaxonomyClassificationSlugPathParam"
|
|
965
|
+
}
|
|
966
|
+
],
|
|
967
|
+
"responses": {}
|
|
968
|
+
}
|
|
969
|
+
},
|
|
920
970
|
"/v1/entity/taxonomies/{taxonomySlug}:autocomplete": {
|
|
921
971
|
"get": {
|
|
922
972
|
"operationId": "taxonomyAutocomplete",
|
|
@@ -956,22 +1006,6 @@
|
|
|
956
1006
|
"responses": {}
|
|
957
1007
|
}
|
|
958
1008
|
},
|
|
959
|
-
"/v1/entity/taxonomies/{taxonomySlug}/classifications": {
|
|
960
|
-
"post": {
|
|
961
|
-
"operationId": "updateClassificationsForTaxonomy",
|
|
962
|
-
"parameters": [
|
|
963
|
-
{
|
|
964
|
-
"$ref": "#/components/parameters/TaxonomySlugPathParam"
|
|
965
|
-
}
|
|
966
|
-
],
|
|
967
|
-
"requestBody": {
|
|
968
|
-
"content": {
|
|
969
|
-
"application/json": {}
|
|
970
|
-
}
|
|
971
|
-
},
|
|
972
|
-
"responses": {}
|
|
973
|
-
}
|
|
974
|
-
},
|
|
975
1009
|
"/v1/entity/schemas/{slug}/taxonomy/{taxonomySlug}": {
|
|
976
1010
|
"get": {
|
|
977
1011
|
"operationId": "listTaxonomyClassificationsForSchema",
|
|
@@ -994,21 +1028,25 @@
|
|
|
994
1028
|
"responses": {}
|
|
995
1029
|
}
|
|
996
1030
|
},
|
|
997
|
-
"/
|
|
1031
|
+
"/v1/entity/taxonomies/jobs": {
|
|
998
1032
|
"get": {
|
|
999
|
-
"operationId": "
|
|
1033
|
+
"operationId": "getJobs",
|
|
1000
1034
|
"parameters": [
|
|
1001
1035
|
{
|
|
1002
|
-
"
|
|
1036
|
+
"in": "query",
|
|
1037
|
+
"name": "status"
|
|
1003
1038
|
}
|
|
1004
1039
|
],
|
|
1005
1040
|
"responses": {}
|
|
1006
|
-
}
|
|
1007
|
-
|
|
1008
|
-
|
|
1041
|
+
}
|
|
1042
|
+
},
|
|
1043
|
+
"/v1/entity/taxonomies/classifications:move": {
|
|
1044
|
+
"post": {
|
|
1045
|
+
"operationId": "bulkMoveClassifications",
|
|
1009
1046
|
"parameters": [
|
|
1010
1047
|
{
|
|
1011
|
-
"
|
|
1048
|
+
"in": "query",
|
|
1049
|
+
"name": "target_taxonomy"
|
|
1012
1050
|
}
|
|
1013
1051
|
],
|
|
1014
1052
|
"requestBody": {
|
|
@@ -1017,14 +1055,22 @@
|
|
|
1017
1055
|
}
|
|
1018
1056
|
},
|
|
1019
1057
|
"responses": {}
|
|
1020
|
-
}
|
|
1021
|
-
|
|
1022
|
-
|
|
1058
|
+
}
|
|
1059
|
+
},
|
|
1060
|
+
"/v1/entity/taxonomies/classifications:delete": {
|
|
1061
|
+
"post": {
|
|
1062
|
+
"operationId": "bulkDeleteClassifications",
|
|
1023
1063
|
"parameters": [
|
|
1024
1064
|
{
|
|
1025
|
-
"
|
|
1065
|
+
"in": "query",
|
|
1066
|
+
"name": "permanent"
|
|
1026
1067
|
}
|
|
1027
1068
|
],
|
|
1069
|
+
"requestBody": {
|
|
1070
|
+
"content": {
|
|
1071
|
+
"application/json": {}
|
|
1072
|
+
}
|
|
1073
|
+
},
|
|
1028
1074
|
"responses": {}
|
|
1029
1075
|
}
|
|
1030
1076
|
},
|
package/dist/openapi.d.ts
CHANGED
|
@@ -7065,6 +7065,20 @@ declare namespace Components {
|
|
|
7065
7065
|
*/
|
|
7066
7066
|
enabled_locations?: TaxonomyLocationId[];
|
|
7067
7067
|
}
|
|
7068
|
+
export interface TaxonomyBulkJob {
|
|
7069
|
+
job_id?: string; // uuid
|
|
7070
|
+
status?: /* The status of the bulk job */ TaxonomyBulkJobStatus;
|
|
7071
|
+
type?: TaxonomyBulkJobType;
|
|
7072
|
+
}
|
|
7073
|
+
/**
|
|
7074
|
+
* The status of the bulk job
|
|
7075
|
+
*/
|
|
7076
|
+
export type TaxonomyBulkJobStatus = "PENDING" | "FAILED" | "COMPLETED";
|
|
7077
|
+
export interface TaxonomyBulkJobTriggerResponse {
|
|
7078
|
+
job_id?: string; // uuid
|
|
7079
|
+
status?: /* The status of the bulk job */ TaxonomyBulkJobStatus;
|
|
7080
|
+
}
|
|
7081
|
+
export type TaxonomyBulkJobType = "MOVE_LABELS" | "DELETE_LABELS";
|
|
7068
7082
|
export interface TaxonomyClassification {
|
|
7069
7083
|
id?: /**
|
|
7070
7084
|
* example:
|
|
@@ -7237,6 +7251,7 @@ declare namespace Components {
|
|
|
7237
7251
|
};
|
|
7238
7252
|
type?: "string";
|
|
7239
7253
|
multiline?: boolean;
|
|
7254
|
+
rich_text?: boolean;
|
|
7240
7255
|
}
|
|
7241
7256
|
/**
|
|
7242
7257
|
* User Relationship
|
|
@@ -7473,6 +7488,47 @@ declare namespace Paths {
|
|
|
7473
7488
|
}
|
|
7474
7489
|
}
|
|
7475
7490
|
}
|
|
7491
|
+
namespace BulkDeleteClassifications {
|
|
7492
|
+
namespace Parameters {
|
|
7493
|
+
export type Permanent = boolean;
|
|
7494
|
+
}
|
|
7495
|
+
export interface QueryParameters {
|
|
7496
|
+
permanent?: Parameters.Permanent;
|
|
7497
|
+
}
|
|
7498
|
+
export interface RequestBody {
|
|
7499
|
+
classification_ids?: /**
|
|
7500
|
+
* example:
|
|
7501
|
+
* taxonomy-slug:classification-slug
|
|
7502
|
+
*/
|
|
7503
|
+
Components.Schemas.ClassificationId[];
|
|
7504
|
+
}
|
|
7505
|
+
namespace Responses {
|
|
7506
|
+
export type $200 = Components.Schemas.TaxonomyBulkJobTriggerResponse;
|
|
7507
|
+
}
|
|
7508
|
+
}
|
|
7509
|
+
namespace BulkMoveClassifications {
|
|
7510
|
+
namespace Parameters {
|
|
7511
|
+
export type TargetTaxonomy = /**
|
|
7512
|
+
* URL-friendly name for taxonomy
|
|
7513
|
+
* example:
|
|
7514
|
+
* purpose
|
|
7515
|
+
*/
|
|
7516
|
+
Components.Schemas.TaxonomySlug;
|
|
7517
|
+
}
|
|
7518
|
+
export interface QueryParameters {
|
|
7519
|
+
target_taxonomy?: Parameters.TargetTaxonomy;
|
|
7520
|
+
}
|
|
7521
|
+
export interface RequestBody {
|
|
7522
|
+
classification_ids?: /**
|
|
7523
|
+
* example:
|
|
7524
|
+
* taxonomy-slug:classification-slug
|
|
7525
|
+
*/
|
|
7526
|
+
Components.Schemas.ClassificationId[];
|
|
7527
|
+
}
|
|
7528
|
+
namespace Responses {
|
|
7529
|
+
export type $200 = Components.Schemas.TaxonomyBulkJobTriggerResponse;
|
|
7530
|
+
}
|
|
7531
|
+
}
|
|
7476
7532
|
namespace CreateActivity {
|
|
7477
7533
|
namespace Parameters {
|
|
7478
7534
|
export type Entities = Components.Schemas.EntityId /* uuid */[];
|
|
@@ -8128,6 +8184,17 @@ declare namespace Paths {
|
|
|
8128
8184
|
Components.Schemas.EntityItem;
|
|
8129
8185
|
}
|
|
8130
8186
|
}
|
|
8187
|
+
namespace GetJobs {
|
|
8188
|
+
namespace Parameters {
|
|
8189
|
+
export type Status = /* The status of the bulk job */ Components.Schemas.TaxonomyBulkJobStatus;
|
|
8190
|
+
}
|
|
8191
|
+
export interface QueryParameters {
|
|
8192
|
+
status?: Parameters.Status;
|
|
8193
|
+
}
|
|
8194
|
+
namespace Responses {
|
|
8195
|
+
export type $200 = Components.Schemas.TaxonomyBulkJob[];
|
|
8196
|
+
}
|
|
8197
|
+
}
|
|
8131
8198
|
namespace GetJsonSchema {
|
|
8132
8199
|
namespace Parameters {
|
|
8133
8200
|
export type Slug = /**
|
|
@@ -10545,6 +10612,46 @@ export interface OperationMethods {
|
|
|
10545
10612
|
data?: any,
|
|
10546
10613
|
config?: AxiosRequestConfig
|
|
10547
10614
|
): OperationResponse<Paths.DeleteTaxonomy.Responses.$204>
|
|
10615
|
+
/**
|
|
10616
|
+
* updateClassificationsForTaxonomy - updateClassificationsForTaxonomy
|
|
10617
|
+
*
|
|
10618
|
+
* Update the classifications for a taxonomy
|
|
10619
|
+
*/
|
|
10620
|
+
'updateClassificationsForTaxonomy'(
|
|
10621
|
+
parameters?: Parameters<Paths.UpdateClassificationsForTaxonomy.PathParameters> | null,
|
|
10622
|
+
data?: Paths.UpdateClassificationsForTaxonomy.RequestBody,
|
|
10623
|
+
config?: AxiosRequestConfig
|
|
10624
|
+
): OperationResponse<Paths.UpdateClassificationsForTaxonomy.Responses.$200>
|
|
10625
|
+
/**
|
|
10626
|
+
* getTaxonomyClassification - getTaxonomyClassification
|
|
10627
|
+
*
|
|
10628
|
+
* Get a classification for a taxonomy
|
|
10629
|
+
*/
|
|
10630
|
+
'getTaxonomyClassification'(
|
|
10631
|
+
parameters?: Parameters<Paths.GetTaxonomyClassification.PathParameters> | null,
|
|
10632
|
+
data?: any,
|
|
10633
|
+
config?: AxiosRequestConfig
|
|
10634
|
+
): OperationResponse<Paths.GetTaxonomyClassification.Responses.$200>
|
|
10635
|
+
/**
|
|
10636
|
+
* updateTaxonomyClassification - updateTaxonomyClassification
|
|
10637
|
+
*
|
|
10638
|
+
* Update a classification for a taxonomy
|
|
10639
|
+
*/
|
|
10640
|
+
'updateTaxonomyClassification'(
|
|
10641
|
+
parameters?: Parameters<Paths.UpdateTaxonomyClassification.PathParameters> | null,
|
|
10642
|
+
data?: Paths.UpdateTaxonomyClassification.RequestBody,
|
|
10643
|
+
config?: AxiosRequestConfig
|
|
10644
|
+
): OperationResponse<Paths.UpdateTaxonomyClassification.Responses.$200>
|
|
10645
|
+
/**
|
|
10646
|
+
* deleteTaxonomyClassification - deleteTaxonomyClassification
|
|
10647
|
+
*
|
|
10648
|
+
* Delete a classification for a taxonomy
|
|
10649
|
+
*/
|
|
10650
|
+
'deleteTaxonomyClassification'(
|
|
10651
|
+
parameters?: Parameters<Paths.DeleteTaxonomyClassification.PathParameters> | null,
|
|
10652
|
+
data?: any,
|
|
10653
|
+
config?: AxiosRequestConfig
|
|
10654
|
+
): OperationResponse<Paths.DeleteTaxonomyClassification.Responses.$200>
|
|
10548
10655
|
/**
|
|
10549
10656
|
* taxonomyAutocomplete - taxonomyAutocomplete
|
|
10550
10657
|
*
|
|
@@ -10565,16 +10672,6 @@ export interface OperationMethods {
|
|
|
10565
10672
|
data?: Paths.TaxonomiesClassificationsSearch.RequestBody,
|
|
10566
10673
|
config?: AxiosRequestConfig
|
|
10567
10674
|
): OperationResponse<Paths.TaxonomiesClassificationsSearch.Responses.$200>
|
|
10568
|
-
/**
|
|
10569
|
-
* updateClassificationsForTaxonomy - updateClassificationsForTaxonomy
|
|
10570
|
-
*
|
|
10571
|
-
* Update the classifications for a taxonomy
|
|
10572
|
-
*/
|
|
10573
|
-
'updateClassificationsForTaxonomy'(
|
|
10574
|
-
parameters?: Parameters<Paths.UpdateClassificationsForTaxonomy.PathParameters> | null,
|
|
10575
|
-
data?: Paths.UpdateClassificationsForTaxonomy.RequestBody,
|
|
10576
|
-
config?: AxiosRequestConfig
|
|
10577
|
-
): OperationResponse<Paths.UpdateClassificationsForTaxonomy.Responses.$200>
|
|
10578
10675
|
/**
|
|
10579
10676
|
* listTaxonomyClassificationsForSchema - listTaxonomyClassificationsForSchema
|
|
10580
10677
|
*
|
|
@@ -10586,35 +10683,39 @@ export interface OperationMethods {
|
|
|
10586
10683
|
config?: AxiosRequestConfig
|
|
10587
10684
|
): OperationResponse<Paths.ListTaxonomyClassificationsForSchema.Responses.$200>
|
|
10588
10685
|
/**
|
|
10589
|
-
*
|
|
10686
|
+
* getJobs - getJobs
|
|
10590
10687
|
*
|
|
10591
|
-
*
|
|
10688
|
+
* Gets bulk jobs by job status
|
|
10592
10689
|
*/
|
|
10593
|
-
'
|
|
10594
|
-
parameters?: Parameters<Paths.
|
|
10690
|
+
'getJobs'(
|
|
10691
|
+
parameters?: Parameters<Paths.GetJobs.QueryParameters> | null,
|
|
10595
10692
|
data?: any,
|
|
10596
10693
|
config?: AxiosRequestConfig
|
|
10597
|
-
): OperationResponse<Paths.
|
|
10694
|
+
): OperationResponse<Paths.GetJobs.Responses.$200>
|
|
10598
10695
|
/**
|
|
10599
|
-
*
|
|
10696
|
+
* bulkMoveClassifications - bulkMoveClassifications
|
|
10697
|
+
*
|
|
10698
|
+
* Moves classifications from one taxonomy to another, through a bulk async operation which
|
|
10699
|
+
* also updates all references from the old classification to the new one under the target taxonomy.
|
|
10600
10700
|
*
|
|
10601
|
-
* Update a classification for a taxonomy
|
|
10602
10701
|
*/
|
|
10603
|
-
'
|
|
10604
|
-
parameters?: Parameters<Paths.
|
|
10605
|
-
data?: Paths.
|
|
10702
|
+
'bulkMoveClassifications'(
|
|
10703
|
+
parameters?: Parameters<Paths.BulkMoveClassifications.QueryParameters> | null,
|
|
10704
|
+
data?: Paths.BulkMoveClassifications.RequestBody,
|
|
10606
10705
|
config?: AxiosRequestConfig
|
|
10607
|
-
): OperationResponse<Paths.
|
|
10706
|
+
): OperationResponse<Paths.BulkMoveClassifications.Responses.$200>
|
|
10608
10707
|
/**
|
|
10609
|
-
*
|
|
10708
|
+
* bulkDeleteClassifications - bulkDeleteClassifications
|
|
10709
|
+
*
|
|
10710
|
+
* Archives or permanently deletes taxonomy classifications. When permanent is true, the classifications are deleted through a bulk
|
|
10711
|
+
* async operation which also deletes all references of the deleted classifications from the entities referencing them.
|
|
10610
10712
|
*
|
|
10611
|
-
* Delete a classification for a taxonomy
|
|
10612
10713
|
*/
|
|
10613
|
-
'
|
|
10614
|
-
parameters?: Parameters<Paths.
|
|
10615
|
-
data?:
|
|
10714
|
+
'bulkDeleteClassifications'(
|
|
10715
|
+
parameters?: Parameters<Paths.BulkDeleteClassifications.QueryParameters> | null,
|
|
10716
|
+
data?: Paths.BulkDeleteClassifications.RequestBody,
|
|
10616
10717
|
config?: AxiosRequestConfig
|
|
10617
|
-
): OperationResponse<Paths.
|
|
10718
|
+
): OperationResponse<Paths.BulkDeleteClassifications.Responses.$200>
|
|
10618
10719
|
/**
|
|
10619
10720
|
* createSchemaAttribute - createSchemaAttribute
|
|
10620
10721
|
*
|
|
@@ -11566,6 +11667,50 @@ export interface PathsDictionary {
|
|
|
11566
11667
|
config?: AxiosRequestConfig
|
|
11567
11668
|
): OperationResponse<Paths.DeleteTaxonomy.Responses.$204>
|
|
11568
11669
|
}
|
|
11670
|
+
['/v1/entity/taxonomies/{taxonomySlug}/classifications']: {
|
|
11671
|
+
/**
|
|
11672
|
+
* updateClassificationsForTaxonomy - updateClassificationsForTaxonomy
|
|
11673
|
+
*
|
|
11674
|
+
* Update the classifications for a taxonomy
|
|
11675
|
+
*/
|
|
11676
|
+
'post'(
|
|
11677
|
+
parameters?: Parameters<Paths.UpdateClassificationsForTaxonomy.PathParameters> | null,
|
|
11678
|
+
data?: Paths.UpdateClassificationsForTaxonomy.RequestBody,
|
|
11679
|
+
config?: AxiosRequestConfig
|
|
11680
|
+
): OperationResponse<Paths.UpdateClassificationsForTaxonomy.Responses.$200>
|
|
11681
|
+
}
|
|
11682
|
+
['/v2/entity/taxonomies/classifications/{classificationSlug}']: {
|
|
11683
|
+
/**
|
|
11684
|
+
* getTaxonomyClassification - getTaxonomyClassification
|
|
11685
|
+
*
|
|
11686
|
+
* Get a classification for a taxonomy
|
|
11687
|
+
*/
|
|
11688
|
+
'get'(
|
|
11689
|
+
parameters?: Parameters<Paths.GetTaxonomyClassification.PathParameters> | null,
|
|
11690
|
+
data?: any,
|
|
11691
|
+
config?: AxiosRequestConfig
|
|
11692
|
+
): OperationResponse<Paths.GetTaxonomyClassification.Responses.$200>
|
|
11693
|
+
/**
|
|
11694
|
+
* updateTaxonomyClassification - updateTaxonomyClassification
|
|
11695
|
+
*
|
|
11696
|
+
* Update a classification for a taxonomy
|
|
11697
|
+
*/
|
|
11698
|
+
'put'(
|
|
11699
|
+
parameters?: Parameters<Paths.UpdateTaxonomyClassification.PathParameters> | null,
|
|
11700
|
+
data?: Paths.UpdateTaxonomyClassification.RequestBody,
|
|
11701
|
+
config?: AxiosRequestConfig
|
|
11702
|
+
): OperationResponse<Paths.UpdateTaxonomyClassification.Responses.$200>
|
|
11703
|
+
/**
|
|
11704
|
+
* deleteTaxonomyClassification - deleteTaxonomyClassification
|
|
11705
|
+
*
|
|
11706
|
+
* Delete a classification for a taxonomy
|
|
11707
|
+
*/
|
|
11708
|
+
'delete'(
|
|
11709
|
+
parameters?: Parameters<Paths.DeleteTaxonomyClassification.PathParameters> | null,
|
|
11710
|
+
data?: any,
|
|
11711
|
+
config?: AxiosRequestConfig
|
|
11712
|
+
): OperationResponse<Paths.DeleteTaxonomyClassification.Responses.$200>
|
|
11713
|
+
}
|
|
11569
11714
|
['/v1/entity/taxonomies/{taxonomySlug}:autocomplete']: {
|
|
11570
11715
|
/**
|
|
11571
11716
|
* taxonomyAutocomplete - taxonomyAutocomplete
|
|
@@ -11590,18 +11735,6 @@ export interface PathsDictionary {
|
|
|
11590
11735
|
config?: AxiosRequestConfig
|
|
11591
11736
|
): OperationResponse<Paths.TaxonomiesClassificationsSearch.Responses.$200>
|
|
11592
11737
|
}
|
|
11593
|
-
['/v1/entity/taxonomies/{taxonomySlug}/classifications']: {
|
|
11594
|
-
/**
|
|
11595
|
-
* updateClassificationsForTaxonomy - updateClassificationsForTaxonomy
|
|
11596
|
-
*
|
|
11597
|
-
* Update the classifications for a taxonomy
|
|
11598
|
-
*/
|
|
11599
|
-
'post'(
|
|
11600
|
-
parameters?: Parameters<Paths.UpdateClassificationsForTaxonomy.PathParameters> | null,
|
|
11601
|
-
data?: Paths.UpdateClassificationsForTaxonomy.RequestBody,
|
|
11602
|
-
config?: AxiosRequestConfig
|
|
11603
|
-
): OperationResponse<Paths.UpdateClassificationsForTaxonomy.Responses.$200>
|
|
11604
|
-
}
|
|
11605
11738
|
['/v1/entity/schemas/{slug}/taxonomy/{taxonomySlug}']: {
|
|
11606
11739
|
/**
|
|
11607
11740
|
* listTaxonomyClassificationsForSchema - listTaxonomyClassificationsForSchema
|
|
@@ -11614,37 +11747,45 @@ export interface PathsDictionary {
|
|
|
11614
11747
|
config?: AxiosRequestConfig
|
|
11615
11748
|
): OperationResponse<Paths.ListTaxonomyClassificationsForSchema.Responses.$200>
|
|
11616
11749
|
}
|
|
11617
|
-
['/
|
|
11750
|
+
['/v1/entity/taxonomies/jobs']: {
|
|
11618
11751
|
/**
|
|
11619
|
-
*
|
|
11752
|
+
* getJobs - getJobs
|
|
11620
11753
|
*
|
|
11621
|
-
*
|
|
11754
|
+
* Gets bulk jobs by job status
|
|
11622
11755
|
*/
|
|
11623
11756
|
'get'(
|
|
11624
|
-
parameters?: Parameters<Paths.
|
|
11757
|
+
parameters?: Parameters<Paths.GetJobs.QueryParameters> | null,
|
|
11625
11758
|
data?: any,
|
|
11626
11759
|
config?: AxiosRequestConfig
|
|
11627
|
-
): OperationResponse<Paths.
|
|
11760
|
+
): OperationResponse<Paths.GetJobs.Responses.$200>
|
|
11761
|
+
}
|
|
11762
|
+
['/v1/entity/taxonomies/classifications:move']: {
|
|
11628
11763
|
/**
|
|
11629
|
-
*
|
|
11764
|
+
* bulkMoveClassifications - bulkMoveClassifications
|
|
11765
|
+
*
|
|
11766
|
+
* Moves classifications from one taxonomy to another, through a bulk async operation which
|
|
11767
|
+
* also updates all references from the old classification to the new one under the target taxonomy.
|
|
11630
11768
|
*
|
|
11631
|
-
* Update a classification for a taxonomy
|
|
11632
11769
|
*/
|
|
11633
|
-
'
|
|
11634
|
-
parameters?: Parameters<Paths.
|
|
11635
|
-
data?: Paths.
|
|
11770
|
+
'post'(
|
|
11771
|
+
parameters?: Parameters<Paths.BulkMoveClassifications.QueryParameters> | null,
|
|
11772
|
+
data?: Paths.BulkMoveClassifications.RequestBody,
|
|
11636
11773
|
config?: AxiosRequestConfig
|
|
11637
|
-
): OperationResponse<Paths.
|
|
11774
|
+
): OperationResponse<Paths.BulkMoveClassifications.Responses.$200>
|
|
11775
|
+
}
|
|
11776
|
+
['/v1/entity/taxonomies/classifications:delete']: {
|
|
11638
11777
|
/**
|
|
11639
|
-
*
|
|
11778
|
+
* bulkDeleteClassifications - bulkDeleteClassifications
|
|
11779
|
+
*
|
|
11780
|
+
* Archives or permanently deletes taxonomy classifications. When permanent is true, the classifications are deleted through a bulk
|
|
11781
|
+
* async operation which also deletes all references of the deleted classifications from the entities referencing them.
|
|
11640
11782
|
*
|
|
11641
|
-
* Delete a classification for a taxonomy
|
|
11642
11783
|
*/
|
|
11643
|
-
'
|
|
11644
|
-
parameters?: Parameters<Paths.
|
|
11645
|
-
data?:
|
|
11784
|
+
'post'(
|
|
11785
|
+
parameters?: Parameters<Paths.BulkDeleteClassifications.QueryParameters> | null,
|
|
11786
|
+
data?: Paths.BulkDeleteClassifications.RequestBody,
|
|
11646
11787
|
config?: AxiosRequestConfig
|
|
11647
|
-
): OperationResponse<Paths.
|
|
11788
|
+
): OperationResponse<Paths.BulkDeleteClassifications.Responses.$200>
|
|
11648
11789
|
}
|
|
11649
11790
|
['/v1/entity/schemas/attributes']: {
|
|
11650
11791
|
/**
|
|
@@ -11928,6 +12069,10 @@ export type SummaryAttribute = Components.Schemas.SummaryAttribute;
|
|
|
11928
12069
|
export type SummaryField = Components.Schemas.SummaryField;
|
|
11929
12070
|
export type TagsAttribute = Components.Schemas.TagsAttribute;
|
|
11930
12071
|
export type Taxonomy = Components.Schemas.Taxonomy;
|
|
12072
|
+
export type TaxonomyBulkJob = Components.Schemas.TaxonomyBulkJob;
|
|
12073
|
+
export type TaxonomyBulkJobStatus = Components.Schemas.TaxonomyBulkJobStatus;
|
|
12074
|
+
export type TaxonomyBulkJobTriggerResponse = Components.Schemas.TaxonomyBulkJobTriggerResponse;
|
|
12075
|
+
export type TaxonomyBulkJobType = Components.Schemas.TaxonomyBulkJobType;
|
|
11931
12076
|
export type TaxonomyClassification = Components.Schemas.TaxonomyClassification;
|
|
11932
12077
|
export type TaxonomyLocationId = Components.Schemas.TaxonomyLocationId;
|
|
11933
12078
|
export type TaxonomySlug = Components.Schemas.TaxonomySlug;
|
package/dist/openapi.json
CHANGED
|
@@ -23,8 +23,8 @@
|
|
|
23
23
|
"description": "Entity Events"
|
|
24
24
|
},
|
|
25
25
|
{
|
|
26
|
-
"name": "Export",
|
|
27
|
-
"description": "
|
|
26
|
+
"name": "Import-Export",
|
|
27
|
+
"description": "Import and Export entities via portable files (CSV)"
|
|
28
28
|
},
|
|
29
29
|
{
|
|
30
30
|
"name": "Saved Views",
|
|
@@ -2139,7 +2139,7 @@
|
|
|
2139
2139
|
"summary": "exportEntities",
|
|
2140
2140
|
"description": "Export entity data in a CSV-format. The export will export data as close as possible to what is visible on Entity UI tables.\nThe values exported as in some cases, transformed to human-readable values.\n\nTo force the export of raw values, use the `#` prefix in front of your field name when specifying the field on the `fields` param.\n",
|
|
2141
2141
|
"tags": [
|
|
2142
|
-
"Export"
|
|
2142
|
+
"Import-Export"
|
|
2143
2143
|
],
|
|
2144
2144
|
"parameters": [
|
|
2145
2145
|
{
|
|
@@ -2189,7 +2189,7 @@
|
|
|
2189
2189
|
"summary": "Import Entities",
|
|
2190
2190
|
"description": "This endpoint enables the import of entities into the platform.\nThe entities should be provided in a CSV format inside an S3 bucket.\nThis API will return the `job_id`` which can be used to fetch the status of the import process.\n",
|
|
2191
2191
|
"tags": [
|
|
2192
|
-
"
|
|
2192
|
+
"Import-Export"
|
|
2193
2193
|
],
|
|
2194
2194
|
"parameters": [
|
|
2195
2195
|
{
|
|
@@ -2590,6 +2590,154 @@
|
|
|
2590
2590
|
}
|
|
2591
2591
|
}
|
|
2592
2592
|
},
|
|
2593
|
+
"/v1/entity/taxonomies/{taxonomySlug}/classifications": {
|
|
2594
|
+
"post": {
|
|
2595
|
+
"operationId": "updateClassificationsForTaxonomy",
|
|
2596
|
+
"summary": "updateClassificationsForTaxonomy",
|
|
2597
|
+
"description": "Update the classifications for a taxonomy",
|
|
2598
|
+
"tags": [
|
|
2599
|
+
"Taxonomy"
|
|
2600
|
+
],
|
|
2601
|
+
"parameters": [
|
|
2602
|
+
{
|
|
2603
|
+
"$ref": "#/components/parameters/TaxonomySlugPathParam"
|
|
2604
|
+
}
|
|
2605
|
+
],
|
|
2606
|
+
"requestBody": {
|
|
2607
|
+
"content": {
|
|
2608
|
+
"application/json": {
|
|
2609
|
+
"schema": {
|
|
2610
|
+
"$ref": "#/components/schemas/ClassificationsUpdate"
|
|
2611
|
+
}
|
|
2612
|
+
}
|
|
2613
|
+
}
|
|
2614
|
+
},
|
|
2615
|
+
"responses": {
|
|
2616
|
+
"200": {
|
|
2617
|
+
"description": "Taxonomies classifications",
|
|
2618
|
+
"content": {
|
|
2619
|
+
"application/json": {
|
|
2620
|
+
"schema": {
|
|
2621
|
+
"type": "object",
|
|
2622
|
+
"properties": {
|
|
2623
|
+
"created": {
|
|
2624
|
+
"type": "array",
|
|
2625
|
+
"items": {
|
|
2626
|
+
"$ref": "#/components/schemas/TaxonomyClassification"
|
|
2627
|
+
}
|
|
2628
|
+
},
|
|
2629
|
+
"updated": {
|
|
2630
|
+
"type": "array",
|
|
2631
|
+
"items": {
|
|
2632
|
+
"$ref": "#/components/schemas/TaxonomyClassification"
|
|
2633
|
+
}
|
|
2634
|
+
},
|
|
2635
|
+
"deleted": {
|
|
2636
|
+
"type": "object",
|
|
2637
|
+
"items": {
|
|
2638
|
+
"$ref": "#/components/schemas/ClassificationId"
|
|
2639
|
+
}
|
|
2640
|
+
}
|
|
2641
|
+
}
|
|
2642
|
+
}
|
|
2643
|
+
}
|
|
2644
|
+
}
|
|
2645
|
+
}
|
|
2646
|
+
}
|
|
2647
|
+
}
|
|
2648
|
+
},
|
|
2649
|
+
"/v2/entity/taxonomies/classifications/{classificationSlug}": {
|
|
2650
|
+
"get": {
|
|
2651
|
+
"operationId": "getTaxonomyClassification",
|
|
2652
|
+
"summary": "getTaxonomyClassification",
|
|
2653
|
+
"description": "Get a classification for a taxonomy",
|
|
2654
|
+
"tags": [
|
|
2655
|
+
"Taxonomy"
|
|
2656
|
+
],
|
|
2657
|
+
"parameters": [
|
|
2658
|
+
{
|
|
2659
|
+
"$ref": "#/components/parameters/TaxonomyClassificationSlugPathParam"
|
|
2660
|
+
}
|
|
2661
|
+
],
|
|
2662
|
+
"responses": {
|
|
2663
|
+
"200": {
|
|
2664
|
+
"description": "Taxonomy classification",
|
|
2665
|
+
"content": {
|
|
2666
|
+
"application/json": {
|
|
2667
|
+
"schema": {
|
|
2668
|
+
"$ref": "#/components/schemas/TaxonomyClassification"
|
|
2669
|
+
}
|
|
2670
|
+
}
|
|
2671
|
+
}
|
|
2672
|
+
},
|
|
2673
|
+
"404": {
|
|
2674
|
+
"description": "Taxonomy classification not found"
|
|
2675
|
+
}
|
|
2676
|
+
}
|
|
2677
|
+
},
|
|
2678
|
+
"put": {
|
|
2679
|
+
"operationId": "updateTaxonomyClassification",
|
|
2680
|
+
"summary": "updateTaxonomyClassification",
|
|
2681
|
+
"description": "Update a classification for a taxonomy",
|
|
2682
|
+
"tags": [
|
|
2683
|
+
"Taxonomy"
|
|
2684
|
+
],
|
|
2685
|
+
"parameters": [
|
|
2686
|
+
{
|
|
2687
|
+
"$ref": "#/components/parameters/TaxonomyClassificationSlugPathParam"
|
|
2688
|
+
}
|
|
2689
|
+
],
|
|
2690
|
+
"requestBody": {
|
|
2691
|
+
"content": {
|
|
2692
|
+
"application/json": {
|
|
2693
|
+
"schema": {
|
|
2694
|
+
"$ref": "#/components/schemas/TaxonomyClassification"
|
|
2695
|
+
}
|
|
2696
|
+
}
|
|
2697
|
+
}
|
|
2698
|
+
},
|
|
2699
|
+
"responses": {
|
|
2700
|
+
"200": {
|
|
2701
|
+
"description": "Taxonomy classification updated",
|
|
2702
|
+
"content": {
|
|
2703
|
+
"application/json": {
|
|
2704
|
+
"schema": {
|
|
2705
|
+
"$ref": "#/components/schemas/TaxonomyClassification"
|
|
2706
|
+
}
|
|
2707
|
+
}
|
|
2708
|
+
}
|
|
2709
|
+
},
|
|
2710
|
+
"404": {
|
|
2711
|
+
"description": "Taxonomy classification not found"
|
|
2712
|
+
}
|
|
2713
|
+
}
|
|
2714
|
+
},
|
|
2715
|
+
"delete": {
|
|
2716
|
+
"operationId": "deleteTaxonomyClassification",
|
|
2717
|
+
"summary": "deleteTaxonomyClassification",
|
|
2718
|
+
"description": "Delete a classification for a taxonomy",
|
|
2719
|
+
"tags": [
|
|
2720
|
+
"Taxonomy"
|
|
2721
|
+
],
|
|
2722
|
+
"parameters": [
|
|
2723
|
+
{
|
|
2724
|
+
"$ref": "#/components/parameters/TaxonomyClassificationSlugPathParam"
|
|
2725
|
+
}
|
|
2726
|
+
],
|
|
2727
|
+
"responses": {
|
|
2728
|
+
"200": {
|
|
2729
|
+
"description": "Taxonomy classification deleted",
|
|
2730
|
+
"content": {
|
|
2731
|
+
"application/json": {
|
|
2732
|
+
"schema": {
|
|
2733
|
+
"$ref": "#/components/schemas/TaxonomyClassification"
|
|
2734
|
+
}
|
|
2735
|
+
}
|
|
2736
|
+
}
|
|
2737
|
+
}
|
|
2738
|
+
}
|
|
2739
|
+
}
|
|
2740
|
+
},
|
|
2593
2741
|
"/v1/entity/taxonomies/{taxonomySlug}:autocomplete": {
|
|
2594
2742
|
"get": {
|
|
2595
2743
|
"operationId": "taxonomyAutocomplete",
|
|
@@ -2702,62 +2850,6 @@
|
|
|
2702
2850
|
}
|
|
2703
2851
|
}
|
|
2704
2852
|
},
|
|
2705
|
-
"/v1/entity/taxonomies/{taxonomySlug}/classifications": {
|
|
2706
|
-
"post": {
|
|
2707
|
-
"operationId": "updateClassificationsForTaxonomy",
|
|
2708
|
-
"summary": "updateClassificationsForTaxonomy",
|
|
2709
|
-
"description": "Update the classifications for a taxonomy",
|
|
2710
|
-
"tags": [
|
|
2711
|
-
"Taxonomy"
|
|
2712
|
-
],
|
|
2713
|
-
"parameters": [
|
|
2714
|
-
{
|
|
2715
|
-
"$ref": "#/components/parameters/TaxonomySlugPathParam"
|
|
2716
|
-
}
|
|
2717
|
-
],
|
|
2718
|
-
"requestBody": {
|
|
2719
|
-
"content": {
|
|
2720
|
-
"application/json": {
|
|
2721
|
-
"schema": {
|
|
2722
|
-
"$ref": "#/components/schemas/ClassificationsUpdate"
|
|
2723
|
-
}
|
|
2724
|
-
}
|
|
2725
|
-
}
|
|
2726
|
-
},
|
|
2727
|
-
"responses": {
|
|
2728
|
-
"200": {
|
|
2729
|
-
"description": "Taxonomies classifications",
|
|
2730
|
-
"content": {
|
|
2731
|
-
"application/json": {
|
|
2732
|
-
"schema": {
|
|
2733
|
-
"type": "object",
|
|
2734
|
-
"properties": {
|
|
2735
|
-
"created": {
|
|
2736
|
-
"type": "array",
|
|
2737
|
-
"items": {
|
|
2738
|
-
"$ref": "#/components/schemas/TaxonomyClassification"
|
|
2739
|
-
}
|
|
2740
|
-
},
|
|
2741
|
-
"updated": {
|
|
2742
|
-
"type": "array",
|
|
2743
|
-
"items": {
|
|
2744
|
-
"$ref": "#/components/schemas/TaxonomyClassification"
|
|
2745
|
-
}
|
|
2746
|
-
},
|
|
2747
|
-
"deleted": {
|
|
2748
|
-
"type": "object",
|
|
2749
|
-
"items": {
|
|
2750
|
-
"$ref": "#/components/schemas/ClassificationId"
|
|
2751
|
-
}
|
|
2752
|
-
}
|
|
2753
|
-
}
|
|
2754
|
-
}
|
|
2755
|
-
}
|
|
2756
|
-
}
|
|
2757
|
-
}
|
|
2758
|
-
}
|
|
2759
|
-
}
|
|
2760
|
-
},
|
|
2761
2853
|
"/v1/entity/schemas/{slug}/taxonomy/{taxonomySlug}": {
|
|
2762
2854
|
"get": {
|
|
2763
2855
|
"operationId": "listTaxonomyClassificationsForSchema",
|
|
@@ -2810,91 +2902,150 @@
|
|
|
2810
2902
|
}
|
|
2811
2903
|
}
|
|
2812
2904
|
},
|
|
2813
|
-
"/
|
|
2905
|
+
"/v1/entity/taxonomies/jobs": {
|
|
2814
2906
|
"get": {
|
|
2815
|
-
"operationId": "
|
|
2816
|
-
"summary": "
|
|
2817
|
-
"description": "
|
|
2907
|
+
"operationId": "getJobs",
|
|
2908
|
+
"summary": "getJobs",
|
|
2909
|
+
"description": "Gets bulk jobs by job status",
|
|
2818
2910
|
"tags": [
|
|
2819
2911
|
"Taxonomy"
|
|
2820
2912
|
],
|
|
2821
2913
|
"parameters": [
|
|
2822
2914
|
{
|
|
2823
|
-
"
|
|
2915
|
+
"in": "query",
|
|
2916
|
+
"name": "status",
|
|
2917
|
+
"schema": {
|
|
2918
|
+
"$ref": "#/components/schemas/TaxonomyBulkJobStatus"
|
|
2919
|
+
}
|
|
2824
2920
|
}
|
|
2825
2921
|
],
|
|
2826
2922
|
"responses": {
|
|
2827
2923
|
"200": {
|
|
2828
|
-
"description": "
|
|
2924
|
+
"description": "Returns the jobs matching the given query or the active jobs if no status is provided",
|
|
2829
2925
|
"content": {
|
|
2830
2926
|
"application/json": {
|
|
2831
2927
|
"schema": {
|
|
2832
|
-
"
|
|
2928
|
+
"type": "array",
|
|
2929
|
+
"items": {
|
|
2930
|
+
"$ref": "#/components/schemas/TaxonomyBulkJob"
|
|
2931
|
+
}
|
|
2833
2932
|
}
|
|
2834
2933
|
}
|
|
2835
2934
|
}
|
|
2836
|
-
},
|
|
2837
|
-
"404": {
|
|
2838
|
-
"description": "Taxonomy classification not found"
|
|
2839
2935
|
}
|
|
2840
2936
|
}
|
|
2841
|
-
}
|
|
2842
|
-
|
|
2843
|
-
|
|
2844
|
-
|
|
2845
|
-
"
|
|
2937
|
+
}
|
|
2938
|
+
},
|
|
2939
|
+
"/v1/entity/taxonomies/classifications:move": {
|
|
2940
|
+
"post": {
|
|
2941
|
+
"operationId": "bulkMoveClassifications",
|
|
2942
|
+
"summary": "bulkMoveClassifications",
|
|
2943
|
+
"description": "Moves classifications from one taxonomy to another, through a bulk async operation which\nalso updates all references from the old classification to the new one under the target taxonomy.\n",
|
|
2846
2944
|
"tags": [
|
|
2847
2945
|
"Taxonomy"
|
|
2848
2946
|
],
|
|
2849
2947
|
"parameters": [
|
|
2850
2948
|
{
|
|
2851
|
-
"
|
|
2949
|
+
"in": "query",
|
|
2950
|
+
"name": "target_taxonomy",
|
|
2951
|
+
"description": "The target taxonomy to which the classifications will be moved",
|
|
2952
|
+
"schema": {
|
|
2953
|
+
"$ref": "#/components/schemas/TaxonomySlug"
|
|
2954
|
+
}
|
|
2852
2955
|
}
|
|
2853
2956
|
],
|
|
2854
2957
|
"requestBody": {
|
|
2855
2958
|
"content": {
|
|
2856
2959
|
"application/json": {
|
|
2857
2960
|
"schema": {
|
|
2858
|
-
"
|
|
2961
|
+
"type": "object",
|
|
2962
|
+
"properties": {
|
|
2963
|
+
"classification_ids": {
|
|
2964
|
+
"type": "array",
|
|
2965
|
+
"items": {
|
|
2966
|
+
"$ref": "#/components/schemas/ClassificationId"
|
|
2967
|
+
}
|
|
2968
|
+
}
|
|
2969
|
+
}
|
|
2970
|
+
},
|
|
2971
|
+
"example": {
|
|
2972
|
+
"classification_ids": [
|
|
2973
|
+
"taxonomy-slug:classification-slug"
|
|
2974
|
+
]
|
|
2859
2975
|
}
|
|
2860
2976
|
}
|
|
2861
2977
|
}
|
|
2862
2978
|
},
|
|
2863
2979
|
"responses": {
|
|
2864
2980
|
"200": {
|
|
2865
|
-
"description": "
|
|
2981
|
+
"description": "Returns the job id for the async job and current status",
|
|
2866
2982
|
"content": {
|
|
2867
2983
|
"application/json": {
|
|
2868
2984
|
"schema": {
|
|
2869
|
-
"$ref": "#/components/schemas/
|
|
2985
|
+
"$ref": "#/components/schemas/TaxonomyBulkJobTriggerResponse"
|
|
2986
|
+
},
|
|
2987
|
+
"example": {
|
|
2988
|
+
"job_id": "123",
|
|
2989
|
+
"status": "PENDING"
|
|
2870
2990
|
}
|
|
2871
2991
|
}
|
|
2872
2992
|
}
|
|
2873
|
-
},
|
|
2874
|
-
"404": {
|
|
2875
|
-
"description": "Taxonomy classification not found"
|
|
2876
2993
|
}
|
|
2877
2994
|
}
|
|
2878
|
-
}
|
|
2879
|
-
|
|
2880
|
-
|
|
2881
|
-
|
|
2882
|
-
"
|
|
2995
|
+
}
|
|
2996
|
+
},
|
|
2997
|
+
"/v1/entity/taxonomies/classifications:delete": {
|
|
2998
|
+
"post": {
|
|
2999
|
+
"operationId": "bulkDeleteClassifications",
|
|
3000
|
+
"summary": "bulkDeleteClassifications",
|
|
3001
|
+
"description": "Archives or permanently deletes taxonomy classifications. When permanent is true, the classifications are deleted through a bulk \nasync operation which also deletes all references of the deleted classifications from the entities referencing them.\n",
|
|
2883
3002
|
"tags": [
|
|
2884
3003
|
"Taxonomy"
|
|
2885
3004
|
],
|
|
2886
3005
|
"parameters": [
|
|
2887
3006
|
{
|
|
2888
|
-
"
|
|
3007
|
+
"in": "query",
|
|
3008
|
+
"name": "permanent",
|
|
3009
|
+
"schema": {
|
|
3010
|
+
"type": "boolean",
|
|
3011
|
+
"default": false
|
|
3012
|
+
},
|
|
3013
|
+
"description": "Whether to permanently delete the classifications or just archive them"
|
|
2889
3014
|
}
|
|
2890
3015
|
],
|
|
3016
|
+
"requestBody": {
|
|
3017
|
+
"content": {
|
|
3018
|
+
"application/json": {
|
|
3019
|
+
"schema": {
|
|
3020
|
+
"type": "object",
|
|
3021
|
+
"properties": {
|
|
3022
|
+
"classification_ids": {
|
|
3023
|
+
"type": "array",
|
|
3024
|
+
"items": {
|
|
3025
|
+
"$ref": "#/components/schemas/ClassificationId"
|
|
3026
|
+
}
|
|
3027
|
+
}
|
|
3028
|
+
}
|
|
3029
|
+
},
|
|
3030
|
+
"example": {
|
|
3031
|
+
"classification_ids": [
|
|
3032
|
+
"taxonomy-slug:classification-slug"
|
|
3033
|
+
]
|
|
3034
|
+
}
|
|
3035
|
+
}
|
|
3036
|
+
}
|
|
3037
|
+
},
|
|
2891
3038
|
"responses": {
|
|
2892
3039
|
"200": {
|
|
2893
|
-
"description": "
|
|
3040
|
+
"description": "Returns the job id for the async job and current status",
|
|
2894
3041
|
"content": {
|
|
2895
3042
|
"application/json": {
|
|
2896
3043
|
"schema": {
|
|
2897
|
-
"$ref": "#/components/schemas/
|
|
3044
|
+
"$ref": "#/components/schemas/TaxonomyBulkJobTriggerResponse"
|
|
3045
|
+
},
|
|
3046
|
+
"example": {
|
|
3047
|
+
"job_id": "123",
|
|
3048
|
+
"status": "PENDING"
|
|
2898
3049
|
}
|
|
2899
3050
|
}
|
|
2900
3051
|
}
|
|
@@ -4288,6 +4439,9 @@
|
|
|
4288
4439
|
},
|
|
4289
4440
|
"multiline": {
|
|
4290
4441
|
"type": "boolean"
|
|
4442
|
+
},
|
|
4443
|
+
"rich_text": {
|
|
4444
|
+
"type": "boolean"
|
|
4291
4445
|
}
|
|
4292
4446
|
}
|
|
4293
4447
|
}
|
|
@@ -7207,6 +7361,49 @@
|
|
|
7207
7361
|
}
|
|
7208
7362
|
}
|
|
7209
7363
|
},
|
|
7364
|
+
"TaxonomyBulkJobTriggerResponse": {
|
|
7365
|
+
"type": "object",
|
|
7366
|
+
"properties": {
|
|
7367
|
+
"job_id": {
|
|
7368
|
+
"type": "string",
|
|
7369
|
+
"format": "uuid"
|
|
7370
|
+
},
|
|
7371
|
+
"status": {
|
|
7372
|
+
"$ref": "#/components/schemas/TaxonomyBulkJobStatus"
|
|
7373
|
+
}
|
|
7374
|
+
}
|
|
7375
|
+
},
|
|
7376
|
+
"TaxonomyBulkJobStatus": {
|
|
7377
|
+
"type": "string",
|
|
7378
|
+
"description": "The status of the bulk job",
|
|
7379
|
+
"enum": [
|
|
7380
|
+
"PENDING",
|
|
7381
|
+
"FAILED",
|
|
7382
|
+
"COMPLETED"
|
|
7383
|
+
]
|
|
7384
|
+
},
|
|
7385
|
+
"TaxonomyBulkJobType": {
|
|
7386
|
+
"type": "string",
|
|
7387
|
+
"enum": [
|
|
7388
|
+
"MOVE_LABELS",
|
|
7389
|
+
"DELETE_LABELS"
|
|
7390
|
+
]
|
|
7391
|
+
},
|
|
7392
|
+
"TaxonomyBulkJob": {
|
|
7393
|
+
"type": "object",
|
|
7394
|
+
"properties": {
|
|
7395
|
+
"job_id": {
|
|
7396
|
+
"type": "string",
|
|
7397
|
+
"format": "uuid"
|
|
7398
|
+
},
|
|
7399
|
+
"status": {
|
|
7400
|
+
"$ref": "#/components/schemas/TaxonomyBulkJobStatus"
|
|
7401
|
+
},
|
|
7402
|
+
"type": {
|
|
7403
|
+
"$ref": "#/components/schemas/TaxonomyBulkJobType"
|
|
7404
|
+
}
|
|
7405
|
+
}
|
|
7406
|
+
},
|
|
7210
7407
|
"ESClusterAssignment": {
|
|
7211
7408
|
"type": "object",
|
|
7212
7409
|
"properties": {
|
|
@@ -8116,6 +8313,9 @@
|
|
|
8116
8313
|
}
|
|
8117
8314
|
},
|
|
8118
8315
|
"servers": [
|
|
8316
|
+
{
|
|
8317
|
+
"url": "https://entity.sls.epilot.io"
|
|
8318
|
+
},
|
|
8119
8319
|
{
|
|
8120
8320
|
"url": "https://entity.sls.epilot.io"
|
|
8121
8321
|
}
|