Skip to content

Commit 0e05494

Browse files
juliapampusjuliapampus
authored
refactor: restructure list of files (#68)
1 parent 3f9fc7c commit 0e05494

8 files changed

Lines changed: 146 additions & 48 deletions

File tree

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,4 +56,4 @@ A connector will implement additional internal functionalities, like monitoring
5656

5757
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

59-
![Overview on protocol and context](./figures/ProtocolOverview.png)
59+
![Overview on protocol and context](./resources/figures/ProtocolOverview.png)

‎SUMMARY.md‎

Lines changed: 6 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -21,51 +21,10 @@
2121
* [Specification](./transfer/transfer.process.protocol.md)
2222
* [Binding: HTTPS](./transfer/transfer.process.binding.https.md)
2323

24-
## List of files
24+
## List of Files
2525

26-
* [README.md](./README.md)
27-
* [SUMMARY.md](./SUMMARY.md)
28-
* [Section 1 Terminology and Section 2 Concepts](./model/information.model.md)
29-
* [Figure: Entities and Relationships in Data Space](./model/m.dataspace.relationships.png)
30-
* [Figure (source): Entities and Relationships in Data Space](./model/m.dataspace.relationships.puml)
31-
* [Figure: Entities and relationships to DCAT and ODRL](./model/m.participant.entities.png)
32-
* [Figure (source): Entities and relationships to DCAT and ODRL](./model/m.participant.entities.drawio)
33-
* [Section 3 Catalog protocol](./catalog/catalog.protocol.md)
34-
* [Catalog HTTPS Binding](./catalog/catalog.binding.https.md)
35-
* [Example: DCAT Distribution (json)](./catalog/message/example/dcat.distribution.example.json)
36-
* [Example: DCAT Distribution option 1 (json)](./catalog/message/example/dcat.distribution.example.option1.json)
37-
* [Example: DCAT Distribution option 2 (json)](./catalog/message/example/dcat.distribution.example.option2.json)
38-
* [Catalog Error Message (json)](./catalog/message/catalog-error-message.json)
39-
* [Catalog Message (json)](./catalog/message/catalog.json)
40-
* [Catalog Request Message (json)](./catalog/message/catalog-request-message.json)
41-
* [Section 4 Contract Negotiation](./negotiation/contract.negotiation.protocol.md)
42-
* [Contract Negotiation HTTPS Binding](./negotiation/contract.negotiation.binding.https.md)
43-
* [Figure: Contract Negotiation State Machine](./negotiation/contract.negotiation.state.machine.png)
44-
* [Figure (Source): Contract Negotiation State Machine](./negotiation/contract.negotiation.state.machine.puml)
45-
* [Contract Agreement Message (json)](./negotiation/message/contract-agreement-message.json)
46-
* [Contract Agreement Verification Message (json)](./negotiation/message/contract-agreement-verification-message.json)
47-
* [Contract Negotiation Error Message (json)](./negotiation/message/contract-negotiation.json)
48-
* [Contract Negotiation Event Message (json)](./negotiation/message/contract-negotiation-event-message.json)
49-
* [Contract Negotiation Message (json)](./negotiation/message/contract-negotiation.json)
50-
* [Contract Negotiation Termination Message (json)](./negotiation/message/contract-negotiation-termination-message.json)
51-
* [Contract Offer Message (json)](./negotiation/message/contract-offer-message.json)
52-
* [Contract Request Message (json)](./negotiation/message/contract-request-message.json)
53-
* [Example: Contract Agreement Message HTTP](./negotiation/message/example/contract.agreement.message.http.transfer.json)
54-
* [Section 5 Transfer process](./transfer/transfer.process.protocol.md)
55-
* [Transfer process HTTPS Binding](./transfer/transfer.process.binding.https.md)
56-
* [Figure: Transfer Process State Machine](./transfer/transfer-process-state-machine.png)
57-
* [Figure (source): Transfer Process State Machine](./transfer/transfer-process-state-machine.puml)
58-
* [Transfer Completion Message (json)](./transfer/message/transfer-completion-message.json)
59-
* [Transfer Error Message (json)](./transfer/message/transfer-error.json)
60-
* [Transfer Process Message (json)](./transfer/message/transfer-process.json)
61-
* [Transfer Request Message (json)](./transfer/message/transfer-request-message.json)
62-
* [Transfer Start Message (json)](./transfer/message/transfer-start-message.json)
63-
* [Transfer Suspension Message (json)](./transfer/message/transfer-suspension-message.json)
64-
* [Transfer Termination Message (json)](./transfer/message/transfer-termination-message.json)
65-
* [Common Schema (json)](./common/schema/definitions.schema.json)
66-
* [Shape: Contract Agreement Message (ttl)](./negotiation/message/shape/contract-agreement-message-shape.ttl)
67-
* [Shape: Contract Agreement Verification message (ttl)](./negotiation/message/shape/contract-agreement-verification-message-shape.ttl)
68-
* [Shape: Contract Negotiation Event Message (ttl)](./negotiation/message/shape/contract-negotiation-event-message-shape.ttl)
69-
* [Shape: Contract Negotiation Termination Message (ttl)](./negotiation/message/shape/contract-negotiation-termination-message-shape.ttl)
70-
* [Shape: Contract Request Message (ttl)](./negotiation/message/shape/contract-request-message-shape.ttl)
71-
* [diagram.styles.puml](./common/style/diagram.styles.puml)
26+
* [Common](./resources/list_common.md)
27+
* [Figures](./resources/list_figures.md)
28+
* [Messages](./resources/list_messages.md)
29+
* [Schemes](./resources/list_schemes.md)
30+
* [Shapes](./resources/list_shapes.md)

figures/ProtocolOverview.png renamed to resources/figures/ProtocolOverview.png

File renamed without changes.

‎resources/list_common.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Common
2+
3+
* [Context (json)](./../common/schema/context.json)
4+
* [Definitions Scheme (json)](./../common/schema/definitions.schema.json)
5+
* [Message Shape (ttl)](./../common/shape/message-shape.ttl)
6+
* [ODRL Shape (ttl)](./../common/shape/odrl-shapes.ttl)
7+
* [Diagram Style (puml)](./../common/style/diagram.styles.puml)

‎resources/list_figures.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Figures
2+
3+
* [Protocol Overview (png)](./figures/ProtocolOverview.png)
4+
* [Dataspace Relations (png)](./../model/m.dataspace.relationships.png)
5+
* [Dataspace Relations (source)](./../model/m.dataspace.relationships.puml)
6+
* [Participant Entities (png)](./../model/m.participant.entities.png)
7+
* [Participant Entities (source)](./../model/m.participant.entities.drawio)
8+
9+
## Catalog
10+
* [Catalog (png)](./../catalog/message/diagram/catalog.png)
11+
* [Catalog (source)](./../catalog/message/diagram/catalog.puml)
12+
* [Catalog error message (png)](./../catalog/message/diagram/catalog-error-message.png)
13+
* [Catalog error message (source)](./../catalog/message/diagram/catalog-error-message.puml)
14+
* [Catalog request message (png)](./../catalog/message/diagram/catalog-request-message.png)
15+
* [Catalog request message (source)](./../catalog/message/diagram/catalog-request-message.puml)
16+
17+
## Contract Negotiation
18+
* [Contract agreement message (png)](./../negotiation/message/diagram/contract-agreement-message.png)
19+
* [Contract agreement message (source)](./../negotiation/message/diagram/contract-agreement-message.puml)
20+
* [Contract agreement verification message (png)](./../negotiation/message/diagram/contract-agreement-verification-message.png)
21+
* [Contract agreement verification message (source)](./../negotiation/message/diagram/contract-agreement-verification-message.puml)
22+
* [Contract negotiation (png)](./../negotiation/message/diagram/contract-negotiation.png)
23+
* [Contract negotiation (source)](./../negotiation/message/diagram/contract-negotiation.puml)
24+
* [Contract negotiation error (png)](./../negotiation/message/diagram/contract-negotiation-error.png)
25+
* [Contract negotiation error (source)](./../negotiation/message/diagram/contract-negotiation-error.puml)
26+
* [Contract negotiation event message (png)](./../negotiation/message/diagram/contract-negotiation-event-message.png)
27+
* [Contract negotiation event message (source)](./../negotiation/message/diagram/contract-negotiation-event-message.puml)
28+
* [Contract negotiation termination message (png)](./../negotiation/message/diagram/contract-negotiation-termination-message.png)
29+
* [Contract negotiation termination message (source)](./../negotiation/message/diagram/contract-negotiation-termination-message.puml)
30+
* [Contract offer message (png)](./../negotiation/message/diagram/contract-offer-message.png)
31+
* [Contract offer message (source)](./../negotiation/message/diagram/contract-offer-message.puml)
32+
* [Contract request message (png)](./../negotiation/message/diagram/contract-request-message.png)
33+
* [Contract request message (source)](./../negotiation/message/diagram/contract-request-message.puml)
34+
35+
## Transfer Process
36+
* [Transfer completion message (png)](./../transfer/message/diagram/transfer-completion-message.png)
37+
* [Transfer completion message (source)](./../transfer/message/diagram/transfer-completion-message.puml)
38+
* [Transfer error (png)](./../transfer/message/diagram/transfer-error.png)
39+
* [Transfer error (source)](./../transfer/message/diagram/transfer-error.puml)
40+
* [Transfer prcess (png)](./../transfer/message/diagram/transfer-process.png)
41+
* [Transfer prcess (source)](./../transfer/message/diagram/transfer-process.puml)
42+
* [Transfer request message (png)](./../transfer/message/diagram/transfer-request-message.png)
43+
* [Transfer request message (source)](./../transfer/message/diagram/transfer-request-message.puml)
44+
* [Transfer start message (png)](./../transfer/message/diagram/transfer-start-message.png)
45+
* [Transfer start message (source)](./../transfer/message/diagram/transfer-start-message.puml)
46+
* [Transfer suspension message (png)](./../transfer/message/diagram/transfer-suspension-message.png)
47+
* [Transfer suspension message (source)](./../transfer/message/diagram/transfer-suspension-message.puml)
48+
* [Transfer termination message (png)](./../transfer/message/diagram/transfer-termination-message.png)
49+
* [Transfer termination message (source)](./../transfer/message/diagram/transfer-termination-message.puml)

‎resources/list_messages.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Messages
2+
3+
## Catalog
4+
* [Catalog (json)](./../catalog/message/catalog.json)
5+
* [Catalog error message (json)](./../catalog/message/catalog-error-message.json)
6+
* [Catalog request message (json)](./../catalog/message/catalog-request-message.json)
7+
* [Dataset (json)](./../catalog/message/dataset.json)
8+
* [Dataset request message (json)](./../catalog/message/dataset-request-message.json)
9+
10+
## Contract Negotiation
11+
* [Contract agreement message (json)](./../negotiation/message/contract-agreement-message.json)
12+
* [Contract agreement verification message (json)](./../negotiation/message/contract-agreement-verification-message.json)
13+
* [Contract negotiation (json)](./../negotiation/message/contract-negotiation.json)
14+
* [Contract negotiation error (json)](./../negotiation/message/contract-negotiation-error.json)
15+
* [Contract negotiation event message (json)](./../negotiation/message/contract-negotiation-event-message.json)
16+
* [Contract negotiation termination message (json)](./../negotiation/message/contract-negotiation-termination-message.json)
17+
* [Contract offer message (json)](./../negotiation/message/contract-offer-message.json)
18+
* [Contract request message (json)](./../negotiation/message/contract-request-message.json)
19+
20+
## Transfer Process
21+
* [Transfer completion message (json)](./../transfer/message/transfer-completion-message.json)
22+
* [Transfer error (json)](./../transfer/message/transfer-error.json)
23+
* [Transfer prcess (json)](./../transfer/message/transfer-process.json)
24+
* [Transfer request message (json)](./../transfer/message/transfer-request-message.json)
25+
* [Transfer start message (json)](./../transfer/message/transfer-start-message.json)
26+
* [Transfer suspension message (json)](./../transfer/message/transfer-suspension-message.json)
27+
* [Transfer termination message (json)](./../transfer/message/transfer-termination-message.json)

‎resources/list_schemes.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Schemes
2+
3+
4+
## Catalog
5+
* [Catalog error schema (json)](./../catalog/message/schema/catalog-error-message-schema.json)
6+
* [Catalog message schema (json)](./../catalog/message/schema/catalog-message-schema.json)
7+
* [Catalog request message schema (json)](./../catalog/message/schema/catalog-request-message-schema.json)
8+
* [Catalog schema (json)](./../catalog/message/schema/catalog-schema.json)
9+
* [Dataset request message schema (json)](./../catalog/message/schema/dataset-request-message-schema.json)
10+
11+
## Contract Negotiation
12+
* [Contract agreement schema (json)](./../negotiation/message/schema/contract-agreement-message-schema.json)
13+
* [Contract agreement verification schema (json)](./../negotiation/message/schema/contract-agreement-verification-message-schema.json)
14+
* [Contract negotiation error schema (json)](./../negotiation/message/schema/contract-negotiation-error-schema.json)
15+
* [Contract negotiation event schema (json)](./../negotiation/message/schema/contract-negotiation-event-message-schema.json)
16+
* [Contract negotiation schema (json)](./../negotiation/message/schema/contract-negotiation-schema.json)
17+
* [Contract negotiation termination schema (json)](./../negotiation/message/schema/contract-negotiation-termination-message-schema.json)
18+
* [Contract offer message schema (json)](./../negotiation/message/schema/contract-offer-message-schema.json)
19+
* [Contract request schema (json)](./../negotiation/message/schema/contract-request-message-schema.json)
20+
21+
## Transfer Process
22+
* [Transfer completion schema (json)](./../transfer/message/schema/transfer-completion-message-schema.json)
23+
* [Transfer error schema (json)](./../transfer/message/schema/transfer-error-schema.json)
24+
* [Transfer prcess schema (json)](./../transfer/message/schema/transfer-process-schema.json)
25+
* [Transfer request schema (json)](./../transfer/message/schema/transfer-request-message-schema.json)
26+
* [Transfer start schema (json)](./../transfer/message/schema/transfer-start-message-schema.json)
27+
* [Transfer suspension schema (json)](./../transfer/message/schema/transfer-suspension-message-schema.json)
28+
* [Transfer termination schema (json)](./../transfer/message/schema/transfer-termination-message-schema.json)

‎resources/list_shapes.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Shapes
2+
3+
## Catalog
4+
* [Catalog error shape (ttl)](./../catalog/message/shape/catalog-error-message-shape.ttl)
5+
* [Catalog message shape (ttl)](./../catalog/message/shape/catalog-message-shape.ttl)
6+
* [Catalog request message shape (ttl)](./../catalog/message/shape/catalog-request-message-shape.ttl)
7+
* [Catalog shape (ttl)](./../catalog/message/shape/catalog-shape.ttl)
8+
* [Dataset request message shape (ttl)](./../catalog/message/shape/dataset-request-message-shape.ttl)
9+
10+
## Contract Negotiation
11+
* [Contract agreement shape (ttl)](./../negotiation/message/shape/contract-agreement-message-shape.ttl)
12+
* [Contract agreement verification shape (ttl)](./../negotiation/message/shape/contract-agreement-verification-message-shape.ttl)
13+
* [Contract negotiation error shape (ttl)](./../negotiation/message/shape/contract-negotiation-error-shape.ttl)
14+
* [Contract negotiation event shape (ttl)](./../negotiation/message/shape/contract-negotiation-event-message-shape.ttl)
15+
* [Contract negotiation message shape (ttl)](./../negotiation/message/shape/contract-negotiation-message-shape.ttl)
16+
* [Contract negotiation shape (ttl)](./../negotiation/message/shape/contract-negotiation-shape.ttl)
17+
* [Contract negotiation termination shape (ttl)](./../negotiation/message/shape/contract-negotiation-termination-message-shape.ttl)
18+
* [Contract offer message shape (ttl)](./../negotiation/message/shape/contract-offer-message-shape.ttl)
19+
* [Contract request shape (ttl)](./../negotiation/message/shape/contract-request-message-shape.ttl)
20+
21+
## Transfer Process
22+
* [Transfer completion shape (ttl)](./../transfer/message/shape/transfer-completion-message-shape.ttl)
23+
* [Transfer error shape (ttl)](./../transfer/message/shape/transfer-error-shape.ttl)
24+
* [Transfer prcess shape (ttl)](./../transfer/message/shape/transfer-process-shape.ttl)
25+
* [Transfer request shape (ttl)](./../transfer/message/shape/transfer-request-message-shape.ttl)
26+
* [Transfer start shape (ttl)](./../transfer/message/shape/transfer-start-message-shape.ttl)
27+
* [Transfer suspension shape (ttl)](./../transfer/message/shape/transfer-suspension-message-shape.ttl)
28+
* [Transfer termination shape (ttl)](./../transfer/message/shape/transfer-termination-message-shape.ttl)

0 commit comments

Comments
 (0)