Skip to content

Commit

Permalink
refactor: clean up file structure
Browse files Browse the repository at this point in the history
  • Loading branch information
juliapampus committed Feb 17, 2023
1 parent c4bee2a commit 6950efe
Show file tree
Hide file tree
Showing 83 changed files with 41 additions and 41 deletions.
20 changes: 10 additions & 10 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@
* [Figure (source): Entities and relationships to DCAT and ODRL](./model/m.participant.entities.drawio)
* [Section 3 Catalog protocol](./catalog/catalog.protocol.md)
* [Catalog HTTPS Binding](./catalog/catalog.binding.https.md)
* [Example: DCAT Distribution (json)](./catalog/example/dcat.distribution.example.json)
* [Example: DCAT Distribution option 1 (json)](./catalog/example/dcat.distribution.example.option1.json)
* [Example: DCAT Distribution option 2 (json)](./catalog/example/dcat.distribution.example.option2.json)
* [Example: DCAT Distribution (json)](./catalog/message/example/dcat.distribution.example.json)
* [Example: DCAT Distribution option 1 (json)](./catalog/message/example/dcat.distribution.example.option1.json)
* [Example: DCAT Distribution option 2 (json)](./catalog/message/example/dcat.distribution.example.option2.json)
* [Catalog Error Message (json)](./catalog/message/catalog-error-message.json)
* [Catalog Message (json)](./catalog/message/catalog.json)
* [Catalog Request Message (json)](./catalog/message/catalog-request-message.json)
Expand Down Expand Up @@ -62,10 +62,10 @@
* [Transfer Start Message (json)](./transfer/message/transfer-start-message.json)
* [Transfer Suspension Message (json)](./transfer/message/transfer-suspension-message.json)
* [Transfer Termination Message (json)](./transfer/message/transfer-termination-message.json)
* [Common Schema (json)](./common/definitions.schema.json)
* [Shape: Contract Agreement Message (ttl)](./schemas/contract-agreement-message-shape.ttl)
* [Shape: Contract Agreement Verification message (ttl)](./schemas/contract-agreement-verification-message-shape.ttl)
* [Shape: Contract Negotiation Event Message (ttl)](./schemas/contract-negotiation-event-message-shape.ttl)
* [Shape: Contract Negotiation Termination Message (ttl)](./schemas/contract-negotiation-termination-message-shape.ttl)
* [Shape: Contract Request Message (ttl)](./schemas/contract-request-message-shape.ttl)
* [diagram.styles.puml](./diagrams/diagram.styles.puml)
* [Common Schema (json)](./common/schema/definitions.schema.json)
* [Shape: Contract Agreement Message (ttl)](./negotiation/message/shape/contract-agreement-message-shape.ttl)
* [Shape: Contract Agreement Verification message (ttl)](./negotiation/message/shape/contract-agreement-verification-message-shape.ttl)
* [Shape: Contract Negotiation Event Message (ttl)](./negotiation/message/shape/contract-negotiation-event-message-shape.ttl)
* [Shape: Contract Negotiation Termination Message (ttl)](./negotiation/message/shape/contract-negotiation-termination-message-shape.ttl)
* [Shape: Contract Request Message (ttl)](./negotiation/message/shape/contract-request-message-shape.ttl)
* [diagram.styles.puml](./common/style/diagram.styles.puml)
12 changes: 6 additions & 6 deletions catalog/catalog.protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ Future IDS specifications may define additional optional serialization formats.

### 2.1 CatalogRequestMessage

![](./images/catalog-request-message.png)
![](./message/diagram/catalog-request-message.png)

**Sent by**: Consumer

**Example**: [CatalogRequestMessage](./message/catalog-request-message.json)

**Response**: [Catalog](#22-catalog) containing the [DCAT catalog](https://www.w3.org/TR/vocab-dcat-3/#Class:Catalog).

**Schema**: [CatalogRequestMessageShape](../schemas/catalog-request-message-shape.ttl) and the [CatalogRequestMessage JSON Schema](../schemas/catalog-request-message-schema.json)
**Schema**: [CatalogRequestMessageShape](./message/shape/catalog-request-message-shape.ttl) and the [CatalogRequestMessage JSON Schema](./message/schema/catalog-request-message-schema.json)

#### Description

Expand All @@ -43,7 +43,7 @@ be defined in the relevant catalog binding specification.

### 2.2 Catalog

![](./images/catalog.png)
![](./message/diagram/catalog.png)

**Sent by**: Provider

Expand All @@ -52,7 +52,7 @@ be defined in the relevant catalog binding specification.

**Response**: OK or ERROR

**Schema**: [CatalogShape](../schemas/catalog-shape.ttl) and the [Catalog JSON Schema](../schemas/catalog-schema.json)
**Schema**: [CatalogShape](./message/shape/catalog-shape.ttl) and the [Catalog JSON Schema](./message/schema/catalog-schema.json)

#### Description

Expand All @@ -61,15 +61,15 @@ The catalog contains all [Asset Entries](#31-asset-entry) which the requester sh

### 2.3 Catalog Error Message

![](./images/catalog-error-message.png)
![](./message/diagram/catalog-error-message.png)

**Sent by**: Consumer or Provider

**Example**: [CatalogErrorMessage](./message/catalog-error-message.json)

**Response**: OK or ERROR

**Schema**: [CatalogErrorMessageShape](../schemas/catalog-error-message-shape.ttl) and the [CatalogErrorMessage JSON Schema](../schemas/catalog-error-message-schema.json)
**Schema**: [CatalogErrorMessageShape](./message/shape/catalog-error-message-shape.ttl) and the [CatalogErrorMessage JSON Schema](./message/schema/catalog-error-message-schema.json)

#### Description

Expand Down
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
24 changes: 12 additions & 12 deletions negotiation/contract.negotiation.protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ The CN state machine is transitioned upon receipt and acknowledgement of a messa

### 1. ContractRequestMessage

![](./message/contract-request-message.png)
![](./message/diagram/contract-request-message.png)

**Sent by**: Consumer

Expand All @@ -63,9 +63,9 @@ The CN state machine is transitioned upon receipt and acknowledgement of a messa
**Example**: [ContractRequestMessage](./message/contract-request-message.json)

**Response**: [ContractNegotiation](./message/contract-negotiation.json) containing the negotiation id or ERROR:
![](./message/contract-negotiation.png)
![](./message/diagram/contract-negotiation.png)

**Schema**: [ContractRequestMessageShape](../schemas/contract-request-message-shape.ttl), [ContractRequestMessage JSON Schema](../schemas/contract-request-message-schema.json), [ContractNegotiationShape](../schemas/contract-negotiation-shape.ttl) and [ContractNegotiation JSON Schema](../schemas/contract-negotiation-schema.json)
**Schema**: [ContractRequestMessageShape](./message/shape/contract-request-message-shape.ttl), [ContractRequestMessage JSON Schema](./message/schema/contract-request-message-schema.json), [ContractNegotiationShape](./message/shape/contract-negotiation-shape.ttl) and [ContractNegotiation JSON Schema](./message/schema/contract-negotiation-schema.json)

#### Description

Expand All @@ -90,7 +90,7 @@ The _ContractRequestMessage_ is sent by a consumer to initiate a contract negoti
### 2. ContractAgreementMessage

![](./message/contract-agreement-message.png)
![](./message/diagram/contract-agreement-message.png)

**Sent by**: Provider

Expand All @@ -100,7 +100,7 @@ The _ContractRequestMessage_ is sent by a consumer to initiate a contract negoti

**Response**: OK or ERROR

**Schema**: [ContractAgreementMessageShape](../schemas/contract-agreement-message-shape.ttl) and [ContractAgreementMessage JSON Schema](../schemas/contract-agreement-message-schema.json)
**Schema**: [ContractAgreementMessageShape](./message/shape/contract-agreement-message-shape.ttl) and [ContractAgreementMessage JSON Schema](./message/schema/contract-agreement-message-schema.json)

#### Description

Expand All @@ -113,7 +113,7 @@ A _ContractAgreementMessage_ must contain an ODRL Agreement.
### 3. ContractAgreementVerificationMessage


![](./message/contract-agreement-verification-message.png)
![](./message/diagram/contract-agreement-verification-message.png)

**Sent by**: Consumer

Expand All @@ -123,7 +123,7 @@ A _ContractAgreementMessage_ must contain an ODRL Agreement.

**Response**: OK or ERROR

**Schema**: [ContractAgreementVerificationMessageShape](../schemas/contract-agreement-verification-message-shape.ttl) and the [ContractAgreementVerificationMessage JSON Schema](../schemas/contract-agreement-verification-message-schema.json)
**Schema**: [ContractAgreementVerificationMessageShape](./message/shape/contract-agreement-verification-message-shape.ttl) and the [ContractAgreementVerificationMessage JSON Schema](./message/schema/contract-agreement-verification-message-schema.json)

#### Description

Expand All @@ -135,7 +135,7 @@ A _ContractAgreementVerificationMessage_ must contain a `processId`.
### 4. ContractNegotiationEventMessage


![](./message/contract-negotiation-event-message.png)
![](./message/diagram/contract-negotiation-event-message.png)

**Sent by**: Provider or Consumer

Expand All @@ -145,7 +145,7 @@ A _ContractAgreementVerificationMessage_ must contain a `processId`.

**Response**: OK or ERROR

**Schema**: [ContractNegotiationEventMessageShape](../schemas/contract-negotiation-event-message-shape.ttl) and the [ContractNegotiationEventMessage JSON Schema](../schemas/contract-negotiation-event-message-schema.json)
**Schema**: [ContractNegotiationEventMessageShape](./message/shape/contract-negotiation-event-message-shape.ttl) and the [ContractNegotiationEventMessage JSON Schema](./message/schema/contract-negotiation-event-message-schema.json)

#### Description

Expand All @@ -168,7 +168,7 @@ provider to send a contract negotiation event after the negotiation state machin

### 5. ContractNegotiationTerminationMessage

![](./message/contract-negotiation-termination-message.png)
![](./message/diagram/contract-negotiation-termination-message.png)


**Sent by**: Consumer or Provider
Expand All @@ -177,7 +177,7 @@ provider to send a contract negotiation event after the negotiation state machin

**Example**: [ContractNegotiationTerminationMessage](./message/contract-negotiation-termination-message.json)

**Schema**: [ContractNegotiationTerminationMessageShape](../schemas/contract-negotiation-termination-message-shape.ttl) and the [ContractNegotiationTerminationMessage JSON Schema](../schemas/contract-negotiation-termination-message-schema.json)
**Schema**: [ContractNegotiationTerminationMessageShape](./message/shape/contract-negotiation-termination-message-shape.ttl) and the [ContractNegotiationTerminationMessage JSON Schema](./message/schema/contract-negotiation-termination-message-schema.json)

#### Description

Expand All @@ -199,7 +199,7 @@ without providing an explanation. Nevertheless, the sender may provide a descrip

**Example**: [NegotiationError](./message/contract-negotiation-error.json)

**Schema**: [ContractNegotiationErrorShape](../schemas/contract-negotiation-error-shape.ttl) and the [ContractNegotiationErrorMessage JSON Schema](../schemas/contract-negotiation-error-schema.json)
**Schema**: [ContractNegotiationErrorShape](./message/shape/contract-negotiation-error-shape.ttl) and the [ContractNegotiationErrorMessage JSON Schema](./message/schema/contract-negotiation-error-schema.json)

#### Description

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
26 changes: 13 additions & 13 deletions transfer/transfer.process.protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ The TP states are:

### 1. Transfer Request Message

![](./images/transfer-request-message.png)
![](./message/diagram/transfer-request-message.png)

**Sent by**: Consumer

Expand All @@ -81,9 +81,9 @@ The TP states are:

**Response**: [TransferProcess](./message/transfer-process.json) containing the transfer process id or ERROR.

![](./images/transfer-process.png)
![](./message/diagram/transfer-process.png)

**Schema**: [TransferRequestMessage](../schemas/transfer-request-message-shape.ttl), [TransferRequestMessage JSON Schema](../schemas/transfer-request-message-schema.json), [TransferProcess Shape](../schemas/transfer-process-shape.ttl) and the [TransferProcess JSON Schema](../schemas/transfer-process-schema.json)
**Schema**: [TransferRequestMessage](./message/shape/transfer-request-message-shape.ttl), [TransferRequestMessage JSON Schema](./message/schema/transfer-request-message-schema.json), [TransferProcess Shape](./message/shape/transfer-process-shape.ttl) and the [TransferProcess JSON Schema](./message/schema/transfer-process-schema.json)

#### Description

Expand Down Expand Up @@ -112,7 +112,7 @@ Providers must include a `correlationId` property in the `TransferProcessMessage

### 2. Transfer Start Message

![](./images/transfer-start-message.png)
![](./message/diagram/transfer-start-message.png)

**Sent by**: Provider

Expand All @@ -122,7 +122,7 @@ Providers must include a `correlationId` property in the `TransferProcessMessage

**Response**: ACK or ERROR.

**Schema**: [TransferStartMessageShape](../schemas/transfer-start-message-shape.ttl) and the [TransferStartMessage JSON Schema](../schemas/transfer-start-message-schema.json)
**Schema**: [TransferStartMessageShape](./message/shape/transfer-start-message-shape.ttl) and the [TransferStartMessage JSON Schema](./message/schema/transfer-start-message-schema.json)


#### Description
Expand All @@ -136,7 +136,7 @@ The _TransferStartMessage_ is sent by the provider to indicate the asset transfe

### 3. Transfer Suspension Message

![](./images/transfer-suspension-message.png)
![](./message/diagram/transfer-suspension-message.png)

**Sent by**: Provider or Consumer

Expand All @@ -146,15 +146,15 @@ The _TransferStartMessage_ is sent by the provider to indicate the asset transfe

**Response**: ACK or ERROR.

**Schema**: [TransferSuspensionMessageShape](../schemas/transfer-suspension-message-shape.ttl) and the [TransferSuspensionMessage JSON Schema](../schemas/transfer-suspension-message-schema.json)
**Schema**: [TransferSuspensionMessageShape](./message/shape/transfer-suspension-message-shape.ttl) and the [TransferSuspensionMessage JSON Schema](./message/schema/transfer-suspension-message-schema.json)

#### Description

The _TransferSuspensionMessage_ is sent by the provider or consumer when either of them needs to temporarily suspend the data transfer.

### 4. Transfer Completion Message

![](./images/transfer-completion-message.png)
![](./message/diagram/transfer-completion-message.png)

**Sent by**:

Expand All @@ -164,7 +164,7 @@ The _TransferSuspensionMessage_ is sent by the provider or consumer when either

**Response**: ACK or ERROR.

**Schema**: [TransferCompletionMessageShape](../schemas/transfer-completion-message-shape.ttl) and the [TransferCompletionMessage JSON Schema](../schemas/transfer-completion-message-schema.json)
**Schema**: [TransferCompletionMessageShape](./message/shape/transfer-completion-message-shape.ttl) and the [TransferCompletionMessage JSON Schema](./message/schema/transfer-completion-message-schema.json)

#### Description

Expand All @@ -173,7 +173,7 @@ notification by performing it as part of its wire protocol. In those cases, a _T

### 5. Transfer Termination Message

![](./images/transfer-termination-message.png)
![](./message/diagram/transfer-termination-message.png)

**Sent by**: Provider or Consumer

Expand All @@ -183,7 +183,7 @@ notification by performing it as part of its wire protocol. In those cases, a _T

**Response**: ACK or ERROR.

**Schema**: [TransferTerminationMessageShape](../schemas/transfer-termination-message-shape.ttl) and the [TransferTerminationMessage JSON Schema](../schemas/transfer-termination-message-schema.json)
**Schema**: [TransferTerminationMessageShape](./message/shape/transfer-termination-message-shape.ttl) and the [TransferTerminationMessage JSON Schema](./message/schema/transfer-termination-message-schema.json)

#### Description

Expand All @@ -192,13 +192,13 @@ a terminal state. If the termination was due to an error, the sender may include

## TransferError

![](./images/transfer-error.png)
![](./message/diagram/transfer-error.png)

**Sent by**: Consumer or Provider

**Example**: [TransferError](./message/transfer-error.json)

**Schema**: [TransferErrorShape](../schemas/transfer-error-shape.ttl) and the [TransferError JSON Schema](../schemas/transfer-error-schema.json)
**Schema**: [TransferErrorShape](./message/shape/transfer-error-shape.ttl) and the [TransferError JSON Schema](./message/schema/transfer-error-schema.json)

#### Description

Expand Down

0 comments on commit 6950efe

Please sign in to comment.