chore: adjust links, readd diagrams

.github/workflows/autopublish.yaml

@@ -18,12 +18,8 @@ jobs:
           node-version: 22.x
       - name: Copy files for correct web access
         run: |
-          mkdir ./message
-          mkdir ./figures
-          cp ./**/message/* -R ./message/
-          cp ./**/figures/*.png ./figures/
-          cp ./model/*.png .
-          cp ./releases/* . -r
+          chmod +x ./.github/workflows/script.sh
+          ./.github/workflows/script.sh
       - name: Run Respec
         run:
           sudo npx puppeteer browsers install chrome

.github/workflows/script.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+mkdir -p ./message/schema
+mkdir -p ./message/example
+mkdir -p ./message/diagram
+mkdir ./figures
+cp ./artifacts/src/main/resources/**/* ./message/schema || true
+echo "successfully copied message schemas"
+cp -R "./artifacts/src/main/resources"/**/"example"/* ./message/example
+echo "successfully copied message examples"
+cp -R "./specifications"/**/"message/diagram"/*".png" message/diagram
+echo "successfully copied message diagrams"
+cp -R "./specifications"/**/"figures"/*".png" ./figures/
+echo "successfully copied figures"
+cp -R "./specifications/releases"/** .
+echo "successfully copied releases"
+#rm -rf artifacts
+#echo "successfully removed artifacts"

.gitignore

@@ -7,8 +7,6 @@
 *.zip
 *.tar.gz
 *.rar
-# only top level images
-*.png
 
 .idea
 *.iml

README.md

@@ -16,8 +16,8 @@ This version ([2024-1](https://github.com/International-Data-Spaces-Association/
 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 define the schemas and protocols required for entities to publish data, negotiate [Agreements](specifications/model/terminology.md#agreement), and access data as part of a federation of technical systems termed a [Dataspace](specifications/model/terminology.md#dataspace).
 
 
-* [Introduction to the Dataspace Protocol](specifications/introduction.md)
-* [Scope of the Dataspace Protocol](specifications/scope.md)
+* [Introduction to the Dataspace Protocol](specifications/common/introduction.md)
+* [Scope of the Dataspace Protocol](specifications/common/scope.md)
 
 ## Introduction
 

index.html

@@ -49,46 +49,46 @@ <h1 id="title">Dataspace Protocol</h1>
     </p>
 </section>
 
-<section class="notoc" data-include="foreword.md" data-include-format="markdown">
+<section class="notoc" data-include="specifications/common/foreword.md" data-include-format="markdown">
 </section>
 
-<section class="notoc" data-include="introduction.md" data-include-format="markdown">
+<section class="notoc" data-include="specifications/common/introduction.md" data-include-format="markdown">
 </section>
 
-<section data-include="scope.md" data-include-format="markdown">
+<section data-include="specifications/common/scope.md" data-include-format="markdown">
 </section>
 
-<section data-include="normative.references.md" data-include-format="markdown">
+<section data-include="specifications/common/normative.references.md" data-include-format="markdown">
 </section>
 
-<section data-include="model/terminology.md" data-include-format="markdown">
+<section data-include="specifications/model/terminology.md" data-include-format="markdown">
 </section>
 
-<section data-include="model/model.md" data-include-format="markdown">
+<section data-include="specifications/model/model.md" data-include-format="markdown">
 </section>
 
-<section data-include="common/common.protocol.md" data-include-format="markdown">
+<section data-include="specifications/common/common.protocol.md" data-include-format="markdown">
 </section>
 
-<section data-include="common/common.binding.https.md" data-include-format="markdown">
+<section data-include="specifications/common/common.binding.https.md" data-include-format="markdown">
 </section>
 
-<section data-include="catalog/catalog.protocol.md" data-include-format="markdown">
+<section data-include="specifications/catalog/catalog.protocol.md" data-include-format="markdown">
 </section>
 
-<section data-include="catalog/catalog.binding.https.md" data-include-format="markdown">
+<section data-include="specifications/catalog/catalog.binding.https.md" data-include-format="markdown">
 </section>
 
-<section data-include="negotiation/contract.negotiation.protocol.md" data-include-format="markdown">
+<section data-include="specifications/negotiation/contract.negotiation.protocol.md" data-include-format="markdown">
 </section>
 
-<section data-include="negotiation/contract.negotiation.binding.https.md" data-include-format="markdown">
+<section data-include="specifications/negotiation/contract.negotiation.binding.https.md" data-include-format="markdown">
 </section>
 
-<section data-include="transfer/transfer.process.protocol.md" data-include-format="markdown">
+<section data-include="specifications/transfer/transfer.process.protocol.md" data-include-format="markdown">
 </section>
 
-<section data-include="transfer/transfer.process.binding.https.md" data-include-format="markdown">
+<section data-include="specifications/transfer/transfer.process.binding.https.md" data-include-format="markdown">
 </section>
 
 <section id='conformance'></section>

specifications/introduction.md → specifications/common/introduction.md

@@ -29,4 +29,4 @@ The same applies for the actual data that is transferred between the systems. Wh
 transport protocol, the structure, syntax or semantics of the data, a specification for those aspects is required and
 subject to the agreements of the [=Participants=] or the [=Dataspace=].
 
-![Overview on protocol and context](resources/figures/ProtocolOverview.png "Overview on protocol and context")
+![Overview on protocol and context](./figures/ProtocolOverview.png "Overview on protocol and context")

specifications/common/scope.md

@@ -0,0 +1,30 @@
+# Scope
+
+Sharing data between autonomous entities requires the provision of metadata to facilitate the transfer of [Datasets](../model/terminology.md#dataset) by making use of a data transfer (or application layer) protocol.
+The __Dataspace Protocol__ defines how this metadata is provisioned:
+
+1. How [Datasets](../model/terminology.md#dataset) are deployed as [DCAT Catalogs](https://www.w3.org/TR/vocab-dcat-3/#Class:Catalog) and usage control is expressed as [ODRL Policies](https://www.w3.org/TR/odrl-model/).
+2. How [Agreements](../model/terminology.md#agreement) that govern data usage are syntactically expressed and electronically negotiated.
+3. How [Datasets](../model/terminology.md#dataset) are accessed using [Transfer Process Protocols](../model/terminology.md#transfer-process-protocol).
+
+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.
+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.
+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 [Dataspace](../model/terminology.md#dataspace).
+On this foundation the bindings to data transfer protocols, like HTTPS, are described.
+
+The specifications are organized into the following documents:
+
+* [__*Dataspace Model*__](../model/model.md) and [__*Dataspace Terminology*__](../model/terminology.md) documents that define key terms.
+* [__*Common Functionalities*__](common.protocol.md) and their [__*Binding in HTTPS*__](common.binding.https.md) declares cross-cutting functions as, e.g., the declaration of supported versions of this Dataspace Protocol.
+* [__*Catalog Protocol*__](../catalog/catalog.protocol.md) and [__*Catalog HTTPS Binding*__](../catalog/catalog.binding.https.md) documents that define how [DCAT Catalogs](https://www.w3.org/TR/vocab-dcat-3/#Class:Catalog) are published and accessed as HTTPS endpoints respectively.
+* [__*Contract Negotiation Protocol*__](../negotiation/contract.negotiation.protocol.md) and [__*Contract Negotiation HTTPS Binding*__](../negotiation/contract.negotiation.binding.https.md) documents that define how [Contract Negotiations](../model/terminology.md#contract-negotiation) are conducted and requested via HTTPS endpoints.
+* [__*Transfer Process Protocol*__](../transfer/transfer.process.protocol.md) and [__*Transfer Process HTTPS Binding*__](../transfer/transfer.process.binding.https.md) documents that define how [Transfer Processes](../model/terminology.md#transfer-process) using a given data transfer protocol are governed via HTTPS
+  endpoints.
+
+> **This specification does not cover the data transfer process as such.**
+>
+> While the data transfer is controlled by the __*Transfer Process Protocol*__ mentioned above, e.g. the initation of the transfer channels or their decomissioning, the data transfer itself and especially the handling of technical exceptions is an obligation to the Transport Protocol.
+>
+> As an implication, the data transfer can be conducted in a separated process if required, as long as this process is to the specified extend controlled by the __*Transfer Process Protocol*__.
+>
+> Nevertheless, illustrative message examples are provided in the [__*Transfer Process Protocol section*__](../transfer/transfer.process.protocol.md#2-message-types). The best practices section may contain further non-normative examples and explanations.

specifications/model/model.md

@@ -14,7 +14,7 @@ a Dataspace. This may require additional concepts, which are not in the scope of
 The definitions below are therefore informative and not-normative.
 The relationships between the primary [=Dataspace=] entities are defined as follows:
 
-![](m.dataspace.relationships.png "Information Model Relationships")
+![](figures/m.dataspace.relationships.png "Information Model Relationships")
 
 Note that all relationships are multiplicities unless specified. `Dataspace Authority` and `Dataspace Registry` are non-normative entities.
 
@@ -34,7 +34,7 @@ The following concepts are therefore normative.
 
 The diagram below depicts the relationships between [=Participant Agent=] types:
 
-![](m.participant.entities.png "Class Diagram Participant Agent")
+![](figures/m.participant.entities.png "Class Diagram Participant Agent")
 
 - A [=Catalog Service=] is a [=Participant Agent=] that makes a [DCAT Catalog](https://www.w3.org/TR/vocab-dcat-3/#Class:Catalog) available to other [=Participants=].
 - A [=Catalog=] contains one or more [=Datasets=], which are [DCAT Datasets](https://www.w3.org/TR/vocab-dcat-3/#Class:Dataset). A [=Catalog=] also contains **_at least one_** [DCAT DataService](https://www.w3.org/TR/vocab-dcat-3/#Class:Data_Service) that references a [=Connector=] where [=Datasets=] may be obtained.