forked from TrueCloudLab/frostfs-api
[#216] English Check
Signed-off-by: Elizaveta Chichindaeva <elizaveta@nspcc.ru>
This commit is contained in:
Elizaveta Chichindaeva
LeL
parent
431335054c
commit
f233a2fd67
22 changed files with 156 additions and 156 deletions
|
|
@ -17,7 +17,7 @@ import "session/types.proto";
|
|||
service ContainerService {
|
||||
// `Put` invokes `Container` smart contract's `Put` method and returns
|
||||
// response immediately. After a new block is issued in sidechain, request is
|
||||
// verified by Inner Ring nodes. After one more block in sidechain, container
|
||||
// verified by Inner Ring nodes. After one more block in sidechain, the container
|
||||
// is added into smart contract storage.
|
||||
//
|
||||
// Statuses:
|
||||
|
|
@ -28,7 +28,7 @@ service ContainerService {
|
|||
|
||||
// `Delete` invokes `Container` smart contract's `Delete` method and returns
|
||||
// response immediately. After a new block is issued in sidechain, request is
|
||||
// verified by Inner Ring nodes. After one more block in sidechain, container
|
||||
// verified by Inner Ring nodes. After one more block in sidechain, the container
|
||||
// is added into smart contract storage.
|
||||
//
|
||||
// Statuses:
|
||||
|
|
@ -56,7 +56,7 @@ service ContainerService {
|
|||
rpc List(ListRequest) returns (ListResponse);
|
||||
|
||||
// Invokes 'SetEACL' method of 'Container` smart contract and returns response
|
||||
// immediately. After one more block in sidechain, Extended ACL changes are
|
||||
// immediately. After one more block in sidechain, changes in an Extended ACL are
|
||||
// added into smart contract storage.
|
||||
//
|
||||
// Statuses:
|
||||
|
|
@ -76,7 +76,7 @@ service ContainerService {
|
|||
// container not found.
|
||||
rpc GetExtendedACL(GetExtendedACLRequest) returns (GetExtendedACLResponse);
|
||||
|
||||
// Announce container used space values for P2P synchronization.
|
||||
// Announces the space values used by the container for P2P synchronization.
|
||||
//
|
||||
// Statuses:
|
||||
// - **OK** (0, SECTION_SUCCESS): \
|
||||
|
|
@ -117,7 +117,7 @@ message PutResponse {
|
|||
// Container put response body contains information about the newly registered
|
||||
// container as seen by `Container` smart contract. `ContainerID` can be
|
||||
// calculated beforehand from the container structure and compared to the one
|
||||
// returned here to make sure everything was done as expected.
|
||||
// returned here to make sure everything has been done as expected.
|
||||
message Body {
|
||||
// Unique identifier of the newly created container
|
||||
neo.fs.v2.refs.ContainerID container_id = 1;
|
||||
|
|
@ -137,8 +137,8 @@ message PutResponse {
|
|||
|
||||
// Container removal request
|
||||
message DeleteRequest {
|
||||
// Container removal request body has a signed `ContainerID` as a proof of
|
||||
// container owner's intent. The signature will be verified by `Container`
|
||||
// Container removal request body has signed `ContainerID` as a proof of
|
||||
// the container owner's intent. The signature will be verified by `Container`
|
||||
// smart contract, so signing algorithm must be supported by NeoVM.
|
||||
message Body {
|
||||
// Identifier of the container to delete from NeoFS
|
||||
|
|
@ -202,7 +202,7 @@ message GetRequest {
|
|||
// Get container structure
|
||||
message GetResponse {
|
||||
// Get container response body does not have container structure signature. It
|
||||
// was already verified on container creation.
|
||||
// has been already verified upon container creation.
|
||||
message Body {
|
||||
// Requested container structure
|
||||
Container container = 1;
|
||||
|
|
@ -210,7 +210,7 @@ message GetResponse {
|
|||
// Signature of a stable-marshalled container according to RFC-6979.
|
||||
neo.fs.v2.refs.SignatureRFC6979 signature = 2;
|
||||
|
||||
// Session token if the container was created within a session
|
||||
// Session token if the container has been created within the session
|
||||
neo.fs.v2.session.SessionToken session_token = 3;
|
||||
}
|
||||
// Body of container get response message.
|
||||
|
|
@ -272,7 +272,7 @@ message SetExtendedACLRequest {
|
|||
// Set Extended ACL request body does not have separate `ContainerID`
|
||||
// reference. It will be taken from `EACLTable.container_id` field.
|
||||
message Body {
|
||||
// Extended ACL table to set for container
|
||||
// Extended ACL table to set for the container
|
||||
neo.fs.v2.acl.EACLTable eacl = 1;
|
||||
|
||||
// Signature of stable-marshalled Extended ACL table according to RFC-6979.
|
||||
|
|
@ -294,7 +294,7 @@ message SetExtendedACLRequest {
|
|||
// Set Extended ACL
|
||||
message SetExtendedACLResponse {
|
||||
// `SetExtendedACLResponse` has an empty body because the operation is
|
||||
// asynchronous and update should be reflected in `Container` smart contract's
|
||||
// asynchronous and the update should be reflected in `Container` smart contract's
|
||||
// storage after next block is issued in sidechain.
|
||||
message Body { }
|
||||
|
||||
|
|
@ -334,9 +334,9 @@ message GetExtendedACLRequest {
|
|||
|
||||
// Get Extended ACL
|
||||
message GetExtendedACLResponse {
|
||||
// Get Extended ACL Response body can be empty if the requested container did
|
||||
// not have Extended ACL Table attached or Extended ACL was not allowed at
|
||||
// container creation.
|
||||
// Get Extended ACL Response body can be empty if the requested container does
|
||||
// not have Extended ACL Table attached or Extended ACL has not been allowed at
|
||||
// the time of container creation.
|
||||
message Body {
|
||||
// Extended ACL requested, if available
|
||||
neo.fs.v2.acl.EACLTable eacl = 1;
|
||||
|
|
@ -364,21 +364,21 @@ message GetExtendedACLResponse {
|
|||
message AnnounceUsedSpaceRequest {
|
||||
// Container used space announcement body.
|
||||
message Body {
|
||||
// Announcement contains used space information about single container.
|
||||
// Announcement contains used space information for a single container.
|
||||
message Announcement {
|
||||
// Epoch number for which container size estimation was produced.
|
||||
// Epoch number for which the container size estimation was produced.
|
||||
uint64 epoch = 1;
|
||||
|
||||
// Identifier of the container.
|
||||
neo.fs.v2.refs.ContainerID container_id = 2;
|
||||
|
||||
// Used space is a sum of object payload sizes of specified
|
||||
// Used space is a sum of object payload sizes of a specified
|
||||
// container, stored in the node. It must not include inhumed objects.
|
||||
uint64 used_space = 3;
|
||||
}
|
||||
|
||||
// List of announcements. If nodes share several containers, then
|
||||
// announcements transferred in a batch.
|
||||
// List of announcements. If nodes share several containers,
|
||||
// announcements are transferred in a batch.
|
||||
repeated Announcement announcements = 1;
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -10,11 +10,11 @@ import "refs/types.proto";
|
|||
|
||||
// Container is a structure that defines object placement behaviour. Objects can
|
||||
// be stored only within containers. They define placement rule, attributes and
|
||||
// access control information. ID of the container is a 32 byte long SHA256 hash
|
||||
// access control information. An ID of a container is a 32 byte long SHA256 hash
|
||||
// of stable-marshalled container message.
|
||||
message Container {
|
||||
// Container format version. Effectively the version of API library used to
|
||||
// create container.
|
||||
// Container format version. Effectively, the version of API library used to
|
||||
// create the container.
|
||||
neo.fs.v2.refs.Version version = 1 [json_name = "version"];
|
||||
|
||||
// Identifier of the container owner
|
||||
|
|
@ -23,13 +23,13 @@ message Container {
|
|||
// Nonce is a 16 byte UUIDv4, used to avoid collisions of `ContainerID`s
|
||||
bytes nonce = 3 [json_name = "nonce"];
|
||||
|
||||
// `BasicACL` contains access control rules for owner, system, others groups
|
||||
// and permission bits for `BearerToken` and `Extended ACL`
|
||||
// `BasicACL` contains access control rules for the owner, system and others groups,
|
||||
// as well as permission bits for `BearerToken` and `Extended ACL`
|
||||
uint32 basic_acl = 4 [json_name = "basicACL"];
|
||||
|
||||
// `Attribute` is a user-defined Key-Value metadata pair attached to the
|
||||
// container. Container attributes are immutable. They are set at container
|
||||
// creation and can never be added or updated.
|
||||
// container. Container attributes are immutable. They are set at the moment of
|
||||
// container creation and can never be added or updated.
|
||||
//
|
||||
// Key name must be a container-unique valid UTF-8 string. Value can't be
|
||||
// empty. Containers with duplicated attribute names or attributes with empty
|
||||
|
|
@ -38,14 +38,14 @@ message Container {
|
|||
// There are some "well-known" attributes affecting system behaviour:
|
||||
//
|
||||
// * __NEOFS__SUBNET \
|
||||
// String ID of container's storage subnet. Container can be attached to
|
||||
// only one subnet.
|
||||
// String ID of a container's storage subnet. Any container can be attached to
|
||||
// one subnet only.
|
||||
// * __NEOFS__NAME \
|
||||
// String of human-friendly container name registered as the domain in
|
||||
// String of a human-friendly container name registered as a domain in
|
||||
// NNS contract.
|
||||
// * __NEOFS__ZONE \
|
||||
// String of zone for `__NEOFS__NAME`. Used as TLD of domain name in NNS
|
||||
// contract. If zone is not specified, use default zone: `container`.
|
||||
// String of a zone for `__NEOFS__NAME`. Used as a TLD of a domain name in NNS
|
||||
// contract. If no zone is specified, use default zone: `container`.
|
||||
//
|
||||
// And some well-known attributes used by applications only:
|
||||
//
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue