docs: add container proto documentation

This commit is contained in:
alexvanin 2019-11-20 20:16:24 +03:00
parent 04f1cbca48
commit ad86acf62f
2 changed files with 40 additions and 14 deletions

View file

@ -9,8 +9,8 @@ option (gogoproto.stable_marshaler_all) = true;
// The Container service definition.
message Container {
bytes OwnerID = 1 [(gogoproto.customtype) = "OwnerID", (gogoproto.nullable) = false];
bytes Salt = 2 [(gogoproto.customtype) = "UUID", (gogoproto.nullable) = false];
uint64 Capacity = 3;
netmap.PlacementRule Rules = 4 [(gogoproto.nullable) = false];
bytes OwnerID = 1 [(gogoproto.customtype) = "OwnerID", (gogoproto.nullable) = false]; // OwnerID is a wallet address.
bytes Salt = 2 [(gogoproto.customtype) = "UUID", (gogoproto.nullable) = false]; // Salt is a nonce for unique container id calculation.
uint64 Capacity = 3; // Capacity defines amount of data that can be stored in the container (doesn't used for now).
netmap.PlacementRule Rules = 4 [(gogoproto.nullable) = false]; // Rules define storage policy for the object inside the container.
}