Skip to content

Commit

Permalink
feat(tp-binding)!: change path from /transfer-processes to /transfers (
Browse files Browse the repository at this point in the history
  • Loading branch information
juliapampus authored Mar 8, 2023
1 parent a98e3d4 commit 7cf8abb
Showing 1 changed file with 17 additions and 17 deletions.
34 changes: 17 additions & 17 deletions transfer/transfer.process.binding.https.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The OpenAPI definitions for this specification can be accessed [here](TBD).
### 2.1 Prerequisites

1. The `<base>` notation indicates the base URL for a connector endpoint. For example, if the base connector URL is `connector.example.com`, the
URL `https://<base>/transfer-processes/request` will map to `https//connector.example.com/transfer-processes/request`.
URL `https://<base>/transfers/request` will map to `https//connector.example.com/transfers/request`.

2. All request and response messages must use the `application/json` media type.

Expand All @@ -37,12 +37,12 @@ an HTTP code 400 (Bad Request) with an `TransferError` in the response body.
All requests should use the `Authorizartion` header to include authorization data as specified by an authorization protocol such as [OAuth2](https://www.rfc-editor.org/rfc/rfc6749)
. The `Authorization` HTTP header is optional if the connector does not require authorization. This specification does not mandate the use of a particular authorization standard.

### 2.4 The provider `transfer-processes` resource
### 2.4 The provider `transfers` resource

#### 2.4.1 GET

```
GET https://connector.provider.com/transfer-processes/:id
GET https://connector.provider.com/transfers/:id
Authorization: ...
Expand All @@ -65,15 +65,15 @@ Predefined states are: `REQUESTED`, `STARTED`, `SUSPENDED`, `REQUESTED`, `COMPLE

If the transfer process does not exist or the client is not authorized, the provider connector must return an HTTP 404 (Not Found) response.

### 2.5 The provider `transfer-processes/request` resource
### 2.5 The provider `transfers/request` resource

#### 2.5.1 POST

A transfer process is started and placed in the `REQUESTED` state when a consumer POSTs a [TransferRequestMessage](./transfer.process.protocol.md#1-transferrequestmessage)
to `transfer-processes/request`:
to `transfers/request`:

```
POST https://connector.provider.com/transfer-processes/request
POST https://connector.provider.com/transfers/request
Authorization: ...
Expand All @@ -100,7 +100,7 @@ The provider connector must return an HTTP 201 (Created) response with the locat
the [TransferProcess](./message/transfer.process.json) message:

```
Location: /transfer-processes/urn:uuid:71f8dfab-9337-4e9d-a4c7-524e04443f16
Location: /transfers/urn:uuid:71f8dfab-9337-4e9d-a4c7-524e04443f16
{
"@context": "https://w3id.org/dspace/1/0/context.json",
Expand All @@ -114,28 +114,28 @@ the [TransferProcess](./message/transfer.process.json) message:

Note that if the location header is not an absolute URL, it must resolve to an address that is relative to the base address of the request.

### 2.6 The provider `transfer-processes/:id/start` resource
### 2.6 The provider `transfers/:id/start` resource

#### 2.6.1 POST

The consumer connector can POST a [TransferStartMessage](./message/transfer.start.message.json) to attempt to start a transfer process after it has been suspended. If the transfer
process state is successfully transitioned, the producer must return HTTP code 200 (OK). The response body is not specified and clients are not required to process it.

### 2.7 The provider `transfer-processes/:id/completion` resource
### 2.7 The provider `transfers/:id/completion` resource

#### 2.7.1 POST

The consumer connector can POST a [TransferCompletionMessage](./message/transfer.completion.message.json) to complete a transfer process. If the transfer
process state is successfully transitioned, the provider must return HTTP code 200 (OK). The response body is not specified and clients are not required to process it.

### 2.8 The provider `transfer-processes/:id/termination` resource
### 2.8 The provider `transfers/:id/termination` resource

#### 2.8.1 POST

The consumer connector can POST a [TransferTerminationMessage](./message/transfer.termination.message.json) to terminate a transfer process. If the transfer
process state is successfully transitioned, the provider must return HTTP code 200 (OK). The response body is not specified and clients are not required to process it.

### 2.9 The provider `transfer-processes/:id/suspension` resource
### 2.9 The provider `transfers/:id/suspension` resource

#### 2.9.1 POST

Expand All @@ -147,31 +147,31 @@ process state is successfully transitioned, the producer must return HTTP code 2
### 3.1 Prerequisites

All callback paths are relative to the `callbackAddress` base URL specified in the `TransferRequestMessage` that initiated a transfer process. For example, if
the `callbackAddress` is specified as `https://connector.consumer/callback` and a callback path binding is `transfer-processes/:id/start`, the resolved URL will
be `https://connector.consumer.com/callback/transfer-processes/:id/start`.
the `callbackAddress` is specified as `https://connector.consumer/callback` and a callback path binding is `transfers/:id/start`, the resolved URL will
be `https://connector.consumer.com/callback/transfers/:id/start`.

### 3.2 The consumer `transfer-processes/:id/start` resource
### 3.2 The consumer `transfers/:id/start` resource

#### 3.2.1 POST

The provider connector can POST a [TransferStartMessage](./message/transfer.start.message.json) to indicate the start of a transfer process. If the transfer
process state is successfully transitioned, the consumer must return HTTP code 200 (OK). The response body is not specified and clients are not required to process it.

### 3.3 The consumer `transfer-processes/:id/completion` resource
### 3.3 The consumer `transfers/:id/completion` resource

#### 3.3.1 POST

The provider connector can POST a [TransferCompletionMessage](./message/transfer.completion.message.json) to complete a transfer process. If the transfer
process state is successfully transitioned, the consumer must return HTTP code 200 (OK). The response body is not specified and clients are not required to process it.

### 3.4 The consumer `transfer-processes/:id/termination` resource
### 3.4 The consumer `transfers/:id/termination` resource

#### 3.4.1 POST

The provider connector can POST a [TransferTerminationMessage](./message/transfer.termination.message.json) to terminate a transfer process. If the transfer
process state is successfully transitioned, the consumer must return HTTP code 200 (OK). The response body is not specified and clients are not required to process it.

### 3.5 The consumer `transfer-processes/:id/suspension` resource
### 3.5 The consumer `transfers/:id/suspension` resource

#### 3.5.1 POST

Expand Down

0 comments on commit 7cf8abb

Please sign in to comment.