@twin.org/standards-dataspace-protocol 0.0.3-next.4 → 0.0.3-next.5
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/es/dataTypes/catalogDataTypes.js +32 -0
- package/dist/es/dataTypes/catalogDataTypes.js.map +1 -0
- package/dist/es/dataTypes/{dataspaceProtolDataTypes.js → contractNegotiationDataTypes.js} +3 -29
- package/dist/es/dataTypes/contractNegotiationDataTypes.js.map +1 -0
- package/dist/es/dataTypes/dataspaceProtocolDataTypes.js +27 -0
- package/dist/es/dataTypes/dataspaceProtocolDataTypes.js.map +1 -0
- package/dist/es/dataTypes/transferProcessDataTypes.js +68 -0
- package/dist/es/dataTypes/transferProcessDataTypes.js.map +1 -0
- package/dist/es/index.js +16 -1
- package/dist/es/index.js.map +1 -1
- package/dist/es/models/catalog/ICatalogError.js.map +1 -1
- package/dist/es/models/catalog/ICatalogRequestMessage.js.map +1 -1
- package/dist/es/models/contractNegotiation/IContractNegotiationError.js.map +1 -1
- package/dist/es/models/dataspaceProtocolContextType.js.map +1 -1
- package/dist/es/models/transferProcess/IDataAddress.js +2 -0
- package/dist/es/models/transferProcess/IDataAddress.js.map +1 -0
- package/dist/es/models/transferProcess/IEndpointProperty.js +2 -0
- package/dist/es/models/transferProcess/IEndpointProperty.js.map +1 -0
- package/dist/es/models/transferProcess/ITransferCompletionMessage.js +2 -0
- package/dist/es/models/transferProcess/ITransferCompletionMessage.js.map +1 -0
- package/dist/es/models/transferProcess/ITransferError.js +2 -0
- package/dist/es/models/transferProcess/ITransferError.js.map +1 -0
- package/dist/es/models/transferProcess/ITransferProcess.js +2 -0
- package/dist/es/models/transferProcess/ITransferProcess.js.map +1 -0
- package/dist/es/models/transferProcess/ITransferRequestMessage.js +2 -0
- package/dist/es/models/transferProcess/ITransferRequestMessage.js.map +1 -0
- package/dist/es/models/transferProcess/ITransferStartMessage.js +2 -0
- package/dist/es/models/transferProcess/ITransferStartMessage.js.map +1 -0
- package/dist/es/models/transferProcess/ITransferSuspensionMessage.js +4 -0
- package/dist/es/models/transferProcess/ITransferSuspensionMessage.js.map +1 -0
- package/dist/es/models/transferProcess/ITransferTerminationMessage.js +2 -0
- package/dist/es/models/transferProcess/ITransferTerminationMessage.js.map +1 -0
- package/dist/es/models/transferProcess/transferProcessTypes.js +46 -0
- package/dist/es/models/transferProcess/transferProcessTypes.js.map +1 -0
- package/dist/es/models/transferProcess/types/transferProcessStateType.js +30 -0
- package/dist/es/models/transferProcess/types/transferProcessStateType.js.map +1 -0
- package/dist/es/schemas/CatalogError.json +10 -7
- package/dist/es/schemas/CatalogRequestMessage.json +9 -2
- package/dist/es/schemas/ContractAgreementMessage.json +7 -2
- package/dist/es/schemas/ContractAgreementVerificationMessage.json +7 -2
- package/dist/es/schemas/ContractNegotiation.json +7 -2
- package/dist/es/schemas/ContractNegotiationError.json +8 -36
- package/dist/es/schemas/ContractNegotiationEventMessage.json +7 -2
- package/dist/es/schemas/ContractNegotiationTerminationMessage.json +7 -2
- package/dist/es/schemas/ContractOfferMessage.json +7 -2
- package/dist/es/schemas/ContractRequestMessage.json +7 -2
- package/dist/es/schemas/DataAddress.json +33 -0
- package/dist/es/schemas/DatasetRequestMessage.json +7 -2
- package/dist/es/schemas/EndpointProperty.json +27 -0
- package/dist/es/schemas/TransferCompletionMessage.json +74 -0
- package/dist/es/schemas/TransferError.json +83 -0
- package/dist/es/schemas/TransferProcess.json +109 -0
- package/dist/es/schemas/TransferRequestMessage.json +88 -0
- package/dist/es/schemas/TransferStartMessage.json +78 -0
- package/dist/es/schemas/TransferSuspensionMessage.json +83 -0
- package/dist/es/schemas/TransferTerminationMessage.json +83 -0
- package/dist/types/dataTypes/catalogDataTypes.d.ts +9 -0
- package/dist/types/dataTypes/contractNegotiationDataTypes.d.ts +9 -0
- package/dist/types/dataTypes/transferProcessDataTypes.d.ts +9 -0
- package/dist/types/index.d.ts +15 -1
- package/dist/types/models/catalog/ICatalogError.d.ts +2 -2
- package/dist/types/models/catalog/ICatalogRequestMessage.d.ts +1 -1
- package/dist/types/models/contractNegotiation/IContractNegotiationError.d.ts +1 -11
- package/dist/types/models/dataspaceProtocolContextType.d.ts +1 -1
- package/dist/types/models/transferProcess/IDataAddress.d.ts +24 -0
- package/dist/types/models/transferProcess/IEndpointProperty.d.ts +19 -0
- package/dist/types/models/transferProcess/ITransferCompletionMessage.d.ts +24 -0
- package/dist/types/models/transferProcess/ITransferError.d.ts +32 -0
- package/dist/types/models/transferProcess/ITransferProcess.d.ts +29 -0
- package/dist/types/models/transferProcess/ITransferRequestMessage.d.ts +39 -0
- package/dist/types/models/transferProcess/ITransferStartMessage.d.ts +30 -0
- package/dist/types/models/transferProcess/ITransferSuspensionMessage.d.ts +32 -0
- package/dist/types/models/transferProcess/ITransferTerminationMessage.d.ts +32 -0
- package/dist/types/models/transferProcess/transferProcessTypes.d.ts +46 -0
- package/dist/types/models/transferProcess/types/transferProcessStateType.d.ts +30 -0
- package/docs/changelog.md +20 -0
- package/docs/reference/classes/CatalogDataTypes.md +25 -0
- package/docs/reference/classes/ContractNegotiationDataTypes.md +25 -0
- package/docs/reference/classes/TransferProcessDataTypes.md +25 -0
- package/docs/reference/index.md +16 -0
- package/docs/reference/interfaces/ICatalogError.md +3 -3
- package/docs/reference/interfaces/ICatalogRequestMessage.md +1 -1
- package/docs/reference/interfaces/IContractNegotiationError.md +1 -25
- package/docs/reference/interfaces/IDataAddress.md +36 -0
- package/docs/reference/interfaces/IEndpointProperty.md +28 -0
- package/docs/reference/interfaces/ITransferCompletionMessage.md +36 -0
- package/docs/reference/interfaces/ITransferError.md +52 -0
- package/docs/reference/interfaces/ITransferProcess.md +74 -0
- package/docs/reference/interfaces/ITransferRequestMessage.md +62 -0
- package/docs/reference/interfaces/ITransferStartMessage.md +45 -0
- package/docs/reference/interfaces/ITransferSuspensionMessage.md +52 -0
- package/docs/reference/interfaces/ITransferTerminationMessage.md +52 -0
- package/docs/reference/type-aliases/DataspaceProtocolContextType.md +1 -1
- package/docs/reference/type-aliases/TransferProcessStateType.md +5 -0
- package/docs/reference/type-aliases/TransferProcessTypes.md +5 -0
- package/docs/reference/variables/TransferProcessStateType.md +38 -0
- package/docs/reference/variables/TransferProcessTypes.md +62 -0
- package/package.json +3 -3
- package/dist/es/dataTypes/dataspaceProtolDataTypes.js.map +0 -1
- /package/dist/types/dataTypes/{dataspaceProtolDataTypes.d.ts → dataspaceProtocolDataTypes.d.ts} +0 -0
|
@@ -8,8 +8,13 @@
|
|
|
8
8
|
"description": "The Dataspace Protocol Protocol JSON-LD context type.",
|
|
9
9
|
"anyOf": [
|
|
10
10
|
{
|
|
11
|
-
"type": "
|
|
12
|
-
"
|
|
11
|
+
"type": "array",
|
|
12
|
+
"items": {
|
|
13
|
+
"type": "string",
|
|
14
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
15
|
+
},
|
|
16
|
+
"minItems": 1,
|
|
17
|
+
"maxItems": 1
|
|
13
18
|
},
|
|
14
19
|
{
|
|
15
20
|
"type": "array",
|
|
@@ -8,8 +8,13 @@
|
|
|
8
8
|
"description": "The Dataspace Protocol Protocol JSON-LD context type.",
|
|
9
9
|
"anyOf": [
|
|
10
10
|
{
|
|
11
|
-
"type": "
|
|
12
|
-
"
|
|
11
|
+
"type": "array",
|
|
12
|
+
"items": {
|
|
13
|
+
"type": "string",
|
|
14
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
15
|
+
},
|
|
16
|
+
"minItems": 1,
|
|
17
|
+
"maxItems": 1
|
|
13
18
|
},
|
|
14
19
|
{
|
|
15
20
|
"type": "array",
|
|
@@ -8,8 +8,13 @@
|
|
|
8
8
|
"description": "The Dataspace Protocol Protocol JSON-LD context type.",
|
|
9
9
|
"anyOf": [
|
|
10
10
|
{
|
|
11
|
-
"type": "
|
|
12
|
-
"
|
|
11
|
+
"type": "array",
|
|
12
|
+
"items": {
|
|
13
|
+
"type": "string",
|
|
14
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
15
|
+
},
|
|
16
|
+
"minItems": 1,
|
|
17
|
+
"maxItems": 1
|
|
13
18
|
},
|
|
14
19
|
{
|
|
15
20
|
"type": "array",
|
|
@@ -64,41 +69,8 @@
|
|
|
64
69
|
},
|
|
65
70
|
"reason": {
|
|
66
71
|
"type": "array",
|
|
67
|
-
"items": {
|
|
68
|
-
"type": "object",
|
|
69
|
-
"properties": {
|
|
70
|
-
"@value": {
|
|
71
|
-
"type": "string"
|
|
72
|
-
},
|
|
73
|
-
"@language": {
|
|
74
|
-
"type": "string"
|
|
75
|
-
}
|
|
76
|
-
},
|
|
77
|
-
"required": [
|
|
78
|
-
"@value"
|
|
79
|
-
],
|
|
80
|
-
"additionalProperties": false
|
|
81
|
-
},
|
|
72
|
+
"items": {},
|
|
82
73
|
"description": "The error reason(s)."
|
|
83
|
-
},
|
|
84
|
-
"description": {
|
|
85
|
-
"type": "array",
|
|
86
|
-
"items": {
|
|
87
|
-
"type": "object",
|
|
88
|
-
"properties": {
|
|
89
|
-
"@value": {
|
|
90
|
-
"type": "string"
|
|
91
|
-
},
|
|
92
|
-
"@language": {
|
|
93
|
-
"type": "string"
|
|
94
|
-
}
|
|
95
|
-
},
|
|
96
|
-
"required": [
|
|
97
|
-
"@value"
|
|
98
|
-
],
|
|
99
|
-
"additionalProperties": false
|
|
100
|
-
},
|
|
101
|
-
"description": "The error description(s)."
|
|
102
74
|
}
|
|
103
75
|
},
|
|
104
76
|
"required": [
|
|
@@ -8,8 +8,13 @@
|
|
|
8
8
|
"description": "The Dataspace Protocol Protocol JSON-LD context type.",
|
|
9
9
|
"anyOf": [
|
|
10
10
|
{
|
|
11
|
-
"type": "
|
|
12
|
-
"
|
|
11
|
+
"type": "array",
|
|
12
|
+
"items": {
|
|
13
|
+
"type": "string",
|
|
14
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
15
|
+
},
|
|
16
|
+
"minItems": 1,
|
|
17
|
+
"maxItems": 1
|
|
13
18
|
},
|
|
14
19
|
{
|
|
15
20
|
"type": "array",
|
|
@@ -8,8 +8,13 @@
|
|
|
8
8
|
"description": "The Dataspace Protocol Protocol JSON-LD context type.",
|
|
9
9
|
"anyOf": [
|
|
10
10
|
{
|
|
11
|
-
"type": "
|
|
12
|
-
"
|
|
11
|
+
"type": "array",
|
|
12
|
+
"items": {
|
|
13
|
+
"type": "string",
|
|
14
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
15
|
+
},
|
|
16
|
+
"minItems": 1,
|
|
17
|
+
"maxItems": 1
|
|
13
18
|
},
|
|
14
19
|
{
|
|
15
20
|
"type": "array",
|
|
@@ -8,8 +8,13 @@
|
|
|
8
8
|
"description": "The Dataspace Protocol Protocol JSON-LD context type.",
|
|
9
9
|
"anyOf": [
|
|
10
10
|
{
|
|
11
|
-
"type": "
|
|
12
|
-
"
|
|
11
|
+
"type": "array",
|
|
12
|
+
"items": {
|
|
13
|
+
"type": "string",
|
|
14
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
15
|
+
},
|
|
16
|
+
"minItems": 1,
|
|
17
|
+
"maxItems": 1
|
|
13
18
|
},
|
|
14
19
|
{
|
|
15
20
|
"type": "array",
|
|
@@ -8,8 +8,13 @@
|
|
|
8
8
|
"description": "The Dataspace Protocol Protocol JSON-LD context type.",
|
|
9
9
|
"anyOf": [
|
|
10
10
|
{
|
|
11
|
-
"type": "
|
|
12
|
-
"
|
|
11
|
+
"type": "array",
|
|
12
|
+
"items": {
|
|
13
|
+
"type": "string",
|
|
14
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
15
|
+
},
|
|
16
|
+
"minItems": 1,
|
|
17
|
+
"maxItems": 1
|
|
13
18
|
},
|
|
14
19
|
{
|
|
15
20
|
"type": "array",
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"$id": "https://schema.twindev.org/dataspace-protocol/DataAddress",
|
|
4
|
+
"description": "Interface for Dataspace Protocol Transfer Messages. https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#lower-level-types",
|
|
5
|
+
"type": "object",
|
|
6
|
+
"properties": {
|
|
7
|
+
"@type": {
|
|
8
|
+
"type": "string",
|
|
9
|
+
"const": "DataAddress",
|
|
10
|
+
"description": "LD Type"
|
|
11
|
+
},
|
|
12
|
+
"endpointType": {
|
|
13
|
+
"type": "string",
|
|
14
|
+
"description": "The type of endpoint of this data address."
|
|
15
|
+
},
|
|
16
|
+
"endpoint": {
|
|
17
|
+
"type": "string",
|
|
18
|
+
"description": "The endpoint of the data address"
|
|
19
|
+
},
|
|
20
|
+
"endpointProperties": {
|
|
21
|
+
"type": "array",
|
|
22
|
+
"items": {
|
|
23
|
+
"$ref": "https://schema.twindev.org/dataspace-protocol/EndpointProperty"
|
|
24
|
+
},
|
|
25
|
+
"description": "Properties associated to the endpoint which might depend on the endpoint type."
|
|
26
|
+
}
|
|
27
|
+
},
|
|
28
|
+
"required": [
|
|
29
|
+
"@type",
|
|
30
|
+
"endpointType"
|
|
31
|
+
],
|
|
32
|
+
"additionalProperties": false
|
|
33
|
+
}
|
|
@@ -8,8 +8,13 @@
|
|
|
8
8
|
"description": "The Dataspace Protocol Protocol JSON-LD context type.",
|
|
9
9
|
"anyOf": [
|
|
10
10
|
{
|
|
11
|
-
"type": "
|
|
12
|
-
"
|
|
11
|
+
"type": "array",
|
|
12
|
+
"items": {
|
|
13
|
+
"type": "string",
|
|
14
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
15
|
+
},
|
|
16
|
+
"minItems": 1,
|
|
17
|
+
"maxItems": 1
|
|
13
18
|
},
|
|
14
19
|
{
|
|
15
20
|
"type": "array",
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"$id": "https://schema.twindev.org/dataspace-protocol/EndpointProperty",
|
|
4
|
+
"description": "Interface for Dataspace Protocol Transfer Messages. https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#lower-level-types",
|
|
5
|
+
"type": "object",
|
|
6
|
+
"properties": {
|
|
7
|
+
"@type": {
|
|
8
|
+
"type": "string",
|
|
9
|
+
"const": "EndpointProperty",
|
|
10
|
+
"description": "LD Type."
|
|
11
|
+
},
|
|
12
|
+
"name": {
|
|
13
|
+
"type": "string",
|
|
14
|
+
"description": "Property name."
|
|
15
|
+
},
|
|
16
|
+
"value": {
|
|
17
|
+
"type": "string",
|
|
18
|
+
"description": "Property value."
|
|
19
|
+
}
|
|
20
|
+
},
|
|
21
|
+
"required": [
|
|
22
|
+
"@type",
|
|
23
|
+
"name",
|
|
24
|
+
"value"
|
|
25
|
+
],
|
|
26
|
+
"additionalProperties": false
|
|
27
|
+
}
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"$id": "https://schema.twindev.org/dataspace-protocol/TransferCompletionMessage",
|
|
4
|
+
"description": "Interface for Dataspace Protocol Transfer Messages. https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-completion-message",
|
|
5
|
+
"type": "object",
|
|
6
|
+
"properties": {
|
|
7
|
+
"@context": {
|
|
8
|
+
"description": "The Dataspace Protocol Protocol JSON-LD context type.",
|
|
9
|
+
"anyOf": [
|
|
10
|
+
{
|
|
11
|
+
"type": "array",
|
|
12
|
+
"items": {
|
|
13
|
+
"type": "string",
|
|
14
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
15
|
+
},
|
|
16
|
+
"minItems": 1,
|
|
17
|
+
"maxItems": 1
|
|
18
|
+
},
|
|
19
|
+
{
|
|
20
|
+
"type": "array",
|
|
21
|
+
"minItems": 2,
|
|
22
|
+
"prefixItems": [
|
|
23
|
+
{
|
|
24
|
+
"type": "string",
|
|
25
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
26
|
+
},
|
|
27
|
+
{
|
|
28
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
29
|
+
}
|
|
30
|
+
],
|
|
31
|
+
"items": {
|
|
32
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
33
|
+
}
|
|
34
|
+
},
|
|
35
|
+
{
|
|
36
|
+
"type": "array",
|
|
37
|
+
"minItems": 2,
|
|
38
|
+
"prefixItems": [
|
|
39
|
+
{
|
|
40
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
41
|
+
},
|
|
42
|
+
{
|
|
43
|
+
"type": "string",
|
|
44
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
45
|
+
}
|
|
46
|
+
],
|
|
47
|
+
"items": {
|
|
48
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
]
|
|
52
|
+
},
|
|
53
|
+
"@type": {
|
|
54
|
+
"type": "string",
|
|
55
|
+
"const": "TransferCompletionMessage",
|
|
56
|
+
"description": "LD Type"
|
|
57
|
+
},
|
|
58
|
+
"consumerPid": {
|
|
59
|
+
"type": "string",
|
|
60
|
+
"description": "MUST refer to the transfer identifier of the Consumer side."
|
|
61
|
+
},
|
|
62
|
+
"providerPid": {
|
|
63
|
+
"type": "string",
|
|
64
|
+
"description": "MUST refer to the transfer identifier of the Provider side."
|
|
65
|
+
}
|
|
66
|
+
},
|
|
67
|
+
"required": [
|
|
68
|
+
"@context",
|
|
69
|
+
"@type",
|
|
70
|
+
"consumerPid",
|
|
71
|
+
"providerPid"
|
|
72
|
+
],
|
|
73
|
+
"additionalProperties": false
|
|
74
|
+
}
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"$id": "https://schema.twindev.org/dataspace-protocol/TransferError",
|
|
4
|
+
"description": "Interface for Dataspace Protocol Transfer Messages. https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol#error-transfer-error",
|
|
5
|
+
"type": "object",
|
|
6
|
+
"properties": {
|
|
7
|
+
"@context": {
|
|
8
|
+
"description": "The Dataspace Protocol Protocol JSON-LD context type.",
|
|
9
|
+
"anyOf": [
|
|
10
|
+
{
|
|
11
|
+
"type": "array",
|
|
12
|
+
"items": {
|
|
13
|
+
"type": "string",
|
|
14
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
15
|
+
},
|
|
16
|
+
"minItems": 1,
|
|
17
|
+
"maxItems": 1
|
|
18
|
+
},
|
|
19
|
+
{
|
|
20
|
+
"type": "array",
|
|
21
|
+
"minItems": 2,
|
|
22
|
+
"prefixItems": [
|
|
23
|
+
{
|
|
24
|
+
"type": "string",
|
|
25
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
26
|
+
},
|
|
27
|
+
{
|
|
28
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
29
|
+
}
|
|
30
|
+
],
|
|
31
|
+
"items": {
|
|
32
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
33
|
+
}
|
|
34
|
+
},
|
|
35
|
+
{
|
|
36
|
+
"type": "array",
|
|
37
|
+
"minItems": 2,
|
|
38
|
+
"prefixItems": [
|
|
39
|
+
{
|
|
40
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
41
|
+
},
|
|
42
|
+
{
|
|
43
|
+
"type": "string",
|
|
44
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
45
|
+
}
|
|
46
|
+
],
|
|
47
|
+
"items": {
|
|
48
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
]
|
|
52
|
+
},
|
|
53
|
+
"@type": {
|
|
54
|
+
"type": "string",
|
|
55
|
+
"const": "TransferError",
|
|
56
|
+
"description": "LD Type"
|
|
57
|
+
},
|
|
58
|
+
"consumerPid": {
|
|
59
|
+
"type": "string",
|
|
60
|
+
"description": "MUST refer to the transfer identifier of the Consumer side."
|
|
61
|
+
},
|
|
62
|
+
"providerPid": {
|
|
63
|
+
"type": "string",
|
|
64
|
+
"description": "MUST refer to the transfer identifier of the Provider side."
|
|
65
|
+
},
|
|
66
|
+
"code": {
|
|
67
|
+
"type": "string",
|
|
68
|
+
"description": "The error code."
|
|
69
|
+
},
|
|
70
|
+
"reason": {
|
|
71
|
+
"type": "array",
|
|
72
|
+
"items": {},
|
|
73
|
+
"description": "The error reason(s)."
|
|
74
|
+
}
|
|
75
|
+
},
|
|
76
|
+
"required": [
|
|
77
|
+
"@context",
|
|
78
|
+
"@type",
|
|
79
|
+
"consumerPid",
|
|
80
|
+
"providerPid"
|
|
81
|
+
],
|
|
82
|
+
"additionalProperties": false
|
|
83
|
+
}
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"$id": "https://schema.twindev.org/dataspace-protocol/TransferProcess",
|
|
4
|
+
"description": "Interface for Dataspace Protocol Transfer Messages. https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#ack-transfer-process",
|
|
5
|
+
"type": "object",
|
|
6
|
+
"properties": {
|
|
7
|
+
"@context": {
|
|
8
|
+
"description": "The Dataspace Protocol Protocol JSON-LD context type.",
|
|
9
|
+
"anyOf": [
|
|
10
|
+
{
|
|
11
|
+
"type": "array",
|
|
12
|
+
"items": {
|
|
13
|
+
"type": "string",
|
|
14
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
15
|
+
},
|
|
16
|
+
"minItems": 1,
|
|
17
|
+
"maxItems": 1
|
|
18
|
+
},
|
|
19
|
+
{
|
|
20
|
+
"type": "array",
|
|
21
|
+
"minItems": 2,
|
|
22
|
+
"prefixItems": [
|
|
23
|
+
{
|
|
24
|
+
"type": "string",
|
|
25
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
26
|
+
},
|
|
27
|
+
{
|
|
28
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
29
|
+
}
|
|
30
|
+
],
|
|
31
|
+
"items": {
|
|
32
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
33
|
+
}
|
|
34
|
+
},
|
|
35
|
+
{
|
|
36
|
+
"type": "array",
|
|
37
|
+
"minItems": 2,
|
|
38
|
+
"prefixItems": [
|
|
39
|
+
{
|
|
40
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
41
|
+
},
|
|
42
|
+
{
|
|
43
|
+
"type": "string",
|
|
44
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
45
|
+
}
|
|
46
|
+
],
|
|
47
|
+
"items": {
|
|
48
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
]
|
|
52
|
+
},
|
|
53
|
+
"@type": {
|
|
54
|
+
"type": "string",
|
|
55
|
+
"const": "TransferProcess",
|
|
56
|
+
"description": "LD Type"
|
|
57
|
+
},
|
|
58
|
+
"consumerPid": {
|
|
59
|
+
"type": "string",
|
|
60
|
+
"description": "MUST refer to the transfer identifier of the Consumer side."
|
|
61
|
+
},
|
|
62
|
+
"providerPid": {
|
|
63
|
+
"type": "string",
|
|
64
|
+
"description": "MUST refer to the transfer identifier of the Provider side."
|
|
65
|
+
},
|
|
66
|
+
"state": {
|
|
67
|
+
"type": "object",
|
|
68
|
+
"properties": {
|
|
69
|
+
"COMPLETED": {
|
|
70
|
+
"type": "string",
|
|
71
|
+
"const": "COMPLETED"
|
|
72
|
+
},
|
|
73
|
+
"REQUESTED": {
|
|
74
|
+
"type": "string",
|
|
75
|
+
"const": "REQUESTED"
|
|
76
|
+
},
|
|
77
|
+
"STARTED": {
|
|
78
|
+
"type": "string",
|
|
79
|
+
"const": "STARTED"
|
|
80
|
+
},
|
|
81
|
+
"SUSPENDED": {
|
|
82
|
+
"type": "string",
|
|
83
|
+
"const": "SUSPENDED"
|
|
84
|
+
},
|
|
85
|
+
"TERMINATED": {
|
|
86
|
+
"type": "string",
|
|
87
|
+
"const": "TERMINATED"
|
|
88
|
+
}
|
|
89
|
+
},
|
|
90
|
+
"required": [
|
|
91
|
+
"COMPLETED",
|
|
92
|
+
"REQUESTED",
|
|
93
|
+
"STARTED",
|
|
94
|
+
"SUSPENDED",
|
|
95
|
+
"TERMINATED"
|
|
96
|
+
],
|
|
97
|
+
"additionalProperties": false,
|
|
98
|
+
"description": "The transfer process state."
|
|
99
|
+
}
|
|
100
|
+
},
|
|
101
|
+
"required": [
|
|
102
|
+
"@context",
|
|
103
|
+
"@type",
|
|
104
|
+
"consumerPid",
|
|
105
|
+
"providerPid",
|
|
106
|
+
"state"
|
|
107
|
+
],
|
|
108
|
+
"additionalProperties": false
|
|
109
|
+
}
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"$id": "https://schema.twindev.org/dataspace-protocol/TransferRequestMessage",
|
|
4
|
+
"description": "Interface for Dataspace Protocol Transfer Messages. https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-request-message",
|
|
5
|
+
"type": "object",
|
|
6
|
+
"properties": {
|
|
7
|
+
"@context": {
|
|
8
|
+
"description": "The Dataspace Protocol Protocol JSON-LD context type.",
|
|
9
|
+
"anyOf": [
|
|
10
|
+
{
|
|
11
|
+
"type": "array",
|
|
12
|
+
"items": {
|
|
13
|
+
"type": "string",
|
|
14
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
15
|
+
},
|
|
16
|
+
"minItems": 1,
|
|
17
|
+
"maxItems": 1
|
|
18
|
+
},
|
|
19
|
+
{
|
|
20
|
+
"type": "array",
|
|
21
|
+
"minItems": 2,
|
|
22
|
+
"prefixItems": [
|
|
23
|
+
{
|
|
24
|
+
"type": "string",
|
|
25
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
26
|
+
},
|
|
27
|
+
{
|
|
28
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
29
|
+
}
|
|
30
|
+
],
|
|
31
|
+
"items": {
|
|
32
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
33
|
+
}
|
|
34
|
+
},
|
|
35
|
+
{
|
|
36
|
+
"type": "array",
|
|
37
|
+
"minItems": 2,
|
|
38
|
+
"prefixItems": [
|
|
39
|
+
{
|
|
40
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
41
|
+
},
|
|
42
|
+
{
|
|
43
|
+
"type": "string",
|
|
44
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
45
|
+
}
|
|
46
|
+
],
|
|
47
|
+
"items": {
|
|
48
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
]
|
|
52
|
+
},
|
|
53
|
+
"@type": {
|
|
54
|
+
"type": "string",
|
|
55
|
+
"const": "TransferRequestMessage",
|
|
56
|
+
"description": "LD Type"
|
|
57
|
+
},
|
|
58
|
+
"agreementId": {
|
|
59
|
+
"type": "string",
|
|
60
|
+
"description": "MUST refer to an existing Agreement between the Consumer and Provider."
|
|
61
|
+
},
|
|
62
|
+
"callbackAddress": {
|
|
63
|
+
"type": "string",
|
|
64
|
+
"description": "MUST be a URI indicating where messages to the Consumer SHOULD be sent."
|
|
65
|
+
},
|
|
66
|
+
"consumerPid": {
|
|
67
|
+
"type": "string",
|
|
68
|
+
"description": "MUST refer to the transfer identifier of the Consumer side."
|
|
69
|
+
},
|
|
70
|
+
"format": {
|
|
71
|
+
"type": "string",
|
|
72
|
+
"description": "The format property is a format specified by a Distribution for the Dataset associated with the Agreement. This is generally obtained from the Provider's Catalog."
|
|
73
|
+
},
|
|
74
|
+
"dataAddress": {
|
|
75
|
+
"$ref": "https://schema.twindev.org/dataspace-protocol/DataAddress",
|
|
76
|
+
"description": "If defined MUST contain a transport-specific set of properties for pushing the data. It MAY include an endpoint, a temporary authorization via the endpointProperties property - depending on the endpointType."
|
|
77
|
+
}
|
|
78
|
+
},
|
|
79
|
+
"required": [
|
|
80
|
+
"@context",
|
|
81
|
+
"@type",
|
|
82
|
+
"agreementId",
|
|
83
|
+
"callbackAddress",
|
|
84
|
+
"consumerPid",
|
|
85
|
+
"format"
|
|
86
|
+
],
|
|
87
|
+
"additionalProperties": false
|
|
88
|
+
}
|