Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs-only] added comments to detail the mapping of OCM properties #206

Merged
merged 1 commit into from
Mar 29, 2023
Merged

[docs-only] added comments to detail the mapping of OCM properties #206

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions cs3/ocm/core/v1beta1/ocm_core_api.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,8 @@ message CreateOCMCoreShareRequest {
cs3.types.v1beta1.Timestamp expiration = 10;
// REQUIRED.
// The protocols which are used to establish synchronisation.
// See also cs3/sharing/ocm/v1beta1/resources.proto for how to map
// this to the OCM share payload.
repeated cs3.sharing.ocm.v1beta1.Protocol protocols = 11;
}

Expand Down
3 changes: 3 additions & 0 deletions cs3/sharing/ocm/v1beta1/ocm_api.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ import "google/protobuf/field_mask.proto";
// resources from the perspective of the creator or the share and
// from the perspective of the receiver of the share.
//
// The following APIs match the OCM v1.1 spec, including the invitation
// workflow and multi-protocol shares.
//
// The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL
// NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and
// "OPTIONAL" in this document are to be interpreted as described in
Expand Down
14 changes: 11 additions & 3 deletions cs3/sharing/ocm/v1beta1/resources.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ message Share {
// Last modification time of the share.
cs3.types.v1beta1.Timestamp mtime = 9;
// OPTIONAL.
// The expiration time for the ocm share.
// The expiration time for the OCM share.
cs3.types.v1beta1.Timestamp expiration = 10;
// REQUIRED.
// Recipient share type.
Expand Down Expand Up @@ -127,6 +127,13 @@ message ReceivedShare {
// Recipient share type.
cs3.sharing.ocm.v1beta1.ShareType share_type = 10;
// REQUIRED.
// List of protocols offered for this share.
// In the OCM specifications, this corresponds to the `protocol`
// property, to maintain backwards compatibility with OCM v1 where
// only a single protocol was implemented. Furthermore,
// `protocol.name` MAY be set to `multi` and `protocol.options`
// MAY be left empty in the OCM share payload, in order to use
// the `protocol.webdav` and similar properties.
repeated Protocol protocols = 11;
// REQUIRED.
// The state of the share.
Expand Down Expand Up @@ -176,13 +183,14 @@ message ShareKey {
storage.provider.v1beta1.Grantee grantee = 3;
}

// A share id identifies uniquely a // share in the share provider namespace.
// A share id identifies uniquely a share in the share provider namespace.
// A ShareId MUST be unique inside the share provider.
message ShareId {
// REQUIRED.
// The internal id used by service implementor to
// uniquely identity the share in the internal
// uniquely identify the share in the internal
// implementation of the service.
// In the OCM specifications, this corresponds to the `providerId`.
string opaque_id = 1;
}

Expand Down
24 changes: 17 additions & 7 deletions docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8854,7 +8854,9 @@ <h3 id="cs3.ocm.core.v1beta1.CreateOCMCoreShareRequest">CreateOCMCoreShareReques
<td><a href="#cs3.sharing.ocm.v1beta1.Protocol">cs3.sharing.ocm.v1beta1.Protocol</a></td>
<td>repeated</td>
<td><p>REQUIRED.
The protocols which are used to establish synchronisation. </p></td>
The protocols which are used to establish synchronisation.
See also cs3/sharing/ocm/v1beta1/resources.proto for how to map
this to the OCM share payload. </p></td>
</tr>

</tbody>
Expand Down Expand Up @@ -13417,7 +13419,7 @@ <h3 id="cs3.sharing.ocm.v1beta1.ListOCMSharesRequest.Filter.Type">ListOCMSharesR


<h3 id="cs3.sharing.ocm.v1beta1.OcmAPI">OcmAPI</h3>
<p>OCM Share Provider API</p><p>The OCM Share Provider API is meant to manipulate share</p><p>resources from the perspective of the creator or the share and</p><p>from the perspective of the receiver of the share.</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>
<p>OCM Share Provider API</p><p>The OCM Share Provider API is meant to manipulate share</p><p>resources from the perspective of the creator or the share and</p><p>from the perspective of the receiver of the share.</p><p>The following APIs match the OCM v1.1 spec, including the invitation</p><p>workflow and multi-protocol shares.</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>
<tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
Expand Down Expand Up @@ -13703,7 +13705,14 @@ <h3 id="cs3.sharing.ocm.v1beta1.ReceivedShare">ReceivedShare</h3>
<td>protocols</td>
<td><a href="#cs3.sharing.ocm.v1beta1.Protocol">Protocol</a></td>
<td>repeated</td>
<td><p>REQUIRED. </p></td>
<td><p>REQUIRED.
List of protocols offered for this share.
In the OCM specifications, this corresponds to the `protocol`
property, to maintain backwards compatibility with OCM v1 where
only a single protocol was implemented. Furthermore,
`protocol.name` MAY be set to `multi` and `protocol.options`
MAY be left empty in the OCM share payload, in order to use
the `protocol.webdav` and similar properties. </p></td>
</tr>

<tr>
Expand Down Expand Up @@ -13829,7 +13838,7 @@ <h3 id="cs3.sharing.ocm.v1beta1.Share">Share</h3>
<td><a href="#cs3.types.v1beta1.Timestamp">cs3.types.v1beta1.Timestamp</a></td>
<td></td>
<td><p>OPTIONAL.
The expiration time for the ocm share. </p></td>
The expiration time for the OCM share. </p></td>
</tr>

<tr>
Expand Down Expand Up @@ -13895,7 +13904,7 @@ <h3 id="cs3.sharing.ocm.v1beta1.ShareGrant">ShareGrant</h3>


<h3 id="cs3.sharing.ocm.v1beta1.ShareId">ShareId</h3>
<p>A share id identifies uniquely a // share in the share provider namespace.</p><p>A ShareId MUST be unique inside the share provider.</p>
<p>A share id identifies uniquely a share in the share provider namespace.</p><p>A ShareId MUST be unique inside the share provider.</p>


<table class="field-table">
Expand All @@ -13910,8 +13919,9 @@ <h3 id="cs3.sharing.ocm.v1beta1.ShareId">ShareId</h3>
<td></td>
<td><p>REQUIRED.
The internal id used by service implementor to
uniquely identity the share in the internal
implementation of the service. </p></td>
uniquely identify the share in the internal
implementation of the service.
In the OCM specifications, this corresponds to the `providerId`. </p></td>
</tr>

</tbody>
Expand Down