Skip to content

Commit 91bc46d

Browse files
authored
chore: update protocol naming and version (#58)
* fix: change protocol version from 1.0 to 0.8 * chore: set protocol name and version in README * fix(README): resolve typos * fix: change data connector to connector
1 parent c0231ff commit 91bc46d

105 files changed

Lines changed: 185 additions & 185 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# International Dataspaces (IDS) - Version X
1+
# Dataspace Protocol - Version 0.8
22

33
### Working Draft 1 February 2023
44

@@ -8,27 +8,27 @@
88
99
## Abstract
1010

11-
IDS is a set of specifications designed to facilitate interoperable data sharing between entities governed by usage control and based on Web technologies. These specifications
11+
The __Dataspace Protocol__ is a set of specifications designed to facilitate interoperable data sharing between entities governed by usage control and based on Web technologies. These specifications
1212
define the schemas and protocols required for entities to publish data, negotiate usage agreements, and access data as part of a federation of technical systems termed a
1313
__*dataspace*__.
1414

1515
## Introduction
1616

1717
Sharing data between autonomous entities requires the provision of metadata to facilitate the transfer of assets by making use of a data transfer (or application layer) protocol.
18-
IDS defines how this metadata is provisioned:
18+
The __Dataspace Protocol__ defines how this metadata is provisioned:
1919

2020
1. How data assets are deployed as [DCAT Catalogs](https://www.w3.org/TR/vocab-dcat-3/) and usage control is expressed as [ODRL Policies](https://www.w3.org/TR/odrl-model/).
2121
2. How contract agreements that govern data usage are syntactically expressed and electronically negotiated.
2222
3. How data assets are accessed using data transfer protocols.
2323

2424
These specifications build on protocols located in the [ISO OSI model (ISO/IEC 7498-1:1994)](https://www.iso.org/standard/20269.html) layers, like HTTPS.
25-
The purpose of this specification is to define interactions between systems independend of such protocols, but describing how to implement it in an unambigious and extensible way.
25+
The purpose of this specification is to define interactions between systems independent of such protocols, but describing how to implement it in an unambiguous and extensible way.
2626
To do so, the messages that are exchanged during the process are described in this specification and the states and their transitions are specified as state machines, based on the key terms and concepts of a data space.
2727
On this foundation the binding to data transfer protocols, like HTTPS, is described.
2828

2929
The specifications are organized into the following documents:
3030

31-
* A __*Dataspace Information Model*__ document that defines key terms.
31+
* __*Dataspace Model*__ and __*Dataspace Terminology*__ documents that define key terms.
3232
* __*Catalog Protocol*__ and __*Catalog HTTPS Binding*__ documents that define how DCAT Catalogs are published and accessed as HTTPS endpoints respectively.
3333
* __*Contract Negotiation Protocol*__ and __*Contract Negotiation HTTPS Binding*__ documents that define how contract negotiations are conducted and requested via HTTPS endpoints.
3434
* __*Transfer Process Protocol*__ and __*Transfer Process HTTPS Binding*__ documents that define how transfer processes using a given data transfer protocol are governed via HTTPS
@@ -40,20 +40,20 @@ As an implication, the data transfer can be conducted in a separated process if
4040

4141
### Context of this specification
4242

43-
The __*Name of the protocol goes here*__ is used in the context of data spaces as described and defined in the subequent sections with the purpose to support interoperability.
44-
In this context, the specification provides fundamental technical interoperability for particiants in data spaces and therefore the protocol specified here is required to join any data space as specified [here]().
43+
The __Dataspace Protocol__ is used in the context of data spaces as described and defined in the subsequent sections with the purpose to support interoperability.
44+
In this context, the specification provides fundamental technical interoperability for participants in data spaces and therefore the protocol specified here is required to join any data space as specified [here]().
4545
Beyond the technical interoperability measures described in this specification, semantic interoperability should also be addressed by the participants. On the perspective of the data space, interoperability needs to be addressed also on the level of trust, on organizational level and on legal level.
4646
The aspect of cross data space communication is not subject of this document, as this is addressed by the data spaces' organizational and legal agreements.
4747

48-
The interaction of participants in a data space is conducted by the participant agents, so called Data Connectors, which implement the protocols described above.
49-
While most interactions take place between data connectors, some interactions with other systems are required.
48+
The interaction of participants in a data space is conducted by the participant agents, so-called Connectors, which implement the protocols described above.
49+
While most interactions take place between Connectors, some interactions with other systems are required.
5050
The figure below provides an overview on the context of this specification.
5151

5252
An Identity Provider realizes the required interfaces and provides required information to implement Trust Framework of a data space.
53-
The validation of the identity of a given participant agent and the validation of addtional claims is the fundamental mechanism. The strucutre and content of such claims and identity may vary between different data spaces, as well as the structure of such an Identity Provider, e.g. a centralized system, a decentralized system or a federated system.
53+
The validation of the identity of a given participant agent and the validation of additional claims is the fundamental mechanism. The structure and content of such claims and identity may vary between different data spaces, as well as the structure of such an Identity Provider, e.g. a centralized system, a decentralized system or a federated system.
5454

55-
A connector will implement addtional internal functionalities, like monitoring or Policy Engines, as appropriate. It is not covered by this specification, if a connector implements such or how.
55+
A connector will implement additional internal functionalities, like monitoring or Policy Engines, as appropriate. It is not covered by this specification, if a connector implements such or how.
5656

57-
The same applies for the data, which is transfered between the systems. While this document does not define the transpprt protocol, the structure, syntax and semantics of the data, a specification for those aspects is required and subject to the agreements of the participants or the data space.
57+
The same applies for the data, which is transferred between the systems. While this document does not define the transport protocol, the structure, syntax and semantics of the data, a specification for those aspects is required and subject to the agreements of the participants or the data space.
5858

5959
![Overview on protocol and context](./figures/ProtocolOverview.png)

catalog/catalog.binding.https.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ POST https://provider.com/catalog/request
3636
Authorization: ...
3737
3838
{
39-
"@context": "https://w3id.org/dspace/1/0/context.json",
39+
"@context": "https://w3id.org/dspace/v0.8/context.json",
4040
"@type": "dspace:CatalogRequest"
4141
"dspace:filter": {}
4242
}
@@ -93,7 +93,7 @@ and the HTTP `Link` header. The `Link` header will contain URLs for navigating t
9393
```
9494
Link: <https://provider.com/catalog?page=2&per_page=100>; rel="next"
9595
{
96-
"@context": "https://w3id.org/dspace/1/0/context.json",
96+
"@context": "https://w3id.org/dspace/v0.8/context.json",
9797
"@type": "dcat:Catalog"
9898
...
9999
}
@@ -140,7 +140,7 @@ POST https://provider.com/catalog/request
140140
Authorization: ...
141141
142142
{
143-
"@context": "https://w3id.org/dspace/1/0/context.json",
143+
"@context": "https://w3id.org/dspace/v0.8/context.json",
144144
"@type": "dspace:CatalogRequest"
145145
"@id: "..."
146146
"dspace:callbackAddress": "https://example.com/endpoint"

catalog/message/catalog-error-message.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"@context": "https://w3id.org/dspace/1/0/context.json",
2+
"@context": "https://w3id.org/dspace/v0.8/context.json",
33
"@type": "dspace:CatalogErrorMessage",
44
"dspace:code": "123:A",
55
"dspace:reason": [
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"@context": "https://w3id.org/dspace/1/0/context.json",
2+
"@context": "https://w3id.org/dspace/v0.8/context.json",
33
"@type": "dspace:CatalogRequestMessage",
44
"dspace:filter": {}
55
}

catalog/message/catalog.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"@context": "https://w3id.org/dspace/1/0/context.json",
2+
"@context": "https://w3id.org/dspace/v0.8/context.json",
33
"@id": "urn:uuid:3afeadd8-ed2d-569e-d634-8394a8836d57",
44
"@type": "dcat:Catalog",
55
"dct:title": "Data Provider A Catalog",
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"@context": "https://w3id.org/dspace/1/0/context.json",
2+
"@context": "https://w3id.org/dspace/v0.8/context.json",
33
"@type": "dspace:DatasetRequestMessage",
44
"dspace:dataset": "urn:uuid:3dd1add8-4d2d-569e-d634-8394a8836a88"
55
}
-2.19 KB
Loading

catalog/message/diagram/catalog-error-message.puml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ hide empty description
77

88

99
class "dspace:CatalogErrorMessage" {
10-
@context : "https://w3id.org/dspace/1/0/context.json"
10+
@context : "https://w3id.org/dspace/v0.8/context.json"
1111
@type : "dspace:CatalogErrorMessage"
1212
dspace:code : String
1313
dspace:reason : Array
-2.04 KB
Loading

catalog/message/diagram/catalog-request-message.puml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ hide empty description
77

88

99
class "dspace:CatalogRequestMessage" {
10-
@context : "https://w3id.org/dspace/1/0/context.json"
10+
@context : "https://w3id.org/dspace/v0.8/context.json"
1111
@type : dspace:CatalogRequestMessage
1212
dspace:filter : Object
1313
}

0 commit comments

Comments
 (0)