Skip to content

Commit

Permalink
chore: markdown inspection
Browse files Browse the repository at this point in the history
  • Loading branch information
juliapampus committed Feb 6, 2024
1 parent c45b400 commit 51d42e4
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 15 deletions.
11 changes: 5 additions & 6 deletions catalog/catalog.protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@ This section describes how the DSP Information Model maps to [DCAT](https://www.

A [Dataset](../model/terminology.md#dataset) is a [DCAT Dataset](https://www.w3.org/TR/vocab-dcat-3/#Class:Dataset) with the following attributes:


##### odrl:hasPolicy

A [Dataset](../model/terminology.md#dataset) must have 1..N `hasPolicy` attributes that contain an [ODRL `Offer`](https://www.w3.org/TR/odrl-vocab/#term-Offer) defining the [Usage Policy](../model/terminology.md#policy) associated with the [Catalog](../model/terminology.md#catalog). Offers must NOT contain any
Expand All @@ -62,7 +61,7 @@ If the Data Service refers to an endpoint that supports the Dataspace Protocol,

| Category | Description |
|------------|----------------------------------------------------------------------------|
| Definition | Specifies the service type |
| Definition | Specifies the service type |
| Domain | [dcat:DataService](https://www.w3.org/TR/vocab-dcat-2/#Class:Data_Service) |
| Type | xsd:string |
| Note | The value of this field is left intentionally open for future extension. |
Expand All @@ -83,7 +82,7 @@ Note that the property `dcat:servesDataset` should be omitted from the `DataServ
The [Catalog](../model/terminology.md#catalog) is a [DCAT Catalog](https://www.w3.org/TR/vocab-dcat-3/#Class:Catalog) with the following restrictions:

1. Each [ODRL `Offer`](https://www.w3.org/TR/odrl-vocab/#term-Offer) must be unique to a [Dataset](../model/terminology.md#dataset) since the target of the [Offer](../model/terminology.md#offer) is derived from its enclosing context.
1. Each [ODRL Offer](https://www.w3.org/TR/odrl-vocab/#term-Offer) linked from a [Catalog](../model/terminology.md#catalog) must NOT include an explicit `target` attribute.
2. Each [ODRL Offer](https://www.w3.org/TR/odrl-vocab/#term-Offer) linked from a [Catalog](../model/terminology.md#catalog) must NOT include an explicit `target` attribute.

## 2 Message Types

Expand Down Expand Up @@ -144,7 +143,7 @@ The [Catalog](../model/terminology.md#catalog) contains all [Datasets](#111-data
|-----------------|---------------------------------------------------------------------------------------------------|
| **Sent by** | [Provider](../model/terminology.md#provider) |
| **Schema** | [TTL Shape](./message/shape/dcat-shapes.ttl), [JSON Schema](./message/schema/dataset-schema.json) |
| **Example** | [Dataset Example](./message/example/dataset.json) |
| **Example** | [Dataset Example](./message/example/dataset.json) |
| **Diagram(s)** | ![](./message/diagram/dataset.png) |

### 3.3 ERROR - Catalog Error
Expand All @@ -158,8 +157,8 @@ The [Catalog](../model/terminology.md#catalog) contains all [Datasets](#111-data

A Catalog Error is used when an error occurred after a [Catalog Request Message](#21-catalog-request-message) or a [Dataset Request Message](#22-dataset-request-message) and the [Provider](../model/terminology.md#provider) cannot provide its [Catalog](../model/terminology.md#catalog) to the requester.

| Field | Type | Description |
|---------|---------------|--------------------------------------------------------------|
| Field | Type | Description |
|-----------|---------------|-------------------------------------------------------------|
| `code` | String | An optional implementation-specific error code. |
| `reasons` | Array[object] | An optional array of implementation-specific error objects. |

Expand Down
2 changes: 1 addition & 1 deletion common/common.binding.https.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ Each implementation must provide the version metadata endpoint, which must use t
/.well-known/dspace-version
```

The contents of the response is a JSON object defined in the [Dataspace Protocol](./common.protocol.md#exposure-of-dataspace-protocol-versions).
The contents of the response is a JSON object defined in the [Dataspace Protocol](./common.protocol.md#1-exposure-of-dataspace-protocol-versions).

Note that if multiple [Connectors](../model/terminology.md#connector--data-service-) are hosted under the same base URL, a path segment appended to the base well-known URL can be used, for example, `https://example.com/.well-known/dspace-version/connector1.`
16 changes: 8 additions & 8 deletions negotiation/contract.negotiation.protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,19 +64,19 @@ The Contract Request Message is sent by a [Consumer](../model/terminology.md#con
- The [Consumer](../model/terminology.md#consumer) must include an `offer` property, which itself must have a `@id` property. If the message includes a `providerPid` property, the request will be associated with an existing CN and a [Consumer](../model/terminology.md#consumer) [Offer](../model/terminology.md#offer) will be created using either the `offer` or `offer.@id` properties. If the message does not include a `providerPid`, a new CN will be created on [Provider](../model/terminology.md#provider) side using either the `offer` or `offer.@id` properties and the [Provider](../model/terminology.md#provider) selects an appropriate `providerPid`.
- An `offer.@id` will generally refer to an [Offer](../model/terminology.md#offer) contained in a [Catalog](../model/terminology.md#catalog). If the [Provider](../model/terminology.md#provider) is not aware of the `offer.@id` value, it must respond with an error message.
- The `callbackAddress` is a URL indicating where messages to the [Consumer](../model/terminology.md#consumer) should be sent in asynchronous settings. If the address is not understood, the [Provider](../model/terminology.md#provider) MUST return an UNRECOVERABLE error.
- Different to a [Catalog](../catalog/catalog.protocol.md#221-odrlhaspolicy) or [Dataset](../catalog/catalog.protocol.md#311-odrlhaspolicy), the Offer inside a ContractRequestMessage must have an `odrl:target` attribute. However, it's contained Rules must not have any `odrl:target` attributes to prevent inconsistencies with the [ODRL inferencing rules for compact policies](https://www.w3.org/TR/odrl-model/#composition-compact).
- Different to a [Catalog](../model/terminology.md#catalog) or [Dataset](../model/terminology.md#dataset), the [Offer](../model/terminology.md#offer) inside a [Contract Request Message](#21-contract-request-message) must have an `odrl:target` attribute. However, it's contained Rules must not have any `odrl:target` attributes to prevent inconsistencies with the [ODRL inferencing rules for compact policies](https://www.w3.org/TR/odrl-model/#composition-compact).


### 2.2 Contract Offer Message

| | |
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------|
| **Sent by** | [Provider](../model/terminology.md#provider) |
| **Resulting state** | `OFFERED`, `TERMINATED` |
| **Response** | [ACK](#31-ack---contract-negotiation) or [ERROR](#32-error---contract-negotiation-error) |
| **Schema** | [TTL Shape](./message/shape/contract-offer-message-shape.ttl), [JSON Schema](./message/schema/contract-offer-message-schema.json) |
| | |
|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|
| **Sent by** | [Provider](../model/terminology.md#provider) |
| **Resulting state** | `OFFERED`, `TERMINATED` |
| **Response** | [ACK](#31-ack---contract-negotiation) or [ERROR](#32-error---contract-negotiation-error) |
| **Schema** | [TTL Shape](./message/shape/contract-offer-message-shape.ttl), [JSON Schema](./message/schema/contract-offer-message-schema.json) |
| **Example** | [Example Initial Message](./message/example/contract-offer-message_initial.json), [Example Message](./message/example/contract-offer-message.json) |
| **Diagram(s)** | ![](./message/diagram/contract-offer-message_initial.png) ![](./message/diagram/contract-offer-message.png) |
| **Diagram(s)** | ![](./message/diagram/contract-offer-message_initial.png) ![](./message/diagram/contract-offer-message.png) |

The Contract Offer Message is sent by a [Provider](../model/terminology.md#provider) to initiate a CN or to respond to a [Contract Request Message](#21-contract-request-message) sent by a [Consumer](../model/terminology.md#consumer).
- If the message includes a `consumerPid` property, the request will be associated with an existing CN. If the message does not include a `consumerPid`, a new CN will be created on [Consumer](../model/terminology.md#consumer) side and the [Consumer](../model/terminology.md#consumer) selects an appropriate `consumerPid`.
Expand Down

0 comments on commit 51d42e4

Please sign in to comment.