TrueCloudLab/frostfs-api
32
0
Fork 18
Code Issues 14 Pull requests 1 Releases Activity Actions

Compare commits

base: TrueCloudLab:master
Branches Tags
TrueCloudLab:master
TrueCloudLab:feature/compatibility
TrueCloudLab:rebranding
potyarkin:feature/codeowners
potyarkin:tmp/meaningless-pr
potyarkin:master
potyarkin:empty
..
compare: potyarkin:feature/codeowners
Branches Tags
potyarkin:feature/codeowners
potyarkin:tmp/meaningless-pr
potyarkin:master
potyarkin:empty
TrueCloudLab:master
TrueCloudLab:feature/compatibility
TrueCloudLab:rebranding

No commits in common. "master" and "feature/codeowners" have entirely different histories.
master ... feature/co

21 changed files with 20 additions and 104 deletions
Show stats Expand all files Collapse all files

2
CODEOWNERS
View file

@ -1,3 +1,3 @@
.* @alexvanin @realloc @fyrchik @a.bogatyrev @TrueCloudLab/storage-sdk-developers
.* @alexvanin @realloc @fyrchik @a.bogatyrev
.forgejo/.* @potyarkin
Makefile @potyarkin

2
accounting/service.proto
View file

@ -1,4 +1,4 @@
edition = "2023";
syntax = "proto3";
package neo.fs.v2.accounting;

2
accounting/types.proto
View file

@ -1,4 +1,4 @@
edition = "2023";
syntax = "proto3";
package neo.fs.v2.accounting;

2
acl/types.proto
View file

@ -1,4 +1,4 @@
edition = "2023";
syntax = "proto3";
package neo.fs.v2.acl;

2
ape/types.proto
View file

@ -1,4 +1,4 @@
edition = "2023";
syntax = "proto3";
package frostfs.v2.ape;

2
apemanager/service.proto
View file

@ -1,4 +1,4 @@
edition = "2023";
syntax = "proto3";
package frostfs.v2.apemanager;

2
container/service.proto
View file

@ -1,4 +1,4 @@
edition = "2023";
syntax = "proto3";
package neo.fs.v2.container;

2
container/types.proto
View file

@ -1,4 +1,4 @@
edition = "2023";
syntax = "proto3";
package neo.fs.v2.container;

2
lock/types.proto
View file

@ -1,4 +1,4 @@
edition = "2023";
syntax = "proto3";
package neo.fs.v2.lock;

2
netmap/service.proto
View file

@ -1,4 +1,4 @@
edition = "2023";
syntax = "proto3";
package neo.fs.v2.netmap;

2
netmap/types.proto
View file

@ -1,4 +1,4 @@
edition = "2023";
syntax = "proto3";
package neo.fs.v2.netmap;

10
object/service.proto
View file

@ -1,4 +1,4 @@
edition = "2023";
syntax = "proto3";
package neo.fs.v2.object;
@ -124,9 +124,6 @@ service ObjectService {
// returned. If `main_only` request field is set, the short header with only
// the very minimal information will be returned instead.
//
// Max header size is currently not limited by this API, but may be restricted
// on the service level. By default, gRPC uses a message size of 4 MiB.
//
// Extended headers can change `Head` behaviour:
// * [ __SYSTEM__NETMAP_EPOCH ] \
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
@ -573,7 +570,6 @@ message HeadResponse {
ShortHeader short_header = 2;
// Meta information of split hierarchy.
// Indicates that the object is virtual, manual assembly is required.
SplitInfo split_info = 3;
// Meta information for EC object assembly.
@ -891,10 +887,6 @@ message PatchRequest {
// key, then it just replaces it while merging the lists.
bool replace_attributes = 3;
// New split header for the object. This defines how the object will relate
// to other objects in a split operation.
neo.fs.v2.object.Header.Split new_split_header = 5;
// The patch for the object's payload.
message Patch {
// The range of the source object for which the payload is replaced by the

2
object/types.proto
View file

@ -1,4 +1,4 @@
edition = "2023";
syntax = "proto3";
package neo.fs.v2.object;

70
proto-docs/container.md
View file

@ -20,10 +20,6 @@
- [ListRequest.Body](#neo.fs.v2.container.ListRequest.Body)
- [ListResponse](#neo.fs.v2.container.ListResponse)
- [ListResponse.Body](#neo.fs.v2.container.ListResponse.Body)
- [ListStreamRequest](#neo.fs.v2.container.ListStreamRequest)
- [ListStreamRequest.Body](#neo.fs.v2.container.ListStreamRequest.Body)
- [ListStreamResponse](#neo.fs.v2.container.ListStreamResponse)
- [ListStreamResponse.Body](#neo.fs.v2.container.ListStreamResponse.Body)
- [PutRequest](#neo.fs.v2.container.PutRequest)
- [PutRequest.Body](#neo.fs.v2.container.PutRequest.Body)
- [PutResponse](#neo.fs.v2.container.PutResponse)
@ -62,7 +58,6 @@ rpc Put(PutRequest) returns (PutResponse);
rpc Delete(DeleteRequest) returns (DeleteResponse);
rpc Get(GetRequest) returns (GetResponse);
rpc List(ListRequest) returns (ListResponse);
rpc ListStream(ListStreamRequest) returns (stream ListStreamResponse);
```
@ -118,7 +113,7 @@ Statuses:
| Get | [GetRequest](#neo.fs.v2.container.GetRequest) | [GetResponse](#neo.fs.v2.container.GetResponse) |
#### Method List
Returns all owner's containers from `Container` smart contract storage.
Returns all owner's containers from 'Container` smart contract' storage.
Statuses:
- **OK** (0, SECTION_SUCCESS): \
@ -130,21 +125,6 @@ Statuses:
| Name | Input | Output |
| ---- | ----- | ------ |
| List | [ListRequest](#neo.fs.v2.container.ListRequest) | [ListResponse](#neo.fs.v2.container.ListResponse) |
#### Method ListStream
Returns all owner's containers from `Container` smart contract storage
via stream.
Statuses:
- **OK** (0, SECTION_SUCCESS): \
container list has been successfully read;
- Common failures (SECTION_FAILURE_COMMON);
- **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
container list access denied.
| Name | Input | Output |
| ---- | ----- | ------ |
| ListStream | [ListStreamRequest](#neo.fs.v2.container.ListStreamRequest) | [ListStreamResponse](#neo.fs.v2.container.ListStreamResponse) |
<!-- end services -->
@ -296,54 +276,6 @@ List containers response body.
| container_ids | [neo.fs.v2.refs.ContainerID](#neo.fs.v2.refs.ContainerID) | repeated | List of `ContainerID`s belonging to the requested `OwnerID` |
<a name="neo.fs.v2.container.ListStreamRequest"></a>
### Message ListStreamRequest
List containers stream
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| body | [ListStreamRequest.Body](#neo.fs.v2.container.ListStreamRequest.Body) | | Body of list containers stream request message. |
| meta_header | [neo.fs.v2.session.RequestMetaHeader](#neo.fs.v2.session.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. |
| verify_header | [neo.fs.v2.session.RequestVerificationHeader](#neo.fs.v2.session.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
<a name="neo.fs.v2.container.ListStreamRequest.Body"></a>
### Message ListStreamRequest.Body
List containers stream request body.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| owner_id | [neo.fs.v2.refs.OwnerID](#neo.fs.v2.refs.OwnerID) | | Identifier of the container owner. |
<a name="neo.fs.v2.container.ListStreamResponse"></a>
### Message ListStreamResponse
List containers stream
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| body | [ListStreamResponse.Body](#neo.fs.v2.container.ListStreamResponse.Body) | | Body of list containers stream response message. |
| meta_header | [neo.fs.v2.session.ResponseMetaHeader](#neo.fs.v2.session.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. |
| verify_header | [neo.fs.v2.session.ResponseVerificationHeader](#neo.fs.v2.session.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
<a name="neo.fs.v2.container.ListStreamResponse.Body"></a>
### Message ListStreamResponse.Body
List containers stream response body.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| container_ids | [neo.fs.v2.refs.ContainerID](#neo.fs.v2.refs.ContainerID) | repeated | List of `ContainerID`s belonging to the requested `OwnerID` |
<a name="neo.fs.v2.container.PutRequest"></a>
### Message PutRequest

5
proto-docs/object.md
View file

@ -223,9 +223,6 @@ Returns the object Headers without data payload. By default full header is
returned. If `main_only` request field is set, the short header with only
the very minimal information will be returned instead.
Max header size is currently not limited by this API, but may be restricted
on the service level. By default, gRPC uses a message size of 4 MiB.
Extended headers can change `Head` behaviour:
* [ __SYSTEM__NETMAP_EPOCH ] \
(`__NEOFS__NETMAP_EPOCH` is deprecated) \
@ -731,7 +728,7 @@ Object HEAD response body
| ----- | ---- | ----- | ----------- |
| header | [HeaderWithSignature](#neo.fs.v2.object.HeaderWithSignature) | | Full object's `Header` with `ObjectID` signature |
| short_header | [ShortHeader](#neo.fs.v2.object.ShortHeader) | | Short object header |
| split_info | [SplitInfo](#neo.fs.v2.object.SplitInfo) | | Meta information of split hierarchy. Indicates that the object is virtual, manual assembly is required. |
| split_info | [SplitInfo](#neo.fs.v2.object.SplitInfo) | | Meta information of split hierarchy. |
| ec_info | [ECInfo](#neo.fs.v2.object.ECInfo) | | Meta information for EC object assembly. |

1
proto-docs/status.md
View file

@ -102,7 +102,6 @@ Section of failed statuses independent of the operation.
| SIGNATURE_VERIFICATION_FAIL | 2 | [**1026**] Signature verification failure. |
| NODE_UNDER_MAINTENANCE | 3 | [**1027**] Node is under maintenance. |
| INVALID_ARGUMENT | 4 | [**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. |
| RESOURCE_EXHAUSTED | 5 | [**1029**] Resource exhausted failure. This code should be used if the operation cannot be performed due to a lack of resources. |

2
refs/types.proto
View file

@ -1,4 +1,4 @@
edition = "2023";
syntax = "proto3";
package neo.fs.v2.refs;

2
session/service.proto
View file

@ -1,4 +1,4 @@
edition = "2023";
syntax = "proto3";
package neo.fs.v2.session;

2
session/types.proto
View file

@ -1,4 +1,4 @@
edition = "2023";
syntax = "proto3";
package neo.fs.v2.session;

6
status/types.proto
View file

@ -1,4 +1,4 @@
edition = "2023";
syntax = "proto3";
package neo.fs.v2.status;
@ -109,10 +109,6 @@ enum CommonFail {
// request parameter as the client sent it incorrectly, then this code should
// be used.
INVALID_ARGUMENT = 4;
// [**1029**] Resource exhausted failure. This code should be used
// if the operation cannot be performed due to a lack of resources.
RESOURCE_EXHAUSTED = 5;
}
// Section of statuses for object-related operations.

2
tombstone/types.proto
View file

@ -1,4 +1,4 @@
edition = "2023";
syntax = "proto3";
package neo.fs.v2.tombstone;