From 38baf4d94e5d076c5297ad2a07fe652e040967fc Mon Sep 17 00:00:00 2001 From: Antoon P Date: Mon, 12 Dec 2022 15:51:30 +0100 Subject: [PATCH] Name change in module datatx: PullTransfer -> CreateTransfer --- cs3/gateway/v1beta1/gateway_api.proto | 4 +- cs3/tx/v1beta1/tx_api.proto | 10 +- docs/index.html | 174 ++++++------- proto.lock | 345 +++++++++++++++++++++++++- 4 files changed, 432 insertions(+), 101 deletions(-) diff --git a/cs3/gateway/v1beta1/gateway_api.proto b/cs3/gateway/v1beta1/gateway_api.proto index 18aacf23..c3b6e9f2 100644 --- a/cs3/gateway/v1beta1/gateway_api.proto +++ b/cs3/gateway/v1beta1/gateway_api.proto @@ -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. diff --git a/cs3/tx/v1beta1/tx_api.proto b/cs3/tx/v1beta1/tx_api.proto index c8c6d396..8d12fe6a 100644 --- a/cs3/tx/v1beta1/tx_api.proto +++ b/cs3/tx/v1beta1/tx_api.proto @@ -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. @@ -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. @@ -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; diff --git a/docs/index.html b/docs/index.html index 973e5b06..fb79ea1c 100644 --- a/docs/index.html +++ b/docs/index.html @@ -398,31 +398,31 @@

Table of Contents

  • - MGetTransferStatusRequest + MCreateTransferRequest
  • - MGetTransferStatusResponse + MCreateTransferResponse
  • - MListTransfersRequest + MGetTransferStatusRequest
  • - MListTransfersRequest.Filter + MGetTransferStatusResponse
  • - MListTransfersResponse + MListTransfersRequest
  • - MPullTransferRequest + MListTransfersRequest.Filter
  • - MPullTransferResponse + MListTransfersResponse
  • @@ -3261,10 +3261,10 @@

    GatewayAPI

    - PullTransfer - .cs3.tx.v1beta1.PullTransferRequest - .cs3.tx.v1beta1.PullTransferResponse -

    Requests the destination to pull a resource from source.

    + CreateTransfer + .cs3.tx.v1beta1.CreateTransferRequest + .cs3.tx.v1beta1.CreateTransferResponse +

    Requests creation of a transfer.

    @@ -4382,7 +4382,7 @@

    CancelTransferResponse

    -

    GetTransferStatusRequest

    +

    CreateTransferRequest

    @@ -4393,11 +4393,21 @@

    GetTransferStatusRequest

    - tx_id - TxId + src_target_uri + string

    REQUIRED. -The transfer identifier.

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

    + + + + dest_target_uri + string + +

    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.

    @@ -4415,7 +4425,7 @@

    GetTransferStatusRequest

    -

    GetTransferStatusResponse

    +

    CreateTransferResponse

    @@ -4438,7 +4448,7 @@

    GetTransferStatusResponse

    TxInfo

    REQUIRED. -TxInfo, includes ao. transfer id, status, description.

    +TxInfo, includes transfer id, status, description.

    @@ -4456,7 +4466,7 @@

    GetTransferStatusResponse

    -

    ListTransfersRequest

    +

    GetTransferStatusRequest

    @@ -4467,19 +4477,19 @@

    ListTransfersRequest

    - opaque - cs3.types.v1beta1.Opaque + tx_id + TxId -

    OPTIONAL. -Opaque information.

    +

    REQUIRED. +The transfer identifier.

    - filters - ListTransfersRequest.Filter - repeated + opaque + cs3.types.v1beta1.Opaque +

    OPTIONAL. -The list of filters to apply if any.

    +Opaque information.

    @@ -4489,8 +4499,8 @@

    ListTransfersRequest

    -

    ListTransfersRequest.Filter

    -

    REQUIRED.

    Represents a filter to apply to the request.

    +

    GetTransferStatusResponse

    +

    @@ -4499,32 +4509,28 @@

    ListTransfersRequest.Filter<

    - - - - - - - - + - + - - + + - + - - + + - + @@ -4534,7 +4540,7 @@

    ListTransfersRequest.Filter< -

    ListTransfersResponse

    +

    ListTransfersRequest

    @@ -4545,27 +4551,19 @@

    ListTransfersResponse

    - - + + - + - - + + - - - - - - - +The list of filters to apply if any.

    @@ -4575,8 +4573,8 @@

    ListTransfersResponse

    -

    PullTransferRequest

    -

    +

    ListTransfersRequest.Filter

    +

    REQUIRED.

    Represents a filter to apply to the request.

    typeListTransfersRequest.Filter.Type

    REQUIRED.

    statusStatuscs3.rpc.v1beta1.Status

    REQUIRED. +The response status.

    share_idcs3.sharing.ocm.v1beta1.ShareIdtx_infoTxInfo

    REQUIRED. +TxInfo, includes ao. transfer id, status, description.

    tx_idTxIdopaquecs3.types.v1beta1.Opaque

    OPTIONAL. +Opaque information.

    statuscs3.rpc.v1beta1.Statusopaquecs3.types.v1beta1.Opaque

    REQUIRED. -The response status.

    OPTIONAL. +Opaque information.

    transfersTxInfofiltersListTransfersRequest.Filter repeated

    REQUIRED. -List of TxInfo types representing transfers.

    opaquecs3.types.v1beta1.Opaque

    OPTIONAL. -Opaque information.

    @@ -4586,29 +4584,31 @@

    PullTransferRequest

    - - + + - + - - + + - + - - + + - + + + + + + + + @@ -4618,7 +4618,7 @@

    PullTransferRequest

    -

    PullTransferResponse

    +

    ListTransfersResponse

    @@ -4637,11 +4637,11 @@

    PullTransferResponse

    - + - + +List of TxInfo types representing transfers.

    @@ -4783,11 +4783,11 @@

    TxAPI

    - - - - + + + + @@ -8295,6 +8295,12 @@

    UserType

    + + + + + +
    src_target_uristringtypeListTransfersRequest.Filter.Type

    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.

    REQUIRED.

    dest_target_uristringstatusStatus

    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.

    opaquecs3.types.v1beta1.Opaqueshare_idcs3.sharing.ocm.v1beta1.ShareId

    OPTIONAL. -Opaque information.

    tx_idTxId
    tx_infotransfers TxInforepeated

    REQUIRED. -TxInfo, includes transfer id, status, description.

    PullTransferPullTransferRequestPullTransferResponse

    Requests the destination to pull a resource from source. -Returns a PullTransferResponse

    		CreateTransferCreateTransferRequestCreateTransferResponse

    Requests creation of a transfer. +Returns a CreateTransferResponse.

    A lightweight user account without access to various major functionalities.
    USER_TYPE_SPACE_OWNER8

    A space owner to allow access for public link or content indexing.
    diff --git a/proto.lock b/proto.lock index 80fc168e..f3d90eed 100644 --- a/proto.lock +++ b/proto.lock @@ -370,6 +370,10 @@ { "name": "VIEW_MODE_READ_WRITE", "integer": 3 + }, + { + "name": "VIEW_MODE_PREVIEW", + "integer": 4 } ] } @@ -1770,6 +1774,10 @@ { "name": "VIEW_MODE_READ_WRITE", "integer": 3 + }, + { + "name": "VIEW_MODE_PREVIEW", + "integer": 4 } ] } @@ -2406,9 +2414,9 @@ "out_type": "cs3.ocm.core.v1beta1.CreateOCMCoreShareResponse" }, { - "name": "PullTransfer", - "in_type": "cs3.tx.v1beta1.PullTransferRequest", - "out_type": "cs3.tx.v1beta1.PullTransferResponse" + "name": "CreateTransfer", + "in_type": "cs3.tx.v1beta1.CreateTransferRequest", + "out_type": "cs3.tx.v1beta1.CreateTransferResponse" }, { "name": "GetTransferStatus", @@ -3076,6 +3084,10 @@ { "name": "USER_TYPE_LIGHTWEIGHT", "integer": 7 + }, + { + "name": "USER_TYPE_SPACE_OWNER", + "integer": 8 } ] } @@ -4528,10 +4540,10 @@ ], "imports": [ { - "path": "cs3/rpc/v1beta1/status.proto" + "path": "cs3/preferences/v1beta1/resources.proto" }, { - "path": "cs3/preferences/v1beta1/resources.proto" + "path": "cs3/rpc/v1beta1/status.proto" } ], "package": { @@ -4932,6 +4944,16 @@ "name": "filters", "type": "Filter", "is_repeated": true + }, + { + "id": 3, + "name": "page_size", + "type": "int32" + }, + { + "id": 4, + "name": "page_token", + "type": "string" } ] }, @@ -4953,6 +4975,11 @@ "name": "shares", "type": "Share", "is_repeated": true + }, + { + "id": 4, + "name": "next_page_token", + "type": "string" } ] }, @@ -5034,6 +5061,16 @@ "name": "filters", "type": "Filter", "is_repeated": true + }, + { + "id": 4, + "name": "page_size", + "type": "int32" + }, + { + "id": 5, + "name": "page_token", + "type": "string" } ] }, @@ -5055,6 +5092,11 @@ "name": "shares", "type": "ReceivedShare", "is_repeated": true + }, + { + "id": 4, + "name": "next_page_token", + "type": "string" } ] }, @@ -5286,6 +5328,14 @@ { "name": "TYPE_EXCLUDE_DENIALS", "integer": 6 + }, + { + "name": "TYPE_SPACE_ID", + "integer": 7 + }, + { + "name": "TYPE_STATE", + "integer": 8 } ] } @@ -5453,6 +5503,16 @@ "id": 6, "name": "grantee_type", "type": "storage.provider.v1beta1.GranteeType" + }, + { + "id": 7, + "name": "space_id", + "type": "string" + }, + { + "id": 8, + "name": "state", + "type": "ShareState" } ] } @@ -5528,6 +5588,10 @@ { "name": "TYPE_DISPLAYNAME", "integer": 4 + }, + { + "name": "TYPE_DESCRIPTION", + "integer": 5 } ] }, @@ -5570,6 +5634,16 @@ "id": 3, "name": "grant", "type": "Grant" + }, + { + "id": 4, + "name": "description", + "type": "string" + }, + { + "id": 5, + "name": "internal", + "type": "bool" } ] }, @@ -5630,6 +5704,11 @@ "id": 5, "name": "display_name", "type": "string" + }, + { + "id": 6, + "name": "description", + "type": "string" } ] } @@ -5673,6 +5752,16 @@ "id": 3, "name": "sign", "type": "bool" + }, + { + "id": 4, + "name": "page_size", + "type": "int32" + }, + { + "id": 5, + "name": "page_token", + "type": "string" } ], "messages": [ @@ -5721,6 +5810,11 @@ "name": "share", "type": "PublicShare", "is_repeated": true + }, + { + "id": 4, + "name": "next_page_token", + "type": "string" } ] }, @@ -6006,6 +6100,16 @@ "id": 12, "name": "signature", "type": "ShareSignature" + }, + { + "id": 13, + "name": "quicklink", + "type": "bool" + }, + { + "id": 14, + "name": "description", + "type": "string" } ] }, @@ -6289,6 +6393,16 @@ "name": "filters", "type": "Filter", "is_repeated": true + }, + { + "id": 3, + "name": "page_size", + "type": "int32" + }, + { + "id": 4, + "name": "page_token", + "type": "string" } ], "messages": [ @@ -6337,6 +6451,11 @@ "name": "shares", "type": "Share", "is_repeated": true + }, + { + "id": 4, + "name": "next_page_token", + "type": "string" } ] }, @@ -6412,6 +6531,16 @@ "id": 1, "name": "opaque", "type": "cs3.types.v1beta1.Opaque" + }, + { + "id": 2, + "name": "page_size", + "type": "int32" + }, + { + "id": 3, + "name": "page_token", + "type": "string" } ] }, @@ -6433,6 +6562,11 @@ "name": "shares", "type": "ReceivedShare", "is_repeated": true + }, + { + "id": 4, + "name": "next_page_token", + "type": "string" } ] }, @@ -6876,6 +7010,14 @@ { "name": "TYPE_SPACE_TYPE", "integer": 4 + }, + { + "name": "TYPE_PATH", + "integer": 5 + }, + { + "name": "TYPE_USER", + "integer": 6 } ] } @@ -7184,6 +7326,11 @@ "name": "if_match", "type": "string" }, + { + "id": 6, + "name": "if_unmodified_since", + "type": "cs3.types.v1beta1.Timestamp" + }, { "id": 5, "name": "lock_id", @@ -7265,6 +7412,16 @@ "id": 2, "name": "ref", "type": "Reference" + }, + { + "id": 3, + "name": "page_size", + "type": "int32" + }, + { + "id": 4, + "name": "page_token", + "type": "string" } ] }, @@ -7286,6 +7443,11 @@ "name": "grants", "type": "Grant", "is_repeated": true + }, + { + "id": 4, + "name": "next_page_token", + "type": "string" } ] }, @@ -7307,6 +7469,21 @@ "name": "arbitrary_metadata_keys", "type": "string", "is_repeated": true + }, + { + "id": 4, + "name": "field_mask", + "type": "google.protobuf.FieldMask" + }, + { + "id": 5, + "name": "page_size", + "type": "int32" + }, + { + "id": 6, + "name": "page_token", + "type": "string" } ] }, @@ -7327,6 +7504,11 @@ "id": 3, "name": "info", "type": "ResourceInfo" + }, + { + "id": 4, + "name": "next_page_token", + "type": "string" } ] }, @@ -7348,6 +7530,21 @@ "name": "arbitrary_metadata_keys", "type": "string", "is_repeated": true + }, + { + "id": 4, + "name": "field_mask", + "type": "google.protobuf.FieldMask" + }, + { + "id": 5, + "name": "page_size", + "type": "int32" + }, + { + "id": 6, + "name": "page_token", + "type": "string" } ] }, @@ -7369,6 +7566,11 @@ "name": "infos", "type": "ResourceInfo", "is_repeated": true + }, + { + "id": 4, + "name": "next_page_token", + "type": "string" } ] }, @@ -7384,6 +7586,16 @@ "id": 2, "name": "ref", "type": "Reference" + }, + { + "id": 3, + "name": "page_size", + "type": "int32" + }, + { + "id": 4, + "name": "page_token", + "type": "string" } ] }, @@ -7405,6 +7617,11 @@ "name": "versions", "type": "FileVersion", "is_repeated": true + }, + { + "id": 4, + "name": "next_page_token", + "type": "string" } ] }, @@ -7435,6 +7652,16 @@ "id": 5, "name": "key", "type": "string" + }, + { + "id": 6, + "name": "page_size", + "type": "int32" + }, + { + "id": 7, + "name": "page_token", + "type": "string" } ] }, @@ -7456,6 +7683,11 @@ "name": "recycle_items", "type": "RecycleItem", "is_repeated": true + }, + { + "id": 4, + "name": "next_page_token", + "type": "string" } ] }, @@ -7486,6 +7718,16 @@ "id": 5, "name": "key", "type": "string" + }, + { + "id": 6, + "name": "page_size", + "type": "int32" + }, + { + "id": 7, + "name": "page_token", + "type": "string" } ] }, @@ -7506,6 +7748,11 @@ "id": 3, "name": "recycle_item", "type": "RecycleItem" + }, + { + "id": 4, + "name": "next_page_token", + "type": "string" } ] }, @@ -7727,6 +7974,11 @@ "name": "arbitrary_metadata_keys", "type": "string", "is_repeated": true + }, + { + "id": 4, + "name": "field_mask", + "type": "google.protobuf.FieldMask" } ] }, @@ -8028,6 +8280,11 @@ "id": 3, "name": "lock", "type": "Lock" + }, + { + "id": 4, + "name": "existing_lock_id", + "type": "string" } ] }, @@ -8169,6 +8426,21 @@ "name": "filters", "type": "Filter", "is_repeated": true + }, + { + "id": 3, + "name": "field_mask", + "type": "google.protobuf.FieldMask" + }, + { + "id": 4, + "name": "page_size", + "type": "int32" + }, + { + "id": 5, + "name": "page_token", + "type": "string" } ], "messages": [ @@ -8194,6 +8466,16 @@ "id": 4, "name": "space_type", "type": "string" + }, + { + "id": 5, + "name": "path", + "type": "string" + }, + { + "id": 6, + "name": "user", + "type": "cs3.identity.user.v1beta1.UserId" } ] } @@ -8217,6 +8499,11 @@ "name": "storage_spaces", "type": "StorageSpace", "is_repeated": true + }, + { + "id": 4, + "name": "next_page_token", + "type": "string" } ] }, @@ -8487,6 +8774,9 @@ }, { "path": "cs3/types/v1beta1/types.proto" + }, + { + "path": "google/protobuf/field_mask.proto" } ], "package": { @@ -8701,6 +8991,21 @@ "name": "advisory_locks", "type": "Lock", "is_repeated": true + }, + { + "id": 17, + "name": "parent_id", + "type": "ResourceId" + }, + { + "id": 18, + "name": "name", + "type": "string" + }, + { + "id": 19, + "name": "space", + "type": "StorageSpace" } ] }, @@ -8819,6 +9124,11 @@ "id": 2, "name": "opaque_id", "type": "string" + }, + { + "id": 3, + "name": "space_id", + "type": "string" } ] }, @@ -8934,6 +9244,11 @@ "id": 2, "name": "permissions", "type": "ResourcePermissions" + }, + { + "id": 3, + "name": "creator", + "type": "cs3.identity.user.v1beta1.UserId" } ] }, @@ -9055,6 +9370,11 @@ "id": 5, "name": "expose", "type": "bool" + }, + { + "id": 6, + "name": "expiration", + "type": "cs3.types.v1beta1.Timestamp" } ] }, @@ -9125,6 +9445,11 @@ "id": 8, "name": "mtime", "type": "cs3.types.v1beta1.Timestamp" + }, + { + "id": 9, + "name": "root_info", + "type": "ResourceInfo" } ] }, @@ -9656,7 +9981,7 @@ ], "messages": [ { - "name": "PullTransferRequest", + "name": "CreateTransferRequest", "fields": [ { "id": 1, @@ -9676,7 +10001,7 @@ ] }, { - "name": "PullTransferResponse", + "name": "CreateTransferResponse", "fields": [ { "id": 1, @@ -9870,9 +10195,9 @@ "name": "TxAPI", "rpcs": [ { - "name": "PullTransfer", - "in_type": "PullTransferRequest", - "out_type": "PullTransferResponse" + "name": "CreateTransfer", + "in_type": "CreateTransferRequest", + "out_type": "CreateTransferResponse" }, { "name": "GetTransferStatus",