forked from TrueCloudLab/frostfs-api
[#57] *: Format with clang-format
Signed-off-by: Evgenii Stratonikov <e.stratonikov@yadro.com>
This commit is contained in:
parent
0916cb5398
commit
4a4a7612f6
5 changed files with 32 additions and 27 deletions
|
@ -196,7 +196,8 @@ message BearerToken {
|
||||||
// valid for this specific container. Otherwise, any container of the same
|
// valid for this specific container. Otherwise, any container of the same
|
||||||
// owner is allowed.
|
// owner is allowed.
|
||||||
//
|
//
|
||||||
// Deprecated: eACL tables are no longer relevant - `APEOverrides` should be used instead.
|
// Deprecated: eACL tables are no longer relevant - `APEOverrides` should be
|
||||||
|
// used instead.
|
||||||
EACLTable eacl_table = 1 [ json_name = "eaclTable" ];
|
EACLTable eacl_table = 1 [ json_name = "eaclTable" ];
|
||||||
|
|
||||||
// `OwnerID` defines to whom the token was issued. It must match the request
|
// `OwnerID` defines to whom the token was issued. It must match the request
|
||||||
|
@ -223,11 +224,12 @@ message BearerToken {
|
||||||
bool allow_impersonate = 4 [ json_name = "allowImpersonate" ];
|
bool allow_impersonate = 4 [ json_name = "allowImpersonate" ];
|
||||||
|
|
||||||
// APEOverride is the list of APE chains defined for a target.
|
// APEOverride is the list of APE chains defined for a target.
|
||||||
// These chains are meant to serve as overrides to the already defined (or even undefined)
|
// These chains are meant to serve as overrides to the already defined (or
|
||||||
// APE chains for the target (see contract `Policy`).
|
// even undefined) APE chains for the target (see contract `Policy`).
|
||||||
//
|
//
|
||||||
// The server-side processing of the bearer token with set APE overrides must verify if a client is permitted
|
// The server-side processing of the bearer token with set APE overrides
|
||||||
// to override chains for the target, preventing unauthorized access through the APE mechanism.
|
// must verify if a client is permitted to override chains for the target,
|
||||||
|
// preventing unauthorized access through the APE mechanism.
|
||||||
message APEOverride {
|
message APEOverride {
|
||||||
// Target for which chains are applied.
|
// Target for which chains are applied.
|
||||||
frostfs.v2.ape.ChainTarget target = 1 [ json_name = "target" ];
|
frostfs.v2.ape.ChainTarget target = 1 [ json_name = "target" ];
|
||||||
|
|
|
@ -25,7 +25,7 @@ service ContainerService {
|
||||||
// request to save the container has been sent to the sidechain;
|
// request to save the container has been sent to the sidechain;
|
||||||
// - Common failures (SECTION_FAILURE_COMMON);
|
// - Common failures (SECTION_FAILURE_COMMON);
|
||||||
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
||||||
// container create access denied.
|
// container create access denied.
|
||||||
rpc Put(PutRequest) returns (PutResponse);
|
rpc Put(PutRequest) returns (PutResponse);
|
||||||
|
|
||||||
// `Delete` invokes `Container` smart contract's `Delete` method and returns
|
// `Delete` invokes `Container` smart contract's `Delete` method and returns
|
||||||
|
@ -38,7 +38,7 @@ service ContainerService {
|
||||||
// request to remove the container has been sent to the sidechain;
|
// request to remove the container has been sent to the sidechain;
|
||||||
// - Common failures (SECTION_FAILURE_COMMON);
|
// - Common failures (SECTION_FAILURE_COMMON);
|
||||||
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
||||||
// container delete access denied.
|
// container delete access denied.
|
||||||
rpc Delete(DeleteRequest) returns (DeleteResponse);
|
rpc Delete(DeleteRequest) returns (DeleteResponse);
|
||||||
|
|
||||||
// Returns container structure from `Container` smart contract storage.
|
// Returns container structure from `Container` smart contract storage.
|
||||||
|
@ -50,7 +50,7 @@ service ContainerService {
|
||||||
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||||
// requested container not found;
|
// requested container not found;
|
||||||
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
||||||
// access to container is denied.
|
// access to container is denied.
|
||||||
rpc Get(GetRequest) returns (GetResponse);
|
rpc Get(GetRequest) returns (GetResponse);
|
||||||
|
|
||||||
// Returns all owner's containers from 'Container` smart contract' storage.
|
// Returns all owner's containers from 'Container` smart contract' storage.
|
||||||
|
@ -60,7 +60,7 @@ service ContainerService {
|
||||||
// container list has been successfully read;
|
// container list has been successfully read;
|
||||||
// - Common failures (SECTION_FAILURE_COMMON);
|
// - Common failures (SECTION_FAILURE_COMMON);
|
||||||
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
||||||
// container list access denied.
|
// container list access denied.
|
||||||
rpc List(ListRequest) returns (ListResponse);
|
rpc List(ListRequest) returns (ListResponse);
|
||||||
|
|
||||||
// Invokes 'SetEACL' method of 'Container` smart contract and returns response
|
// Invokes 'SetEACL' method of 'Container` smart contract and returns response
|
||||||
|
@ -72,7 +72,7 @@ service ContainerService {
|
||||||
// request to save container eACL has been sent to the sidechain;
|
// request to save container eACL has been sent to the sidechain;
|
||||||
// - Common failures (SECTION_FAILURE_COMMON);
|
// - Common failures (SECTION_FAILURE_COMMON);
|
||||||
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
||||||
// set container eACL access denied.
|
// set container eACL access denied.
|
||||||
rpc SetExtendedACL(SetExtendedACLRequest) returns (SetExtendedACLResponse);
|
rpc SetExtendedACL(SetExtendedACLRequest) returns (SetExtendedACLResponse);
|
||||||
|
|
||||||
// Returns Extended ACL table and signature from `Container` smart contract
|
// Returns Extended ACL table and signature from `Container` smart contract
|
||||||
|
@ -87,7 +87,7 @@ service ContainerService {
|
||||||
// - **EACL_NOT_FOUND** (3073, SECTION_CONTAINER): \
|
// - **EACL_NOT_FOUND** (3073, SECTION_CONTAINER): \
|
||||||
// eACL table not found;
|
// eACL table not found;
|
||||||
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
||||||
// access to container eACL is denied.
|
// access to container eACL is denied.
|
||||||
rpc GetExtendedACL(GetExtendedACLRequest) returns (GetExtendedACLResponse);
|
rpc GetExtendedACL(GetExtendedACLRequest) returns (GetExtendedACLResponse);
|
||||||
|
|
||||||
// Announces the space values used by the container for P2P synchronization.
|
// Announces the space values used by the container for P2P synchronization.
|
||||||
|
|
|
@ -46,7 +46,7 @@ service ObjectService {
|
||||||
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||||
// object container not found;
|
// object container not found;
|
||||||
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
||||||
// access to container is denied;
|
// access to container is denied;
|
||||||
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
||||||
// provided session token has expired.
|
// provided session token has expired.
|
||||||
rpc Get(GetRequest) returns (stream GetResponse);
|
rpc Get(GetRequest) returns (stream GetResponse);
|
||||||
|
@ -115,7 +115,7 @@ service ObjectService {
|
||||||
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||||
// object container not found;
|
// object container not found;
|
||||||
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
||||||
// access to container is denied;
|
// access to container is denied;
|
||||||
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
||||||
// provided session token has expired.
|
// provided session token has expired.
|
||||||
rpc Delete(DeleteRequest) returns (DeleteResponse);
|
rpc Delete(DeleteRequest) returns (DeleteResponse);
|
||||||
|
@ -145,7 +145,7 @@ service ObjectService {
|
||||||
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||||
// object container not found;
|
// object container not found;
|
||||||
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
||||||
// access to container is denied;
|
// access to container is denied;
|
||||||
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
||||||
// provided session token has expired.
|
// provided session token has expired.
|
||||||
rpc Head(HeadRequest) returns (HeadResponse);
|
rpc Head(HeadRequest) returns (HeadResponse);
|
||||||
|
@ -171,7 +171,7 @@ service ObjectService {
|
||||||
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||||
// search container not found;
|
// search container not found;
|
||||||
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
||||||
// access to container is denied;
|
// access to container is denied;
|
||||||
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
||||||
// provided session token has expired.
|
// provided session token has expired.
|
||||||
rpc Search(SearchRequest) returns (stream SearchResponse);
|
rpc Search(SearchRequest) returns (stream SearchResponse);
|
||||||
|
@ -208,7 +208,7 @@ service ObjectService {
|
||||||
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||||
// object container not found;
|
// object container not found;
|
||||||
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
||||||
// access to container is denied;
|
// access to container is denied;
|
||||||
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
||||||
// provided session token has expired.
|
// provided session token has expired.
|
||||||
rpc GetRange(GetRangeRequest) returns (stream GetRangeResponse);
|
rpc GetRange(GetRangeRequest) returns (stream GetRangeResponse);
|
||||||
|
@ -243,7 +243,7 @@ service ObjectService {
|
||||||
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||||
// object container not found;
|
// object container not found;
|
||||||
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
||||||
// access to container is denied;
|
// access to container is denied;
|
||||||
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
||||||
// provided session token has expired.
|
// provided session token has expired.
|
||||||
rpc GetRangeHash(GetRangeHashRequest) returns (GetRangeHashResponse);
|
rpc GetRangeHash(GetRangeHashRequest) returns (GetRangeHashResponse);
|
||||||
|
@ -275,7 +275,7 @@ service ObjectService {
|
||||||
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||||
// object storage container not found;
|
// object storage container not found;
|
||||||
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
||||||
// access to container is denied;
|
// access to container is denied;
|
||||||
// - **TOKEN_NOT_FOUND** (4096, SECTION_SESSION): \
|
// - **TOKEN_NOT_FOUND** (4096, SECTION_SESSION): \
|
||||||
// (for trusted object preparation) session private key does not exist or
|
// (for trusted object preparation) session private key does not exist or
|
||||||
// has
|
// has
|
||||||
|
@ -584,8 +584,8 @@ message SearchRequest {
|
||||||
// * $Object:split.splitID \
|
// * $Object:split.splitID \
|
||||||
// 16 byte UUIDv4 used to identify the split object hierarchy parts
|
// 16 byte UUIDv4 used to identify the split object hierarchy parts
|
||||||
// * $Object:ec.parent \
|
// * $Object:ec.parent \
|
||||||
// If the object is stored according to EC policy, then ec_parent attribute
|
// If the object is stored according to EC policy, then ec_parent
|
||||||
// is set to return an id list of all related EC chunks.
|
// attribute is set to return an id list of all related EC chunks.
|
||||||
//
|
//
|
||||||
// There are some well-known filter aliases to match objects by certain
|
// There are some well-known filter aliases to match objects by certain
|
||||||
// properties:
|
// properties:
|
||||||
|
|
|
@ -209,13 +209,15 @@ message Header {
|
||||||
// Chunk of a parent header.
|
// Chunk of a parent header.
|
||||||
bytes header = 5 [ json_name = "header" ];
|
bytes header = 5 [ json_name = "header" ];
|
||||||
// As the origin object is EC-splitted its identifier is known to all
|
// As the origin object is EC-splitted its identifier is known to all
|
||||||
// chunks as parent. But parent itself can be a part of Split (does not relate to EC-split).
|
// chunks as parent. But parent itself can be a part of Split (does not
|
||||||
// In this case parent_split_id should be set.
|
// relate to EC-split). In this case parent_split_id should be set.
|
||||||
bytes parent_split_id = 6 [ json_name = "parentSplitID" ];
|
bytes parent_split_id = 6 [ json_name = "parentSplitID" ];
|
||||||
// EC-parent's parent ID. parent_split_parent_id is set if EC-parent, itself, is a part of Split and
|
// EC-parent's parent ID. parent_split_parent_id is set if EC-parent,
|
||||||
// if an object ID of its parent is presented. The field allows to determine how EC-chunk is placed
|
// itself, is a part of Split and if an object ID of its parent is
|
||||||
// in Split hierarchy.
|
// presented. The field allows to determine how EC-chunk is placed in Split
|
||||||
neo.fs.v2.refs.ObjectID parent_split_parent_id = 7 [ json_name = "parentSplitParentID" ];
|
// hierarchy.
|
||||||
|
neo.fs.v2.refs.ObjectID parent_split_parent_id = 7
|
||||||
|
[ json_name = "parentSplitParentID" ];
|
||||||
// EC parent's attributes.
|
// EC parent's attributes.
|
||||||
repeated Attribute parent_attributes = 8 [ json_name = "parentAttributes" ];
|
repeated Attribute parent_attributes = 8 [ json_name = "parentAttributes" ];
|
||||||
}
|
}
|
||||||
|
|
|
@ -106,7 +106,8 @@ enum CommonFail {
|
||||||
NODE_UNDER_MAINTENANCE = 3;
|
NODE_UNDER_MAINTENANCE = 3;
|
||||||
|
|
||||||
// [**1028**] Invalid argument error. If the server fails on validation of a
|
// [**1028**] Invalid argument error. If the server fails on validation of a
|
||||||
// request parameter as the client sent it incorrectly, then this code should be used.
|
// request parameter as the client sent it incorrectly, then this code should
|
||||||
|
// be used.
|
||||||
INVALID_ARGUMENT = 4;
|
INVALID_ARGUMENT = 4;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue