npm - @twin.org/dataspace-models - Versions diffs - 0.0.3-next.19 → 0.0.3-next.21 - Mend

@twin.org/dataspace-models 0.0.3-next.19 → 0.0.3-next.21

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.

Files changed (53) hide show

package/docs/changelog.md CHANGED Viewed

@@ -1,5 +1,19 @@
 # Changelog
+## [0.0.3-next.21](https://github.com/twinfoundation/dataspace/compare/dataspace-models-v0.0.3-next.20...dataspace-models-v0.0.3-next.21) (2026-03-17)
+### Features
+* improve open-api examples ([1368dbe](https://github.com/twinfoundation/dataspace/commit/1368dbed5c36e074b4854942304a19b9ce51e088))
+## [0.0.3-next.20](https://github.com/twinfoundation/dataspace/compare/dataspace-models-v0.0.3-next.19...dataspace-models-v0.0.3-next.20) (2026-03-17)
+### Miscellaneous Chores
+* **dataspace-models:** Synchronize repo versions
 ## [0.0.3-next.19](https://github.com/twinfoundation/dataspace/compare/dataspace-models-v0.0.3-next.18...dataspace-models-v0.0.3-next.19) (2026-03-12)

package/docs/reference/classes/DataspaceDataTypes.md CHANGED Viewed

@@ -14,7 +14,7 @@ Dataspace datatypes.
 ## Methods
-### registerTypes()
+### registerTypes() {#registertypes}
 > `static` **registerTypes**(): `void`

package/docs/reference/classes/TransferProcess.md CHANGED Viewed

@@ -15,7 +15,7 @@ This entity is the persistent representation of ITransferProcess.
 ## Properties
-### consumerPid
+### consumerPid {#consumerpid}
 > **consumerPid**: `string`
@@ -24,7 +24,7 @@ Used for direct lookup by consumerPid.
 ***
-### id
+### id {#id}
 > **id**: `string`
@@ -32,7 +32,7 @@ Internal UUID for storage (secondary key for providerPid lookup).
 ***
-### providerPid
+### providerPid {#providerpid}
 > **providerPid**: `string`
@@ -41,7 +41,7 @@ Indexed for lookup by providerPid.
 ***
-### agreementId
+### agreementId {#agreementid}
 > **agreementId**: `string`
@@ -49,7 +49,7 @@ Agreement ID linking to the rights-management Agreement.
 ***
-### state
+### state {#state}
 > **state**: `DataspaceProtocolTransferProcessStateType`
@@ -58,7 +58,7 @@ One of: REQUESTED, STARTED, COMPLETED, SUSPENDED, TERMINATED.
 ***
-### datasetId
+### datasetId {#datasetid}
 > **datasetId**: `string`
@@ -66,7 +66,7 @@ Dataset ID for DSC resolution.
 ***
-### offerId
+### offerId {#offerid}
 > **offerId**: `string`
@@ -74,7 +74,7 @@ Offer ID from the original Catalog offer.
 ***
-### consumerIdentity?
+### consumerIdentity? {#consumeridentity}
 > `optional` **consumerIdentity**: `string`
@@ -82,7 +82,7 @@ Consumer identity (DID or URI).
 ***
-### providerIdentity?
+### providerIdentity? {#provideridentity}
 > `optional` **providerIdentity**: `string`
@@ -90,7 +90,7 @@ Provider identity (DID or URI).
 ***
-### format?
+### format? {#format}
 > `optional` **format**: `string`
@@ -98,7 +98,7 @@ Data format from the Dataset Distribution.
 ***
-### callbackAddress?
+### callbackAddress? {#callbackaddress}
 > `optional` **callbackAddress**: `string`
@@ -106,7 +106,7 @@ Callback address for Consumer notifications.
 ***
-### dateCreated
+### dateCreated {#datecreated}
 > **dateCreated**: `string`
@@ -114,7 +114,7 @@ Creation timestamp (ISO string format).
 ***
-### dateModified
+### dateModified {#datemodified}
 > **dateModified**: `string`
@@ -122,7 +122,7 @@ Last update timestamp (ISO string format).
 ***
-### policies?
+### policies? {#policies}
 > `optional` **policies**: `IDataspaceProtocolPolicy`[]
@@ -130,7 +130,7 @@ Policies from the Agreement (stored as JSON).
 ***
-### dataAddress?
+### dataAddress? {#dataaddress}
 > `optional` **dataAddress**: `IDataspaceProtocolDataAddress`

package/docs/reference/interfaces/IActivityLogDates.md CHANGED Viewed

@@ -4,7 +4,7 @@ Activity log dates.
 ## Properties
-### startDate
+### startDate {#startdate}
 > **startDate**: `string`
@@ -12,7 +12,7 @@ Task processing start timestamp
 ***
-### endDate?
+### endDate? {#enddate}
 > `optional` **endDate**: `string`

package/docs/reference/interfaces/IActivityLogDetails.md CHANGED Viewed

@@ -8,7 +8,7 @@ The details related to the processing of an Activity
 ## Properties
-### id
+### id {#id}
 > **id**: `string`
@@ -16,7 +16,7 @@ The Id of the Activity Log entry.
 ***
-### activityId?
+### activityId? {#activityid}
 > `optional` **activityId**: `string`
@@ -24,7 +24,7 @@ The activity Id that this entry refers to.
 ***
-### generator
+### generator {#generator}
 > **generator**: `string`
@@ -32,7 +32,7 @@ The identity of the Activity's generator.
 ***
-### dateCreated
+### dateCreated {#datecreated}
 > **dateCreated**: `string`
@@ -40,7 +40,7 @@ The creation date of this object.
 ***
-### dateModified
+### dateModified {#datemodified}
 > **dateModified**: `string`
@@ -48,7 +48,7 @@ The last update date of this object.
 ***
-### retryCount?
+### retryCount? {#retrycount}
 > `optional` **retryCount**: `number`

package/docs/reference/interfaces/IActivityLogEntry.md CHANGED Viewed

@@ -8,7 +8,7 @@ The details related to the processing of an Activity
 ## Properties
-### id
+### id {#id}
 > **id**: `string`
@@ -20,7 +20,7 @@ The Id of the Activity Log entry.
 ***
-### activityId?
+### activityId? {#activityid}
 > `optional` **activityId**: `string`
@@ -32,7 +32,7 @@ The activity Id that this entry refers to.
 ***
-### generator
+### generator {#generator}
 > **generator**: `string`
@@ -44,7 +44,7 @@ The identity of the Activity's generator.
 ***
-### dateCreated
+### dateCreated {#datecreated}
 > **dateCreated**: `string`
@@ -56,7 +56,7 @@ The creation date of this object.
 ***
-### dateModified
+### dateModified {#datemodified}
 > **dateModified**: `string`
@@ -68,7 +68,7 @@ The last update date of this object.
 ***
-### retryCount?
+### retryCount? {#retrycount}
 > `optional` **retryCount**: `number`
@@ -80,7 +80,7 @@ Number of times this activity has been retried.
 ***
-### status
+### status {#status}
 > **status**: [`ActivityProcessingStatus`](../type-aliases/ActivityProcessingStatus.md)
@@ -88,7 +88,7 @@ Status of the Activity Processing.
 ***
-### pendingTasks?
+### pendingTasks? {#pendingtasks}
 > `optional` **pendingTasks**: [`ITaskApp`](ITaskApp.md)[]
@@ -96,7 +96,7 @@ The pending tasks that have to be run to process the Activity.
 ***
-### runningTasks?
+### runningTasks? {#runningtasks}
 > `optional` **runningTasks**: [`ITaskApp`](ITaskApp.md) & [`IActivityLogDates`](IActivityLogDates.md)[]
@@ -104,7 +104,7 @@ The running tasks that are processing the Activity.
 ***
-### finalizedTasks?
+### finalizedTasks? {#finalizedtasks}
 > `optional` **finalizedTasks**: [`ITaskApp`](ITaskApp.md) & [`IActivityLogDates`](IActivityLogDates.md) & `object`[]
@@ -112,7 +112,7 @@ The tasks that have already finalized.
 ***
-### inErrorTasks?
+### inErrorTasks? {#inerrortasks}
 > `optional` **inErrorTasks**: [`ITaskApp`](ITaskApp.md) & `object`[]

package/docs/reference/interfaces/IActivityLogEntryGetRequest.md CHANGED Viewed

@@ -4,7 +4,7 @@ Get Request for an Activity Log Entry.
 ## Properties
-### pathParams
+### pathParams {#pathparams}
 > **pathParams**: `object`

package/docs/reference/interfaces/IActivityLogEntryGetResponse.md CHANGED Viewed

@@ -4,7 +4,7 @@ Service Offering response
 ## Properties
-### body
+### body {#body}
 > **body**: [`IActivityLogEntry`](IActivityLogEntry.md)

package/docs/reference/interfaces/IActivityLogStatusNotification.md CHANGED Viewed

@@ -4,7 +4,7 @@ The status supplied to clients of the Dataspace Data Plane
 ## Properties
-### activityLogEntryId
+### activityLogEntryId {#activitylogentryid}
 > **activityLogEntryId**: `string`
@@ -12,7 +12,7 @@ The activity log entry id.
 ***
-### activityId?
+### activityId? {#activityid}
 > `optional` **activityId**: `string`
@@ -20,7 +20,7 @@ The activity Id.
 ***
-### taskProcessingStatus
+### taskProcessingStatus {#taskprocessingstatus}
 > **taskProcessingStatus**: `object`

package/docs/reference/interfaces/IActivityLogStatusNotificationPayload.md CHANGED Viewed

@@ -4,7 +4,7 @@ The status supplied to clients of the Dataspace Data Plane
 ## Properties
-### body
+### body {#body}
 > **body**: [`IActivityLogStatusNotification`](IActivityLogStatusNotification.md)

package/docs/reference/interfaces/IActivityLogStatusRequest.md CHANGED Viewed

@@ -4,7 +4,7 @@ Activity log status
 ## Properties
-### body
+### body {#body}
 > **body**: `object`

package/docs/reference/interfaces/IActivityQuery.md CHANGED Viewed

@@ -4,7 +4,7 @@
 ## Properties
-### activityType?
+### activityType? {#activitytype}
 > `optional` **activityType**: `string`
@@ -12,7 +12,7 @@ FQN of the Activity type.
 ***
-### objectType
+### objectType {#objecttype}
 > **objectType**: `string`
@@ -20,7 +20,7 @@ FQN of the Object Type.
 ***
-### targetType?
+### targetType? {#targettype}
 > `optional` **targetType**: `string`

package/docs/reference/interfaces/IActivityStreamNotifyRequest.md CHANGED Viewed

@@ -4,7 +4,7 @@ Activity Stream Notify Request.
 ## Properties
-### body
+### body {#body}
 > **body**: `IActivityStreamsActivity`

package/docs/reference/interfaces/IActivityTask.md CHANGED Viewed

@@ -4,7 +4,7 @@ Denotes a task associated with an Activity
 ## Properties
-### activityLogEntryId
+### activityLogEntryId {#activitylogentryid}
 > **activityLogEntryId**: `string`
@@ -12,7 +12,7 @@ The activity log entry.
 ***
-### associatedTasks
+### associatedTasks {#associatedtasks}
 > **associatedTasks**: [`ITaskApp`](ITaskApp.md)[]

package/docs/reference/interfaces/ICompleteTransferRequest.md CHANGED Viewed

@@ -4,7 +4,7 @@ API request for completing a transfer process.
 ## Properties
-### pathParams
+### pathParams {#pathparams}
 > **pathParams**: `object`
@@ -18,7 +18,7 @@ Process ID (consumerPid).
 ***
-### headers
+### headers {#headers}
 > **headers**: `object`
@@ -30,7 +30,7 @@ Authorization header containing the Base64-encoded trust payload.
 ***
-### body
+### body {#body}
 > **body**: `IDataspaceProtocolTransferCompletionMessage`

package/docs/reference/interfaces/ICompleteTransferResponse.md CHANGED Viewed

@@ -4,7 +4,7 @@ API response for completing a transfer process.
 ## Properties
-### body
+### body {#body}
 > **body**: `IDataspaceProtocolTransferProcess` \| `IDataspaceProtocolTransferError`
@@ -12,7 +12,7 @@ Transfer Process (DSP compliant) with state COMPLETED, or error.
 ***
-### statusCode?
+### statusCode? {#statuscode}
 > `optional` **statusCode**: `HttpStatusCode`

package/docs/reference/interfaces/IDataAssetEntitiesRequest.md CHANGED Viewed

@@ -4,7 +4,7 @@ Data Request type for representing data requests received by Dataspace Apps.
 ## Properties
-### type
+### type {#type}
 > **type**: `"DataAssetEntities"`
@@ -12,7 +12,7 @@ Data Asset Entities type.
 ***
-### dataAsset
+### dataAsset {#dataasset}
 > **dataAsset**: `IDataspaceProtocolDataset`
@@ -20,7 +20,7 @@ The data asset we are referring to.
 ***
-### entitySet
+### entitySet {#entityset}
 > **entitySet**: [`IEntitySet`](IEntitySet.md)

package/docs/reference/interfaces/IDataAssetEntitiesResponse.md CHANGED Viewed

@@ -4,7 +4,7 @@ Response containing data asset entities with optional pagination Link header.
 ## Properties
-### headers?
+### headers? {#headers}
 > `optional` **headers**: `object`
@@ -16,7 +16,7 @@ Optional headers.
 ***
-### body
+### body {#body}
 > **body**: [`IDataAssetItemList`](IDataAssetItemList.md)

package/docs/reference/interfaces/IDataAssetGetEntitiesRequest.md CHANGED Viewed

@@ -4,7 +4,7 @@ Get Request Data Asset Entities
 ## Properties
-### headers?
+### headers? {#headers}
 > `optional` **headers**: `object`
@@ -16,7 +16,7 @@ The headers which can be used to determine the response data type.
 ***
-### query
+### query {#query}
 > **query**: `object`

package/docs/reference/interfaces/IDataAssetItemList.md CHANGED Viewed

@@ -5,7 +5,7 @@ Pagination is handled via HTTP Link headers.
 ## Properties
-### @context
+### @context {#context}
 > **@context**: `"https://schema.org"`
@@ -13,7 +13,7 @@ The LD Context.
 ***
-### type
+### type {#type}
 > **type**: `"ItemList"`
@@ -21,7 +21,7 @@ The type
 ***
-### itemListElement
+### itemListElement {#itemlistelement}
 > **itemListElement**: `IJsonLdNodeObject`[]

package/docs/reference/interfaces/IDataAssetItemListResult.md CHANGED Viewed

@@ -5,7 +5,7 @@ The cursor is returned via HTTP Link headers (RFC 8288), not in the response bod
 ## Properties
-### itemList
+### itemList {#itemlist}
 > **itemList**: [`IDataAssetItemList`](IDataAssetItemList.md)
@@ -13,7 +13,7 @@ The item list data.
 ***
-### cursor?
+### cursor? {#cursor}
 > `optional` **cursor**: `string`

package/docs/reference/interfaces/IDataAssetQuery.md CHANGED Viewed

@@ -12,7 +12,7 @@ IDataspaceDataPlaneApp.datasetsHandled
 ## Properties
-### datasetId
+### datasetId {#datasetid}
 > **datasetId**: `string`

package/docs/reference/interfaces/IDataAssetQueryRequest.md CHANGED Viewed

@@ -4,7 +4,7 @@ Request to query data asset entities.
 ## Properties
-### headers?
+### headers? {#headers}
 > `optional` **headers**: `object`
@@ -16,7 +16,7 @@ The headers which can be used to determine the response data type.
 ***
-### body
+### body {#body}
 > **body**: `object`
@@ -38,7 +38,7 @@ The filtering query.
 ***
-### query?
+### query? {#query}
 > `optional` **query**: `object`

package/docs/reference/interfaces/IDataspaceActivity.md CHANGED Viewed

@@ -18,7 +18,7 @@ A dataspace activity that restricts an activity so that it can be handled by a D
 ## Properties
-### object
+### object {#object}
 > **object**: `ObjectOrArray`\<`JsonLdObjectWithContext`\<`O` & `object`\>\>
@@ -26,7 +26,7 @@ Activity's Object
 ***
-### target?
+### target? {#target}
 > `optional` **target**: `JsonLdObjectWithContext`\<`T` & `object`\>