@epilot/entity-client 5.0.0 → 5.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.
- package/dist/definition.js +1 -1
- package/dist/openapi-runtime.json +28 -0
- package/dist/openapi.d.ts +211 -1
- package/dist/openapi.json +163 -5
- 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"},{"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/blueprints":{"get":{"operationId":"listSchemaBlueprints","responses":{}}},"/v1/entity:search":{"post":{"operationId":"searchEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity:list":{"post":{"operationId":"listEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}":{"post":{"operationId":"createEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}:validate":{"post":{"operationId":"validateEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathPriceParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}:validate":{"post":{"operationId":"validateEntityV2","parameters":[{"$ref":"#/components/parameters/EntitySlugPathPriceParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}:upsert":{"patch":{"operationId":"upsertEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"},{"name":"strict","in":"query","required":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}/{id}":{"get":{"operationId":"getEntityV2","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"in":"query","name":"fields","style":"form","explode":false}],"responses":{}}},"/v1/entity/{slug}/{id}:restore":{"patch":{"operationId":"restoreEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}/{id}:reindex":{"post":{"operationId":"reindexEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}/{id}":{"get":{"operationId":"getEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"}],"responses":{}},"put":{"operationId":"updateEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"patch":{"operationId":"patchEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{}},"delete":{"operationId":"deleteEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"in":"query","name":"purge"}],"responses":{}}},"/v1/entity:autocomplete":{"get":{"operationId":"autocomplete","parameters":[{"name":"input","in":"query"},{"name":"attribute","in":"query","required":true},{"name":"slug","in":"query"},{"name":"size","in":"query"}],"responses":{}}},"/v1/entity/activity":{"post":{"operationId":"createActivity","parameters":[{"in":"query","name":"entities","style":"form","explode":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/activity/{id}":{"get":{"operationId":"getActivity","parameters":[{"$ref":"#/components/parameters/ActivityIdPathParam"},{"in":"query","name":"operations_size"},{"in":"query","name":"operations_from"}],"responses":{}}},"/v1/entity/activity/{id}:attach":{"post":{"operationId":"attachActivity","parameters":[{"$ref":"#/components/parameters/ActivityIdPathParam"},{"in":"query","name":"entities","style":"form","explode":false}],"responses":{}}},"/v1/entity/{slug}/{id}/activity":{"get":{"operationId":"getEntityActivityFeed","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"query","name":"after"},{"in":"query","name":"before"},{"in":"query","name":"start_date"},{"in":"query","name":"end_date"},{"in":"query","name":"preset_range"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size"},{"in":"query","name":"type"},{"in":"query","name":"include_relations"}],"responses":{}}},"/v1/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"$ref":"#/components/parameters/IncludeReverseQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size","required":false},{"$ref":"#/components/parameters/IncludeSchemasQueryParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"}],"responses":{}},"post":{"operationId":"addRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"removeRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelationsV2","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"in":"query","name":"query"},{"$ref":"#/components/parameters/IncludeReverseQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size"},{"in":"query","name":"fields"}],"responses":{}}},"/v3/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelationsV3","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"$ref":"#/components/parameters/IncludeReverseDeprecatedQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size","required":false},{"$ref":"#/components/parameters/IncludeSchemasQueryParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"},{"$ref":"#/components/parameters/EntityRelationsModeQueryParam"},{"in":"query","name":"fields"}],"responses":{}}},"/v2/entity/{slug}/{id}/relations/count":{"get":{"operationId":"getRelatedEntitiesCount","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"}],"responses":{}}},"/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}":{"put":{"operationId":"updateRelation","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"path","name":"attribute","required":true},{"in":"path","name":"entity_id","required":true},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteRelation","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"path","name":"attribute","required":true},{"in":"path","name":"entity_id","required":true},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"responses":{}}},"/v1/entity:export":{"post":{"operationId":"exportEntities","parameters":[{"in":"query","name":"job_id"},{"in":"query","name":"is_template"},{"in":"query","name":"language"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity:import":{"post":{"operationId":"importEntities","parameters":[{"in":"query","name":"job_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/views":{"get":{"operationId":"listSavedViews","parameters":[{"in":"query","name":"slug","required":false},{"in":"query","name":"sort","required":false},{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false},{"in":"query","name":"fields","required":false}],"responses":{}}},"/v1/entity/view":{"post":{"operationId":"createSavedView","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/view/{id}":{"get":{"operationId":"getSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"responses":{}},"put":{"operationId":"updateSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"patch":{"operationId":"patchSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"responses":{}}},"/v1/entity/views/favorites":{"get":{"operationId":"listFavoriteViewsForUser","responses":{}}},"/v1/entity/taxonomies":{"get":{"operationId":"listTaxonomies","parameters":[{"in":"query","name":"include_disabled"},{"in":"query","name":"type"}],"responses":{}},"post":{"operationId":"createTaxonomy","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/taxonomies/{taxonomySlug}":{"get":{"operationId":"getTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"responses":{}},"put":{"operationId":"updateTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"permanent"}],"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":[{"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"}],"responses":{}}},"/v1/entity/taxonomies/bulk-jobs/{job_id}":{"get":{"operationId":"getTaxonomyBulkActionJobById","parameters":[{"in":"path","name":"job_id","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":{"NotFoundError":{"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}(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"},{"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/blueprints":{"get":{"operationId":"listSchemaBlueprints","responses":{}}},"/v1/entity:search":{"post":{"operationId":"searchEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity:list":{"post":{"operationId":"listEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}":{"post":{"operationId":"createEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}:validate":{"post":{"operationId":"validateEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathPriceParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}:validate":{"post":{"operationId":"validateEntityV2","parameters":[{"$ref":"#/components/parameters/EntitySlugPathPriceParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}:upsert":{"patch":{"operationId":"upsertEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"},{"name":"strict","in":"query","required":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}/{id}":{"get":{"operationId":"getEntityV2","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"in":"query","name":"fields","style":"form","explode":false}],"responses":{}}},"/v1/entity/{slug}/{id}:restore":{"patch":{"operationId":"restoreEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}/{id}:reindex":{"post":{"operationId":"reindexEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}/{id}":{"get":{"operationId":"getEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"}],"responses":{}},"put":{"operationId":"updateEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"patch":{"operationId":"patchEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{}},"delete":{"operationId":"deleteEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"in":"query","name":"purge"}],"responses":{}}},"/v1/entity:autocomplete":{"get":{"operationId":"autocomplete","parameters":[{"name":"input","in":"query"},{"name":"attribute","in":"query","required":true},{"name":"slug","in":"query"},{"name":"size","in":"query"}],"responses":{}}},"/v1/entity/activity":{"post":{"operationId":"createActivity","parameters":[{"in":"query","name":"entities","style":"form","explode":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/activity/{id}":{"get":{"operationId":"getActivity","parameters":[{"$ref":"#/components/parameters/ActivityIdPathParam"},{"in":"query","name":"operations_size"},{"in":"query","name":"operations_from"}],"responses":{}}},"/v1/entity/activity/{id}:attach":{"post":{"operationId":"attachActivity","parameters":[{"$ref":"#/components/parameters/ActivityIdPathParam"},{"in":"query","name":"entities","style":"form","explode":false}],"responses":{}}},"/v1/entity/{slug}/{id}/activity":{"get":{"operationId":"getEntityActivityFeed","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"query","name":"after"},{"in":"query","name":"before"},{"in":"query","name":"start_date"},{"in":"query","name":"end_date"},{"in":"query","name":"preset_range"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size"},{"in":"query","name":"type"},{"in":"query","name":"include_relations"},{"in":"query","name":"exclude_activity_groups"}],"responses":{}}},"/v1/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"$ref":"#/components/parameters/IncludeReverseQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size","required":false},{"$ref":"#/components/parameters/IncludeSchemasQueryParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"}],"responses":{}},"post":{"operationId":"addRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"removeRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelationsV2","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"in":"query","name":"query"},{"$ref":"#/components/parameters/IncludeReverseQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size"},{"in":"query","name":"fields"}],"responses":{}}},"/v3/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelationsV3","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"$ref":"#/components/parameters/IncludeReverseDeprecatedQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size","required":false},{"$ref":"#/components/parameters/IncludeSchemasQueryParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"},{"$ref":"#/components/parameters/EntityRelationsModeQueryParam"},{"in":"query","name":"fields"}],"responses":{}}},"/v2/entity/{slug}/{id}/relations/count":{"get":{"operationId":"getRelatedEntitiesCount","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"}],"responses":{}}},"/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}":{"put":{"operationId":"updateRelation","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"path","name":"attribute","required":true},{"in":"path","name":"entity_id","required":true},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteRelation","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"path","name":"attribute","required":true},{"in":"path","name":"entity_id","required":true},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"responses":{}}},"/v1/entity:export":{"post":{"operationId":"exportEntities","parameters":[{"in":"query","name":"job_id"},{"in":"query","name":"is_template"},{"in":"query","name":"language"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity:import":{"post":{"operationId":"importEntities","parameters":[{"in":"query","name":"job_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/views":{"get":{"operationId":"listSavedViews","parameters":[{"in":"query","name":"slug","required":false},{"in":"query","name":"sort","required":false},{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false},{"in":"query","name":"fields","required":false}],"responses":{}}},"/v1/entity/view":{"post":{"operationId":"createSavedView","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/view/{id}":{"get":{"operationId":"getSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"responses":{}},"put":{"operationId":"updateSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"patch":{"operationId":"patchSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"responses":{}}},"/v1/entity/views/favorites":{"get":{"operationId":"listFavoriteViewsForUser","responses":{}}},"/v1/entity/taxonomies":{"get":{"operationId":"listTaxonomies","parameters":[{"in":"query","name":"include_disabled"},{"in":"query","name":"type"}],"responses":{}},"post":{"operationId":"createTaxonomy","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/taxonomies/{taxonomySlug}":{"get":{"operationId":"getTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"responses":{}},"put":{"operationId":"updateTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"permanent"}],"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"}],"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":{"NotFoundError":{"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}(914),r=exports;for(var n in a)r[n]=a[n];a.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();
|
|
@@ -529,6 +529,10 @@
|
|
|
529
529
|
{
|
|
530
530
|
"in": "query",
|
|
531
531
|
"name": "include_relations"
|
|
532
|
+
},
|
|
533
|
+
{
|
|
534
|
+
"in": "query",
|
|
535
|
+
"name": "exclude_activity_groups"
|
|
532
536
|
}
|
|
533
537
|
],
|
|
534
538
|
"responses": {}
|
|
@@ -989,6 +993,17 @@
|
|
|
989
993
|
"responses": {}
|
|
990
994
|
}
|
|
991
995
|
},
|
|
996
|
+
"/v2/entity/taxonomies/classifications": {
|
|
997
|
+
"post": {
|
|
998
|
+
"operationId": "createTaxonomyClassification",
|
|
999
|
+
"requestBody": {
|
|
1000
|
+
"content": {
|
|
1001
|
+
"application/json": {}
|
|
1002
|
+
}
|
|
1003
|
+
},
|
|
1004
|
+
"responses": {}
|
|
1005
|
+
}
|
|
1006
|
+
},
|
|
992
1007
|
"/v2/entity/taxonomies/classifications/{classificationSlug}": {
|
|
993
1008
|
"get": {
|
|
994
1009
|
"operationId": "getTaxonomyClassification",
|
|
@@ -1123,6 +1138,19 @@
|
|
|
1123
1138
|
"responses": {}
|
|
1124
1139
|
}
|
|
1125
1140
|
},
|
|
1141
|
+
"/v1/entity/taxonomies/bulk-jobs/{job_id}/cancel": {
|
|
1142
|
+
"post": {
|
|
1143
|
+
"operationId": "cancelBulkAction",
|
|
1144
|
+
"parameters": [
|
|
1145
|
+
{
|
|
1146
|
+
"name": "job_id",
|
|
1147
|
+
"in": "path",
|
|
1148
|
+
"required": true
|
|
1149
|
+
}
|
|
1150
|
+
],
|
|
1151
|
+
"responses": {}
|
|
1152
|
+
}
|
|
1153
|
+
},
|
|
1126
1154
|
"/v1/entity/taxonomies/classifications:move": {
|
|
1127
1155
|
"post": {
|
|
1128
1156
|
"operationId": "bulkMoveClassifications",
|
package/dist/openapi.d.ts
CHANGED
|
@@ -2633,6 +2633,11 @@ declare namespace Components {
|
|
|
2633
2633
|
* You can pass one sort field or an array of sort fields. Each sort field can be a string
|
|
2634
2634
|
*/
|
|
2635
2635
|
sort?: /* You can pass one sort field or an array of sort fields. Each sort field can be a string */ string | string[];
|
|
2636
|
+
/**
|
|
2637
|
+
* The offset from which to start the search results.
|
|
2638
|
+
* Only one of `from` or `search_after` should be used.
|
|
2639
|
+
*
|
|
2640
|
+
*/
|
|
2636
2641
|
from?: number;
|
|
2637
2642
|
/**
|
|
2638
2643
|
* Max search size is 1000 with higher values defaulting to 1000
|
|
@@ -2684,6 +2689,31 @@ declare namespace Components {
|
|
|
2684
2689
|
*
|
|
2685
2690
|
*/
|
|
2686
2691
|
EntitySearchIncludeDeletedParam;
|
|
2692
|
+
highlight?: any;
|
|
2693
|
+
/**
|
|
2694
|
+
* A TTL (in seconds) that specifies how long the context should be maintained.
|
|
2695
|
+
* Defaults to 30 seconds; configurable up to 60 seconds to prevent abuse.
|
|
2696
|
+
* A value of 0 can be provided the close the context after the query.
|
|
2697
|
+
* Defaults to none.
|
|
2698
|
+
*
|
|
2699
|
+
*/
|
|
2700
|
+
stable_for?: number;
|
|
2701
|
+
/**
|
|
2702
|
+
* A unique identifier of the query context from the last stable query.
|
|
2703
|
+
* The context is maintained for the duration of the stable_for value.
|
|
2704
|
+
*
|
|
2705
|
+
*/
|
|
2706
|
+
stable_query_id?: string;
|
|
2707
|
+
/**
|
|
2708
|
+
* The sort values from which to start the search results.
|
|
2709
|
+
* Only one of `from` or `search_after` should be used.
|
|
2710
|
+
* It is strongly recommended to always use the `sort_end` field from the last search result.
|
|
2711
|
+
* Used for deep pagination, typically together with `stable_query_id` to maintain the context between requests.
|
|
2712
|
+
* Requires explicit sort to work reliably.
|
|
2713
|
+
* Typically used sort fields are `_id` or `_created_at`.
|
|
2714
|
+
*
|
|
2715
|
+
*/
|
|
2716
|
+
search_after?: ((string | null) | (number | null))[];
|
|
2687
2717
|
}
|
|
2688
2718
|
export interface EntityOperation {
|
|
2689
2719
|
entity: EntityId /* uuid */;
|
|
@@ -2698,7 +2728,7 @@ declare namespace Components {
|
|
|
2698
2728
|
* 01F130Q52Q6MWSNS8N2AVXV4JN
|
|
2699
2729
|
*/
|
|
2700
2730
|
ActivityId /* ulid ^01[0-9a-zA-Z]{24}$ */;
|
|
2701
|
-
operation: "createEntity" | "updateEntity" | "deleteEntity" | "softDeleteEntity" | "restoreEntity";
|
|
2731
|
+
operation: "createEntity" | "updateEntity" | "deleteEntity" | "softDeleteEntity" | "restoreEntity" | "relationsAdded" | "relationsRemoved";
|
|
2702
2732
|
/**
|
|
2703
2733
|
* example:
|
|
2704
2734
|
* {
|
|
@@ -3560,6 +3590,11 @@ declare namespace Components {
|
|
|
3560
3590
|
* You can pass one sort field or an array of sort fields. Each sort field can be a string
|
|
3561
3591
|
*/
|
|
3562
3592
|
sort?: /* You can pass one sort field or an array of sort fields. Each sort field can be a string */ string | string[];
|
|
3593
|
+
/**
|
|
3594
|
+
* The offset from which to start the search results.
|
|
3595
|
+
* Only one of `from` or `search_after` should be used.
|
|
3596
|
+
*
|
|
3597
|
+
*/
|
|
3563
3598
|
from?: number;
|
|
3564
3599
|
/**
|
|
3565
3600
|
* Max search size is 1000 with higher values defaulting to 1000
|
|
@@ -3611,6 +3646,30 @@ declare namespace Components {
|
|
|
3611
3646
|
*
|
|
3612
3647
|
*/
|
|
3613
3648
|
EntitySearchIncludeDeletedParam;
|
|
3649
|
+
/**
|
|
3650
|
+
* A TTL (in seconds) that specifies how long the context should be maintained.
|
|
3651
|
+
* Defaults to 30 seconds; configurable up to 60 seconds to prevent abuse.
|
|
3652
|
+
* A value of 0 can be provided the close the context after the query.
|
|
3653
|
+
* Defaults to none.
|
|
3654
|
+
*
|
|
3655
|
+
*/
|
|
3656
|
+
stable_for?: number;
|
|
3657
|
+
/**
|
|
3658
|
+
* A unique identifier of the query context from the last stable query.
|
|
3659
|
+
* The context is maintained for the duration of the stable_for value.
|
|
3660
|
+
*
|
|
3661
|
+
*/
|
|
3662
|
+
stable_query_id?: string;
|
|
3663
|
+
/**
|
|
3664
|
+
* The sort values from which to start the search results.
|
|
3665
|
+
* Only one of `from` or `search_after` should be used.
|
|
3666
|
+
* It is strongly recommended to always use the `sort_end` field from the last search result.
|
|
3667
|
+
* Used for deep pagination, typically together with `stable_query_id` to maintain the context between requests.
|
|
3668
|
+
* Requires explicit sort to work reliably.
|
|
3669
|
+
* Typically used sort fields are `_id` or `_created_at`.
|
|
3670
|
+
*
|
|
3671
|
+
*/
|
|
3672
|
+
search_after?: ((string | null) | (number | null))[];
|
|
3614
3673
|
}
|
|
3615
3674
|
export interface EntitySearchParams {
|
|
3616
3675
|
/**
|
|
@@ -3627,6 +3686,11 @@ declare namespace Components {
|
|
|
3627
3686
|
* You can pass one sort field or an array of sort fields. Each sort field can be a string
|
|
3628
3687
|
*/
|
|
3629
3688
|
sort?: /* You can pass one sort field or an array of sort fields. Each sort field can be a string */ string | string[];
|
|
3689
|
+
/**
|
|
3690
|
+
* The offset from which to start the search results.
|
|
3691
|
+
* Only one of `from` or `search_after` should be used.
|
|
3692
|
+
*
|
|
3693
|
+
*/
|
|
3630
3694
|
from?: number;
|
|
3631
3695
|
/**
|
|
3632
3696
|
* Max search size is 1000 with higher values defaulting to 1000
|
|
@@ -3679,6 +3743,30 @@ declare namespace Components {
|
|
|
3679
3743
|
*/
|
|
3680
3744
|
EntitySearchIncludeDeletedParam;
|
|
3681
3745
|
highlight?: any;
|
|
3746
|
+
/**
|
|
3747
|
+
* A TTL (in seconds) that specifies how long the context should be maintained.
|
|
3748
|
+
* Defaults to 30 seconds; configurable up to 60 seconds to prevent abuse.
|
|
3749
|
+
* A value of 0 can be provided the close the context after the query.
|
|
3750
|
+
* Defaults to none.
|
|
3751
|
+
*
|
|
3752
|
+
*/
|
|
3753
|
+
stable_for?: number;
|
|
3754
|
+
/**
|
|
3755
|
+
* A unique identifier of the query context from the last stable query.
|
|
3756
|
+
* The context is maintained for the duration of the stable_for value.
|
|
3757
|
+
*
|
|
3758
|
+
*/
|
|
3759
|
+
stable_query_id?: string;
|
|
3760
|
+
/**
|
|
3761
|
+
* The sort values from which to start the search results.
|
|
3762
|
+
* Only one of `from` or `search_after` should be used.
|
|
3763
|
+
* It is strongly recommended to always use the `sort_end` field from the last search result.
|
|
3764
|
+
* Used for deep pagination, typically together with `stable_query_id` to maintain the context between requests.
|
|
3765
|
+
* Requires explicit sort to work reliably.
|
|
3766
|
+
* Typically used sort fields are `_id` or `_created_at`.
|
|
3767
|
+
*
|
|
3768
|
+
*/
|
|
3769
|
+
search_after?: ((string | null) | (number | null))[];
|
|
3682
3770
|
}
|
|
3683
3771
|
export interface EntitySearchResults {
|
|
3684
3772
|
/**
|
|
@@ -3755,6 +3843,23 @@ declare namespace Components {
|
|
|
3755
3843
|
aggregations?: {
|
|
3756
3844
|
[key: string]: any;
|
|
3757
3845
|
};
|
|
3846
|
+
/**
|
|
3847
|
+
* A unique identifier of the query context.
|
|
3848
|
+
* Should be used on the input for the next query that needs to be executed in the same context.
|
|
3849
|
+
*
|
|
3850
|
+
*/
|
|
3851
|
+
stable_query_id?: string;
|
|
3852
|
+
/**
|
|
3853
|
+
* The sort value of the last item returned in `results`.
|
|
3854
|
+
* Can be used as the input for the `search_after` in the next query.
|
|
3855
|
+
*
|
|
3856
|
+
* example:
|
|
3857
|
+
* [
|
|
3858
|
+
* 1747905443332,
|
|
3859
|
+
* "0.000023312468"
|
|
3860
|
+
* ]
|
|
3861
|
+
*/
|
|
3862
|
+
sort_end?: ((string | null) | (number | null))[];
|
|
3758
3863
|
}
|
|
3759
3864
|
/**
|
|
3760
3865
|
* URL-friendly identifier for the entity schema
|
|
@@ -8844,6 +8949,8 @@ declare namespace Paths {
|
|
|
8844
8949
|
}
|
|
8845
8950
|
namespace Responses {
|
|
8846
8951
|
export type $200 = Components.Schemas.TaxonomyBulkJobTriggerResponse;
|
|
8952
|
+
export interface $400 {
|
|
8953
|
+
}
|
|
8847
8954
|
}
|
|
8848
8955
|
}
|
|
8849
8956
|
namespace BulkMergeClassifications {
|
|
@@ -8866,6 +8973,8 @@ declare namespace Paths {
|
|
|
8866
8973
|
}
|
|
8867
8974
|
namespace Responses {
|
|
8868
8975
|
export type $200 = Components.Schemas.TaxonomyBulkJobTriggerResponse;
|
|
8976
|
+
export interface $400 {
|
|
8977
|
+
}
|
|
8869
8978
|
}
|
|
8870
8979
|
}
|
|
8871
8980
|
namespace BulkMoveClassifications {
|
|
@@ -8888,6 +8997,39 @@ declare namespace Paths {
|
|
|
8888
8997
|
}
|
|
8889
8998
|
namespace Responses {
|
|
8890
8999
|
export type $200 = Components.Schemas.TaxonomyBulkJobTriggerResponse;
|
|
9000
|
+
export interface $400 {
|
|
9001
|
+
}
|
|
9002
|
+
}
|
|
9003
|
+
}
|
|
9004
|
+
namespace CancelBulkAction {
|
|
9005
|
+
namespace Parameters {
|
|
9006
|
+
export type JobId = string;
|
|
9007
|
+
}
|
|
9008
|
+
export interface PathParameters {
|
|
9009
|
+
job_id: Parameters.JobId;
|
|
9010
|
+
}
|
|
9011
|
+
namespace Responses {
|
|
9012
|
+
export type $200 = /**
|
|
9013
|
+
* example:
|
|
9014
|
+
* {
|
|
9015
|
+
* "job_id": "123e4567-e89b-12d3-a456-426614174000",
|
|
9016
|
+
* "status": "PENDING",
|
|
9017
|
+
* "action_type": "MOVE_CLASSIFICATIONS",
|
|
9018
|
+
* "created_by": "10598",
|
|
9019
|
+
* "created_at": "2024-01-01T00:00:00.000Z",
|
|
9020
|
+
* "updated_at": "2024-01-01T00:00:00.000Z",
|
|
9021
|
+
* "org": "66"
|
|
9022
|
+
* }
|
|
9023
|
+
*/
|
|
9024
|
+
Components.Schemas.TaxonomyBulkJob;
|
|
9025
|
+
export interface $400 {
|
|
9026
|
+
}
|
|
9027
|
+
export interface $403 {
|
|
9028
|
+
}
|
|
9029
|
+
export interface $404 {
|
|
9030
|
+
}
|
|
9031
|
+
export interface $500 {
|
|
9032
|
+
}
|
|
8891
9033
|
}
|
|
8892
9034
|
}
|
|
8893
9035
|
namespace CreateActivity {
|
|
@@ -9054,6 +9196,12 @@ declare namespace Paths {
|
|
|
9054
9196
|
}
|
|
9055
9197
|
}
|
|
9056
9198
|
}
|
|
9199
|
+
namespace CreateTaxonomyClassification {
|
|
9200
|
+
export type RequestBody = Components.Schemas.TaxonomyClassification;
|
|
9201
|
+
namespace Responses {
|
|
9202
|
+
export type $201 = Components.Schemas.TaxonomyClassification;
|
|
9203
|
+
}
|
|
9204
|
+
}
|
|
9057
9205
|
namespace DeleteEntity {
|
|
9058
9206
|
namespace Parameters {
|
|
9059
9207
|
export type ActivityId = /**
|
|
@@ -9257,6 +9405,8 @@ declare namespace Paths {
|
|
|
9257
9405
|
}
|
|
9258
9406
|
namespace Responses {
|
|
9259
9407
|
export type $200 = Components.Schemas.TaxonomyClassification;
|
|
9408
|
+
export interface $403 {
|
|
9409
|
+
}
|
|
9260
9410
|
}
|
|
9261
9411
|
}
|
|
9262
9412
|
namespace ExportEntities {
|
|
@@ -9443,6 +9593,11 @@ declare namespace Paths {
|
|
|
9443
9593
|
export type After = string; // date-time
|
|
9444
9594
|
export type Before = string; // date-time
|
|
9445
9595
|
export type EndDate = string; // date-time
|
|
9596
|
+
/**
|
|
9597
|
+
* example:
|
|
9598
|
+
* workflow
|
|
9599
|
+
*/
|
|
9600
|
+
export type ExcludeActivityGroups = string;
|
|
9446
9601
|
export type From = number;
|
|
9447
9602
|
export type Id = Components.Schemas.EntityId /* uuid */;
|
|
9448
9603
|
export type IncludeRelations = boolean;
|
|
@@ -9487,6 +9642,11 @@ declare namespace Paths {
|
|
|
9487
9642
|
*/
|
|
9488
9643
|
Parameters.Type;
|
|
9489
9644
|
include_relations?: Parameters.IncludeRelations;
|
|
9645
|
+
exclude_activity_groups?: /**
|
|
9646
|
+
* example:
|
|
9647
|
+
* workflow
|
|
9648
|
+
*/
|
|
9649
|
+
Parameters.ExcludeActivityGroups;
|
|
9490
9650
|
}
|
|
9491
9651
|
namespace Responses {
|
|
9492
9652
|
export interface $200 {
|
|
@@ -12383,6 +12543,17 @@ export interface OperationMethods {
|
|
|
12383
12543
|
data?: Paths.UpdateClassificationsForTaxonomy.RequestBody,
|
|
12384
12544
|
config?: AxiosRequestConfig
|
|
12385
12545
|
): OperationResponse<Paths.UpdateClassificationsForTaxonomy.Responses.$200>
|
|
12546
|
+
/**
|
|
12547
|
+
* createTaxonomyClassification - createTaxonomyClassification
|
|
12548
|
+
*
|
|
12549
|
+
* Create a new classification for a taxonomy
|
|
12550
|
+
*
|
|
12551
|
+
*/
|
|
12552
|
+
'createTaxonomyClassification'(
|
|
12553
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
12554
|
+
data?: Paths.CreateTaxonomyClassification.RequestBody,
|
|
12555
|
+
config?: AxiosRequestConfig
|
|
12556
|
+
): OperationResponse<Paths.CreateTaxonomyClassification.Responses.$201>
|
|
12386
12557
|
/**
|
|
12387
12558
|
* getTaxonomyClassification - getTaxonomyClassification
|
|
12388
12559
|
*
|
|
@@ -12471,6 +12642,18 @@ export interface OperationMethods {
|
|
|
12471
12642
|
data?: any,
|
|
12472
12643
|
config?: AxiosRequestConfig
|
|
12473
12644
|
): OperationResponse<Paths.GetTaxonomyBulkActionJobById.Responses.$200>
|
|
12645
|
+
/**
|
|
12646
|
+
* cancelBulkAction - cancelBulkAction
|
|
12647
|
+
*
|
|
12648
|
+
* Cancels a running bulk action job. The job status will be updated to CANCELLED
|
|
12649
|
+
* and the job will be stopped.
|
|
12650
|
+
*
|
|
12651
|
+
*/
|
|
12652
|
+
'cancelBulkAction'(
|
|
12653
|
+
parameters?: Parameters<Paths.CancelBulkAction.PathParameters> | null,
|
|
12654
|
+
data?: any,
|
|
12655
|
+
config?: AxiosRequestConfig
|
|
12656
|
+
): OperationResponse<Paths.CancelBulkAction.Responses.$200>
|
|
12474
12657
|
/**
|
|
12475
12658
|
* bulkMoveClassifications - bulkMoveClassifications
|
|
12476
12659
|
*
|
|
@@ -13494,6 +13677,19 @@ export interface PathsDictionary {
|
|
|
13494
13677
|
config?: AxiosRequestConfig
|
|
13495
13678
|
): OperationResponse<Paths.UpdateClassificationsForTaxonomy.Responses.$200>
|
|
13496
13679
|
}
|
|
13680
|
+
['/v2/entity/taxonomies/classifications']: {
|
|
13681
|
+
/**
|
|
13682
|
+
* createTaxonomyClassification - createTaxonomyClassification
|
|
13683
|
+
*
|
|
13684
|
+
* Create a new classification for a taxonomy
|
|
13685
|
+
*
|
|
13686
|
+
*/
|
|
13687
|
+
'post'(
|
|
13688
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
13689
|
+
data?: Paths.CreateTaxonomyClassification.RequestBody,
|
|
13690
|
+
config?: AxiosRequestConfig
|
|
13691
|
+
): OperationResponse<Paths.CreateTaxonomyClassification.Responses.$201>
|
|
13692
|
+
}
|
|
13497
13693
|
['/v2/entity/taxonomies/classifications/{classificationSlug}']: {
|
|
13498
13694
|
/**
|
|
13499
13695
|
* getTaxonomyClassification - getTaxonomyClassification
|
|
@@ -13594,6 +13790,20 @@ export interface PathsDictionary {
|
|
|
13594
13790
|
config?: AxiosRequestConfig
|
|
13595
13791
|
): OperationResponse<Paths.GetTaxonomyBulkActionJobById.Responses.$200>
|
|
13596
13792
|
}
|
|
13793
|
+
['/v1/entity/taxonomies/bulk-jobs/{job_id}/cancel']: {
|
|
13794
|
+
/**
|
|
13795
|
+
* cancelBulkAction - cancelBulkAction
|
|
13796
|
+
*
|
|
13797
|
+
* Cancels a running bulk action job. The job status will be updated to CANCELLED
|
|
13798
|
+
* and the job will be stopped.
|
|
13799
|
+
*
|
|
13800
|
+
*/
|
|
13801
|
+
'post'(
|
|
13802
|
+
parameters?: Parameters<Paths.CancelBulkAction.PathParameters> | null,
|
|
13803
|
+
data?: any,
|
|
13804
|
+
config?: AxiosRequestConfig
|
|
13805
|
+
): OperationResponse<Paths.CancelBulkAction.Responses.$200>
|
|
13806
|
+
}
|
|
13597
13807
|
['/v1/entity/taxonomies/classifications:move']: {
|
|
13598
13808
|
/**
|
|
13599
13809
|
* bulkMoveClassifications - bulkMoveClassifications
|
package/dist/openapi.json
CHANGED
|
@@ -1740,6 +1740,15 @@
|
|
|
1740
1740
|
"type": "boolean",
|
|
1741
1741
|
"default": false
|
|
1742
1742
|
}
|
|
1743
|
+
},
|
|
1744
|
+
{
|
|
1745
|
+
"in": "query",
|
|
1746
|
+
"name": "exclude_activity_groups",
|
|
1747
|
+
"description": "Exclude all activity types that are part of an activity group from results",
|
|
1748
|
+
"schema": {
|
|
1749
|
+
"type": "string",
|
|
1750
|
+
"example": "workflow"
|
|
1751
|
+
}
|
|
1743
1752
|
}
|
|
1744
1753
|
],
|
|
1745
1754
|
"responses": {
|
|
@@ -2868,6 +2877,37 @@
|
|
|
2868
2877
|
}
|
|
2869
2878
|
}
|
|
2870
2879
|
},
|
|
2880
|
+
"/v2/entity/taxonomies/classifications": {
|
|
2881
|
+
"post": {
|
|
2882
|
+
"operationId": "createTaxonomyClassification",
|
|
2883
|
+
"summary": "createTaxonomyClassification",
|
|
2884
|
+
"description": "Create a new classification for a taxonomy\n",
|
|
2885
|
+
"tags": [
|
|
2886
|
+
"Taxonomy"
|
|
2887
|
+
],
|
|
2888
|
+
"requestBody": {
|
|
2889
|
+
"content": {
|
|
2890
|
+
"application/json": {
|
|
2891
|
+
"schema": {
|
|
2892
|
+
"$ref": "#/components/schemas/TaxonomyClassification"
|
|
2893
|
+
}
|
|
2894
|
+
}
|
|
2895
|
+
}
|
|
2896
|
+
},
|
|
2897
|
+
"responses": {
|
|
2898
|
+
"201": {
|
|
2899
|
+
"description": "Created taxonomy classification",
|
|
2900
|
+
"content": {
|
|
2901
|
+
"application/json": {
|
|
2902
|
+
"schema": {
|
|
2903
|
+
"$ref": "#/components/schemas/TaxonomyClassification"
|
|
2904
|
+
}
|
|
2905
|
+
}
|
|
2906
|
+
}
|
|
2907
|
+
}
|
|
2908
|
+
}
|
|
2909
|
+
}
|
|
2910
|
+
},
|
|
2871
2911
|
"/v2/entity/taxonomies/classifications/{classificationSlug}": {
|
|
2872
2912
|
"get": {
|
|
2873
2913
|
"operationId": "getTaxonomyClassification",
|
|
@@ -2956,6 +2996,9 @@
|
|
|
2956
2996
|
}
|
|
2957
2997
|
}
|
|
2958
2998
|
}
|
|
2999
|
+
},
|
|
3000
|
+
"403": {
|
|
3001
|
+
"description": "Taxonomy classification deletion not allowed"
|
|
2959
3002
|
}
|
|
2960
3003
|
}
|
|
2961
3004
|
}
|
|
@@ -3236,6 +3279,51 @@
|
|
|
3236
3279
|
}
|
|
3237
3280
|
}
|
|
3238
3281
|
},
|
|
3282
|
+
"/v1/entity/taxonomies/bulk-jobs/{job_id}/cancel": {
|
|
3283
|
+
"post": {
|
|
3284
|
+
"operationId": "cancelBulkAction",
|
|
3285
|
+
"summary": "cancelBulkAction",
|
|
3286
|
+
"description": "Cancels a running bulk action job. The job status will be updated to CANCELLED\nand the job will be stopped.\n",
|
|
3287
|
+
"tags": [
|
|
3288
|
+
"Taxonomy"
|
|
3289
|
+
],
|
|
3290
|
+
"parameters": [
|
|
3291
|
+
{
|
|
3292
|
+
"name": "job_id",
|
|
3293
|
+
"in": "path",
|
|
3294
|
+
"required": true,
|
|
3295
|
+
"schema": {
|
|
3296
|
+
"type": "string"
|
|
3297
|
+
},
|
|
3298
|
+
"description": "Job ID of the bulk operation to cancel"
|
|
3299
|
+
}
|
|
3300
|
+
],
|
|
3301
|
+
"responses": {
|
|
3302
|
+
"200": {
|
|
3303
|
+
"description": "Success",
|
|
3304
|
+
"content": {
|
|
3305
|
+
"application/json": {
|
|
3306
|
+
"schema": {
|
|
3307
|
+
"$ref": "#/components/schemas/TaxonomyBulkJob"
|
|
3308
|
+
}
|
|
3309
|
+
}
|
|
3310
|
+
}
|
|
3311
|
+
},
|
|
3312
|
+
"400": {
|
|
3313
|
+
"description": "Bad Request"
|
|
3314
|
+
},
|
|
3315
|
+
"403": {
|
|
3316
|
+
"description": "Forbidden"
|
|
3317
|
+
},
|
|
3318
|
+
"404": {
|
|
3319
|
+
"description": "Not Found"
|
|
3320
|
+
},
|
|
3321
|
+
"500": {
|
|
3322
|
+
"description": "Internal Server Error"
|
|
3323
|
+
}
|
|
3324
|
+
}
|
|
3325
|
+
}
|
|
3326
|
+
},
|
|
3239
3327
|
"/v1/entity/taxonomies/classifications:move": {
|
|
3240
3328
|
"post": {
|
|
3241
3329
|
"operationId": "bulkMoveClassifications",
|
|
@@ -3294,6 +3382,9 @@
|
|
|
3294
3382
|
}
|
|
3295
3383
|
}
|
|
3296
3384
|
}
|
|
3385
|
+
},
|
|
3386
|
+
"400": {
|
|
3387
|
+
"description": "Invalid request"
|
|
3297
3388
|
}
|
|
3298
3389
|
}
|
|
3299
3390
|
}
|
|
@@ -3356,6 +3447,9 @@
|
|
|
3356
3447
|
}
|
|
3357
3448
|
}
|
|
3358
3449
|
}
|
|
3450
|
+
},
|
|
3451
|
+
"400": {
|
|
3452
|
+
"description": "Invalid request"
|
|
3359
3453
|
}
|
|
3360
3454
|
}
|
|
3361
3455
|
}
|
|
@@ -3408,6 +3502,9 @@
|
|
|
3408
3502
|
}
|
|
3409
3503
|
}
|
|
3410
3504
|
}
|
|
3505
|
+
},
|
|
3506
|
+
"400": {
|
|
3507
|
+
"description": "Invalid request"
|
|
3411
3508
|
}
|
|
3412
3509
|
}
|
|
3413
3510
|
}
|
|
@@ -7069,7 +7166,10 @@
|
|
|
7069
7166
|
"fields": {},
|
|
7070
7167
|
"aggs": {},
|
|
7071
7168
|
"include_deleted": {},
|
|
7072
|
-
"highlight": {}
|
|
7169
|
+
"highlight": {},
|
|
7170
|
+
"stable_for": {},
|
|
7171
|
+
"stable_query_id": {},
|
|
7172
|
+
"search_after": {}
|
|
7073
7173
|
},
|
|
7074
7174
|
"additionalProperties": false,
|
|
7075
7175
|
"required": [
|
|
@@ -7100,7 +7200,11 @@
|
|
|
7100
7200
|
"hydrate": {},
|
|
7101
7201
|
"fields": {},
|
|
7102
7202
|
"aggs": {},
|
|
7103
|
-
"include_deleted": {}
|
|
7203
|
+
"include_deleted": {},
|
|
7204
|
+
"highlight": {},
|
|
7205
|
+
"stable_for": {},
|
|
7206
|
+
"stable_query_id": {},
|
|
7207
|
+
"search_after": {}
|
|
7104
7208
|
},
|
|
7105
7209
|
"additionalProperties": false,
|
|
7106
7210
|
"required": [
|
|
@@ -7303,7 +7407,8 @@
|
|
|
7303
7407
|
"from": {
|
|
7304
7408
|
"type": "integer",
|
|
7305
7409
|
"minimum": 0,
|
|
7306
|
-
"default": 0
|
|
7410
|
+
"default": 0,
|
|
7411
|
+
"description": "The offset from which to start the search results.\nOnly one of `from` or `search_after` should be used.\n"
|
|
7307
7412
|
},
|
|
7308
7413
|
"size": {
|
|
7309
7414
|
"type": "integer",
|
|
@@ -7332,6 +7437,32 @@
|
|
|
7332
7437
|
},
|
|
7333
7438
|
"include_deleted": {
|
|
7334
7439
|
"$ref": "#/components/schemas/EntitySearchIncludeDeletedParam"
|
|
7440
|
+
},
|
|
7441
|
+
"stable_for": {
|
|
7442
|
+
"type": "integer",
|
|
7443
|
+
"minimum": 0,
|
|
7444
|
+
"maximum": 60,
|
|
7445
|
+
"description": "A TTL (in seconds) that specifies how long the context should be maintained.\nDefaults to 30 seconds; configurable up to 60 seconds to prevent abuse.\nA value of 0 can be provided the close the context after the query.\nDefaults to none.\n"
|
|
7446
|
+
},
|
|
7447
|
+
"stable_query_id": {
|
|
7448
|
+
"type": "string",
|
|
7449
|
+
"description": "A unique identifier of the query context from the last stable query.\nThe context is maintained for the duration of the stable_for value.\n"
|
|
7450
|
+
},
|
|
7451
|
+
"search_after": {
|
|
7452
|
+
"type": "array",
|
|
7453
|
+
"items": {
|
|
7454
|
+
"oneOf": [
|
|
7455
|
+
{
|
|
7456
|
+
"type": "string",
|
|
7457
|
+
"nullable": true
|
|
7458
|
+
},
|
|
7459
|
+
{
|
|
7460
|
+
"type": "number",
|
|
7461
|
+
"nullable": true
|
|
7462
|
+
}
|
|
7463
|
+
]
|
|
7464
|
+
},
|
|
7465
|
+
"description": "The sort values from which to start the search results.\nOnly one of `from` or `search_after` should be used.\nIt is strongly recommended to always use the `sort_end` field from the last search result.\nUsed for deep pagination, typically together with `stable_query_id` to maintain the context between requests.\nRequires explicit sort to work reliably.\nTypically used sort fields are `_id` or `_created_at`.\n"
|
|
7335
7466
|
}
|
|
7336
7467
|
}
|
|
7337
7468
|
},
|
|
@@ -7417,6 +7548,30 @@
|
|
|
7417
7548
|
]
|
|
7418
7549
|
}
|
|
7419
7550
|
}
|
|
7551
|
+
},
|
|
7552
|
+
"stable_query_id": {
|
|
7553
|
+
"type": "string",
|
|
7554
|
+
"description": "A unique identifier of the query context.\nShould be used on the input for the next query that needs to be executed in the same context.\n"
|
|
7555
|
+
},
|
|
7556
|
+
"sort_end": {
|
|
7557
|
+
"type": "array",
|
|
7558
|
+
"items": {
|
|
7559
|
+
"oneOf": [
|
|
7560
|
+
{
|
|
7561
|
+
"type": "string",
|
|
7562
|
+
"nullable": true
|
|
7563
|
+
},
|
|
7564
|
+
{
|
|
7565
|
+
"type": "number",
|
|
7566
|
+
"nullable": true
|
|
7567
|
+
}
|
|
7568
|
+
]
|
|
7569
|
+
},
|
|
7570
|
+
"description": "The sort value of the last item returned in `results`.\nCan be used as the input for the `search_after` in the next query.\n",
|
|
7571
|
+
"example": [
|
|
7572
|
+
1747905443332,
|
|
7573
|
+
"0.000023312468"
|
|
7574
|
+
]
|
|
7420
7575
|
}
|
|
7421
7576
|
}
|
|
7422
7577
|
},
|
|
@@ -7577,7 +7732,9 @@
|
|
|
7577
7732
|
"updateEntity",
|
|
7578
7733
|
"deleteEntity",
|
|
7579
7734
|
"softDeleteEntity",
|
|
7580
|
-
"restoreEntity"
|
|
7735
|
+
"restoreEntity",
|
|
7736
|
+
"relationsAdded",
|
|
7737
|
+
"relationsRemoved"
|
|
7581
7738
|
]
|
|
7582
7739
|
},
|
|
7583
7740
|
"params": {
|
|
@@ -8018,7 +8175,8 @@
|
|
|
8018
8175
|
},
|
|
8019
8176
|
"ClassificationId": {
|
|
8020
8177
|
"type": "string",
|
|
8021
|
-
"example": "taxonomy-slug:classification-slug"
|
|
8178
|
+
"example": "taxonomy-slug:classification-slug",
|
|
8179
|
+
"readOnly": true
|
|
8022
8180
|
},
|
|
8023
8181
|
"ClassificationSlug": {
|
|
8024
8182
|
"type": "string",
|