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); } diff --git a/cs3/sharing/ocm/v1beta1/resources.proto b/cs3/sharing/ocm/v1beta1/resources.proto index 8a25ce1b..efc0c405 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; + // 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. diff --git a/docs/index.html b/docs/index.html index 855cbe63..fff3d7ab 100644 --- a/docs/index.html +++ b/docs/index.html @@ -759,19 +759,19 @@

Table of Contents

  • - MGetRemoteUserRequest + MGetAcceptedUsersRequest
  • - MGetRemoteUserResponse + MGetAcceptedUsersResponse
    • - +
  • - MGetAcceptedUsersRequest + MGetRemoteUserRequest
    • - +
  • - MGetAcceptedUsersResponse + MGetRemoteUserResponse
    • @@ -1250,6 +1250,10 @@

    Table of Contents

    +
  • + EShare.ShareType +
    • +
  • EShareState
    • @@ -2840,14 +2844,11 @@

    GatewayAPI

    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.

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

    @@ -6373,6 +6374,80 @@

    GenerateInviteTokenR +

    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.

    + + + + +

    GetRemoteUserRequest

    @@ -6443,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.

    @@ -6557,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.
    @@ -6609,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.

    + @@ -10268,6 +10276,13 @@

    Share

    Last modification time of the share.

    + + share_type + Share.ShareType + +

    Specifies the type of the share.

    + + @@ -10438,6 +10453,35 @@

    ShareReference

    +

    Share.ShareType

    +

    Defines the type of share based on its origin.

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    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.