[#82] Update documentation info

Signed-off-by: Ori Bruk <o.bruk@yadro.com>

object/service.proto

@@ -124,6 +124,9 @@ service ObjectService {
   // returned. If `main_only` request field is set, the short header with only
   // the very minimal information will be returned instead.
   //
+  // There are limitations on the gRPC side,
+  // i.e. you can't get the full information if it takes up more than 4 MiB.
+  //
   // Extended headers can change `Head` behaviour:
   // * [ __SYSTEM__NETMAP_EPOCH ] \
   //   (`__NEOFS__NETMAP_EPOCH` is deprecated) \
@@ -570,6 +573,8 @@ message HeadResponse {
       ShortHeader short_header = 2;
 
       // Meta information of split hierarchy.
+      // The return of this information indicates that an error has occurred.
+      // This information allows you to assemble the object yourself.
       SplitInfo split_info = 3;
 
       // Meta information for EC object assembly.

proto-docs/container.md

@@ -20,6 +20,10 @@
       - [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)
@@ -58,6 +62,7 @@ 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);
 
 ```
 
@@ -113,7 +118,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): \
@@ -125,6 +130,21 @@ 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 -->
 
 
@@ -276,6 +296,54 @@ 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

proto-docs/object.md

@@ -223,6 +223,9 @@ 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.
 
+There are limitations on the gRPC side,
+i.e. you can't get the full information if it takes up more than 4 MiB.
+
 Extended headers can change `Head` behaviour:
 * [ __SYSTEM__NETMAP_EPOCH ] \
   (`__NEOFS__NETMAP_EPOCH` is deprecated) \
@@ -728,7 +731,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. |
+| split_info | [SplitInfo](#neo.fs.v2.object.SplitInfo) |  | Meta information of split hierarchy. The return of this information indicates that an error has occurred. This information allows you to assemble the object yourself. |
 | ec_info | [ECInfo](#neo.fs.v2.object.ECInfo) |  | Meta information for EC object assembly. |
 
 

proto-docs/status.md

@@ -102,6 +102,7 @@ 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. |