Skip to content

Commit

Permalink
Name change in module datatx: PullTransfer -> CreateTransfer
Browse files Browse the repository at this point in the history
  • Loading branch information
@antoonp
antoonp committed Dec 12, 2022
1 parent bb7fbfa commit 38baf4d
Show file tree
Hide file tree
Showing 4 changed files with 432 additions and 101 deletions.
4 changes: 2 additions & 2 deletions cs3/gateway/v1beta1/gateway_api.proto
View file
Original file line number Diff line number Diff line change
Expand Up @@ -400,8 +400,8 @@ service GatewayAPI {
// ************************** FILE TRANSFER ************************/
// *****************************************************************/

// Requests the destination to pull a resource from source.
rpc PullTransfer(cs3.tx.v1beta1.PullTransferRequest) returns (cs3.tx.v1beta1.PullTransferResponse);
// Requests creation of a transfer.
rpc CreateTransfer(cs3.tx.v1beta1.CreateTransferRequest) returns (cs3.tx.v1beta1.CreateTransferResponse);
// Requests a transfer status.
rpc GetTransferStatus(cs3.tx.v1beta1.GetTransferStatusRequest) returns (cs3.tx.v1beta1.GetTransferStatusResponse);
// Requests to cancel a transfer.
Expand Down
10 changes: 5 additions & 5 deletions cs3/tx/v1beta1/tx_api.proto
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,9 @@ import "cs3/types/v1beta1/types.proto";
// Any method MAY return UNKNOWN.
// Any method MAY return UNAUTHENTICATED.
service TxAPI {
// Requests the destination to pull a resource from source.
// Returns a PullTransferResponse
rpc PullTransfer(PullTransferRequest) returns (PullTransferResponse);
// Requests creation of a transfer.
// Returns a CreateTransferResponse.
rpc CreateTransfer(CreateTransferRequest) returns (CreateTransferResponse);
// Requests a transfer status.
rpc GetTransferStatus(GetTransferStatusRequest) returns (GetTransferStatusResponse);
// Requests to cancel a transfer.
Expand All @@ -63,7 +63,7 @@ service TxAPI {
rpc RetryTransfer(RetryTransferRequest) returns (RetryTransferResponse);
}

message PullTransferRequest {
message CreateTransferRequest {
// REQUIRED.
// The source target URI. Should include at the minimum all the info needed to access the source.
// https://golang.org/pkg/net/url/#URL provides a quick view of the format.
Expand All @@ -77,7 +77,7 @@ message PullTransferRequest {
cs3.types.v1beta1.Opaque opaque = 3;
}

message PullTransferResponse {
message CreateTransferResponse {
// REQUIRED.
// The response status.
cs3.rpc.v1beta1.Status status = 1;
Expand Down
174 changes: 90 additions & 84 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -398,31 +398,31 @@ <h2>Table of Contents</h2>
</li>

<li>
<a href="#cs3.tx.v1beta1.GetTransferStatusRequest"><span class="badge">M</span>GetTransferStatusRequest</a>
<a href="#cs3.tx.v1beta1.CreateTransferRequest"><span class="badge">M</span>CreateTransferRequest</a>
</li>

<li>
<a href="#cs3.tx.v1beta1.GetTransferStatusResponse"><span class="badge">M</span>GetTransferStatusResponse</a>
<a href="#cs3.tx.v1beta1.CreateTransferResponse"><span class="badge">M</span>CreateTransferResponse</a>
</li>

<li>
<a href="#cs3.tx.v1beta1.ListTransfersRequest"><span class="badge">M</span>ListTransfersRequest</a>
<a href="#cs3.tx.v1beta1.GetTransferStatusRequest"><span class="badge">M</span>GetTransferStatusRequest</a>
</li>

<li>
<a href="#cs3.tx.v1beta1.ListTransfersRequest.Filter"><span class="badge">M</span>ListTransfersRequest.Filter</a>
<a href="#cs3.tx.v1beta1.GetTransferStatusResponse"><span class="badge">M</span>GetTransferStatusResponse</a>
</li>

<li>
<a href="#cs3.tx.v1beta1.ListTransfersResponse"><span class="badge">M</span>ListTransfersResponse</a>
<a href="#cs3.tx.v1beta1.ListTransfersRequest"><span class="badge">M</span>ListTransfersRequest</a>
</li>

<li>
<a href="#cs3.tx.v1beta1.PullTransferRequest"><span class="badge">M</span>PullTransferRequest</a>
<a href="#cs3.tx.v1beta1.ListTransfersRequest.Filter"><span class="badge">M</span>ListTransfersRequest.Filter</a>
</li>

<li>
<a href="#cs3.tx.v1beta1.PullTransferResponse"><span class="badge">M</span>PullTransferResponse</a>
<a href="#cs3.tx.v1beta1.ListTransfersResponse"><span class="badge">M</span>ListTransfersResponse</a>
</li>

<li>
Expand Down Expand Up @@ -3261,10 +3261,10 @@ <h3 id="cs3.gateway.v1beta1.GatewayAPI">GatewayAPI</h3>
</tr>

<tr>
<td>PullTransfer</td>
<td><a href="#cs3.tx.v1beta1.PullTransferRequest">.cs3.tx.v1beta1.PullTransferRequest</a></td>
<td><a href="#cs3.tx.v1beta1.PullTransferResponse">.cs3.tx.v1beta1.PullTransferResponse</a></td>
<td><p>Requests the destination to pull a resource from source.</p></td>
<td>CreateTransfer</td>
<td><a href="#cs3.tx.v1beta1.CreateTransferRequest">.cs3.tx.v1beta1.CreateTransferRequest</a></td>
<td><a href="#cs3.tx.v1beta1.CreateTransferResponse">.cs3.tx.v1beta1.CreateTransferResponse</a></td>
<td><p>Requests creation of a transfer.</p></td>
</tr>

<tr>
Expand Down Expand Up @@ -4382,7 +4382,7 @@ <h3 id="cs3.tx.v1beta1.CancelTransferResponse">CancelTransferResponse</h3>



<h3 id="cs3.tx.v1beta1.GetTransferStatusRequest">GetTransferStatusRequest</h3>
<h3 id="cs3.tx.v1beta1.CreateTransferRequest">CreateTransferRequest</h3>
<p></p>


Expand All @@ -4393,11 +4393,21 @@ <h3 id="cs3.tx.v1beta1.GetTransferStatusRequest">GetTransferStatusRequest</h3>
<tbody>

<tr>
<td>tx_id</td>
<td><a href="#cs3.tx.v1beta1.TxId">TxId</a></td>
<td>src_target_uri</td>
<td><a href="#string">string</a></td>
<td></td>
<td><p>REQUIRED.
The transfer identifier. </p></td>
The source target URI. Should include at the minimum all the info needed to access the source.
https://golang.org/pkg/net/url/#URL provides a quick view of the format. </p></td>
</tr>

<tr>
<td>dest_target_uri</td>
<td><a href="#string">string</a></td>
<td></td>
<td><p>REQUIRED.
The destination target URI. Should include at the minimum all the info needed to access the destination.
https://golang.org/pkg/net/url/#URL provides a quick view of the format. </p></td>
</tr>

<tr>
Expand All @@ -4415,7 +4425,7 @@ <h3 id="cs3.tx.v1beta1.GetTransferStatusRequest">GetTransferStatusRequest</h3>



<h3 id="cs3.tx.v1beta1.GetTransferStatusResponse">GetTransferStatusResponse</h3>
<h3 id="cs3.tx.v1beta1.CreateTransferResponse">CreateTransferResponse</h3>
<p></p>


Expand All @@ -4438,7 +4448,7 @@ <h3 id="cs3.tx.v1beta1.GetTransferStatusResponse">GetTransferStatusResponse</h3>
<td><a href="#cs3.tx.v1beta1.TxInfo">TxInfo</a></td>
<td></td>
<td><p>REQUIRED.
TxInfo, includes ao. transfer id, status, description. </p></td>
TxInfo, includes transfer id, status, description. </p></td>
</tr>

<tr>
Expand All @@ -4456,7 +4466,7 @@ <h3 id="cs3.tx.v1beta1.GetTransferStatusResponse">GetTransferStatusResponse</h3>



<h3 id="cs3.tx.v1beta1.ListTransfersRequest">ListTransfersRequest</h3>
<h3 id="cs3.tx.v1beta1.GetTransferStatusRequest">GetTransferStatusRequest</h3>
<p></p>


Expand All @@ -4467,19 +4477,19 @@ <h3 id="cs3.tx.v1beta1.ListTransfersRequest">ListTransfersRequest</h3>
<tbody>

<tr>
<td>opaque</td>
<td><a href="#cs3.types.v1beta1.Opaque">cs3.types.v1beta1.Opaque</a></td>
<td>tx_id</td>
<td><a href="#cs3.tx.v1beta1.TxId">TxId</a></td>
<td></td>
<td><p>OPTIONAL.
Opaque information. </p></td>
<td><p>REQUIRED.
The transfer identifier. </p></td>
</tr>

<tr>
<td>filters</td>
<td><a href="#cs3.tx.v1beta1.ListTransfersRequest.Filter">ListTransfersRequest.Filter</a></td>
<td>repeated</td>
<td>opaque</td>
<td><a href="#cs3.types.v1beta1.Opaque">cs3.types.v1beta1.Opaque</a></td>
<td></td>
<td><p>OPTIONAL.
The list of filters to apply if any. </p></td>
Opaque information. </p></td>
</tr>

</tbody>
Expand All @@ -4489,8 +4499,8 @@ <h3 id="cs3.tx.v1beta1.ListTransfersRequest">ListTransfersRequest</h3>



<h3 id="cs3.tx.v1beta1.ListTransfersRequest.Filter">ListTransfersRequest.Filter</h3>
<p>REQUIRED.</p><p>Represents a filter to apply to the request.</p>
<h3 id="cs3.tx.v1beta1.GetTransferStatusResponse">GetTransferStatusResponse</h3>
<p></p>


<table class="field-table">
Expand All @@ -4499,32 +4509,28 @@ <h3 id="cs3.tx.v1beta1.ListTransfersRequest.Filter">ListTransfersRequest.Filter<
</thead>
<tbody>

<tr>
<td>type</td>
<td><a href="#cs3.tx.v1beta1.ListTransfersRequest.Filter.Type">ListTransfersRequest.Filter.Type</a></td>
<td></td>
<td><p>REQUIRED. </p></td>
</tr>

<tr>
<td>status</td>
<td><a href="#cs3.tx.v1beta1.Status">Status</a></td>
<td><a href="#cs3.rpc.v1beta1.Status">cs3.rpc.v1beta1.Status</a></td>
<td></td>
<td><p> </p></td>
<td><p>REQUIRED.
The response status. </p></td>
</tr>

<tr>
<td>share_id</td>
<td><a href="#cs3.sharing.ocm.v1beta1.ShareId">cs3.sharing.ocm.v1beta1.ShareId</a></td>
<td>tx_info</td>
<td><a href="#cs3.tx.v1beta1.TxInfo">TxInfo</a></td>
<td></td>
<td><p> </p></td>
<td><p>REQUIRED.
TxInfo, includes ao. transfer id, status, description. </p></td>
</tr>

<tr>
<td>tx_id</td>
<td><a href="#cs3.tx.v1beta1.TxId">TxId</a></td>
<td>opaque</td>
<td><a href="#cs3.types.v1beta1.Opaque">cs3.types.v1beta1.Opaque</a></td>
<td></td>
<td><p> </p></td>
<td><p>OPTIONAL.
Opaque information. </p></td>
</tr>

</tbody>
Expand All @@ -4534,7 +4540,7 @@ <h3 id="cs3.tx.v1beta1.ListTransfersRequest.Filter">ListTransfersRequest.Filter<



<h3 id="cs3.tx.v1beta1.ListTransfersResponse">ListTransfersResponse</h3>
<h3 id="cs3.tx.v1beta1.ListTransfersRequest">ListTransfersRequest</h3>
<p></p>


Expand All @@ -4545,27 +4551,19 @@ <h3 id="cs3.tx.v1beta1.ListTransfersResponse">ListTransfersResponse</h3>
<tbody>

<tr>
<td>status</td>
<td><a href="#cs3.rpc.v1beta1.Status">cs3.rpc.v1beta1.Status</a></td>
<td>opaque</td>
<td><a href="#cs3.types.v1beta1.Opaque">cs3.types.v1beta1.Opaque</a></td>
<td></td>
<td><p>REQUIRED.
The response status. </p></td>
<td><p>OPTIONAL.
Opaque information. </p></td>
</tr>

<tr>
<td>transfers</td>
<td><a href="#cs3.tx.v1beta1.TxInfo">TxInfo</a></td>
<td>filters</td>
<td><a href="#cs3.tx.v1beta1.ListTransfersRequest.Filter">ListTransfersRequest.Filter</a></td>
<td>repeated</td>
<td><p>REQUIRED.
List of TxInfo types representing transfers. </p></td>
</tr>

<tr>
<td>opaque</td>
<td><a href="#cs3.types.v1beta1.Opaque">cs3.types.v1beta1.Opaque</a></td>
<td></td>
<td><p>OPTIONAL.
Opaque information. </p></td>
The list of filters to apply if any. </p></td>
</tr>

</tbody>
Expand All @@ -4575,8 +4573,8 @@ <h3 id="cs3.tx.v1beta1.ListTransfersResponse">ListTransfersResponse</h3>



<h3 id="cs3.tx.v1beta1.PullTransferRequest">PullTransferRequest</h3>
<p></p>
<h3 id="cs3.tx.v1beta1.ListTransfersRequest.Filter">ListTransfersRequest.Filter</h3>
<p>REQUIRED.</p><p>Represents a filter to apply to the request.</p>


<table class="field-table">
Expand All @@ -4586,29 +4584,31 @@ <h3 id="cs3.tx.v1beta1.PullTransferRequest">PullTransferRequest</h3>
<tbody>

<tr>
<td>src_target_uri</td>
<td><a href="#string">string</a></td>
<td>type</td>
<td><a href="#cs3.tx.v1beta1.ListTransfersRequest.Filter.Type">ListTransfersRequest.Filter.Type</a></td>
<td></td>
<td><p>REQUIRED.
The source target URI. Should include at the minimum all the info needed to access the source.
https://golang.org/pkg/net/url/#URL provides a quick view of the format. </p></td>
<td><p>REQUIRED. </p></td>
</tr>

<tr>
<td>dest_target_uri</td>
<td><a href="#string">string</a></td>
<td>status</td>
<td><a href="#cs3.tx.v1beta1.Status">Status</a></td>
<td></td>
<td><p>REQUIRED.
The destination target URI. Should include at the minimum all the info needed to access the destination.
https://golang.org/pkg/net/url/#URL provides a quick view of the format. </p></td>
<td><p> </p></td>
</tr>

<tr>
<td>opaque</td>
<td><a href="#cs3.types.v1beta1.Opaque">cs3.types.v1beta1.Opaque</a></td>
<td>share_id</td>
<td><a href="#cs3.sharing.ocm.v1beta1.ShareId">cs3.sharing.ocm.v1beta1.ShareId</a></td>
<td></td>
<td><p>OPTIONAL.
Opaque information. </p></td>
<td><p> </p></td>
</tr>

<tr>
<td>tx_id</td>
<td><a href="#cs3.tx.v1beta1.TxId">TxId</a></td>
<td></td>
<td><p> </p></td>
</tr>

</tbody>
Expand All @@ -4618,7 +4618,7 @@ <h3 id="cs3.tx.v1beta1.PullTransferRequest">PullTransferRequest</h3>



<h3 id="cs3.tx.v1beta1.PullTransferResponse">PullTransferResponse</h3>
<h3 id="cs3.tx.v1beta1.ListTransfersResponse">ListTransfersResponse</h3>
<p></p>


Expand All @@ -4637,11 +4637,11 @@ <h3 id="cs3.tx.v1beta1.PullTransferResponse">PullTransferResponse</h3>
</tr>

<tr>
<td>tx_info</td>
<td>transfers</td>
<td><a href="#cs3.tx.v1beta1.TxInfo">TxInfo</a></td>
<td></td>
<td>repeated</td>
<td><p>REQUIRED.
TxInfo, includes transfer id, status, description. </p></td>
List of TxInfo types representing transfers. </p></td>
</tr>

<tr>
Expand Down Expand Up @@ -4783,11 +4783,11 @@ <h3 id="cs3.tx.v1beta1.TxAPI">TxAPI</h3>
<tbody>

<tr>
<td>PullTransfer</td>
<td><a href="#cs3.tx.v1beta1.PullTransferRequest">PullTransferRequest</a></td>
<td><a href="#cs3.tx.v1beta1.PullTransferResponse">PullTransferResponse</a></td>
<td><p>Requests the destination to pull a resource from source.
Returns a PullTransferResponse</p></td>
<td>CreateTransfer</td>
<td><a href="#cs3.tx.v1beta1.CreateTransferRequest">CreateTransferRequest</a></td>
<td><a href="#cs3.tx.v1beta1.CreateTransferResponse">CreateTransferResponse</a></td>
<td><p>Requests creation of a transfer.
Returns a CreateTransferResponse.</p></td>
</tr>

<tr>
Expand Down Expand Up @@ -8295,6 +8295,12 @@ <h3 id="cs3.identity.user.v1beta1.UserType">UserType</h3>
<td><p>A lightweight user account without access to various major functionalities.</p></td>
</tr>

<tr>
<td>USER_TYPE_SPACE_OWNER</td>
<td>8</td>
<td><p>A space owner to allow access for public link or content indexing.</p></td>
</tr>

</tbody>
</table>

Expand Down
Loading

0 comments on commit 38baf4d

Please sign in to comment.