Skip to content

Commit

Permalink
Share type added to specify Share purpose. (#109)
Browse files Browse the repository at this point in the history
  • Loading branch information
@redblom
redblom authored Mar 4, 2021
1 parent ea7ed45 commit 1e7d068
Show file tree
Hide file tree
Showing 3 changed files with 154 additions and 100 deletions.
2 changes: 1 addition & 1 deletion cs3/ocm/invite/v1beta1/invite_api.proto
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ service InviteAPI {
rpc AcceptInvite(AcceptInviteRequest) returns (AcceptInviteResponse);
// Retrieves details about a remote user who has accepted an invite to share.
rpc GetRemoteUser(GetRemoteUserRequest) returns (GetRemoteUserResponse);
// Retrieves a list of users that accepted a certain invite token
// Retrieves a list of users that accepted a certain invite token.
rpc GetAcceptedUsers(GetAcceptedUsersRequest) returns (GetAcceptedUsersResponse);
}

Expand Down
10 changes: 10 additions & 0 deletions cs3/sharing/ocm/v1beta1/resources.proto
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,16 @@ message Share {
// REQUIRED.
// Last modification time of the share.
cs3.types.v1beta1.Timestamp mtime = 9;
// Defines the type of share based on its origin.
enum ShareType {
SHARE_TYPE_INVALID = 0;
// A regular file or folder share.
SHARE_TYPE_REGULAR = 1;
// A file or folder transfer.
SHARE_TYPE_TRANSFER = 2;
}
// Specifies the type of the share.
ShareType share_type = 10;
}

// The permissions for a share.
Expand Down
242 changes: 143 additions & 99 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -759,19 +759,19 @@ <h2>Table of Contents</h2>
</li>

<li>
<a href="#cs3.ocm.invite.v1beta1.GetRemoteUserRequest"><span class="badge">M</span>GetRemoteUserRequest</a>
<a href="#cs3.ocm.invite.v1beta1.GetAcceptedUsersRequest"><span class="badge">M</span>GetAcceptedUsersRequest</a>
</li>

<li>
<a href="#cs3.ocm.invite.v1beta1.GetRemoteUserResponse"><span class="badge">M</span>GetRemoteUserResponse</a>
<a href="#cs3.ocm.invite.v1beta1.GetAcceptedUsersResponse"><span class="badge">M</span>GetAcceptedUsersResponse</a>
</li>

<li>
<a href="#cs3.ocm.invite.v1beta1.GetAcceptedUsersRequest"><span class="badge">M</span>GetAcceptedUsersRequest</a>
<a href="#cs3.ocm.invite.v1beta1.GetRemoteUserRequest"><span class="badge">M</span>GetRemoteUserRequest</a>
</li>

<li>
<a href="#cs3.ocm.invite.v1beta1.GetAcceptedUsersResponse"><span class="badge">M</span>GetAcceptedUsersResponse</a>
<a href="#cs3.ocm.invite.v1beta1.GetRemoteUserResponse"><span class="badge">M</span>GetRemoteUserResponse</a>
</li>


Expand Down Expand Up @@ -1250,6 +1250,10 @@ <h2>Table of Contents</h2>
</li>


<li>
<a href="#cs3.sharing.ocm.v1beta1.Share.ShareType"><span class="badge">E</span>Share.ShareType</a>
</li>

<li>
<a href="#cs3.sharing.ocm.v1beta1.ShareState"><span class="badge">E</span>ShareState</a>
</li>
Expand Down Expand Up @@ -2840,14 +2844,11 @@ <h3 id="cs3.gateway.v1beta1.GatewayAPI">GatewayAPI</h3>
<td>GetRemoteUser</td>
<td><a href="#cs3.ocm.invite.v1beta1.GetRemoteUserRequest">.cs3.ocm.invite.v1beta1.GetRemoteUserRequest</a></td>
<td><a href="#cs3.ocm.invite.v1beta1.GetRemoteUserResponse">.cs3.ocm.invite.v1beta1.GetRemoteUserResponse</a></td>
<td><p>Retrieves details about a remote user who has accepted an invite to share.</p></td>
</tr>
<td><p>Retrieves details about a remote user who has accepted an invite to share.

<tr>
<td>GetAcceptedUsers</td>
<td><a href="#cs3.ocm.invite.v1beta1.GetAcceptedUsersRequest">.cs3.ocm.invite.v1beta1.GetAcceptedUsersRequest</a></td>
<td><a href="#cs3.ocm.invite.v1beta1.GetAcceptedUsersResponse">.cs3.ocm.invite.v1beta1.GetAcceptedUsersResponse</a></td>
<td><p>Retrieves a list of users that accepted a certain invite token.</p></td>
*****************************************************************/
******************** OCM PROVIDER AUTHORIZER ********************/
*****************************************************************/</p></td>
</tr>

<tr>
Expand Down Expand Up @@ -6373,6 +6374,80 @@ <h3 id="cs3.ocm.invite.v1beta1.GenerateInviteTokenResponse">GenerateInviteTokenR



<h3 id="cs3.ocm.invite.v1beta1.GetAcceptedUsersRequest">GetAcceptedUsersRequest</h3>
<p></p>


<table class="field-table">
<thead>
<tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
</thead>
<tbody>

<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>
</tr>

<tr>
<td>token_name</td>
<td><a href="#string">string</a></td>
<td></td>
<td><p>REQUIRED.
The token name to search accepted users for. </p></td>
</tr>

</tbody>
</table>





<h3 id="cs3.ocm.invite.v1beta1.GetAcceptedUsersResponse">GetAcceptedUsersResponse</h3>
<p></p>


<table class="field-table">
<thead>
<tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
</thead>
<tbody>

<tr>
<td>status</td>
<td><a href="#cs3.rpc.v1beta1.Status">cs3.rpc.v1beta1.Status</a></td>
<td></td>
<td><p>REQUIRED.
The response status. </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>
</tr>

<tr>
<td>accepted_users</td>
<td><a href="#cs3.identity.user.v1beta1.User">cs3.identity.user.v1beta1.User</a></td>
<td>repeated</td>
<td><p>REQUIRED.
The users that accepted the token with the given name. </p></td>
</tr>

</tbody>
</table>





<h3 id="cs3.ocm.invite.v1beta1.GetRemoteUserRequest">GetRemoteUserRequest</h3>
<p></p>

Expand Down Expand Up @@ -6443,86 +6518,17 @@ <h3 id="cs3.ocm.invite.v1beta1.GetRemoteUserResponse">GetRemoteUserResponse</h3>
</tbody>
</table>











<h3 id="cs3.ocm.invite.v1beta1.GetAcceptedUsersRequest">GetAcceptedUsersRequest</h3>
<p></p>


<table class="field-table">
<thead>
<tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
</thead>
<tbody>

<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>
</tr>

<tr>
<td>token_name</td>
<td><a href="#string">string</a></td>
<td></td>
<td><p>REQUIRED.
The token name to search accepted users for. </p></td>
</tr>

</tbody>
</table>





<h3 id="cs3.ocm.invite.v1beta1.GetAcceptedUsersResponse">GetAcceptedUsersResponse</h3>
<p></p>


<table class="field-table">
<thead>
<tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
</thead>
<tbody>

<tr>
<td>status</td>
<td><a href="#cs3.rpc.v1beta1.Status">cs3.rpc.v1beta1.Status</a></td>
<td></td>
<td><p>REQUIRED.
The response status. </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>
</tr>

<tr>
<td>accepted_users</td>
<td><a href="#cs3.identity.user.v1beta1.User">cs3.identity.user.v1beta1.User</a></td>
<td>repeated</td>
<td><p>REQUIRED.
The users that accepted the token with the given name. </p></td>
</tr>

</tbody>
</table>





<h3 id="cs3.ocm.invite.v1beta1.InviteAPI">InviteAPI</h3>

<h3 id="cs3.ocm.invite.v1beta1.InviteAPI">InviteAPI</h3>
<p>Invite API</p><p>The Invite API is meant to invite users and groups belonging to other</p><p>sync'n'share systems, so that collaboration of resources can be enabled.</p><p>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL</p><p>NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and</p><p>"OPTIONAL" in this document are to be interpreted as described in</p><p>RFC 2119.</p><p>The following are global requirements that apply to all methods:</p><p>Any method MUST return CODE_OK on a succesful operation.</p><p>Any method MAY return NOT_IMPLEMENTED.</p><p>Any method MAY return INTERNAL.</p><p>Any method MAY return UNKNOWN.</p><p>Any method MAY return UNAUTHENTICATED.</p>
<table class="enum-table">
<thead>
Expand Down Expand Up @@ -6557,13 +6563,14 @@ <h3 id="cs3.ocm.invite.v1beta1.InviteAPI">InviteAPI</h3>
<td><a href="#cs3.ocm.invite.v1beta1.GetRemoteUserResponse">GetRemoteUserResponse</a></td>
<td><p>Retrieves details about a remote user who has accepted an invite to share.</p></td>
</tr>

<tr>
<td>GetAcceptedUsers</td>
<td><a href="#cs3.ocm.invite.v1beta1.GetAcceptedUsersRequest">GetAcceptedUsersRequest</a></td>
<td><a href="#cs3.ocm.invite.v1beta1.GetAcceptedUsersResponse">GetAcceptedUsersResponse</a></td>
<td><p>Retrieves a list of users that accepted a certain invite token.</p></td>
<td>GetAcceptedUsers</td>
<td><a href="#cs3.ocm.invite.v1beta1.GetAcceptedUsersRequest">GetAcceptedUsersRequest</a></td>
<td><a href="#cs3.ocm.invite.v1beta1.GetAcceptedUsersResponse">GetAcceptedUsersResponse</a></td>
<td><p>Retrieves a list of users that accepted a certain invite token.</p></td>
</tr>

</tbody>
</table>

Expand Down Expand Up @@ -6609,14 +6616,15 @@ <h3 id="cs3.ocm.invite.v1beta1.InviteToken">InviteToken</h3>
<td><p>OPTIONAL.
The time when the token will expire. </p></td>
</tr>

<tr>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
<td><p>REQUIRED.
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
<td><p>REQUIRED.
User-defined token name for token identification. </p></td>
</tr>

</tbody>
</table>

Expand Down Expand Up @@ -10268,6 +10276,13 @@ <h3 id="cs3.sharing.ocm.v1beta1.Share">Share</h3>
Last modification time of the share. </p></td>
</tr>

<tr>
<td>share_type</td>
<td><a href="#cs3.sharing.ocm.v1beta1.Share.ShareType">Share.ShareType</a></td>
<td></td>
<td><p>Specifies the type of the share. </p></td>
</tr>

</tbody>
</table>

Expand Down Expand Up @@ -10438,6 +10453,35 @@ <h3 id="cs3.sharing.ocm.v1beta1.ShareReference">ShareReference</h3>



<h3 id="cs3.sharing.ocm.v1beta1.Share.ShareType">Share.ShareType</h3>
<p>Defines the type of share based on its origin.</p>
<table class="enum-table">
<thead>
<tr><td>Name</td><td>Number</td><td>Description</td></tr>
</thead>
<tbody>

<tr>
<td>SHARE_TYPE_INVALID</td>
<td>0</td>
<td><p></p></td>
</tr>

<tr>
<td>SHARE_TYPE_REGULAR</td>
<td>1</td>
<td><p>A regular file or folder share.</p></td>
</tr>

<tr>
<td>SHARE_TYPE_TRANSFER</td>
<td>2</td>
<td><p>A file or folder transfer.</p></td>
</tr>

</tbody>
</table>

<h3 id="cs3.sharing.ocm.v1beta1.ShareState">ShareState</h3>
<p>The state of the share.</p>
<table class="enum-table">
Expand Down

0 comments on commit 1e7d068

Please sign in to comment.