realloc/frostfs-api
1
0
Fork 0
forked from TrueCloudLab/frostfs-api
Code Issues Pull requests Projects Releases Packages Wiki Activity

[#45] docs: Regenerate Markdown docs

Browse source 
Signed-off-by: Stanislav Bogatyrev <stanislav@nspcc.ru>
This commit is contained in:
Stanislav Bogatyrev 2020-08-13 19:18:53 +03:00 committed by Alex Vanin
parent 42e35fefff
commit eb61f7cafd
9 changed files with 567 additions and 578 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

48
proto-docs/accounting.md
View file

@ -5,14 +5,14 @@
- [accounting/service.proto](#accounting/service.proto)
- Services
- [Accounting](#accounting.Accounting)
- [AccountingService](#neo.fs.v2.accounting.AccountingService)
- Messages
- [BalanceRequest](#accounting.BalanceRequest)
- [BalanceRequest.Body](#accounting.BalanceRequest.Body)
- [BalanceResponse](#accounting.BalanceResponse)
- [BalanceResponse.Body](#accounting.BalanceResponse.Body)
- [Decimal](#accounting.Decimal)
- [BalanceRequest](#neo.fs.v2.accounting.BalanceRequest)
- [BalanceRequest.Body](#neo.fs.v2.accounting.BalanceRequest.Body)
- [BalanceResponse](#neo.fs.v2.accounting.BalanceResponse)
- [BalanceResponse.Body](#neo.fs.v2.accounting.BalanceResponse.Body)
- [Decimal](#neo.fs.v2.accounting.Decimal)
- [Scalar Value Types](#scalar-value-types)
@ -27,9 +27,9 @@
<a name="accounting.Accounting"></a>
<a name="neo.fs.v2.accounting.AccountingService"></a>
### Service "accounting.Accounting"
### Service "neo.fs.v2.accounting.AccountingService"
The service provides methods for obtaining information
about the account balance in NeoFS system.
@ -44,11 +44,11 @@ Returns the amount of funds for the requested NeoFS account.
| Name | Input | Output |
| ---- | ----- | ------ |
| Balance | [BalanceRequest](#accounting.BalanceRequest) | [BalanceResponse](#accounting.BalanceResponse) |
| Balance | [BalanceRequest](#neo.fs.v2.accounting.BalanceRequest) | [BalanceResponse](#neo.fs.v2.accounting.BalanceResponse) |
<!-- end services -->
<a name="accounting.BalanceRequest"></a>
<a name="neo.fs.v2.accounting.BalanceRequest"></a>
### Message BalanceRequest
Message defines the request body of Balance method.
@ -62,23 +62,23 @@ according to the requirements from the system specification.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| body | [BalanceRequest.Body](#accounting.BalanceRequest.Body) | | Body of the balance request message. |
| meta_header | [service.RequestMetaHeader](#service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. |
| verify_header | [service.RequestVerificationHeader](#service.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
| body | [BalanceRequest.Body](#neo.fs.v2.accounting.BalanceRequest.Body) | | Body of the balance request message. |
| meta_header | [neo.fs.v2.service.RequestMetaHeader](#neo.fs.v2.service.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.service.RequestVerificationHeader](#neo.fs.v2.service.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="accounting.BalanceRequest.Body"></a>
<a name="neo.fs.v2.accounting.BalanceRequest.Body"></a>
### Message BalanceRequest.Body
Request body
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| owner_id | [refs.OwnerID](#refs.OwnerID) | | Carries user identifier in NeoFS system for which the balance is requested. |
| owner_id | [neo.fs.v2.refs.OwnerID](#neo.fs.v2.refs.OwnerID) | | Carries user identifier in NeoFS system for which the balance is requested. |
<a name="accounting.BalanceResponse"></a>
<a name="neo.fs.v2.accounting.BalanceResponse"></a>
### Message BalanceResponse
Message defines the response body of Balance method.
@ -88,23 +88,23 @@ The amount of funds is calculated in decimal numbers.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| body | [BalanceResponse.Body](#accounting.BalanceResponse.Body) | | Body of the balance response message. |
| meta_header | [service.ResponseMetaHeader](#service.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. |
| verify_header | [service.ResponseVerificationHeader](#service.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
| body | [BalanceResponse.Body](#neo.fs.v2.accounting.BalanceResponse.Body) | | Body of the balance response message. |
| meta_header | [neo.fs.v2.service.ResponseMetaHeader](#neo.fs.v2.service.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.service.ResponseVerificationHeader](#neo.fs.v2.service.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="accounting.BalanceResponse.Body"></a>
<a name="neo.fs.v2.accounting.BalanceResponse.Body"></a>
### Message BalanceResponse.Body
Request body
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| balance | [Decimal](#accounting.Decimal) | | Carries the amount of funds on the account. |
| balance | [Decimal](#neo.fs.v2.accounting.Decimal) | | Carries the amount of funds on the account. |
<a name="accounting.Decimal"></a>
<a name="neo.fs.v2.accounting.Decimal"></a>
### Message Decimal
Decimal represents the decimal numbers.

80
proto-docs/acl.md
View file

@ -6,10 +6,10 @@
- [acl/types.proto](#acl/types.proto)
- Messages
- [EACLRecord](#acl.EACLRecord)
- [EACLRecord.FilterInfo](#acl.EACLRecord.FilterInfo)
- [EACLRecord.TargetInfo](#acl.EACLRecord.TargetInfo)
- [EACLTable](#acl.EACLTable)
- [EACLRecord](#neo.fs.v2.acl.EACLRecord)
- [EACLRecord.FilterInfo](#neo.fs.v2.acl.EACLRecord.FilterInfo)
- [EACLRecord.TargetInfo](#neo.fs.v2.acl.EACLRecord.TargetInfo)
- [EACLTable](#neo.fs.v2.acl.EACLTable)
- [Scalar Value Types](#scalar-value-types)
@ -25,7 +25,7 @@
<!-- end services -->
<a name="acl.EACLRecord"></a>
<a name="neo.fs.v2.acl.EACLRecord"></a>
### Message EACLRecord
EACLRecord groups information about extended ACL rule.
@ -33,13 +33,13 @@ EACLRecord groups information about extended ACL rule.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| operation | [EACLRecord.Operation](#acl.EACLRecord.Operation) | | Operation carries type of operation. |
| action | [EACLRecord.Action](#acl.EACLRecord.Action) | | Action carries ACL target action. |
| filters | [EACLRecord.FilterInfo](#acl.EACLRecord.FilterInfo) | repeated | filters carries set of filters. |
| targets | [EACLRecord.TargetInfo](#acl.EACLRecord.TargetInfo) | repeated | targets carries information about extended ACL target list. |
| operation | [EACLRecord.Operation](#neo.fs.v2.acl.EACLRecord.Operation) | | Operation carries type of operation. |
| action | [EACLRecord.Action](#neo.fs.v2.acl.EACLRecord.Action) | | Action carries ACL target action. |
| filters | [EACLRecord.FilterInfo](#neo.fs.v2.acl.EACLRecord.FilterInfo) | repeated | filters carries set of filters. |
| targets | [EACLRecord.TargetInfo](#neo.fs.v2.acl.EACLRecord.TargetInfo) | repeated | targets carries information about extended ACL target list. |
<a name="acl.EACLRecord.FilterInfo"></a>
<a name="neo.fs.v2.acl.EACLRecord.FilterInfo"></a>
### Message EACLRecord.FilterInfo
FilterInfo groups information about filter.
@ -47,13 +47,13 @@ FilterInfo groups information about filter.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| header | [EACLRecord.FilterInfo.Header](#acl.EACLRecord.FilterInfo.Header) | | Header carries type of header. |
| match_type | [EACLRecord.FilterInfo.MatchType](#acl.EACLRecord.FilterInfo.MatchType) | | MatchType carries type of match. |
| header | [EACLRecord.FilterInfo.Header](#neo.fs.v2.acl.EACLRecord.FilterInfo.Header) | | Header carries type of header. |
| match_type | [EACLRecord.FilterInfo.MatchType](#neo.fs.v2.acl.EACLRecord.FilterInfo.MatchType) | | MatchType carries type of match. |
| header_name | [string](#string) | | header_name carries name of filtering header. |
| header_val | [string](#string) | | header_val carries value of filtering header. |
<a name="acl.EACLRecord.TargetInfo"></a>
<a name="neo.fs.v2.acl.EACLRecord.TargetInfo"></a>
### Message EACLRecord.TargetInfo
TargetInfo groups information about extended ACL target.
@ -61,11 +61,11 @@ TargetInfo groups information about extended ACL target.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| target | [Target](#acl.Target) | | target carries target of ACL rule. |
| target | [Target](#neo.fs.v2.acl.Target) | | target carries target of ACL rule. |
| key_list | [bytes](#bytes) | repeated | key_list carries public keys of ACL target. |
<a name="acl.EACLTable"></a>
<a name="neo.fs.v2.acl.EACLTable"></a>
### Message EACLTable
EACLRecord carries the information about extended ACL rules.
@ -73,77 +73,77 @@ EACLRecord carries the information about extended ACL rules.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| container_id | [refs.ContainerID](#refs.ContainerID) | | Carries identifier of the container that should use given access control rules. |
| records | [EACLRecord](#acl.EACLRecord) | repeated | Records carries list of extended ACL rule records. |
| container_id | [neo.fs.v2.refs.ContainerID](#neo.fs.v2.refs.ContainerID) | | Carries identifier of the container that should use given access control rules. |
| records | [EACLRecord](#neo.fs.v2.acl.EACLRecord) | repeated | Records carries list of extended ACL rule records. |
<!-- end messages -->
<a name="acl.EACLRecord.Action"></a>
<a name="neo.fs.v2.acl.EACLRecord.Action"></a>
### EACLRecord.Action
Action is an enumeration of EACL actions.
| Name | Number | Description |
| ---- | ------ | ----------- |
| ACTION_UNKNOWN | 0 | |
| ALLOW | 1 | |
| DENY | 2 | |
| ACTION_UNSPECIFIED | 0 | Unspecified action, default value. |
| ALLOW | 1 | Allow action |
| DENY | 2 | Deny action |
<a name="acl.EACLRecord.FilterInfo.Header"></a>
<a name="neo.fs.v2.acl.EACLRecord.FilterInfo.Header"></a>
### EACLRecord.FilterInfo.Header
Header is an enumeration of filtering header types.
| Name | Number | Description |
| ---- | ------ | ----------- |
| HEADER_UNKNOWN | 0 | |
| REQUEST | 1 | |
| OBJECT | 2 | |
| HEADER_UNSPECIFIED | 0 | Unspecified header, default value. |
| REQUEST | 1 | Filter request headers |
| OBJECT | 2 | Filter object headers |
<a name="acl.EACLRecord.FilterInfo.MatchType"></a>
<a name="neo.fs.v2.acl.EACLRecord.FilterInfo.MatchType"></a>
### EACLRecord.FilterInfo.MatchType
MatchType is an enumeration of match types.
| Name | Number | Description |
| ---- | ------ | ----------- |
| MATCH_UNKNOWN | 0 | |
| STRING_EQUAL | 1 | |
| STRING_NOT_EQUAL | 2 | |
| MATCH_TYPE_UNSPECIFIED | 0 | Unspecified match type, default value. |
| STRING_EQUAL | 1 | Return true if strings are equal |
| STRING_NOT_EQUAL | 2 | Return true if strings are different |
<a name="acl.EACLRecord.Operation"></a>
<a name="neo.fs.v2.acl.EACLRecord.Operation"></a>
### EACLRecord.Operation
Operation is an enumeration of operation types.
| Name | Number | Description |
| ---- | ------ | ----------- |
| OPERATION_UNKNOWN | 0 | |
| GET | 1 | |
| HEAD | 2 | |
| PUT | 3 | |
| DELETE | 4 | |
| SEARCH | 5 | |
| GETRANGE | 6 | |
| GETRANGEHASH | 7 | |
| OPERATION_UNSPECIFIED | 0 | Unspecified operation, default value. |
| GET | 1 | Get |
| HEAD | 2 | Head |
| PUT | 3 | Put |
| DELETE | 4 | Delete |
| SEARCH | 5 | Search |
| GETRANGE | 6 | GetRange |
| GETRANGEHASH | 7 | GetRangeHash |
<a name="acl.Target"></a>
<a name="neo.fs.v2.acl.Target"></a>
### Target
Target of the access control rule in access control list.
| Name | Number | Description |
| ---- | ------ | ----------- |
| UNKNOWN | 0 | Unknown target, default value. |
| TARGET_UNSPECIFIED | 0 | Unspecified target, default value. |
| USER | 1 | User target rule is applied if sender is the owner of the container. |
| SYSTEM | 2 | System target rule is applied if sender is the storage node within the container or inner ring node. |
| OTHERS | 3 | Others target rule is applied if sender is not user or system target. |

268
proto-docs/container.md
View file

@ -5,40 +5,40 @@
- [container/service.proto](#container/service.proto)
- Services
- [Service](#container.Service)
- [ContainerService](#neo.fs.v2.container.ContainerService)
- Messages
- [DeleteRequest](#container.DeleteRequest)
- [DeleteRequest.Body](#container.DeleteRequest.Body)
- [DeleteResponse](#container.DeleteResponse)
- [DeleteResponse.Body](#container.DeleteResponse.Body)
- [GetExtendedACLRequest](#container.GetExtendedACLRequest)
- [GetExtendedACLRequest.Body](#container.GetExtendedACLRequest.Body)
- [GetExtendedACLResponse](#container.GetExtendedACLResponse)
- [GetExtendedACLResponse.Body](#container.GetExtendedACLResponse.Body)
- [GetRequest](#container.GetRequest)
- [GetRequest.Body](#container.GetRequest.Body)
- [GetResponse](#container.GetResponse)
- [GetResponse.Body](#container.GetResponse.Body)
- [ListRequest](#container.ListRequest)
- [ListRequest.Body](#container.ListRequest.Body)
- [ListResponse](#container.ListResponse)
- [ListResponse.Body](#container.ListResponse.Body)
- [PutRequest](#container.PutRequest)
- [PutRequest.Body](#container.PutRequest.Body)
- [PutResponse](#container.PutResponse)
- [PutResponse.Body](#container.PutResponse.Body)
- [SetExtendedACLRequest](#container.SetExtendedACLRequest)
- [SetExtendedACLRequest.Body](#container.SetExtendedACLRequest.Body)
- [SetExtendedACLResponse](#container.SetExtendedACLResponse)
- [SetExtendedACLResponse.Body](#container.SetExtendedACLResponse.Body)
- [DeleteRequest](#neo.fs.v2.container.DeleteRequest)
- [DeleteRequest.Body](#neo.fs.v2.container.DeleteRequest.Body)
- [DeleteResponse](#neo.fs.v2.container.DeleteResponse)
- [DeleteResponse.Body](#neo.fs.v2.container.DeleteResponse.Body)
- [GetExtendedACLRequest](#neo.fs.v2.container.GetExtendedACLRequest)
- [GetExtendedACLRequest.Body](#neo.fs.v2.container.GetExtendedACLRequest.Body)
- [GetExtendedACLResponse](#neo.fs.v2.container.GetExtendedACLResponse)
- [GetExtendedACLResponse.Body](#neo.fs.v2.container.GetExtendedACLResponse.Body)
- [GetRequest](#neo.fs.v2.container.GetRequest)
- [GetRequest.Body](#neo.fs.v2.container.GetRequest.Body)
- [GetResponse](#neo.fs.v2.container.GetResponse)
- [GetResponse.Body](#neo.fs.v2.container.GetResponse.Body)
- [ListRequest](#neo.fs.v2.container.ListRequest)
- [ListRequest.Body](#neo.fs.v2.container.ListRequest.Body)
- [ListResponse](#neo.fs.v2.container.ListResponse)
- [ListResponse.Body](#neo.fs.v2.container.ListResponse.Body)
- [PutRequest](#neo.fs.v2.container.PutRequest)
- [PutRequest.Body](#neo.fs.v2.container.PutRequest.Body)
- [PutResponse](#neo.fs.v2.container.PutResponse)
- [PutResponse.Body](#neo.fs.v2.container.PutResponse.Body)
- [SetExtendedACLRequest](#neo.fs.v2.container.SetExtendedACLRequest)
- [SetExtendedACLRequest.Body](#neo.fs.v2.container.SetExtendedACLRequest.Body)
- [SetExtendedACLResponse](#neo.fs.v2.container.SetExtendedACLResponse)
- [SetExtendedACLResponse.Body](#neo.fs.v2.container.SetExtendedACLResponse.Body)
- [container/types.proto](#container/types.proto)
- Messages
- [Container](#container.Container)
- [Container.Attribute](#container.Container.Attribute)
- [Container](#neo.fs.v2.container.Container)
- [Container.Attribute](#neo.fs.v2.container.Container.Attribute)
- [Scalar Value Types](#scalar-value-types)
@ -53,10 +53,10 @@
<a name="container.Service"></a>
<a name="neo.fs.v2.container.ContainerService"></a>
### Service "container.Service"
Service provides API to access container smart-contract in morph chain
### Service "neo.fs.v2.container.ContainerService"
ContainerService provides API to access container smart-contract in morph chain
via NeoFS node.
```
@ -78,7 +78,7 @@ added into smart-contract storage.
| Name | Input | Output |
| ---- | ----- | ------ |
| Put | [PutRequest](#container.PutRequest) | [PutResponse](#container.PutResponse) |
| Put | [PutRequest](#neo.fs.v2.container.PutRequest) | [PutResponse](#neo.fs.v2.container.PutResponse) |
#### Method Delete
Delete invokes 'Delete' method in container smart-contract and returns
@ -88,14 +88,14 @@ removed from smart-contract storage.
| Name | Input | Output |
| ---- | ----- | ------ |
| Delete | [DeleteRequest](#container.DeleteRequest) | [DeleteResponse](#container.DeleteResponse) |
| Delete | [DeleteRequest](#neo.fs.v2.container.DeleteRequest) | [DeleteResponse](#neo.fs.v2.container.DeleteResponse) |
#### Method Get
Get returns container from container smart-contract storage.
| Name | Input | Output |
| ---- | ----- | ------ |
| Get | [GetRequest](#container.GetRequest) | [GetResponse](#container.GetResponse) |
| Get | [GetRequest](#neo.fs.v2.container.GetRequest) | [GetResponse](#neo.fs.v2.container.GetResponse) |
#### Method List
List returns all owner's containers from container smart-contract
@ -103,7 +103,7 @@ storage.
| Name | Input | Output |
| ---- | ----- | ------ |
| List | [ListRequest](#container.ListRequest) | [ListResponse](#container.ListResponse) |
| List | [ListRequest](#neo.fs.v2.container.ListRequest) | [ListResponse](#neo.fs.v2.container.ListResponse) |
#### Method SetExtendedACL
SetExtendedACL invokes 'SetEACL' method in container smart-contract and
@ -112,7 +112,7 @@ Extended ACL added into smart-contract storage.
| Name | Input | Output |
| ---- | ----- | ------ |
| SetExtendedACL | [SetExtendedACLRequest](#container.SetExtendedACLRequest) | [SetExtendedACLResponse](#container.SetExtendedACLResponse) |
| SetExtendedACL | [SetExtendedACLRequest](#neo.fs.v2.container.SetExtendedACLRequest) | [SetExtendedACLResponse](#neo.fs.v2.container.SetExtendedACLResponse) |
#### Method GetExtendedACL
GetExtendedACL returns Extended ACL table and signature from container
@ -120,36 +120,36 @@ smart-contract storage.
| Name | Input | Output |
| ---- | ----- | ------ |
| GetExtendedACL | [GetExtendedACLRequest](#container.GetExtendedACLRequest) | [GetExtendedACLResponse](#container.GetExtendedACLResponse) |
| GetExtendedACL | [GetExtendedACLRequest](#neo.fs.v2.container.GetExtendedACLRequest) | [GetExtendedACLResponse](#neo.fs.v2.container.GetExtendedACLResponse) |
<!-- end services -->
<a name="container.DeleteRequest"></a>
<a name="neo.fs.v2.container.DeleteRequest"></a>
### Message DeleteRequest
Container removal request
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| body | [DeleteRequest.Body](#container.DeleteRequest.Body) | | Body of container delete request message. |
| meta_header | [service.RequestMetaHeader](#service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. |
| verify_header | [service.RequestVerificationHeader](#service.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
| body | [DeleteRequest.Body](#neo.fs.v2.container.DeleteRequest.Body) | | Body of container delete request message. |
| meta_header | [neo.fs.v2.service.RequestMetaHeader](#neo.fs.v2.service.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.service.RequestVerificationHeader](#neo.fs.v2.service.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="container.DeleteRequest.Body"></a>
<a name="neo.fs.v2.container.DeleteRequest.Body"></a>
### Message DeleteRequest.Body
Request body
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| container_id | [refs.ContainerID](#refs.ContainerID) | | container_id carries identifier of the container to delete from NeoFS. |
| container_id | [neo.fs.v2.refs.ContainerID](#neo.fs.v2.refs.ContainerID) | | container_id carries identifier of the container to delete from NeoFS. |
| signature | [bytes](#bytes) | | Signature of container id according to RFC-6979. |
<a name="container.DeleteResponse"></a>
<a name="neo.fs.v2.container.DeleteResponse"></a>
### Message DeleteResponse
DeleteResponse is empty because delete operation is asynchronous and done
@ -158,255 +158,255 @@ via consensus in inner ring nodes
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| body | [DeleteResponse.Body](#container.DeleteResponse.Body) | | Body of container delete response message. |
| meta_header | [service.ResponseMetaHeader](#service.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. |
| verify_header | [service.ResponseVerificationHeader](#service.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
| body | [DeleteResponse.Body](#neo.fs.v2.container.DeleteResponse.Body) | | Body of container delete response message. |
| meta_header | [neo.fs.v2.service.ResponseMetaHeader](#neo.fs.v2.service.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.service.ResponseVerificationHeader](#neo.fs.v2.service.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="container.DeleteResponse.Body"></a>
<a name="neo.fs.v2.container.DeleteResponse.Body"></a>
### Message DeleteResponse.Body
Response body
<a name="container.GetExtendedACLRequest"></a>
<a name="neo.fs.v2.container.GetExtendedACLRequest"></a>
### Message GetExtendedACLRequest
Get Extended ACL
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| body | [GetExtendedACLRequest.Body](#container.GetExtendedACLRequest.Body) | | Body of get extended acl request message. |
| meta_header | [service.RequestMetaHeader](#service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. |
| verify_header | [service.RequestVerificationHeader](#service.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
| body | [GetExtendedACLRequest.Body](#neo.fs.v2.container.GetExtendedACLRequest.Body) | | Body of get extended acl request message. |
| meta_header | [neo.fs.v2.service.RequestMetaHeader](#neo.fs.v2.service.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.service.RequestVerificationHeader](#neo.fs.v2.service.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="container.GetExtendedACLRequest.Body"></a>
<a name="neo.fs.v2.container.GetExtendedACLRequest.Body"></a>
### Message GetExtendedACLRequest.Body
Request body
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| container_id | [refs.ContainerID](#refs.ContainerID) | | container_id carries identifier of the container that has Extended ACL. |
| container_id | [neo.fs.v2.refs.ContainerID](#neo.fs.v2.refs.ContainerID) | | container_id carries identifier of the container that has Extended ACL. |
<a name="container.GetExtendedACLResponse"></a>
<a name="neo.fs.v2.container.GetExtendedACLResponse"></a>
### Message GetExtendedACLResponse
Get Extended ACL
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| body | [GetExtendedACLResponse.Body](#container.GetExtendedACLResponse.Body) | | Body of get extended acl response message. |
| meta_header | [service.ResponseMetaHeader](#service.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. |
| verify_header | [service.ResponseVerificationHeader](#service.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
| body | [GetExtendedACLResponse.Body](#neo.fs.v2.container.GetExtendedACLResponse.Body) | | Body of get extended acl response message. |
| meta_header | [neo.fs.v2.service.ResponseMetaHeader](#neo.fs.v2.service.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.service.ResponseVerificationHeader](#neo.fs.v2.service.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="container.GetExtendedACLResponse.Body"></a>
<a name="neo.fs.v2.container.GetExtendedACLResponse.Body"></a>
### Message GetExtendedACLResponse.Body
Response body
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| eacl | [acl.EACLTable](#acl.EACLTable) | | Extended ACL that has been requested if it was set up. |
| eacl | [neo.fs.v2.acl.EACLTable](#neo.fs.v2.acl.EACLTable) | | Extended ACL that has been requested if it was set up. |
| signature | [bytes](#bytes) | | Signature of stable-marshalled Extended ACL according to RFC-6979. |
<a name="container.GetRequest"></a>
<a name="neo.fs.v2.container.GetRequest"></a>
### Message GetRequest
Get container structure
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| body | [GetRequest.Body](#container.GetRequest.Body) | | Body of container get request message. |
| meta_header | [service.RequestMetaHeader](#service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. |
| verify_header | [service.RequestVerificationHeader](#service.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
| body | [GetRequest.Body](#neo.fs.v2.container.GetRequest.Body) | | Body of container get request message. |
| meta_header | [neo.fs.v2.service.RequestMetaHeader](#neo.fs.v2.service.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.service.RequestVerificationHeader](#neo.fs.v2.service.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="container.GetRequest.Body"></a>
<a name="neo.fs.v2.container.GetRequest.Body"></a>
### Message GetRequest.Body
Request body
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| container_id | [refs.ContainerID](#refs.ContainerID) | | container_id carries identifier of the container to get. |
| container_id | [neo.fs.v2.refs.ContainerID](#neo.fs.v2.refs.ContainerID) | | container_id carries identifier of the container to get. |
<a name="container.GetResponse"></a>
<a name="neo.fs.v2.container.GetResponse"></a>
### Message GetResponse
Get container structure
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| body | [GetResponse.Body](#container.GetResponse.Body) | | Body of container get response message. |
| meta_header | [service.ResponseMetaHeader](#service.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. |
| verify_header | [service.ResponseVerificationHeader](#service.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
| body | [GetResponse.Body](#neo.fs.v2.container.GetResponse.Body) | | Body of container get response message. |
| meta_header | [neo.fs.v2.service.ResponseMetaHeader](#neo.fs.v2.service.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.service.ResponseVerificationHeader](#neo.fs.v2.service.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="container.GetResponse.Body"></a>
<a name="neo.fs.v2.container.GetResponse.Body"></a>
### Message GetResponse.Body
Response body
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| container | [Container](#container.Container) | | Container that has been requested. |
| container | [Container](#neo.fs.v2.container.Container) | | Container that has been requested. |
<a name="container.ListRequest"></a>
<a name="neo.fs.v2.container.ListRequest"></a>
### Message ListRequest
List containers
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| body | [ListRequest.Body](#container.ListRequest.Body) | | Body of list containers request message. |
| meta_header | [service.RequestMetaHeader](#service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. |
| verify_header | [service.RequestVerificationHeader](#service.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
| body | [ListRequest.Body](#neo.fs.v2.container.ListRequest.Body) | | Body of list containers request message. |
| meta_header | [neo.fs.v2.service.RequestMetaHeader](#neo.fs.v2.service.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.service.RequestVerificationHeader](#neo.fs.v2.service.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="container.ListRequest.Body"></a>
<a name="neo.fs.v2.container.ListRequest.Body"></a>
### Message ListRequest.Body
Request body
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| owner_id | [refs.OwnerID](#refs.OwnerID) | | owner_id carries identifier of the container owner. |
| owner_id | [neo.fs.v2.refs.OwnerID](#neo.fs.v2.refs.OwnerID) | | owner_id carries identifier of the container owner. |
<a name="container.ListResponse"></a>
<a name="neo.fs.v2.container.ListResponse"></a>
### Message ListResponse
List containers
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| body | [ListResponse.Body](#container.ListResponse.Body) | | Body of list containers response message. |
| meta_header | [service.ResponseMetaHeader](#service.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. |
| verify_header | [service.ResponseVerificationHeader](#service.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
| body | [ListResponse.Body](#neo.fs.v2.container.ListResponse.Body) | | Body of list containers response message. |
| meta_header | [neo.fs.v2.service.ResponseMetaHeader](#neo.fs.v2.service.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.service.ResponseVerificationHeader](#neo.fs.v2.service.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="container.ListResponse.Body"></a>
<a name="neo.fs.v2.container.ListResponse.Body"></a>
### Message ListResponse.Body
Response body
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| container_ids | [refs.ContainerID](#refs.ContainerID) | repeated | ContainerIDs carries list of identifiers of the containers that belong to the owner. |
| container_ids | [neo.fs.v2.refs.ContainerID](#neo.fs.v2.refs.ContainerID) | repeated | ContainerIDs carries list of identifiers of the containers that belong to the owner. |
<a name="container.PutRequest"></a>
<a name="neo.fs.v2.container.PutRequest"></a>
### Message PutRequest
New NeoFS Container creation request
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| body | [PutRequest.Body](#container.PutRequest.Body) | | Body of container put request message. |
| meta_header | [service.RequestMetaHeader](#service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. |
| verify_header | [service.RequestVerificationHeader](#service.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
| body | [PutRequest.Body](#neo.fs.v2.container.PutRequest.Body) | | Body of container put request message. |
| meta_header | [neo.fs.v2.service.RequestMetaHeader](#neo.fs.v2.service.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.service.RequestVerificationHeader](#neo.fs.v2.service.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="container.PutRequest.Body"></a>
<a name="neo.fs.v2.container.PutRequest.Body"></a>
### Message PutRequest.Body
Request body
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| container | [Container](#container.Container) | | Container to create in NeoFS. |
| container | [Container](#neo.fs.v2.container.Container) | | Container to create in NeoFS. |
| public_key | [bytes](#bytes) | | Public Key of container owner. It can be public key of the owner or it can be public key that bound in neofs.id smart-contract. |
| signature | [bytes](#bytes) | | Signature of stable-marshalled container according to RFC-6979. |
<a name="container.PutResponse"></a>
<a name="neo.fs.v2.container.PutResponse"></a>
### Message PutResponse
New NeoFS Container creation response
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| body | [PutResponse.Body](#container.PutResponse.Body) | | Body of container put response message. |
| meta_header | [service.ResponseMetaHeader](#service.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. |
| verify_header | [service.ResponseVerificationHeader](#service.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
| body | [PutResponse.Body](#neo.fs.v2.container.PutResponse.Body) | | Body of container put response message. |
| meta_header | [neo.fs.v2.service.ResponseMetaHeader](#neo.fs.v2.service.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.service.ResponseVerificationHeader](#neo.fs.v2.service.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="container.PutResponse.Body"></a>
<a name="neo.fs.v2.container.PutResponse.Body"></a>
### Message PutResponse.Body
Response body
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| container_id | [refs.ContainerID](#refs.ContainerID) | | container_id carries identifier of the new container. |
| container_id | [neo.fs.v2.refs.ContainerID](#neo.fs.v2.refs.ContainerID) | | container_id carries identifier of the new container. |
<a name="container.SetExtendedACLRequest"></a>
<a name="neo.fs.v2.container.SetExtendedACLRequest"></a>
### Message SetExtendedACLRequest
Set Extended ACL
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| body | [SetExtendedACLRequest.Body](#container.SetExtendedACLRequest.Body) | | Body of set extended acl request message. |
| meta_header | [service.RequestMetaHeader](#service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. |
| verify_header | [service.RequestVerificationHeader](#service.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
| body | [SetExtendedACLRequest.Body](#neo.fs.v2.container.SetExtendedACLRequest.Body) | | Body of set extended acl request message. |
| meta_header | [neo.fs.v2.service.RequestMetaHeader](#neo.fs.v2.service.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.service.RequestVerificationHeader](#neo.fs.v2.service.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="container.SetExtendedACLRequest.Body"></a>
<a name="neo.fs.v2.container.SetExtendedACLRequest.Body"></a>
### Message SetExtendedACLRequest.Body
Request body
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| eacl | [acl.EACLTable](#acl.EACLTable) | | Extended ACL to set for the container. |
| eacl | [neo.fs.v2.acl.EACLTable](#neo.fs.v2.acl.EACLTable) | | Extended ACL to set for the container. |
| signature | [bytes](#bytes) | | Signature of stable-marshalled Extended ACL according to RFC-6979. |
<a name="container.SetExtendedACLResponse"></a>
<a name="neo.fs.v2.container.SetExtendedACLResponse"></a>
### Message SetExtendedACLResponse
Set Extended ACL
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| body | [SetExtendedACLResponse.Body](#container.SetExtendedACLResponse.Body) | | Body of set extended acl response message. |
| meta_header | [service.ResponseMetaHeader](#service.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. |
| verify_header | [service.ResponseVerificationHeader](#service.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
| body | [SetExtendedACLResponse.Body](#neo.fs.v2.container.SetExtendedACLResponse.Body) | | Body of set extended acl response message. |
| meta_header | [neo.fs.v2.service.ResponseMetaHeader](#neo.fs.v2.service.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.service.ResponseVerificationHeader](#neo.fs.v2.service.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="container.SetExtendedACLResponse.Body"></a>
<a name="neo.fs.v2.container.SetExtendedACLResponse.Body"></a>
### Message SetExtendedACLResponse.Body
Response body
<!-- end messages -->
@ -424,7 +424,7 @@ via consensus in inner ring nodes
<!-- end services -->
<a name="container.Container"></a>
<a name="neo.fs.v2.container.Container"></a>
### Message Container
Container is a structure that defines object placement behaviour. Objects
@ -435,14 +435,14 @@ SHA256 hash of stable-marshalled container message.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| owner_id | [refs.OwnerID](#refs.OwnerID) | | OwnerID carries identifier of the container owner. |
| owner_id | [neo.fs.v2.refs.OwnerID](#neo.fs.v2.refs.OwnerID) | | OwnerID carries identifier of the container owner. |
| nonce | [bytes](#bytes) | | Nonce is a 16 byte UUID, used to avoid collisions of container id. |
| basic_acl | [uint32](#uint32) | | BasicACL contains access control rules for owner, system, others groups and permission bits for bearer token and Extended ACL. |
| attributes | [Container.Attribute](#container.Container.Attribute) | repeated | Attributes define any immutable characteristics of container. |
| rules | [netmap.PlacementRule](#netmap.PlacementRule) | | Rules define storage policy for the object inside the container. |
| attributes | [Container.Attribute](#neo.fs.v2.container.Container.Attribute) | repeated | Attributes define any immutable characteristics of container. |
| placement_policy | [neo.fs.v2.netmap.PlacementPolicy](#neo.fs.v2.netmap.PlacementPolicy) | | Placement policy for the object inside the container. |
<a name="container.Container.Attribute"></a>
<a name="neo.fs.v2.container.Container.Attribute"></a>
### Message Container.Attribute
Attribute is a key-value pair of strings.

126
proto-docs/netmap.md
View file

@ -6,14 +6,14 @@
- [netmap/types.proto](#netmap/types.proto)
- Messages
- [NodeInfo](#netmap.NodeInfo)
- [NodeInfo.Attribute](#netmap.NodeInfo.Attribute)
- [PlacementRule](#netmap.PlacementRule)
- [PlacementRule.SFGroup](#netmap.PlacementRule.SFGroup)
- [PlacementRule.SFGroup.Filter](#netmap.PlacementRule.SFGroup.Filter)
- [PlacementRule.SFGroup.Filter.SimpleFilter](#netmap.PlacementRule.SFGroup.Filter.SimpleFilter)
- [PlacementRule.SFGroup.Filter.SimpleFilters](#netmap.PlacementRule.SFGroup.Filter.SimpleFilters)
- [PlacementRule.SFGroup.Selector](#netmap.PlacementRule.SFGroup.Selector)
- [NodeInfo](#neo.fs.v2.netmap.NodeInfo)
- [NodeInfo.Attribute](#neo.fs.v2.netmap.NodeInfo.Attribute)
- [PlacementPolicy](#neo.fs.v2.netmap.PlacementPolicy)
- [PlacementPolicy.FilterGroup](#neo.fs.v2.netmap.PlacementPolicy.FilterGroup)
- [PlacementPolicy.FilterGroup.Filter](#neo.fs.v2.netmap.PlacementPolicy.FilterGroup.Filter)
- [PlacementPolicy.FilterGroup.Filter.SimpleFilter](#neo.fs.v2.netmap.PlacementPolicy.FilterGroup.Filter.SimpleFilter)
- [PlacementPolicy.FilterGroup.Filter.SimpleFilter.SimpleFilters](#neo.fs.v2.netmap.PlacementPolicy.FilterGroup.Filter.SimpleFilter.SimpleFilters)
- [PlacementPolicy.FilterGroup.Selector](#neo.fs.v2.netmap.PlacementPolicy.FilterGroup.Selector)
- [Scalar Value Types](#scalar-value-types)
@ -29,136 +29,136 @@
<!-- end services -->
<a name="netmap.NodeInfo"></a>
<a name="neo.fs.v2.netmap.NodeInfo"></a>
### Message NodeInfo
Groups the information about the NeoFS node.
NeoFS node description
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| address | [string](#string) | | Carries network address of the NeoFS node. |
| public_key | [bytes](#bytes) | | Carries public key of the NeoFS node in a binary format. |
| attributes | [NodeInfo.Attribute](#netmap.NodeInfo.Attribute) | repeated | Carries list of the NeoFS node attributes in a string key-value format. |
| state | [NodeInfo.State](#netmap.NodeInfo.State) | | Carries state of the NeoFS node. |
| address | [string](#string) | | Ways to connect to a node |
| public_key | [bytes](#bytes) | | Public key of the NeoFS node in a binary format. |
| attributes | [NodeInfo.Attribute](#neo.fs.v2.netmap.NodeInfo.Attribute) | repeated | Carries list of the NeoFS node attributes in a string key-value format. |
| state | [NodeInfo.State](#neo.fs.v2.netmap.NodeInfo.State) | | Carries state of the NeoFS node. |
<a name="netmap.NodeInfo.Attribute"></a>
<a name="neo.fs.v2.netmap.NodeInfo.Attribute"></a>
### Message NodeInfo.Attribute
Groups attributes of the NeoFS node.
Attributes of the NeoFS node.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| key | [string](#string) | | Carries string key to the node attribute. |
| value | [string](#string) | | Carries string value of the node attribute. |
| key | [string](#string) | | Key of the node attribute. |
| value | [string](#string) | | Value of the node attribute. |
<a name="netmap.PlacementRule"></a>
### Message PlacementRule
<a name="neo.fs.v2.netmap.PlacementPolicy"></a>
### Message PlacementPolicy
Set of rules to select a subset of nodes able to store container's objects
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| repl_factor | [uint32](#uint32) | | |
| sf_groups | [PlacementRule.SFGroup](#netmap.PlacementRule.SFGroup) | repeated | |
| repl_factor | [uint32](#uint32) | | Replication factor |
| filter_groups | [PlacementPolicy.FilterGroup](#neo.fs.v2.netmap.PlacementPolicy.FilterGroup) | repeated | List of filter groups |
<a name="netmap.PlacementRule.SFGroup"></a>
### Message PlacementRule.SFGroup
<a name="neo.fs.v2.netmap.PlacementPolicy.FilterGroup"></a>
### Message PlacementPolicy.FilterGroup
Filters to apply to Network Map
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| filters | [PlacementRule.SFGroup.Filter](#netmap.PlacementRule.SFGroup.Filter) | repeated | |
| selectors | [PlacementRule.SFGroup.Selector](#netmap.PlacementRule.SFGroup.Selector) | repeated | |
| exclude | [uint32](#uint32) | repeated | |
| filters | [PlacementPolicy.FilterGroup.Filter](#neo.fs.v2.netmap.PlacementPolicy.FilterGroup.Filter) | repeated | Resulting filter list |
| selectors | [PlacementPolicy.FilterGroup.Selector](#neo.fs.v2.netmap.PlacementPolicy.FilterGroup.Selector) | repeated | List of selectors |
| exclude | [uint32](#uint32) | repeated | Parts of graph to exclude. Internal use. |
<a name="netmap.PlacementRule.SFGroup.Filter"></a>
### Message PlacementRule.SFGroup.Filter
<a name="neo.fs.v2.netmap.PlacementPolicy.FilterGroup.Filter"></a>
### Message PlacementPolicy.FilterGroup.Filter
Filter definition
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| key | [string](#string) | | |
| f | [PlacementRule.SFGroup.Filter.SimpleFilter](#netmap.PlacementRule.SFGroup.Filter.SimpleFilter) | | |
| key | [string](#string) | | Filter identifier |
| f | [PlacementPolicy.FilterGroup.Filter.SimpleFilter](#neo.fs.v2.netmap.PlacementPolicy.FilterGroup.Filter.SimpleFilter) | | The rest of filter |
<a name="netmap.PlacementRule.SFGroup.Filter.SimpleFilter"></a>
### Message PlacementRule.SFGroup.Filter.SimpleFilter
<a name="neo.fs.v2.netmap.PlacementPolicy.FilterGroup.Filter.SimpleFilter"></a>
### Message PlacementPolicy.FilterGroup.Filter.SimpleFilter
Minimal simple filter
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| op | [PlacementRule.SFGroup.Filter.SimpleFilter.Operation](#netmap.PlacementRule.SFGroup.Filter.SimpleFilter.Operation) | | |
| value | [string](#string) | | |
| f_args | [PlacementRule.SFGroup.Filter.SimpleFilters](#netmap.PlacementRule.SFGroup.Filter.SimpleFilters) | | |
| op | [PlacementPolicy.FilterGroup.Filter.SimpleFilter.Operation](#neo.fs.v2.netmap.PlacementPolicy.FilterGroup.Filter.SimpleFilter.Operation) | | Filtering operation |
| value | [string](#string) | | Value |
| f_args | [PlacementPolicy.FilterGroup.Filter.SimpleFilter.SimpleFilters](#neo.fs.v2.netmap.PlacementPolicy.FilterGroup.Filter.SimpleFilter.SimpleFilters) | | Result of other filter application |
<a name="netmap.PlacementRule.SFGroup.Filter.SimpleFilters"></a>
### Message PlacementRule.SFGroup.Filter.SimpleFilters
<a name="neo.fs.v2.netmap.PlacementPolicy.FilterGroup.Filter.SimpleFilter.SimpleFilters"></a>
### Message PlacementPolicy.FilterGroup.Filter.SimpleFilter.SimpleFilters
List of filters
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| filters | [PlacementRule.SFGroup.Filter.SimpleFilter](#netmap.PlacementRule.SFGroup.Filter.SimpleFilter) | repeated | |
| filters | [PlacementPolicy.FilterGroup.Filter.SimpleFilter](#neo.fs.v2.netmap.PlacementPolicy.FilterGroup.Filter.SimpleFilter) | repeated | List of filters |
<a name="netmap.PlacementRule.SFGroup.Selector"></a>
### Message PlacementRule.SFGroup.Selector
<a name="neo.fs.v2.netmap.PlacementPolicy.FilterGroup.Selector"></a>
### Message PlacementPolicy.FilterGroup.Selector
Selector
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| count | [uint32](#uint32) | | |
| key | [string](#string) | | |
| count | [uint32](#uint32) | | How many to select |
| key | [string](#string) | | Key to select |
<!-- end messages -->
<a name="netmap.NodeInfo.State"></a>
<a name="neo.fs.v2.netmap.NodeInfo.State"></a>
### NodeInfo.State
Represents the enumeration of various states of the NeoFS node.
| Name | Number | Description |
| ---- | ------ | ----------- |
| UNKNOWN | 0 | Undefined state. |
| UNSPECIFIED | 0 | Unknown state. |
| ONLINE | 1 | Active state in the network. |
| OFFLINE | 2 | Network unavailable state. |
<a name="netmap.PlacementRule.SFGroup.Filter.SimpleFilter.Operation"></a>
### PlacementRule.SFGroup.Filter.SimpleFilter.Operation
<a name="neo.fs.v2.netmap.PlacementPolicy.FilterGroup.Filter.SimpleFilter.Operation"></a>
### PlacementPolicy.FilterGroup.Filter.SimpleFilter.Operation
Filtering operation
| Name | Number | Description |
| ---- | ------ | ----------- |
| NP | 0 | |
| EQ | 1 | |
| NE | 2 | |
| GT | 3 | |
| GE | 4 | |
| LT | 5 | |
| LE | 6 | |
| OR | 7 | |
| AND | 8 | |
| OPERATION_UNSPECIFIED | 0 | No Operation defined |
| EQ | 1 | Equal |
| NE | 2 | Not Equal |
| GT | 3 | Greater then |
| GE | 4 | Greater or equal |
| LT | 5 | Less then |
| LE | 6 | Less or equal |
| OR | 7 | Logical OR |
| AND | 8 | Logical AND |
<!-- end enums -->

426
proto-docs/object.md
View file

@ -5,52 +5,51 @@
- [object/service.proto](#object/service.proto)
- Services
- [Service](#object.Service)
- [ObjectService](#neo.fs.v2.object.ObjectService)
- Messages
- [DeleteRequest](#object.DeleteRequest)
- [DeleteRequest.Body](#object.DeleteRequest.Body)
- [DeleteResponse](#object.DeleteResponse)
- [DeleteResponse.Body](#object.DeleteResponse.Body)
- [GetRangeHashRequest](#object.GetRangeHashRequest)
- [GetRangeHashRequest.Body](#object.GetRangeHashRequest.Body)
- [GetRangeHashResponse](#object.GetRangeHashResponse)
- [GetRangeHashResponse.Body](#object.GetRangeHashResponse.Body)
- [GetRangeRequest](#object.GetRangeRequest)
- [GetRangeRequest.Body](#object.GetRangeRequest.Body)
- [GetRangeResponse](#object.GetRangeResponse)
- [GetRangeResponse.Body](#object.GetRangeResponse.Body)
- [GetRequest](#object.GetRequest)
- [GetRequest.Body](#object.GetRequest.Body)
- [GetResponse](#object.GetResponse)
- [GetResponse.Body](#object.GetResponse.Body)
- [GetResponse.Body.Init](#object.GetResponse.Body.Init)
- [HeadRequest](#object.HeadRequest)
- [HeadRequest.Body](#object.HeadRequest.Body)
- [HeadResponse](#object.HeadResponse)
- [HeadResponse.Body](#object.HeadResponse.Body)
- [HeadResponse.Body.ShortHeader](#object.HeadResponse.Body.ShortHeader)
- [PutRequest](#object.PutRequest)
- [PutRequest.Body](#object.PutRequest.Body)
- [PutRequest.Body.Init](#object.PutRequest.Body.Init)
- [PutResponse](#object.PutResponse)
- [PutResponse.Body](#object.PutResponse.Body)
- [Range](#object.Range)
- [SearchRequest](#object.SearchRequest)
- [SearchRequest.Body](#object.SearchRequest.Body)
- [SearchRequest.Body.Query](#object.SearchRequest.Body.Query)
- [SearchRequest.Body.Query.Filter](#object.SearchRequest.Body.Query.Filter)
- [SearchResponse](#object.SearchResponse)
- [SearchResponse.Body](#object.SearchResponse.Body)
- [DeleteRequest](#neo.fs.v2.object.DeleteRequest)
- [DeleteRequest.Body](#neo.fs.v2.object.DeleteRequest.Body)
- [DeleteResponse](#neo.fs.v2.object.DeleteResponse)
- [DeleteResponse.Body](#neo.fs.v2.object.DeleteResponse.Body)
- [GetRangeHashRequest](#neo.fs.v2.object.GetRangeHashRequest)
- [GetRangeHashRequest.Body](#neo.fs.v2.object.GetRangeHashRequest.Body)
- [GetRangeHashResponse](#neo.fs.v2.object.GetRangeHashResponse)
- [GetRangeHashResponse.Body](#neo.fs.v2.object.GetRangeHashResponse.Body)
- [GetRangeRequest](#neo.fs.v2.object.GetRangeRequest)
- [GetRangeRequest.Body](#neo.fs.v2.object.GetRangeRequest.Body)
- [GetRangeResponse](#neo.fs.v2.object.GetRangeResponse)
- [GetRangeResponse.Body](#neo.fs.v2.object.GetRangeResponse.Body)
- [GetRequest](#neo.fs.v2.object.GetRequest)
- [GetRequest.Body](#neo.fs.v2.object.GetRequest.Body)
- [GetResponse](#neo.fs.v2.object.GetResponse)
- [GetResponse.Body](#neo.fs.v2.object.GetResponse.Body)
- [GetResponse.Body.Init](#neo.fs.v2.object.GetResponse.Body.Init)
- [HeadRequest](#neo.fs.v2.object.HeadRequest)
- [HeadRequest.Body](#neo.fs.v2.object.HeadRequest.Body)
- [HeadResponse](#neo.fs.v2.object.HeadResponse)
- [HeadResponse.Body](#neo.fs.v2.object.HeadResponse.Body)
- [HeadResponse.Body.ShortHeader](#neo.fs.v2.object.HeadResponse.Body.ShortHeader)
- [PutRequest](#neo.fs.v2.object.PutRequest)
- [PutRequest.Body](#neo.fs.v2.object.PutRequest.Body)
- [PutRequest.Body.Init](#neo.fs.v2.object.PutRequest.Body.Init)
- [PutResponse](#neo.fs.v2.object.PutResponse)
- [PutResponse.Body](#neo.fs.v2.object.PutResponse.Body)
- [Range](#neo.fs.v2.object.Range)
- [SearchRequest](#neo.fs.v2.object.SearchRequest)
- [SearchRequest.Body](#neo.fs.v2.object.SearchRequest.Body)
- [SearchRequest.Body.Filter](#neo.fs.v2.object.SearchRequest.Body.Filter)
- [SearchResponse](#neo.fs.v2.object.SearchResponse)
- [SearchResponse.Body](#neo.fs.v2.object.SearchResponse.Body)
- [object/types.proto](#object/types.proto)
- Messages
- [Header](#object.Header)
- [Header.Attribute](#object.Header.Attribute)
- [Header.Split](#object.Header.Split)
- [Object](#object.Object)
- [Header](#neo.fs.v2.object.Header)
- [Header.Attribute](#neo.fs.v2.object.Header.Attribute)
- [Header.Split](#neo.fs.v2.object.Header.Split)
- [Object](#neo.fs.v2.object.Object)
- [Scalar Value Types](#scalar-value-types)
@ -65,9 +64,9 @@
<a name="object.Service"></a>
<a name="neo.fs.v2.object.ObjectService"></a>
### Service "object.Service"
### Service "neo.fs.v2.object.ObjectService"
Object service provides API for manipulating with the object.
```
@ -91,7 +90,7 @@ message payload and all chunks keeping receiving order.
| Name | Input | Output |
| ---- | ----- | ------ |
| Get | [GetRequest](#object.GetRequest) | [GetResponse](#object.GetResponse) |
| Get | [GetRequest](#neo.fs.v2.object.GetRequest) | [GetResponse](#neo.fs.v2.object.GetResponse) |
#### Method Put
Put the object into container. Request uses gRPC stream. First message
@ -103,14 +102,14 @@ SHOULD BE sent in direct order of fragmentation.
| Name | Input | Output |
| ---- | ----- | ------ |
| Put | [PutRequest](#object.PutRequest) | [PutResponse](#object.PutResponse) |
| Put | [PutRequest](#neo.fs.v2.object.PutRequest) | [PutResponse](#neo.fs.v2.object.PutResponse) |
#### Method Delete
Delete the object from a container
| Name | Input | Output |
| ---- | ----- | ------ |
| Delete | [DeleteRequest](#object.DeleteRequest) | [DeleteResponse](#object.DeleteResponse) |
| Delete | [DeleteRequest](#neo.fs.v2.object.DeleteRequest) | [DeleteResponse](#neo.fs.v2.object.DeleteResponse) |
#### Method Head
Head returns the object without data payload. Object in the
@ -119,7 +118,7 @@ headers are also present.
| Name | Input | Output |
| ---- | ----- | ------ |
| Head | [HeadRequest](#object.HeadRequest) | [HeadResponse](#object.HeadResponse) |
| Head | [HeadRequest](#neo.fs.v2.object.HeadRequest) | [HeadResponse](#neo.fs.v2.object.HeadResponse) |
#### Method Search
Search objects in container. Version of query language format SHOULD BE
@ -128,7 +127,7 @@ package).
| Name | Input | Output |
| ---- | ----- | ------ |
| Search | [SearchRequest](#object.SearchRequest) | [SearchResponse](#object.SearchResponse) |
| Search | [SearchRequest](#neo.fs.v2.object.SearchRequest) | [SearchResponse](#neo.fs.v2.object.SearchResponse) |
#### Method GetRange
GetRange of data payload. Range is a pair (offset, length).
@ -137,7 +136,7 @@ keeping receiving order.
| Name | Input | Output |
| ---- | ----- | ------ |
| GetRange | [GetRangeRequest](#object.GetRangeRequest) | [GetRangeResponse](#object.GetRangeResponse) |
| GetRange | [GetRangeRequest](#neo.fs.v2.object.GetRangeRequest) | [GetRangeResponse](#neo.fs.v2.object.GetRangeResponse) |
#### Method GetRangeHash
GetRangeHash returns homomorphic hash of object payload range after XOR
@ -147,36 +146,36 @@ calculated for XORed data.
| Name | Input | Output |
| ---- | ----- | ------ |
| GetRangeHash | [GetRangeHashRequest](#object.GetRangeHashRequest) | [GetRangeHashResponse](#object.GetRangeHashResponse) |
| GetRangeHash | [GetRangeHashRequest](#neo.fs.v2.object.GetRangeHashRequest) | [GetRangeHashResponse](#neo.fs.v2.object.GetRangeHashResponse) |
<!-- end services -->
<a name="object.DeleteRequest"></a>
<a name="neo.fs.v2.object.DeleteRequest"></a>
### Message DeleteRequest
Object Delete request
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| body | [DeleteRequest.Body](#object.DeleteRequest.Body) | | Body of delete object request message. |
| meta_header | [service.RequestMetaHeader](#service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. |
| verify_header | [service.RequestVerificationHeader](#service.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
| body | [DeleteRequest.Body](#neo.fs.v2.object.DeleteRequest.Body) | | Body of delete object request message. |
| meta_header | [neo.fs.v2.service.RequestMetaHeader](#neo.fs.v2.service.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.service.RequestVerificationHeader](#neo.fs.v2.service.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="object.DeleteRequest.Body"></a>
<a name="neo.fs.v2.object.DeleteRequest.Body"></a>
### Message DeleteRequest.Body
Request body
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| address | [refs.Address](#refs.Address) | | Carries the address of the object to be deleted. |
| owner_id | [refs.OwnerID](#refs.OwnerID) | | Carries identifier the object owner. |
| address | [neo.fs.v2.refs.Address](#neo.fs.v2.refs.Address) | | Carries the address of the object to be deleted. |
| owner_id | [neo.fs.v2.refs.OwnerID](#neo.fs.v2.refs.OwnerID) | | Carries identifier the object owner. |
<a name="object.DeleteResponse"></a>
<a name="neo.fs.v2.object.DeleteResponse"></a>
### Message DeleteResponse
DeleteResponse is empty because we cannot guarantee permanent object removal
@ -185,61 +184,61 @@ in distributed system.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| body | [DeleteResponse.Body](#object.DeleteResponse.Body) | | Body of delete object response message. |
| meta_header | [service.ResponseMetaHeader](#service.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. |
| verify_header | [service.ResponseVerificationHeader](#service.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
| body | [DeleteResponse.Body](#neo.fs.v2.object.DeleteResponse.Body) | | Body of delete object response message. |
| meta_header | [neo.fs.v2.service.ResponseMetaHeader](#neo.fs.v2.service.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.service.ResponseVerificationHeader](#neo.fs.v2.service.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="object.DeleteResponse.Body"></a>
<a name="neo.fs.v2.object.DeleteResponse.Body"></a>
### Message DeleteResponse.Body
Response body
<a name="object.GetRangeHashRequest"></a>
<a name="neo.fs.v2.object.GetRangeHashRequest"></a>
### Message GetRangeHashRequest
Get hash of object's payload part
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| body | [GetRangeHashRequest.Body](#object.GetRangeHashRequest.Body) | | Body of get range hash object request message. |
| meta_header | [service.RequestMetaHeader](#service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. |
| verify_header | [service.RequestVerificationHeader](#service.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
| body | [GetRangeHashRequest.Body](#neo.fs.v2.object.GetRangeHashRequest.Body) | | Body of get range hash object request message. |
| meta_header | [neo.fs.v2.service.RequestMetaHeader](#neo.fs.v2.service.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.service.RequestVerificationHeader](#neo.fs.v2.service.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="object.GetRangeHashRequest.Body"></a>
<a name="neo.fs.v2.object.GetRangeHashRequest.Body"></a>
### Message GetRangeHashRequest.Body
Request body
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| address | [refs.Address](#refs.Address) | | Carries address of the object that contains the requested payload range. |
| ranges | [Range](#object.Range) | repeated | Carries the list of object payload range to calculate homomorphic hash. |
| address | [neo.fs.v2.refs.Address](#neo.fs.v2.refs.Address) | | Carries address of the object that contains the requested payload range. |
| ranges | [Range](#neo.fs.v2.object.Range) | repeated | Carries the list of object payload range to calculate homomorphic hash. |
| salt | [bytes](#bytes) | | Carries binary salt to XOR object payload ranges before hash calculation. |
<a name="object.GetRangeHashResponse"></a>
<a name="neo.fs.v2.object.GetRangeHashResponse"></a>
### Message GetRangeHashResponse
Get hash of object's payload part
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| body | [GetRangeHashResponse.Body](#object.GetRangeHashResponse.Body) | | Body of get range hash object response message. |
| meta_header | [service.ResponseMetaHeader](#service.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. |
| verify_header | [service.ResponseVerificationHeader](#service.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
| body | [GetRangeHashResponse.Body](#neo.fs.v2.object.GetRangeHashResponse.Body) | | Body of get range hash object response message. |
| meta_header | [neo.fs.v2.service.ResponseMetaHeader](#neo.fs.v2.service.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.service.ResponseVerificationHeader](#neo.fs.v2.service.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="object.GetRangeHashResponse.Body"></a>
<a name="neo.fs.v2.object.GetRangeHashResponse.Body"></a>
### Message GetRangeHashResponse.Body
Response body
| Field | Type | Label | Description |
@ -247,48 +246,48 @@ in distributed system.
| hash_list | [bytes](#bytes) | repeated | Carries list of homomorphic hashes in a binary format. |
<a name="object.GetRangeRequest"></a>
<a name="neo.fs.v2.object.GetRangeRequest"></a>
### Message GetRangeRequest
Request to get part of object's payload
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| body | [GetRangeRequest.Body](#object.GetRangeRequest.Body) | | Body of get range object request message. |
| meta_header | [service.RequestMetaHeader](#service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. |
| verify_header | [service.RequestVerificationHeader](#service.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
| body | [GetRangeRequest.Body](#neo.fs.v2.object.GetRangeRequest.Body) | | Body of get range object request message. |
| meta_header | [neo.fs.v2.service.RequestMetaHeader](#neo.fs.v2.service.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.service.RequestVerificationHeader](#neo.fs.v2.service.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="object.GetRangeRequest.Body"></a>
<a name="neo.fs.v2.object.GetRangeRequest.Body"></a>
### Message GetRangeRequest.Body
Request Body
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| address | [refs.Address](#refs.Address) | | Address carries address of the object that contains the requested payload range. |
| range | [Range](#object.Range) | | Range carries the parameters of the requested payload range. |
| address | [neo.fs.v2.refs.Address](#neo.fs.v2.refs.Address) | | Address carries address of the object that contains the requested payload range. |
| range | [Range](#neo.fs.v2.object.Range) | | Range carries the parameters of the requested payload range. |
<a name="object.GetRangeResponse"></a>
<a name="neo.fs.v2.object.GetRangeResponse"></a>
### Message GetRangeResponse
Get part of object's payload
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| body | [GetRangeResponse.Body](#object.GetRangeResponse.Body) | | Body of get range object response message. |
| meta_header | [service.ResponseMetaHeader](#service.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. |
| verify_header | [service.ResponseVerificationHeader](#service.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
| body | [GetRangeResponse.Body](#neo.fs.v2.object.GetRangeResponse.Body) | | Body of get range object response message. |
| meta_header | [neo.fs.v2.service.ResponseMetaHeader](#neo.fs.v2.service.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.service.ResponseVerificationHeader](#neo.fs.v2.service.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="object.GetRangeResponse.Body"></a>
<a name="neo.fs.v2.object.GetRangeResponse.Body"></a>
### Message GetRangeResponse.Body
Response body
| Field | Type | Label | Description |
@ -296,57 +295,57 @@ in distributed system.
| chunk | [bytes](#bytes) | | Carries part of the object payload. |
<a name="object.GetRequest"></a>
<a name="neo.fs.v2.object.GetRequest"></a>
### Message GetRequest
Get object request
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| body | [GetRequest.Body](#object.GetRequest.Body) | | Body of get object request message. |
| meta_header | [service.RequestMetaHeader](#service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. |
| verify_header | [service.RequestVerificationHeader](#service.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
| body | [GetRequest.Body](#neo.fs.v2.object.GetRequest.Body) | | Body of get object request message. |
| meta_header | [neo.fs.v2.service.RequestMetaHeader](#neo.fs.v2.service.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.service.RequestVerificationHeader](#neo.fs.v2.service.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="object.GetRequest.Body"></a>
<a name="neo.fs.v2.object.GetRequest.Body"></a>
### Message GetRequest.Body
Request body
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| address | [refs.Address](#refs.Address) | | Address of the requested object. |
| address | [neo.fs.v2.refs.Address](#neo.fs.v2.refs.Address) | | Address of the requested object. |
| raw | [bool](#bool) | | Carries the raw option flag of the request. Raw request is sent to receive only the objects that are physically stored on the server. |
<a name="object.GetResponse"></a>
<a name="neo.fs.v2.object.GetResponse"></a>
### Message GetResponse
get object response
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| body | [GetResponse.Body](#object.GetResponse.Body) | | Body of get object response message. |
| meta_header | [service.ResponseMetaHeader](#service.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. |
| verify_header | [service.ResponseVerificationHeader](#service.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
| body | [GetResponse.Body](#neo.fs.v2.object.GetResponse.Body) | | Body of get object response message. |
| meta_header | [neo.fs.v2.service.ResponseMetaHeader](#neo.fs.v2.service.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.service.ResponseVerificationHeader](#neo.fs.v2.service.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="object.GetResponse.Body"></a>
<a name="neo.fs.v2.object.GetResponse.Body"></a>
### Message GetResponse.Body
Response body
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| init | [GetResponse.Body.Init](#object.GetResponse.Body.Init) | | Initialization parameters of the object stream. |
| init | [GetResponse.Body.Init](#neo.fs.v2.object.GetResponse.Body.Init) | | Initialization parameters of the object stream. |
| chunk | [bytes](#bytes) | | Part of the object payload. |
<a name="object.GetResponse.Body.Init"></a>
<a name="neo.fs.v2.object.GetResponse.Body.Init"></a>
### Message GetResponse.Body.Init
Initialization parameters of the object got from NeoFS.
@ -354,103 +353,103 @@ Initialization parameters of the object got from NeoFS.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| object_id | [refs.ObjectID](#refs.ObjectID) | | Object ID |
| signature | [service.Signature](#service.Signature) | | Object signature |
| header | [Header](#object.Header) | | Object header. |
| object_id | [neo.fs.v2.refs.ObjectID](#neo.fs.v2.refs.ObjectID) | | Object ID |
| signature | [neo.fs.v2.service.Signature](#neo.fs.v2.service.Signature) | | Object signature |
| header | [Header](#neo.fs.v2.object.Header) | | Object header. |
<a name="object.HeadRequest"></a>
<a name="neo.fs.v2.object.HeadRequest"></a>
### Message HeadRequest
Object head request
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| body | [HeadRequest.Body](#object.HeadRequest.Body) | | Body of head object request message. |
| meta_header | [service.RequestMetaHeader](#service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. |
| verify_header | [service.RequestVerificationHeader](#service.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
| body | [HeadRequest.Body](#neo.fs.v2.object.HeadRequest.Body) | | Body of head object request message. |
| meta_header | [neo.fs.v2.service.RequestMetaHeader](#neo.fs.v2.service.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.service.RequestVerificationHeader](#neo.fs.v2.service.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="object.HeadRequest.Body"></a>
<a name="neo.fs.v2.object.HeadRequest.Body"></a>
### Message HeadRequest.Body
Request body
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| address | [refs.Address](#refs.Address) | | Address of the object with the requested header. |
| address | [neo.fs.v2.refs.Address](#neo.fs.v2.refs.Address) | | Address of the object with the requested header. |
| main_only | [bool](#bool) | | Return only minimal header subset |
| raw | [bool](#bool) | | Carries the raw option flag of the request. Raw request is sent to receive only the headers of the objects that are physically stored on the server. |
<a name="object.HeadResponse"></a>
<a name="neo.fs.v2.object.HeadResponse"></a>
### Message HeadResponse
Head response
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| body | [HeadResponse.Body](#object.HeadResponse.Body) | | Body of head object response message. |
| meta_header | [service.ResponseMetaHeader](#service.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. |
| verify_header | [service.ResponseVerificationHeader](#service.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
| body | [HeadResponse.Body](#neo.fs.v2.object.HeadResponse.Body) | | Body of head object response message. |
| meta_header | [neo.fs.v2.service.ResponseMetaHeader](#neo.fs.v2.service.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.service.ResponseVerificationHeader](#neo.fs.v2.service.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="object.HeadResponse.Body"></a>
<a name="neo.fs.v2.object.HeadResponse.Body"></a>
### Message HeadResponse.Body
Response body
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| header | [Header](#object.Header) | | |
| short_header | [HeadResponse.Body.ShortHeader](#object.HeadResponse.Body.ShortHeader) | | |
| header | [Header](#neo.fs.v2.object.Header) | | Full object header |
| short_header | [HeadResponse.Body.ShortHeader](#neo.fs.v2.object.HeadResponse.Body.ShortHeader) | | Short object header |
<a name="object.HeadResponse.Body.ShortHeader"></a>
<a name="neo.fs.v2.object.HeadResponse.Body.ShortHeader"></a>
### Message HeadResponse.Body.ShortHeader
Short header fields
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| version | [service.Version](#service.Version) | | Object format version. |
| version | [neo.fs.v2.service.Version](#neo.fs.v2.service.Version) | | Object format version. |
| creation_epoch | [uint64](#uint64) | | Epoch when the object was created |
| owner_id | [refs.OwnerID](#refs.OwnerID) | | Object's owner |
| object_type | [ObjectType](#object.ObjectType) | | Type of the object payload content |
| owner_id | [neo.fs.v2.refs.OwnerID](#neo.fs.v2.refs.OwnerID) | | Object's owner |
| object_type | [ObjectType](#neo.fs.v2.object.ObjectType) | | Type of the object payload content |
| payload_length | [uint64](#uint64) | | Size of payload in bytes. 0xFFFFFFFFFFFFFFFF means `payload_length` is unknown |
<a name="object.PutRequest"></a>
<a name="neo.fs.v2.object.PutRequest"></a>
### Message PutRequest
Put object request
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| body | [PutRequest.Body](#object.PutRequest.Body) | | Body of put object request message. |
| meta_header | [service.RequestMetaHeader](#service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. |
| verify_header | [service.RequestVerificationHeader](#service.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
| body | [PutRequest.Body](#neo.fs.v2.object.PutRequest.Body) | | Body of put object request message. |
| meta_header | [neo.fs.v2.service.RequestMetaHeader](#neo.fs.v2.service.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.service.RequestVerificationHeader](#neo.fs.v2.service.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="object.PutRequest.Body"></a>
<a name="neo.fs.v2.object.PutRequest.Body"></a>
### Message PutRequest.Body
Request body
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| init | [PutRequest.Body.Init](#object.PutRequest.Body.Init) | | Carries the initialization parameters of the object stream. |
| init | [PutRequest.Body.Init](#neo.fs.v2.object.PutRequest.Body.Init) | | Carries the initialization parameters of the object stream. |
| chunk | [bytes](#bytes) | | Carries part of the object payload. |
<a name="object.PutRequest.Body.Init"></a>
<a name="neo.fs.v2.object.PutRequest.Body.Init"></a>
### Message PutRequest.Body.Init
Groups initialization parameters of object placement in NeoFS.
@ -458,37 +457,37 @@ Groups initialization parameters of object placement in NeoFS.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| object_id | [refs.ObjectID](#refs.ObjectID) | | Object ID, where available |
| signature | [service.Signature](#service.Signature) | | Object signature, were available |
| header | [Header](#object.Header) | | Header of the object to save in the system. |
| object_id | [neo.fs.v2.refs.ObjectID](#neo.fs.v2.refs.ObjectID) | | Object ID, where available |
| signature | [neo.fs.v2.service.Signature](#neo.fs.v2.service.Signature) | | Object signature, were available |
| header | [Header](#neo.fs.v2.object.Header) | | Header of the object to save in the system. |
| copies_number | [uint32](#uint32) | | Number of the object copies to store within the RPC call. Default zero value is processed according to the container placement rules. |
<a name="object.PutResponse"></a>
<a name="neo.fs.v2.object.PutResponse"></a>
### Message PutResponse
Put object response
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| body | [PutResponse.Body](#object.PutResponse.Body) | | Body of put object response message. |
| meta_header | [service.ResponseMetaHeader](#service.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. |
| verify_header | [service.ResponseVerificationHeader](#service.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
| body | [PutResponse.Body](#neo.fs.v2.object.PutResponse.Body) | | Body of put object response message. |
| meta_header | [neo.fs.v2.service.ResponseMetaHeader](#neo.fs.v2.service.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.service.ResponseVerificationHeader](#neo.fs.v2.service.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="object.PutResponse.Body"></a>
<a name="neo.fs.v2.object.PutResponse.Body"></a>
### Message PutResponse.Body
Response body
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| object_id | [refs.ObjectID](#refs.ObjectID) | | Carries identifier of the saved object. It is used to access an object in the container. |
| object_id | [neo.fs.v2.refs.ObjectID](#neo.fs.v2.refs.ObjectID) | | Carries identifier of the saved object. It is used to access an object in the container. |
<a name="object.Range"></a>
<a name="neo.fs.v2.object.Range"></a>
### Message Range
Range groups the parameters of object payload range.
@ -500,91 +499,80 @@ Range groups the parameters of object payload range.
| length | [uint64](#uint64) | | Carries the length of the object payload range. |
<a name="object.SearchRequest"></a>
<a name="neo.fs.v2.object.SearchRequest"></a>
### Message SearchRequest
Search objects request
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| body | [SearchRequest.Body](#object.SearchRequest.Body) | | Body of search object request message. |
| meta_header | [service.RequestMetaHeader](#service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. |
| verify_header | [service.RequestVerificationHeader](#service.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
| body | [SearchRequest.Body](#neo.fs.v2.object.SearchRequest.Body) | | Body of search object request message. |
| meta_header | [neo.fs.v2.service.RequestMetaHeader](#neo.fs.v2.service.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.service.RequestVerificationHeader](#neo.fs.v2.service.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="object.SearchRequest.Body"></a>
<a name="neo.fs.v2.object.SearchRequest.Body"></a>
### Message SearchRequest.Body
Request body
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| container_id | [refs.ContainerID](#refs.ContainerID) | | Carries search container identifier. |
| query | [SearchRequest.Body.Query](#object.SearchRequest.Body.Query) | | |
| container_id | [neo.fs.v2.refs.ContainerID](#neo.fs.v2.refs.ContainerID) | | Carries search container identifier. |
| version | [uint32](#uint32) | | Version of the Query Language used |
| filters | [SearchRequest.Body.Filter](#neo.fs.v2.object.SearchRequest.Body.Filter) | repeated | List of search expressions |
<a name="object.SearchRequest.Body.Query"></a>
### Message SearchRequest.Body.Query
<a name="neo.fs.v2.object.SearchRequest.Body.Filter"></a>
### Message SearchRequest.Body.Filter
Filter structure
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| version | [uint32](#uint32) | | |
| filters | [SearchRequest.Body.Query.Filter](#object.SearchRequest.Body.Query.Filter) | repeated | |
| match_type | [SearchRequest.Body.Filter.MatchType](#neo.fs.v2.object.SearchRequest.Body.Filter.MatchType) | | Match type to use |
| name | [string](#string) | | Header name to match |
| value | [string](#string) | | Header value to match |
<a name="object.SearchRequest.Body.Query.Filter"></a>
### Message SearchRequest.Body.Query.Filter
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| match_type | [SearchRequest.Body.Query.Filter.MatchType](#object.SearchRequest.Body.Query.Filter.MatchType) | | |
| name | [string](#string) | | |
| value | [string](#string) | | |
<a name="object.SearchResponse"></a>
<a name="neo.fs.v2.object.SearchResponse"></a>
### Message SearchResponse
Search response
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| body | [SearchResponse.Body](#object.SearchResponse.Body) | | Body of search object response message. |
| meta_header | [service.ResponseMetaHeader](#service.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. |
| verify_header | [service.ResponseVerificationHeader](#service.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
| body | [SearchResponse.Body](#neo.fs.v2.object.SearchResponse.Body) | | Body of search object response message. |
| meta_header | [neo.fs.v2.service.ResponseMetaHeader](#neo.fs.v2.service.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.service.ResponseVerificationHeader](#neo.fs.v2.service.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="object.SearchResponse.Body"></a>
<a name="neo.fs.v2.object.SearchResponse.Body"></a>
### Message SearchResponse.Body
Response body
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| id_list | [refs.ObjectID](#refs.ObjectID) | repeated | Carries list of object identifiers that match the search query. |
| id_list | [neo.fs.v2.refs.ObjectID](#neo.fs.v2.refs.ObjectID) | repeated | Carries list of object identifiers that match the search query |
<!-- end messages -->
<a name="object.SearchRequest.Body.Query.Filter.MatchType"></a>
### SearchRequest.Body.Query.Filter.MatchType
<a name="neo.fs.v2.object.SearchRequest.Body.Filter.MatchType"></a>
### SearchRequest.Body.Filter.MatchType
Type of match expression
| Name | Number | Description |
| ---- | ------ | ----------- |
| MATCH_UNKNOWN | 0 | |
| STRING_EQUAL | 1 | |
| MATCH_TYPE_UNSPECIFIED | 0 | Unknown. Not used |
| STRING_EQUAL | 1 | Full string match |
<!-- end enums -->
@ -600,28 +588,28 @@ Range groups the parameters of object payload range.
<!-- end services -->
<a name="object.Header"></a>
<a name="neo.fs.v2.object.Header"></a>
### Message Header
Object Headers
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| container_id | [refs.ContainerID](#refs.ContainerID) | | Object's container |
| owner_id | [refs.OwnerID](#refs.OwnerID) | | Object's owner |
| container_id | [neo.fs.v2.refs.ContainerID](#neo.fs.v2.refs.ContainerID) | | Object's container |
| owner_id | [neo.fs.v2.refs.OwnerID](#neo.fs.v2.refs.OwnerID) | | Object's owner |
| creation_epoch | [uint64](#uint64) | | Epoch when the object was created |
| version | [service.Version](#service.Version) | | Object format version. Effectively the version of API library used to create particular object |
| version | [neo.fs.v2.service.Version](#neo.fs.v2.service.Version) | | Object format version. Effectively the version of API library used to create particular object |
| payload_length | [uint64](#uint64) | | Size of payload in bytes. 0xFFFFFFFFFFFFFFFF means `payload_length` is unknown |
| payload_hash | [bytes](#bytes) | | Hash of payload bytes |
| object_type | [ObjectType](#object.ObjectType) | | |
| object_type | [ObjectType](#neo.fs.v2.object.ObjectType) | | Special object type |
| homomorphic_hash | [bytes](#bytes) | | Homomorphic hash of the object payload. |
| session_token | [service.SessionToken](#service.SessionToken) | | Session token, if it was used during Object creation. Need it to verify integrity and authenticity out of Request scope. |
| attributes | [Header.Attribute](#object.Header.Attribute) | repeated | |
| split | [Header.Split](#object.Header.Split) | | Position of the object in the split hierarchy. |
| session_token | [neo.fs.v2.service.SessionToken](#neo.fs.v2.service.SessionToken) | | Session token, if it was used during Object creation. Need it to verify integrity and authenticity out of Request scope. |
| attributes | [Header.Attribute](#neo.fs.v2.object.Header.Attribute) | repeated | User-defined object attributes |
| split | [Header.Split](#neo.fs.v2.object.Header.Split) | | Position of the object in the split hierarchy. |
<a name="object.Header.Attribute"></a>
<a name="neo.fs.v2.object.Header.Attribute"></a>
### Message Header.Attribute
Attribute groups the user-defined Key-Value pairs attached to the object
@ -633,7 +621,7 @@ Attribute groups the user-defined Key-Value pairs attached to the object
| value | [string](#string) | | string value of the object attribute |
<a name="object.Header.Split"></a>
<a name="neo.fs.v2.object.Header.Split"></a>
### Message Header.Split
Information about spawning the objects through a payload splitting.
@ -641,14 +629,14 @@ Information about spawning the objects through a payload splitting.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| parent | [refs.ObjectID](#refs.ObjectID) | | Identifier of the origin object. Parent and children objects must be within the same container. Parent object_id is known only to the minor child. |
| previous | [refs.ObjectID](#refs.ObjectID) | | Previous carries identifier of the left split neighbor. |
| parent_signature | [service.Signature](#service.Signature) | | `signature` field of the parent object. Used to reconstruct parent. |
| parent_header | [Header](#object.Header) | | `header` field of the parent object. Used to reconstruct parent. |
| children | [refs.ObjectID](#refs.ObjectID) | repeated | Children carries list of identifiers of the objects generated by splitting the current. |
| parent | [neo.fs.v2.refs.ObjectID](#neo.fs.v2.refs.ObjectID) | | Identifier of the origin object. Parent and children objects must be within the same container. Parent object_id is known only to the minor child. |
| previous | [neo.fs.v2.refs.ObjectID](#neo.fs.v2.refs.ObjectID) | | Previous carries identifier of the left split neighbor. |
| parent_signature | [neo.fs.v2.service.Signature](#neo.fs.v2.service.Signature) | | `signature` field of the parent object. Used to reconstruct parent. |
| parent_header | [Header](#neo.fs.v2.object.Header) | | `header` field of the parent object. Used to reconstruct parent. |
| children | [neo.fs.v2.refs.ObjectID](#neo.fs.v2.refs.ObjectID) | repeated | Children carries list of identifiers of the objects generated by splitting the current. |
<a name="object.Object"></a>
<a name="neo.fs.v2.object.Object"></a>
### Message Object
Object structure.
@ -656,15 +644,15 @@ Object structure.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| object_id | [refs.ObjectID](#refs.ObjectID) | | Object's unique identifier. Object is content-addressed. It means id will change if header or payload changes. It's calculated as a hash of header field, which contains hash of object's payload |
| signature | [service.Signature](#service.Signature) | | Signed object_id |
| header | [Header](#object.Header) | | Object metadata headers |
| object_id | [neo.fs.v2.refs.ObjectID](#neo.fs.v2.refs.ObjectID) | | Object's unique identifier. Object is content-addressed. It means id will change if header or payload changes. It's calculated as a hash of header field, which contains hash of object's payload |
| signature | [neo.fs.v2.service.Signature](#neo.fs.v2.service.Signature) | | Signed object_id |
| header | [Header](#neo.fs.v2.object.Header) | | Object metadata headers |
| payload | [bytes](#bytes) | | Payload bytes. |
<!-- end messages -->
<a name="object.ObjectType"></a>
<a name="neo.fs.v2.object.ObjectType"></a>
### ObjectType
Type of the object payload content

20
proto-docs/refs.md
View file

@ -6,10 +6,10 @@
- [refs/types.proto](#refs/types.proto)
- Messages
- [Address](#refs.Address)
- [ContainerID](#refs.ContainerID)
- [ObjectID](#refs.ObjectID)
- [OwnerID](#refs.OwnerID)
- [Address](#neo.fs.v2.refs.Address)
- [ContainerID](#neo.fs.v2.refs.ContainerID)
- [ObjectID](#neo.fs.v2.refs.ObjectID)
- [OwnerID](#neo.fs.v2.refs.OwnerID)
- [Scalar Value Types](#scalar-value-types)
@ -25,7 +25,7 @@
<!-- end services -->
<a name="refs.Address"></a>
<a name="neo.fs.v2.refs.Address"></a>
### Message Address
Address of object (container id + object id)
@ -33,11 +33,11 @@ Address of object (container id + object id)
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| container_id | [ContainerID](#refs.ContainerID) | | container_id carries container identifier. |
| object_id | [ObjectID](#refs.ObjectID) | | object_id carries object identifier. |
| container_id | [ContainerID](#neo.fs.v2.refs.ContainerID) | | container_id carries container identifier. |
| object_id | [ObjectID](#neo.fs.v2.refs.ObjectID) | | object_id carries object identifier. |
<a name="refs.ContainerID"></a>
<a name="neo.fs.v2.refs.ContainerID"></a>
### Message ContainerID
NeoFS container identifier.
@ -48,7 +48,7 @@ NeoFS container identifier.
| value | [bytes](#bytes) | | value carries the container identifier in a binary format. |
<a name="refs.ObjectID"></a>
<a name="neo.fs.v2.refs.ObjectID"></a>
### Message ObjectID
NeoFS object identifier.
@ -59,7 +59,7 @@ NeoFS object identifier.
| value | [bytes](#bytes) | | value carries the object identifier in a binary format. |
<a name="refs.OwnerID"></a>
<a name="neo.fs.v2.refs.OwnerID"></a>
### Message OwnerID
OwnerID group information about the owner of the NeoFS container.

125
proto-docs/service.md
View file

@ -6,23 +6,23 @@
- [service/meta.proto](#service/meta.proto)
- Messages
- [BearerToken](#service.BearerToken)
- [BearerToken.Body](#service.BearerToken.Body)
- [RequestMetaHeader](#service.RequestMetaHeader)
- [ResponseMetaHeader](#service.ResponseMetaHeader)
- [SessionToken](#service.SessionToken)
- [SessionToken.Body](#service.SessionToken.Body)
- [TokenLifetime](#service.TokenLifetime)
- [Version](#service.Version)
- [XHeader](#service.XHeader)
- [BearerToken](#neo.fs.v2.service.BearerToken)
- [BearerToken.Body](#neo.fs.v2.service.BearerToken.Body)
- [RequestMetaHeader](#neo.fs.v2.service.RequestMetaHeader)
- [ResponseMetaHeader](#neo.fs.v2.service.ResponseMetaHeader)
- [SessionToken](#neo.fs.v2.service.SessionToken)
- [SessionToken.Body](#neo.fs.v2.service.SessionToken.Body)
- [TokenLifetime](#neo.fs.v2.service.TokenLifetime)
- [Version](#neo.fs.v2.service.Version)
- [XHeader](#neo.fs.v2.service.XHeader)
- [service/verify.proto](#service/verify.proto)
- Messages
- [RequestVerificationHeader](#service.RequestVerificationHeader)
- [ResponseVerificationHeader](#service.ResponseVerificationHeader)
- [Signature](#service.Signature)
- [RequestVerificationHeader](#neo.fs.v2.service.RequestVerificationHeader)
- [ResponseVerificationHeader](#neo.fs.v2.service.ResponseVerificationHeader)
- [Signature](#neo.fs.v2.service.Signature)
- [Scalar Value Types](#scalar-value-types)
@ -38,7 +38,7 @@
<!-- end services -->
<a name="service.BearerToken"></a>
<a name="neo.fs.v2.service.BearerToken"></a>
### Message BearerToken
BearerToken has information about request ACL rules with limited lifetime
@ -46,24 +46,24 @@ BearerToken has information about request ACL rules with limited lifetime
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| token | [BearerToken.Body](#service.BearerToken.Body) | | Bearer Token body |
| signature | [Signature](#service.Signature) | | Signature of BearerToken body |
| body | [BearerToken.Body](#neo.fs.v2.service.BearerToken.Body) | | Bearer Token body |
| signature | [Signature](#neo.fs.v2.service.Signature) | | Signature of BearerToken body |
<a name="service.BearerToken.Body"></a>
<a name="neo.fs.v2.service.BearerToken.Body"></a>
### Message BearerToken.Body
Bearer Token body
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| eacl_table | [acl.EACLTable](#acl.EACLTable) | | EACLTable carries table of extended ACL rules |
| owner_id | [refs.OwnerID](#refs.OwnerID) | | OwnerID carries identifier of the token owner |
| lifetime | [TokenLifetime](#service.TokenLifetime) | | Token expiration and valid time period parameters |
| eacl_table | [neo.fs.v2.acl.EACLTable](#neo.fs.v2.acl.EACLTable) | | EACLTable carries table of extended ACL rules |
| owner_id | [neo.fs.v2.refs.OwnerID](#neo.fs.v2.refs.OwnerID) | | OwnerID carries identifier of the token owner |
| lifetime | [TokenLifetime](#neo.fs.v2.service.TokenLifetime) | | Token expiration and valid time period parameters |
<a name="service.RequestMetaHeader"></a>
<a name="neo.fs.v2.service.RequestMetaHeader"></a>
### Message RequestMetaHeader
Information about the request
@ -71,16 +71,16 @@ Information about the request
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| version | [Version](#service.Version) | | Client API version. |
| version | [Version](#neo.fs.v2.service.Version) | | Client API version. |
| epoch | [uint64](#uint64) | | Client local epoch number. Set to 0 if unknown. |
| ttl | [uint32](#uint32) | | Maximum number of nodes in the request route. |
| x_headers | [XHeader](#service.XHeader) | repeated | Request X-Headers. |
| token | [SessionToken](#service.SessionToken) | | Token is a token of the session within which the request is sent |
| bearer | [BearerToken](#service.BearerToken) | | Bearer is a Bearer token of the request |
| origin | [RequestMetaHeader](#service.RequestMetaHeader) | | RequestMetaHeader of the origin request. |
| x_headers | [XHeader](#neo.fs.v2.service.XHeader) | repeated | Request X-Headers. |
| session_token | [SessionToken](#neo.fs.v2.service.SessionToken) | | Token is a token of the session within which the request is sent |
| bearer_token | [BearerToken](#neo.fs.v2.service.BearerToken) | | Bearer is a Bearer token of the request |
| origin | [RequestMetaHeader](#neo.fs.v2.service.RequestMetaHeader) | | RequestMetaHeader of the origin request. |
<a name="service.ResponseMetaHeader"></a>
<a name="neo.fs.v2.service.ResponseMetaHeader"></a>
### Message ResponseMetaHeader
Information about the response
@ -88,14 +88,14 @@ Information about the response
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| version | [Version](#service.Version) | | Server API version. |
| version | [Version](#neo.fs.v2.service.Version) | | Server API version. |
| epoch | [uint64](#uint64) | | Server local epoch number. |
| ttl | [uint32](#uint32) | | Maximum number of nodes in the response route. |
| x_headers | [XHeader](#service.XHeader) | repeated | Response X-Headers. |
| origin | [ResponseMetaHeader](#service.ResponseMetaHeader) | | Carries response meta header of the origin response. |
| x_headers | [XHeader](#neo.fs.v2.service.XHeader) | repeated | Response X-Headers. |
| origin | [ResponseMetaHeader](#neo.fs.v2.service.ResponseMetaHeader) | | Carries response meta header of the origin response. |
<a name="service.SessionToken"></a>
<a name="neo.fs.v2.service.SessionToken"></a>
### Message SessionToken
NeoFS session token.
@ -103,27 +103,27 @@ NeoFS session token.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| token | [SessionToken.Body](#service.SessionToken.Body) | | Session Token body |
| signature | [Signature](#service.Signature) | | Signature is a signature of session token information |
| body | [SessionToken.Body](#neo.fs.v2.service.SessionToken.Body) | | Session Token body |
| signature | [Signature](#neo.fs.v2.service.Signature) | | Signature is a signature of session token information |
<a name="service.SessionToken.Body"></a>
<a name="neo.fs.v2.service.SessionToken.Body"></a>
### Message SessionToken.Body
Session token body
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| id | [bytes](#bytes) | | ID is a token identifier. valid UUIDv4 represented in bytes |
| owner_id | [refs.OwnerID](#refs.OwnerID) | | OwnerID carries identifier of the session initiator. |
| verb | [SessionToken.Body.Verb](#service.SessionToken.Body.Verb) | | Verb is a type of request for which the token is issued |
| lifetime | [TokenLifetime](#service.TokenLifetime) | | Lifetime is a lifetime of the session |
| owner_id | [neo.fs.v2.refs.OwnerID](#neo.fs.v2.refs.OwnerID) | | OwnerID carries identifier of the session initiator. |
| verb | [SessionToken.Body.Verb](#neo.fs.v2.service.SessionToken.Body.Verb) | | Verb is a type of request for which the token is issued |
| lifetime | [TokenLifetime](#neo.fs.v2.service.TokenLifetime) | | Lifetime is a lifetime of the session |
| session_key | [bytes](#bytes) | | SessionKey is a public key of session key |
| object_address | [refs.Address](#refs.Address) | | object_address represents the object session context. |
| object_address | [neo.fs.v2.refs.Address](#neo.fs.v2.refs.Address) | | object_address represents the object session context. |
<a name="service.TokenLifetime"></a>
<a name="neo.fs.v2.service.TokenLifetime"></a>
### Message TokenLifetime
Lifetime parameters of the token. Filed names taken from rfc7519.
@ -136,7 +136,7 @@ Lifetime parameters of the token. Filed names taken from rfc7519.
| iat | [uint64](#uint64) | | Issued at Epoch |
<a name="service.Version"></a>
<a name="neo.fs.v2.service.Version"></a>
### Message Version
Represents API version used by node.
@ -148,10 +148,10 @@ Represents API version used by node.
| minor | [uint32](#uint32) | | Minor API version. |
<a name="service.XHeader"></a>
<a name="neo.fs.v2.service.XHeader"></a>
### Message XHeader
Extended headers for Request/Response
| Field | Type | Label | Description |
@ -162,20 +162,21 @@ Represents API version used by node.
<!-- end messages -->
<a name="service.SessionToken.Body.Verb"></a>
<a name="neo.fs.v2.service.SessionToken.Body.Verb"></a>
### SessionToken.Body.Verb
Verb is an enumeration of session request types
| Name | Number | Description |
| ---- | ------ | ----------- |
| OBJECT_PUT | 0 | Refers to object.Put RPC call |
| OBJECT_GET | 1 | Refers to object.Get RPC call |
| OBJECT_HEAD | 2 | Refers to object.Head RPC call |
| OBJECT_SEARCH | 3 | Refers to object.Search RPC call |
| OBJECT_DELETE | 4 | Refers to object.Delete RPC call |
| OBJECT_RANGE | 5 | Refers to object.GetRange RPC call |
| OBJECT_RANGEHASH | 6 | Refers to object.GetRangeHash RPC call |
| VERB_UNSPECIFIED | 0 | Unknown verb |
| OBJECT_PUT | 1 | Refers to object.Put RPC call |
| OBJECT_GET | 2 | Refers to object.Get RPC call |
| OBJECT_HEAD | 3 | Refers to object.Head RPC call |
| OBJECT_SEARCH | 4 | Refers to object.Search RPC call |
| OBJECT_DELETE | 5 | Refers to object.Delete RPC call |
| OBJECT_RANGE | 6 | Refers to object.GetRange RPC call |
| OBJECT_RANGEHASH | 7 | Refers to object.GetRangeHash RPC call |
<!-- end enums -->
@ -191,7 +192,7 @@ Verb is an enumeration of session request types
<!-- end services -->
<a name="service.RequestVerificationHeader"></a>
<a name="neo.fs.v2.service.RequestVerificationHeader"></a>
### Message RequestVerificationHeader
Verification info for request signed by all intermediate nodes
@ -199,13 +200,13 @@ Verification info for request signed by all intermediate nodes
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| body_signature | [Signature](#service.Signature) | | Request Body signature. Should be generated once by request initiator. |
| meta_signature | [Signature](#service.Signature) | | Request Meta signature is added and signed by any intermediate node |
| origin_signature | [Signature](#service.Signature) | | Sign previous hops |
| origin | [RequestVerificationHeader](#service.RequestVerificationHeader) | | Chain of previous hops signatures |
| body_signature | [Signature](#neo.fs.v2.service.Signature) | | Request Body signature. Should be generated once by request initiator. |
| meta_signature | [Signature](#neo.fs.v2.service.Signature) | | Request Meta signature is added and signed by any intermediate node |
| origin_signature | [Signature](#neo.fs.v2.service.Signature) | | Sign previous hops |
| origin | [RequestVerificationHeader](#neo.fs.v2.service.RequestVerificationHeader) | | Chain of previous hops signatures |
<a name="service.ResponseVerificationHeader"></a>
<a name="neo.fs.v2.service.ResponseVerificationHeader"></a>
### Message ResponseVerificationHeader
Verification info for response signed by all intermediate nodes
@ -213,13 +214,13 @@ Verification info for response signed by all intermediate nodes
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| body_signature | [Signature](#service.Signature) | | Response Body signature. Should be generated once by answering node. |
| meta_signature | [Signature](#service.Signature) | | Response Meta signature is added and signed by any intermediate node |
| origin_signature | [Signature](#service.Signature) | | Sign previous hops |
| origin | [ResponseVerificationHeader](#service.ResponseVerificationHeader) | | Chain of previous hops signatures |
| body_signature | [Signature](#neo.fs.v2.service.Signature) | | Response Body signature. Should be generated once by answering node. |
| meta_signature | [Signature](#neo.fs.v2.service.Signature) | | Response Meta signature is added and signed by any intermediate node |
| origin_signature | [Signature](#neo.fs.v2.service.Signature) | | Sign previous hops |
| origin | [ResponseVerificationHeader](#neo.fs.v2.service.ResponseVerificationHeader) | | Chain of previous hops signatures |
<a name="service.Signature"></a>
<a name="neo.fs.v2.service.Signature"></a>
### Message Signature
Signature of something in NeoFS

46
proto-docs/session.md
View file

@ -5,13 +5,13 @@
- [session/service.proto](#session/service.proto)
- Services
- [Session](#session.Session)
- [SessionService](#neo.fs.v2.session.SessionService)
- Messages
- [CreateRequest](#session.CreateRequest)
- [CreateRequest.Body](#session.CreateRequest.Body)
- [CreateResponse](#session.CreateResponse)
- [CreateResponse.Body](#session.CreateResponse.Body)
- [CreateRequest](#neo.fs.v2.session.CreateRequest)
- [CreateRequest.Body](#neo.fs.v2.session.CreateRequest.Body)
- [CreateResponse](#neo.fs.v2.session.CreateResponse)
- [CreateResponse.Body](#neo.fs.v2.session.CreateResponse.Body)
- [Scalar Value Types](#scalar-value-types)
@ -26,10 +26,10 @@
<a name="session.Session"></a>
### Service "session.Session"
<a name="neo.fs.v2.session.SessionService"></a>
### Service "neo.fs.v2.session.SessionService"
Create Session record on Node side
```
rpc Create(CreateRequest) returns (CreateResponse);
@ -42,11 +42,11 @@ Create opens new session between the client and the server.
| Name | Input | Output |
| ---- | ----- | ------ |
| Create | [CreateRequest](#session.CreateRequest) | [CreateResponse](#session.CreateResponse) |
| Create | [CreateRequest](#neo.fs.v2.session.CreateRequest) | [CreateResponse](#neo.fs.v2.session.CreateResponse) |
<!-- end services -->
<a name="session.CreateRequest"></a>
<a name="neo.fs.v2.session.CreateRequest"></a>
### Message CreateRequest
CreateRequest carries an information necessary for opening a session.
@ -54,24 +54,24 @@ CreateRequest carries an information necessary for opening a session.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| body | [CreateRequest.Body](#session.CreateRequest.Body) | | Body of create session token request message. |
| meta_header | [service.RequestMetaHeader](#service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. |
| verify_header | [service.RequestVerificationHeader](#service.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
| body | [CreateRequest.Body](#neo.fs.v2.session.CreateRequest.Body) | | Body of create session token request message. |
| meta_header | [neo.fs.v2.service.RequestMetaHeader](#neo.fs.v2.service.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.service.RequestVerificationHeader](#neo.fs.v2.service.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="session.CreateRequest.Body"></a>
<a name="neo.fs.v2.session.CreateRequest.Body"></a>
### Message CreateRequest.Body
Request body
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| owner_id | [refs.OwnerID](#refs.OwnerID) | | Carries an identifier of a session initiator. |
| lifetime | [service.TokenLifetime](#service.TokenLifetime) | | Carries a lifetime of the session. |
| owner_id | [neo.fs.v2.refs.OwnerID](#neo.fs.v2.refs.OwnerID) | | Carries an identifier of a session initiator. |
| lifetime | [neo.fs.v2.service.TokenLifetime](#neo.fs.v2.service.TokenLifetime) | | Carries a lifetime of the session. |
<a name="session.CreateResponse"></a>
<a name="neo.fs.v2.session.CreateResponse"></a>
### Message CreateResponse
CreateResponse carries an information about the opened session.
@ -79,15 +79,15 @@ CreateResponse carries an information about the opened session.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| body | [CreateResponse.Body](#session.CreateResponse.Body) | | Body of create session token response message. |
| meta_header | [service.ResponseMetaHeader](#service.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. |
| verify_header | [service.ResponseVerificationHeader](#service.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
| body | [CreateResponse.Body](#neo.fs.v2.session.CreateResponse.Body) | | Body of create session token response message. |
| meta_header | [neo.fs.v2.service.ResponseMetaHeader](#neo.fs.v2.service.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.service.ResponseVerificationHeader](#neo.fs.v2.service.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="session.CreateResponse.Body"></a>
<a name="neo.fs.v2.session.CreateResponse.Body"></a>
### Message CreateResponse.Body
Response body
| Field | Type | Label | Description |

6
proto-docs/storagegroup.md
View file

@ -6,7 +6,7 @@
- [storagegroup/types.proto](#storagegroup/types.proto)
- Messages
- [StorageGroup](#storagegroup.StorageGroup)
- [StorageGroup](#neo.fs.v2.storagegroup.StorageGroup)
- [Scalar Value Types](#scalar-value-types)
@ -22,7 +22,7 @@
<!-- end services -->
<a name="storagegroup.StorageGroup"></a>
<a name="neo.fs.v2.storagegroup.StorageGroup"></a>
### Message StorageGroup
StorageGroup groups the information about the NeoFS storage group.
@ -34,7 +34,7 @@ The storage group consists of objects from single container.
| validation_data_size | [uint64](#uint64) | | validation_data_size carries the total size of the payloads of the storage group members. |
| validation_hash | [bytes](#bytes) | | validation_hash carries homomorphic hash from the concatenation of the payloads of the storage group members The order of concatenation is the same as the order of the members in the Members field. |
| expiration_epoch | [uint64](#uint64) | | expiration_epoch carries last NeoFS epoch number of the storage group lifetime. |
| members | [refs.ObjectID](#refs.ObjectID) | repeated | Members carries the list of identifiers of the object storage group members. The list is strictly ordered. |
| members | [neo.fs.v2.refs.ObjectID](#neo.fs.v2.refs.ObjectID) | repeated | Members carries the list of identifiers of the object storage group members. The list is strictly ordered. |
<!-- end messages -->