From 5165556a5eaebf21ea5164ddbb69833e35c4c090 Mon Sep 17 00:00:00 2001 From: Antoon Prins Date: Wed, 3 Mar 2021 11:09:32 +0100 Subject: [PATCH 01/11] Share type added to specify Share purpose. --- cs3/sharing/ocm/v1beta1/resources.proto | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/cs3/sharing/ocm/v1beta1/resources.proto b/cs3/sharing/ocm/v1beta1/resources.proto index 8a25ce1b..d4546861 100644 --- a/cs3/sharing/ocm/v1beta1/resources.proto +++ b/cs3/sharing/ocm/v1beta1/resources.proto @@ -70,6 +70,16 @@ message Share { // REQUIRED. // Last modification time of the share. cs3.types.v1beta1.Timestamp mtime = 9; + // Share type defines purpose. + enum ShareType { + // A regular file or folder share (this is the default share type). + SHARE = 0; + // A file or folder transfer. + TRANSFER = 1; + } + // Specifies the type of the share so + // the service implementor can act accordingly. + ShareType share_type = 10; } // The permissions for a share. From 6e7f3ae90ac49df1742a438121ee91728fb28996 Mon Sep 17 00:00:00 2001 From: Antoon Prins Date: Wed, 3 Mar 2021 13:03:31 +0100 Subject: [PATCH 02/11] Fixed enum field names. --- cs3/sharing/ocm/v1beta1/resources.proto | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/cs3/sharing/ocm/v1beta1/resources.proto b/cs3/sharing/ocm/v1beta1/resources.proto index d4546861..bb1f6e40 100644 --- a/cs3/sharing/ocm/v1beta1/resources.proto +++ b/cs3/sharing/ocm/v1beta1/resources.proto @@ -72,10 +72,11 @@ message Share { cs3.types.v1beta1.Timestamp mtime = 9; // Share type defines purpose. enum ShareType { + SHARE_TYPE_INVALID = 0; // A regular file or folder share (this is the default share type). - SHARE = 0; + SHARE_TYPE_REGULAR = 1; // A file or folder transfer. - TRANSFER = 1; + SHARE_TYPE_TRANSFER = 2; } // Specifies the type of the share so // the service implementor can act accordingly. From 415bd020613b551ba48ef8d2d872d233cd317091 Mon Sep 17 00:00:00 2001 From: Antoon Prins Date: Thu, 4 Mar 2021 13:18:26 +0100 Subject: [PATCH 03/11] Modified comment. --- cs3/sharing/ocm/v1beta1/resources.proto | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/cs3/sharing/ocm/v1beta1/resources.proto b/cs3/sharing/ocm/v1beta1/resources.proto index bb1f6e40..c8c781c3 100644 --- a/cs3/sharing/ocm/v1beta1/resources.proto +++ b/cs3/sharing/ocm/v1beta1/resources.proto @@ -73,12 +73,12 @@ message Share { // Share type defines purpose. enum ShareType { SHARE_TYPE_INVALID = 0; - // A regular file or folder share (this is the default share type). + // 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 so + // Specifies the type of the share so // the service implementor can act accordingly. ShareType share_type = 10; } From 15cf7d70bb9e4c2a1e117b7e8093540b469dc05b Mon Sep 17 00:00:00 2001 From: Antoon Prins Date: Thu, 4 Mar 2021 13:20:30 +0100 Subject: [PATCH 04/11] Docs for share type. --- docs/index.html | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) diff --git a/docs/index.html b/docs/index.html index 5f6781e3..e3834218 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1242,6 +1242,10 @@

Table of Contents

+
  • + EShare.ShareType +
    • +
  • EShareState
    • @@ -10175,6 +10179,14 @@

    Share

    Last modification time of the share.

    + + share_type + Share.ShareType + +

    Specifies the type of the share so +the service implementor can act accordingly.

    + + @@ -10345,6 +10357,35 @@

    ShareReference

    +

    Share.ShareType

    +

    Share type defines purpose.

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameNumberDescription
    SHARE_TYPE_INVALID0

    SHARE_TYPE_REGULAR1

    A regular file or folder share.

    SHARE_TYPE_TRANSFER2

    A file or folder transfer.

    +

    ShareState

    The state of the share.

    From 8dc3f42a69a85a9be8673f9124518b5d1d922b64 Mon Sep 17 00:00:00 2001 From: Antoon Prins Date: Wed, 3 Mar 2021 11:09:32 +0100 Subject: [PATCH 05/11] Share type added to specify Share purpose. --- cs3/sharing/ocm/v1beta1/resources.proto | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/cs3/sharing/ocm/v1beta1/resources.proto b/cs3/sharing/ocm/v1beta1/resources.proto index 8a25ce1b..d4546861 100644 --- a/cs3/sharing/ocm/v1beta1/resources.proto +++ b/cs3/sharing/ocm/v1beta1/resources.proto @@ -70,6 +70,16 @@ message Share { // REQUIRED. // Last modification time of the share. cs3.types.v1beta1.Timestamp mtime = 9; + // Share type defines purpose. + enum ShareType { + // A regular file or folder share (this is the default share type). + SHARE = 0; + // A file or folder transfer. + TRANSFER = 1; + } + // Specifies the type of the share so + // the service implementor can act accordingly. + ShareType share_type = 10; } // The permissions for a share. From 2d02f3cf1fa4f47dc64b0d26b19c69289ef98481 Mon Sep 17 00:00:00 2001 From: Antoon Prins Date: Wed, 3 Mar 2021 13:03:31 +0100 Subject: [PATCH 06/11] Fixed enum field names. --- cs3/sharing/ocm/v1beta1/resources.proto | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/cs3/sharing/ocm/v1beta1/resources.proto b/cs3/sharing/ocm/v1beta1/resources.proto index d4546861..bb1f6e40 100644 --- a/cs3/sharing/ocm/v1beta1/resources.proto +++ b/cs3/sharing/ocm/v1beta1/resources.proto @@ -72,10 +72,11 @@ message Share { cs3.types.v1beta1.Timestamp mtime = 9; // Share type defines purpose. enum ShareType { + SHARE_TYPE_INVALID = 0; // A regular file or folder share (this is the default share type). - SHARE = 0; + SHARE_TYPE_REGULAR = 1; // A file or folder transfer. - TRANSFER = 1; + SHARE_TYPE_TRANSFER = 2; } // Specifies the type of the share so // the service implementor can act accordingly. From d29481c8190bf49c14df0c57ce8bdbd94446a1dd Mon Sep 17 00:00:00 2001 From: Antoon Prins Date: Thu, 4 Mar 2021 13:18:26 +0100 Subject: [PATCH 07/11] Modified comment. --- cs3/sharing/ocm/v1beta1/resources.proto | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/cs3/sharing/ocm/v1beta1/resources.proto b/cs3/sharing/ocm/v1beta1/resources.proto index bb1f6e40..c8c781c3 100644 --- a/cs3/sharing/ocm/v1beta1/resources.proto +++ b/cs3/sharing/ocm/v1beta1/resources.proto @@ -73,12 +73,12 @@ message Share { // Share type defines purpose. enum ShareType { SHARE_TYPE_INVALID = 0; - // A regular file or folder share (this is the default share type). + // 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 so + // Specifies the type of the share so // the service implementor can act accordingly. ShareType share_type = 10; } From f92b9776aff74120aa23d31f2e430b21461345bf Mon Sep 17 00:00:00 2001 From: Antoon Prins Date: Thu, 4 Mar 2021 13:20:30 +0100 Subject: [PATCH 08/11] Docs for share type. --- docs/index.html | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) diff --git a/docs/index.html b/docs/index.html index 855cbe63..671442fb 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1250,6 +1250,10 @@

    Table of Contents

    +
  • + EShare.ShareType +
    • +
  • EShareState
    • @@ -10268,6 +10272,14 @@

    Share

    Last modification time of the share.

    +     + + + + + +
    share_typeShare.ShareType

    Specifies the type of the share so +the service implementor can act accordingly.

    @@ -10438,6 +10450,35 @@

    ShareReference

    +

    Share.ShareType

    +

    Share type defines purpose.

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameNumberDescription
    SHARE_TYPE_INVALID0

    SHARE_TYPE_REGULAR1

    A regular file or folder share.

    SHARE_TYPE_TRANSFER2

    A file or folder transfer.

    +

    ShareState

    The state of the share.

    From a2bd142248cbae5867ae5960ae12a77239df0f11 Mon Sep 17 00:00:00 2001 From: Antoon Prins Date: Thu, 4 Mar 2021 16:12:56 +0100 Subject: [PATCH 09/11] Fixed missing dot. --- cs3/ocm/invite/v1beta1/invite_api.proto | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cs3/ocm/invite/v1beta1/invite_api.proto b/cs3/ocm/invite/v1beta1/invite_api.proto index e9839f7b..d931a93d 100644 --- a/cs3/ocm/invite/v1beta1/invite_api.proto +++ b/cs3/ocm/invite/v1beta1/invite_api.proto @@ -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); } From 5850fc10f974f11a18aa748b5ba469665acdea3a Mon Sep 17 00:00:00 2001 From: Antoon Prins Date: Thu, 4 Mar 2021 16:15:44 +0100 Subject: [PATCH 10/11] Fixed missing dot. --- docs/index.html | 202 ++++++++++++++++++++++++------------------------ 1 file changed, 103 insertions(+), 99 deletions(-) diff --git a/docs/index.html b/docs/index.html index 671442fb..e4312db1 100644 --- a/docs/index.html +++ b/docs/index.html @@ -759,19 +759,19 @@

    Table of Contents

  • - MGetRemoteUserRequest + MGetAcceptedUsersRequest
  • - MGetRemoteUserResponse + MGetAcceptedUsersResponse
    • - +
  • - MGetAcceptedUsersRequest + MGetRemoteUserRequest
    • - +
  • - MGetAcceptedUsersResponse + MGetRemoteUserResponse
    • @@ -2844,14 +2844,11 @@

    GatewayAPI

     - - + - - - - +*****************************************************************/ +******************** OCM PROVIDER AUTHORIZER ********************/ +*****************************************************************/

    @@ -6377,6 +6374,80 @@

    GenerateInviteTokenR +

    GetAcceptedUsersRequest

    +

    + + +
    GetRemoteUser .cs3.ocm.invite.v1beta1.GetRemoteUserRequest .cs3.ocm.invite.v1beta1.GetRemoteUserResponse

    Retrieves details about a remote user who has accepted an invite to share.

    Retrieves details about a remote user who has accepted an invite to share. -

    GetAcceptedUsers.cs3.ocm.invite.v1beta1.GetAcceptedUsersRequest.cs3.ocm.invite.v1beta1.GetAcceptedUsersResponse

    Retrieves a list of users that accepted a certain invite token.
    + + + + + + + + + + + + + + + + + + + + +
    FieldTypeLabelDescription
    opaquecs3.types.v1beta1.Opaque

    OPTIONAL. +Opaque information.

    token_namestring

    REQUIRED. +The token name to search accepted users for.

    + + + + + +

    GetAcceptedUsersResponse

    +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypeLabelDescription
    statuscs3.rpc.v1beta1.Status

    REQUIRED. +The response status.

    opaquecs3.types.v1beta1.Opaque

    OPTIONAL. +Opaque information.

    accepted_userscs3.identity.user.v1beta1.Userrepeated

    REQUIRED. +The users that accepted the token with the given name.

    + + + + +

    GetRemoteUserRequest

    @@ -6447,86 +6518,17 @@

    GetRemoteUserResponse

    + + + + + - -

    GetAcceptedUsersRequest

    -

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    opaquecs3.types.v1beta1.Opaque

    OPTIONAL. - Opaque information.

    token_namestring

    REQUIRED. - The token name to search accepted users for.

    - - - - - -

    GetAcceptedUsersResponse

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeLabelDescription
    statuscs3.rpc.v1beta1.Status

    REQUIRED. - The response status.

    opaquecs3.types.v1beta1.Opaque

    OPTIONAL. - Opaque information.

    accepted_userscs3.identity.user.v1beta1.Userrepeated

    REQUIRED. - The users that accepted the token with the given name.

    - - - - - -

    InviteAPI

    + +

    InviteAPI

    Invite API

    The Invite API is meant to invite users and groups belonging to other

    sync'n'share systems, so that collaboration of resources can be enabled.

    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

    RFC 2119.

    The following are global requirements that apply to all methods:

    Any method MUST return CODE_OK on a succesful operation.

    Any method MAY return NOT_IMPLEMENTED.

    Any method MAY return INTERNAL.

    Any method MAY return UNKNOWN.

    Any method MAY return UNAUTHENTICATED.

    @@ -6561,13 +6563,14 @@

    InviteAPI

    - + - - - - + + + + +
    GetRemoteUserResponse

    Retrieves details about a remote user who has accepted an invite to share.
    GetAcceptedUsersGetAcceptedUsersRequestGetAcceptedUsersResponse

    Retrieves a list of users that accepted a certain invite token.

    		GetAcceptedUsersGetAcceptedUsersRequestGetAcceptedUsersResponse

    Retrieves a list of users that accepted a certain invite token.
    @@ -6613,14 +6616,15 @@

    InviteToken

    OPTIONAL. The time when the token will expire.

    - + - name - string - -

    REQUIRED. + name + string + +

    REQUIRED. User-defined token name for token identification.

    + From 726a593daa5ba29593cebff28a79f3ab77da3309 Mon Sep 17 00:00:00 2001 From: Antoon Prins Date: Thu, 4 Mar 2021 16:40:54 +0100 Subject: [PATCH 11/11] Comments modified. --- cs3/sharing/ocm/v1beta1/resources.proto | 5 ++--- docs/index.html | 5 ++--- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/cs3/sharing/ocm/v1beta1/resources.proto b/cs3/sharing/ocm/v1beta1/resources.proto index c8c781c3..efc0c405 100644 --- a/cs3/sharing/ocm/v1beta1/resources.proto +++ b/cs3/sharing/ocm/v1beta1/resources.proto @@ -70,7 +70,7 @@ message Share { // REQUIRED. // Last modification time of the share. cs3.types.v1beta1.Timestamp mtime = 9; - // Share type defines purpose. + // Defines the type of share based on its origin. enum ShareType { SHARE_TYPE_INVALID = 0; // A regular file or folder share. @@ -78,8 +78,7 @@ message Share { // A file or folder transfer. SHARE_TYPE_TRANSFER = 2; } - // Specifies the type of the share so - // the service implementor can act accordingly. + // Specifies the type of the share. ShareType share_type = 10; } diff --git a/docs/index.html b/docs/index.html index e4312db1..fff3d7ab 100644 --- a/docs/index.html +++ b/docs/index.html @@ -10280,8 +10280,7 @@

    Share

    share_type Share.ShareType -

    Specifies the type of the share so -the service implementor can act accordingly.

    +

    Specifies the type of the share.

    @@ -10455,7 +10454,7 @@

    ShareReference

    Share.ShareType

    -

    Share type defines purpose.

    +

    Defines the type of share based on its origin.

    NameNumberDescription