[#194] Move Lock payload description to definition

Signed-off-by: Stanislav Bogatyrev <stanislav@nspcc.ru>
This commit is contained in:
Stanislav Bogatyrev 2022-02-21 12:47:21 +03:00 committed by LeL
parent d6bf64589f
commit 1c683c7578
2 changed files with 7 additions and 9 deletions

View file

@ -7,8 +7,11 @@ option csharp_namespace = "Neo.FileStorage.API.Lock";
import "refs/types.proto"; import "refs/types.proto";
// Lock keeps record of objects that are locked. // Lock objects protects a list of objects from being deleted. Lifetime of the
// lock object is limited similar to regular objects in
// `__NEOFS__EXPIRATION_EPOCH` attribute.
message Lock { message Lock {
// List of objects to be locked. // List of objects to lock. Must not be empty or carry empty IDs.
// All members must be of the `REGULAR` type.
repeated neo.fs.v2.refs.ObjectID members = 1 [json_name = "members"]; repeated neo.fs.v2.refs.ObjectID members = 1 [json_name = "members"];
} }

View file

@ -185,13 +185,8 @@ message Header {
// `ObjectID` will change if header or payload changes. It's calculated as a // `ObjectID` will change if header or payload changes. It's calculated as a
// hash of header field, which contains hash of object's payload. // hash of header field, which contains hash of object's payload.
// //
// Payload format depends on object type specified in the header: // For non-regular object types payload format depends on object type specified
// * **LOCK** \ // in the header.
// Must be encoded message of type `Lock` in Protocol Buffers binary format
// with direct field order. Member list must no be empty or carry empty IDs.
// All members must regular objects (`REGULAR` type). Lifetime of the lock
// object is limited similar to regular objects in `__NEOFS__EXPIRATION_EPOCH`
// attribute.
message Object { message Object {
// Object's unique identifier. // Object's unique identifier.
neo.fs.v2.refs.ObjectID object_id = 1 [json_name = "objectID"]; neo.fs.v2.refs.ObjectID object_id = 1 [json_name = "objectID"];