Skip to content

Commit c7884e7

Browse files
arnoweissssteinbuss
authored andcommitted
fix: resolve respec message definition errors
1 parent 226ebff commit c7884e7

7 files changed

Lines changed: 13 additions & 13 deletions

File tree

specifications/catalog/catalog.binding.https.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This binding defines a RESTful Application Programming Interface (API) over HTTP
1010
URL is `api.example.com`, the URL `https://<base>/catalog/request` will map
1111
to `https//api.example.com/catalog/request`.
1212

13-
2. All request and response [=Messages=] MUST use the `application/json` media type.
13+
2. All request and response messages MUST use the `application/json` media type.
1414

1515
### Catalog Error
1616

specifications/common/common.protocol.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ does not require authorization.
88

99
## Schemas & Contexts
1010

11-
All protocol [=Messages=] are normatively defined by a [[json-schema]]. This specification also uses JSON-LD 1.1 and
11+
All protocol messages are normatively defined by a [[json-schema]]. This specification also uses JSON-LD 1.1 and
1212
provides a JSON-LD context to serialize data structures and [=Message types=] as it facilitates extensibility. The
1313
JSON-LD context is designed to produce Message serializations using compaction that validate against the JSON Schema
14-
for the given [=Message type=]. This allows implementations to choose whether to process [=Messages=] as plain JSON or
14+
for the given [=Message type=]. This allows implementations to choose whether to process messages as plain JSON or
1515
as JSON-LD and maintain interoperability between those approaches. Profiles that use JSON-LD are encouraged to provide
1616
similar contexts that facilitate this approach to interoperability. As this specification's JSON-LD objects are
1717
`@protected`, [=Profile=] authors are advised to define their custom terms as protected to spot term redefinition early.

specifications/common/introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The __Dataspace Protocol__ is used in the context of [=Dataspaces=] as described and defined in the subsequent sections with the purpose to support _interoperability_. In this context, the specification provides fundamental technical interoperability for [=Participants=] in [=Dataspaces=].
44

5-
This specification builds on protocols located in the [ISO OSI model (ISO/IEC 7498-1:1994)](https://www.iso.org/standard/20269.html) layers, like the Hypertext Transfer Protocol (HTTP). 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=]. On this foundation the bindings to [=Data Transfer Protocols=], like Hypertext Transfer Protocol Secure (HTTPS), are described.
5+
This specification builds on protocols located in the [ISO OSI model (ISO/IEC 7498-1:1994)](https://www.iso.org/standard/20269.html) layers, like the Hypertext Transfer Protocol (HTTP). 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=]. On this foundation the bindings to [=Data Transfer Protocols=], like Hypertext Transfer Protocol Secure (HTTPS), are described.
66

77
_Note: This specification does not cover the data transfer as such. While this is controlled by the [=Transfer Process Protocol=], e.g., the initiation 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._
88

specifications/negotiation/contract.negotiation.binding.https.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This binding defines a RESTful API over HTTPS for the [Contract Negotiation Prot
99
1. The `<base>` notation indicates the base URL for a [=Connector=] endpoint. For example, if the base [=Connector=] URL
1010
is `connector.example.com`, the URL `https://<base>/negotiations/request` will map
1111
to `https//connector.example.com/negotiation/request`.
12-
2. All request and response [=Messages=] MUST use the `application/json` media type. Derived media types,
12+
2. All request and response messages MUST use the `application/json` media type. Derived media types,
1313
e.g., `application/ld+json` MAY be exposed in addition.
1414

1515
### Contract Negotiation Error
@@ -89,10 +89,10 @@ Authorization: ...</pre>
8989
</pre>
9090
</aside>
9191

92-
- The `callbackAddress` property specifies the base endpoint `URL` where the client receives [=Messages=] associated with
92+
- The `callbackAddress` property specifies the base endpoint `URL` where the client receives messages associated with
9393
the [=Contract Negotiation=]. The HTTPS scheme MUST be supported. Implementations MAY optionally support other URL schemes.
9494

95-
- Callback [=Messages=] will be sent to paths under the base URL as described by this specification. (_NOTE:
95+
- Callback messages will be sent to paths under the base URL as described by this specification. (_NOTE:
9696
[=Providers=] SHOULD properly handle the cases where a trailing `/` is included
9797
with or absent from the `callbackAddress` when resolving full URL._)
9898

specifications/negotiation/contract.negotiation.protocol.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
A [=Contract Negotiation=] involves two parties, a [=Provider=] that offers one or more [=Datasets=] along with a [=Policy=]
66
and a [=Consumer=] that requests [=Datasets=]. A [=Contract Negotiation=] is uniquely identified through an Internationalized Resource Identifier (IRI) [[rfc3987]]. Each [=Contract Negotiation=]
77
requires a newly generated IRI, which MAY not be used in a [=Contract Negotiation=] after a terminal state has been reached. A [=Contract Negotiation=] progresses
8-
through a series of states, which are tracked by the [=Provider=] and [=Consumer=] using [=Messages=]. A [=Contract Negotiation=] transitions to a
8+
through a series of states, which are tracked by the [=Provider=] and [=Consumer=] using messages. A [=Contract Negotiation=] transitions to a
99
state in response to an acknowledged Message from the counter-party. Both parties have the same state of the [=Contract Negotiation=]. In case
1010
the states differ, the [=Contract Negotiation=] MUST be terminated and a new [=Contract Negotiation=] MAY be initiated.
1111

@@ -32,12 +32,12 @@ The [=Contract Negotiation=] state machine is represented in the following diagr
3232

3333
!["Contract Negotiation State Machine"](figures/contract.negotiation.state.machine.png "Contract Negotiation State Machine")
3434

35-
Transitions marked with `C` indicate a Message sent by the [=Consumer=], transitions marked with `P` indicate
35+
Transitions marked with `C` indicate a message sent by the [=Consumer=], transitions marked with `P` indicate
3636
a [=Provider=] Message. Terminal states are final; the state machine MUST NOT transition to another state. A new [=Contract Negotiation=] MAY be initiated if, for instance, the [=Contract Negotiation=] entered the `TERMINATED` state due to a network issue.
3737

3838
## Message Types
3939

40-
The [=Contract Negotiation=] state machine is transitioned upon receipt and acknowledgement of a Message. This section details those [=Messages=] as abstract [=Message Types=].
40+
The [=Contract Negotiation=] state machine is transitioned upon receipt and acknowledgement of a Message. This section details those messages as abstract [=Message Types=].
4141

4242
- Concrete wire formats are defined by the protocol binding,
4343
e.g., [Contract Negotiation HTTPS Binding](#contract-negotiation-https-binding).

specifications/transfer/transfer.process.binding.https.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This binding defines a RESTful API over HTTPS for the [Transfer Process Protocol
99
1. The `<base>` notation indicates the base URL for a [=Connector=] endpoint. For example, if the scheme is `https` and
1010
the full hostname is `connector.example.com`, the URL `<base>/transfers/request` will map
1111
to `https://connector.example.com/transfers/request`.
12-
2. All request and response [=Messages=] MUST use the `application/json` media type. Derived media types,
12+
2. All request and response messages MUST use the `application/json` media type. Derived media types,
1313
e.g., `application/ld+json` MAY be exposed in addition.
1414

1515
### Transfer Error

specifications/transfer/transfer.process.protocol.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
A [=Transfer Process=] involves two parties, a [=Provider=] that offers one or more [=Datasets=] along with
66
a [=Policy=] and a [=Consumer=] that requests [=Datasets=]. A [=Transfer Process=] progresses through a series of states, which are
7-
controlled by the [=Provider=] and [=Consumer=] using [=Messages=]. A [=Transfer Process=] transitions to another state as a result of an
7+
controlled by the [=Provider=] and [=Consumer=] using messages. A [=Transfer Process=] transitions to another state as a result of an
88
exchanged Message.
99

1010
### Prerequisites
@@ -15,7 +15,7 @@ subsection.
1515
#### Control and Data Planes
1616

1717
A [=Transfer Process=] involves two logical constructs, a control plane and a data plane. Serving as a coordinating layer, services on the
18-
_control plane_ receive [=Messages=] and manage the local state of the [=Transfer Process=] (same as for the [=Catalog Protocol=] and
18+
_control plane_ receive messages and manage the local state of the [=Transfer Process=] (same as for the [=Catalog Protocol=] and
1919
the [=Contract Negotiation Protocol=]). On the _data plane_, the actual transfer of data takes place using a wire
2020
protocol. Both [=Participants=] in a data sharing scenario run services logically regarded as control and/or data plane
2121
services.

0 commit comments

Comments
 (0)