Skip to content

Commit

Permalink
Clarified scope of lock_id in InitiateFileUploadRequest (#226)
Browse files Browse the repository at this point in the history
* Removed lock_id from InitiateFileUploadRequest

* Reinstated lock_id and added comments for clarification
  • Loading branch information
glpatcern authored Feb 16, 2024
1 parent 9139704 commit 6b01495
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions cs3/storage/provider/v1beta1/provider_api.proto
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,11 @@ service ProviderAPI {
// Initiates the download of a file using an
// out-of-band data transfer mechanism.
rpc InitiateFileDownload(InitiateFileDownloadRequest) returns (InitiateFileDownloadResponse);
// Initiates the upload of a file using an
// out-of-band data transfer mechanism.
// Initiates the upload of a file using an out-of-band data
// transfer mechanism. SHOULD return CODE_FAILED_PRECONDITION
// if the reference is already locked with a mismatched lock.
// Additionally, the lock check MUST be enforced by the data
// transfer protocol returned in response.
rpc InitiateFileUpload(InitiateFileUploadRequest) returns (InitiateFileUploadResponse);
// Returns the list of grants for the provided reference.
// MUST return CODE_NOT_FOUND if the reference does not exists.
Expand Down Expand Up @@ -371,7 +374,8 @@ message InitiateFileUploadRequest {
}
// OPTIONAL.
// A lock_id: should the reference exist and be locked, the stored
// lock_id MUST be equal to the given value.
// lock_id SHOULD be equal to the given value. Additionally, the
// check MUST be enforced by the out-of-band transfer protocol.
string lock_id = 5;
}

Expand Down

0 comments on commit 6b01495

Please sign in to comment.