orikik/frostfs-api
1
0
Fork 0
forked from TrueCloudLab/frostfs-api
Code Pull requests 1 Activity Actions

[#32] docs: regenerate files

Browse source 
Signed-off-by: Stanislav Bogatyrev <stanislav@nspcc.ru>
This commit is contained in:
Stanislav Bogatyrev 2020-08-07 10:53:45 +03:00 committed by Stanislav Bogatyrev
parent e75ef53793
commit c65920d2ce
9 changed files with 186 additions and 186 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
proto-docs/accounting.md
View file

@ -51,7 +51,7 @@ Returns the amount of funds for the requested NeoFS account.
### Message BalanceRequest ### Message BalanceRequest
Message defines the request body of Balance method. Message defines the request body of Balance method.
To indicate the account for which the balance is requested, its identifier is used. To indicate the account for which the balance is requested, it's identifier is used.
To gain access to the requested information, the request body must be formed according To gain access to the requested information, the request body must be formed according
to the requirements from the system specification. to the requirements from the system specification.
@ -59,7 +59,7 @@ to the requirements from the system specification.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| OwnerID | [refs.OwnerID](#refs.OwnerID) | | Carries user identifier in NeoFS system for which the balance is requested. | | owner_id | [refs.OwnerID](#refs.OwnerID) | | Carries user identifier in NeoFS system for which the balance is requested. |
<a name="accounting.BalanceResponse"></a> <a name="accounting.BalanceResponse"></a>
@ -72,7 +72,7 @@ The amount of funds is calculated in decimal numbers.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| Balance | [Decimal](#accounting.Decimal) | | Carries the amount of funds on the account. | | balance | [Decimal](#accounting.Decimal) | | Carries the amount of funds on the account. |
<a name="accounting.Decimal"></a> <a name="accounting.Decimal"></a>
@ -83,8 +83,8 @@ Decimal represents the decimal numbers.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| Value | [int64](#int64) | | Value carries number value. | | value | [int64](#int64) | | value carries number value. |
| Precision | [uint32](#uint32) | | Precision carries value precision. | | precision | [uint32](#uint32) | | precision carries value precision. |
<!-- end messages --> <!-- end messages -->

46
proto-docs/acl.md
View file

@ -35,8 +35,8 @@ EACLRecord groups information about extended ACL rule.
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| operation | [EACLRecord.Operation](#acl.EACLRecord.Operation) | | Operation carries type of operation. | | operation | [EACLRecord.Operation](#acl.EACLRecord.Operation) | | Operation carries type of operation. |
| action | [EACLRecord.Action](#acl.EACLRecord.Action) | | Action carries ACL target action. | | action | [EACLRecord.Action](#acl.EACLRecord.Action) | | Action carries ACL target action. |
| Filters | [EACLRecord.FilterInfo](#acl.EACLRecord.FilterInfo) | repeated | Filters carries set of filters. | | 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. | | targets | [EACLRecord.TargetInfo](#acl.EACLRecord.TargetInfo) | repeated | targets carries information about extended ACL target list. |
<a name="acl.EACLRecord.FilterInfo"></a> <a name="acl.EACLRecord.FilterInfo"></a>
@ -48,9 +48,9 @@ FilterInfo groups information about filter.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| header | [EACLRecord.FilterInfo.Header](#acl.EACLRecord.FilterInfo.Header) | | Header carries type of header. | | header | [EACLRecord.FilterInfo.Header](#acl.EACLRecord.FilterInfo.Header) | | Header carries type of header. |
| matchType | [EACLRecord.FilterInfo.MatchType](#acl.EACLRecord.FilterInfo.MatchType) | | MatchType carries type of match. | | match_type | [EACLRecord.FilterInfo.MatchType](#acl.EACLRecord.FilterInfo.MatchType) | | MatchType carries type of match. |
| HeaderName | [string](#string) | | HeaderName carries name of filtering header. | | header_name | [string](#string) | | header_name carries name of filtering header. |
| HeaderVal | [string](#string) | | HeaderVal carries value of filtering header. | | header_val | [string](#string) | | header_val carries value of filtering header. |
<a name="acl.EACLRecord.TargetInfo"></a> <a name="acl.EACLRecord.TargetInfo"></a>
@ -61,8 +61,8 @@ TargetInfo groups information about extended ACL target.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| Target | [Target](#acl.Target) | | Target carries target of ACL rule. | | target | [Target](#acl.Target) | | target carries target of ACL rule. |
| KeyList | [bytes](#bytes) | repeated | KeyList carries public keys of ACL target. | | key_list | [bytes](#bytes) | repeated | key_list carries public keys of ACL target. |
<a name="acl.EACLTable"></a> <a name="acl.EACLTable"></a>
@ -73,8 +73,8 @@ EACLRecord carries the information about extended ACL rules.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| ContainerID | [refs.ContainerID](#refs.ContainerID) | | Carries identifier of the container that should use given access control rules. | | 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. | | records | [EACLRecord](#acl.EACLRecord) | repeated | Records carries list of extended ACL rule records. |
<!-- end messages --> <!-- end messages -->
@ -86,9 +86,9 @@ Action is an enumeration of EACL actions.
| Name | Number | Description | | Name | Number | Description |
| ---- | ------ | ----------- | | ---- | ------ | ----------- |
| ActionUnknown | 0 | | | ACTION_UNKNOWN | 0 | |
| Allow | 1 | | | ALLOW | 1 | |
| Deny | 2 | | | DENY | 2 | |
@ -99,10 +99,10 @@ Header is an enumeration of filtering header types.
| Name | Number | Description | | Name | Number | Description |
| ---- | ------ | ----------- | | ---- | ------ | ----------- |
| HeaderUnknown | 0 | | | HEADER_UNKNOWN | 0 | |
| Request | 1 | | | REQUEST | 1 | |
| ObjectSystem | 2 | | | OBJECT_SYSTEM | 2 | |
| ObjectUser | 3 | | | OBJECT_USER | 3 | |
@ -113,9 +113,9 @@ MatchType is an enumeration of match types.
| Name | Number | Description | | Name | Number | Description |
| ---- | ------ | ----------- | | ---- | ------ | ----------- |
| MatchUnknown | 0 | | | MATCH_UNKNOWN | 0 | |
| StringEqual | 1 | | | STRING_EQUAL | 1 | |
| StringNotEqual | 2 | | | STRING_NOT_EQUAL | 2 | |
@ -144,10 +144,10 @@ Target of the access control rule in access control list.
| Name | Number | Description | | Name | Number | Description |
| ---- | ------ | ----------- | | ---- | ------ | ----------- |
| Unknown | 0 | Unknown target, default value. | | UNKNOWN | 0 | Unknown target, default value. |
| User | 1 | User target rule is applied if sender is the owner of the container. | | 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. | | 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. | | OTHERS | 3 | Others target rule is applied if sender is not user or system target. |
<!-- end enums --> <!-- end enums -->

44
proto-docs/container.md
View file

@ -120,8 +120,8 @@ smart-contract storage.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| ContainerID | [refs.ContainerID](#refs.ContainerID) | | ContainerID carries identifier of the container to delete from NeoFS. | | container_id | [refs.ContainerID](#refs.ContainerID) | | container_id carries identifier of the container to delete from NeoFS. |
| Signature | [bytes](#bytes) | | Signature of container id according to RFC-6979. | | signature | [bytes](#bytes) | | Signature of container id according to RFC-6979. |
<a name="container.DeleteResponse"></a> <a name="container.DeleteResponse"></a>
@ -140,7 +140,7 @@ via consensus in inner ring nodes
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| ContainerID | [refs.ContainerID](#refs.ContainerID) | | ContainerID carries identifier of the container that has Extended ACL. | | container_id | [refs.ContainerID](#refs.ContainerID) | | container_id carries identifier of the container that has Extended ACL. |
<a name="container.GetExtendedACLResponse"></a> <a name="container.GetExtendedACLResponse"></a>
@ -151,8 +151,8 @@ via consensus in inner ring nodes
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| EACL | [acl.EACLTable](#acl.EACLTable) | | EACL that has been requested if it was set up. | | eacl | [acl.EACLTable](#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. | | signature | [bytes](#bytes) | | Signature of stable-marshalled Extended ACL according to RFC-6979. |
<a name="container.GetRequest"></a> <a name="container.GetRequest"></a>
@ -163,7 +163,7 @@ via consensus in inner ring nodes
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| ContainerID | [refs.ContainerID](#refs.ContainerID) | | ContainerID carries identifier of the container to get. | | container_id | [refs.ContainerID](#refs.ContainerID) | | container_id carries identifier of the container to get. |
<a name="container.GetResponse"></a> <a name="container.GetResponse"></a>
@ -174,7 +174,7 @@ via consensus in inner ring nodes
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| Container | [Container](#container.Container) | | Container that has been requested. | | container | [Container](#container.Container) | | Container that has been requested. |
<a name="container.ListRequest"></a> <a name="container.ListRequest"></a>
@ -185,7 +185,7 @@ via consensus in inner ring nodes
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| OwnerID | [refs.OwnerID](#refs.OwnerID) | | OwnerID carries identifier of the container owner. | | owner_id | [refs.OwnerID](#refs.OwnerID) | | owner_id carries identifier of the container owner. |
<a name="container.ListResponse"></a> <a name="container.ListResponse"></a>
@ -196,7 +196,7 @@ via consensus in inner ring nodes
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| ContainerIDs | [refs.ContainerID](#refs.ContainerID) | repeated | ContainerIDs carries list of identifiers of the containers that belong to the owner. | | container_ids | [refs.ContainerID](#refs.ContainerID) | repeated | ContainerIDs carries list of identifiers of the containers that belong to the owner. |
<a name="container.PutRequest"></a> <a name="container.PutRequest"></a>
@ -207,9 +207,9 @@ via consensus in inner ring nodes
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| Container | [Container](#container.Container) | | Container to create in NeoFS. | | container | [Container](#container.Container) | | Container to create in NeoFS. |
| PublicKey | [bytes](#bytes) | | PublicKey of container owner. It can be public key of the owner or it can be public key that bound in neofs.id smart-contract. | | 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. | | signature | [bytes](#bytes) | | Signature of stable-marshalled container according to RFC-6979. |
<a name="container.PutResponse"></a> <a name="container.PutResponse"></a>
@ -220,7 +220,7 @@ via consensus in inner ring nodes
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| ContainerID | [refs.ContainerID](#refs.ContainerID) | | ContainerID carries identifier of the new container. | | container_id | [refs.ContainerID](#refs.ContainerID) | | container_id carries identifier of the new container. |
<a name="container.SetExtendedACLRequest"></a> <a name="container.SetExtendedACLRequest"></a>
@ -231,8 +231,8 @@ via consensus in inner ring nodes
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| EACL | [acl.EACLTable](#acl.EACLTable) | | EACL to set for the container. | | eacl | [acl.EACLTable](#acl.EACLTable) | | Extended ACL to set for the container. |
| Signature | [bytes](#bytes) | | Signature of stable-marshalled Extended ACL according to RFC-6979. | | signature | [bytes](#bytes) | | Signature of stable-marshalled Extended ACL according to RFC-6979. |
<a name="container.SetExtendedACLResponse"></a> <a name="container.SetExtendedACLResponse"></a>
@ -267,11 +267,11 @@ SHA256 hash of stable-marshalled container message.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| OwnerID | [refs.OwnerID](#refs.OwnerID) | | OwnerID carries identifier of the container owner. | | owner_id | [refs.OwnerID](#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. | | nonce | [bytes](#bytes) | | Nonce is a 16 byte UUID, used to avoid collisions of container id. |
| BasicACL | [uint32](#uint32) | | BasicACL contains access control rules for owner, system, others groups and permission bits for bearer token and Extended ACL. | | 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. | | 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. | | rules | [netmap.PlacementRule](#netmap.PlacementRule) | | Rules define storage policy for the object inside the container. |
<a name="container.Container.Attribute"></a> <a name="container.Container.Attribute"></a>
@ -282,8 +282,8 @@ Attribute is a key-value pair of strings.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| Key | [string](#string) | | Key of immutable container attribute. | | key | [string](#string) | | Key of immutable container attribute. |
| Value | [string](#string) | | Value of immutable container attribute. | | value | [string](#string) | | Value of immutable container attribute. |
<!-- end messages --> <!-- end messages -->

42
proto-docs/netmap.md
View file

@ -37,9 +37,9 @@ Groups the information about the NeoFS node.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| Address | [string](#string) | | Carries network address of the NeoFS node. | | address | [string](#string) | | Carries network address of the NeoFS node. |
| PublicKey | [bytes](#bytes) | | Carries public key of the NeoFS node in a binary format. | | 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. | | 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. | | state | [NodeInfo.State](#netmap.NodeInfo.State) | | Carries state of the NeoFS node. |
@ -51,8 +51,8 @@ Groups attributes of the NeoFS node.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| Key | [string](#string) | | Carries string key to the node attribute. | | key | [string](#string) | | Carries string key to the node attribute. |
| Value | [string](#string) | | Carries string value of the node attribute. | | value | [string](#string) | | Carries string value of the node attribute. |
<a name="netmap.PlacementRule"></a> <a name="netmap.PlacementRule"></a>
@ -63,8 +63,8 @@ Groups attributes of the NeoFS node.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| ReplFactor | [uint32](#uint32) | | | | repl_factor | [uint32](#uint32) | | |
| SFGroups | [PlacementRule.SFGroup](#netmap.PlacementRule.SFGroup) | repeated | | | sf_groups | [PlacementRule.SFGroup](#netmap.PlacementRule.SFGroup) | repeated | |
<a name="netmap.PlacementRule.SFGroup"></a> <a name="netmap.PlacementRule.SFGroup"></a>
@ -75,9 +75,9 @@ Groups attributes of the NeoFS node.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| Filters | [PlacementRule.SFGroup.Filter](#netmap.PlacementRule.SFGroup.Filter) | repeated | | | filters | [PlacementRule.SFGroup.Filter](#netmap.PlacementRule.SFGroup.Filter) | repeated | |
| Selectors | [PlacementRule.SFGroup.Selector](#netmap.PlacementRule.SFGroup.Selector) | repeated | | | selectors | [PlacementRule.SFGroup.Selector](#netmap.PlacementRule.SFGroup.Selector) | repeated | |
| Exclude | [uint32](#uint32) | repeated | | | exclude | [uint32](#uint32) | repeated | |
<a name="netmap.PlacementRule.SFGroup.Filter"></a> <a name="netmap.PlacementRule.SFGroup.Filter"></a>
@ -88,8 +88,8 @@ Groups attributes of the NeoFS node.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| Key | [string](#string) | | | | key | [string](#string) | | |
| F | [PlacementRule.SFGroup.Filter.SimpleFilter](#netmap.PlacementRule.SFGroup.Filter.SimpleFilter) | | | | f | [PlacementRule.SFGroup.Filter.SimpleFilter](#netmap.PlacementRule.SFGroup.Filter.SimpleFilter) | | |
<a name="netmap.PlacementRule.SFGroup.Filter.SimpleFilter"></a> <a name="netmap.PlacementRule.SFGroup.Filter.SimpleFilter"></a>
@ -100,9 +100,9 @@ Groups attributes of the NeoFS node.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| Op | [PlacementRule.SFGroup.Filter.SimpleFilter.Operation](#netmap.PlacementRule.SFGroup.Filter.SimpleFilter.Operation) | | | | op | [PlacementRule.SFGroup.Filter.SimpleFilter.Operation](#netmap.PlacementRule.SFGroup.Filter.SimpleFilter.Operation) | | |
| Value | [string](#string) | | | | value | [string](#string) | | |
| FArgs | [PlacementRule.SFGroup.Filter.SimpleFilters](#netmap.PlacementRule.SFGroup.Filter.SimpleFilters) | | | | f_args | [PlacementRule.SFGroup.Filter.SimpleFilters](#netmap.PlacementRule.SFGroup.Filter.SimpleFilters) | | |
<a name="netmap.PlacementRule.SFGroup.Filter.SimpleFilters"></a> <a name="netmap.PlacementRule.SFGroup.Filter.SimpleFilters"></a>
@ -113,7 +113,7 @@ Groups attributes of the NeoFS node.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| Filters | [PlacementRule.SFGroup.Filter.SimpleFilter](#netmap.PlacementRule.SFGroup.Filter.SimpleFilter) | repeated | | | filters | [PlacementRule.SFGroup.Filter.SimpleFilter](#netmap.PlacementRule.SFGroup.Filter.SimpleFilter) | repeated | |
<a name="netmap.PlacementRule.SFGroup.Selector"></a> <a name="netmap.PlacementRule.SFGroup.Selector"></a>
@ -124,8 +124,8 @@ Groups attributes of the NeoFS node.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| Count | [uint32](#uint32) | | | | count | [uint32](#uint32) | | |
| Key | [string](#string) | | | | key | [string](#string) | | |
<!-- end messages --> <!-- end messages -->
@ -137,9 +137,9 @@ Represents the enumeration of various states of the NeoFS node.
| Name | Number | Description | | Name | Number | Description |
| ---- | ------ | ----------- | | ---- | ------ | ----------- |
| Unknown | 0 | Undefined state. | | UNKNOWN | 0 | Undefined state. |
| Online | 1 | Active state on the network. | | ONLINE | 1 | Active state in the network. |
| Offline | 2 | Network unavailable state. | | OFFLINE | 2 | Network unavailable state. |

136
proto-docs/object.md
View file

@ -148,10 +148,10 @@ calculated for XORed data.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| Address | [refs.Address](#refs.Address) | | Carries the address of the object to be deleted. | | address | [refs.Address](#refs.Address) | | Carries the address of the object to be deleted. |
| OwnerID | [refs.OwnerID](#refs.OwnerID) | | Carries identifier the object owner. | | owner_id | [refs.OwnerID](#refs.OwnerID) | | Carries identifier the object owner. |
| MetaHeader | [service.RequestMetaHeader](#service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. | | 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. |
| VerifyHeader | [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. | | 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. |
<a name="object.DeleteResponse"></a> <a name="object.DeleteResponse"></a>
@ -170,11 +170,11 @@ in distributed system.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| Address | [refs.Address](#refs.Address) | | Carries address of the object that contains the requested payload range. | | 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. | | ranges | [Range](#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. | | salt | [bytes](#bytes) | | Carries binary salt to XOR object payload ranges before hash calculation. |
| MetaHeader | [service.RequestMetaHeader](#service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. | | 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. |
| VerifyHeader | [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. | | 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. |
<a name="object.GetRangeHashResponse"></a> <a name="object.GetRangeHashResponse"></a>
@ -185,7 +185,7 @@ in distributed system.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| HashList | [bytes](#bytes) | repeated | Carries list of homomorphic hashes in a binary format. | | hash_list | [bytes](#bytes) | repeated | Carries list of homomorphic hashes in a binary format. |
<a name="object.GetRangeRequest"></a> <a name="object.GetRangeRequest"></a>
@ -196,10 +196,10 @@ in distributed system.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| Address | [refs.Address](#refs.Address) | | Address carries address of the object that contains the requested payload range. | | 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. | | range | [Range](#object.Range) | | Range carries the parameters of the requested payload range. |
| MetaHeader | [service.RequestMetaHeader](#service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. | | 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. |
| VerifyHeader | [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. | | 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. |
<a name="object.GetRangeResponse"></a> <a name="object.GetRangeResponse"></a>
@ -210,7 +210,7 @@ in distributed system.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| Chunk | [bytes](#bytes) | | Carries part of the object payload. | | chunk | [bytes](#bytes) | | Carries part of the object payload. |
<a name="object.GetRequest"></a> <a name="object.GetRequest"></a>
@ -221,10 +221,10 @@ in distributed system.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| Address | [refs.Address](#refs.Address) | | Carries the address of the requested object. | | address | [refs.Address](#refs.Address) | | Carries the 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. | | 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. |
| MetaHeader | [service.RequestMetaHeader](#service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. | | 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. |
| VerifyHeader | [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. | | 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. |
<a name="object.GetResponse"></a> <a name="object.GetResponse"></a>
@ -235,8 +235,8 @@ in distributed system.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| Header | [Header](#object.Header) | | Carries the object header. | | header | [Header](#object.Header) | | Carries the object header. |
| Chunk | [bytes](#bytes) | | Carries part of the object payload. | | chunk | [bytes](#bytes) | | Carries part of the object payload. |
<a name="object.HeadRequest"></a> <a name="object.HeadRequest"></a>
@ -247,11 +247,11 @@ in distributed system.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| Address | [refs.Address](#refs.Address) | | Carries the address of the object with the requested header. | | address | [refs.Address](#refs.Address) | | Carries the address of the object with the requested header. |
| MainOnly | [bool](#bool) | | Carries the option to crop header to main part. | | main_only | [bool](#bool) | | Carries the option to crop header to main part. |
| 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. | | 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. |
| MetaHeader | [service.RequestMetaHeader](#service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. | | 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. |
| VerifyHeader | [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. | | 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. |
<a name="object.HeadResponse"></a> <a name="object.HeadResponse"></a>
@ -262,7 +262,7 @@ in distributed system.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| Header | [Header](#object.Header) | | Carries the requested object header. | | header | [Header](#object.Header) | | Carries the requested object header. |
<a name="object.PutRequest"></a> <a name="object.PutRequest"></a>
@ -274,9 +274,9 @@ in distributed system.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| init | [PutRequest.Init](#object.PutRequest.Init) | | Carries the initialization parameters of the object stream. | | init | [PutRequest.Init](#object.PutRequest.Init) | | Carries the initialization parameters of the object stream. |
| Chunk | [bytes](#bytes) | | Carries part of the object payload. | | chunk | [bytes](#bytes) | | Carries part of the object payload. |
| MetaHeader | [service.RequestMetaHeader](#service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. | | 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. |
| VerifyHeader | [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. | | 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. |
<a name="object.PutRequest.Init"></a> <a name="object.PutRequest.Init"></a>
@ -287,8 +287,8 @@ Groups initialization parameters of object placement in NeoFS.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| Header | [Header](#object.Header) | | Carries the header of the object to save in the system. | | header | [Header](#object.Header) | | Carries the header of the object to save in the system. |
| CopiesNumber | [uint32](#uint32) | | Carries the number of the object copies to store within the RPC call. Default zero value is processed according to the container placement rules. | | copies_number | [uint32](#uint32) | | Carries the 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="object.PutResponse"></a>
@ -299,7 +299,7 @@ Groups initialization parameters of object placement in NeoFS.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| ObjectID | [refs.ObjectID](#refs.ObjectID) | | Carries identifier of the saved object. It is used to access an object in the container. | | object_id | [refs.ObjectID](#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="object.Range"></a>
@ -310,8 +310,8 @@ Range groups the parameters of object payload range.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| Offset | [uint64](#uint64) | | Carries the offset of the range from the object payload start. | | offset | [uint64](#uint64) | | Carries the offset of the range from the object payload start. |
| Length | [uint64](#uint64) | | Carries the length of the object payload range. | | length | [uint64](#uint64) | | Carries the length of the object payload range. |
<a name="object.SearchRequest"></a> <a name="object.SearchRequest"></a>
@ -322,10 +322,10 @@ Range groups the parameters of object payload range.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| ContainerID | [refs.ContainerID](#refs.ContainerID) | | Carries search container identifier. | | container_id | [refs.ContainerID](#refs.ContainerID) | | Carries search container identifier. |
| query | [SearchRequest.Query](#object.SearchRequest.Query) | | | | query | [SearchRequest.Query](#object.SearchRequest.Query) | | |
| MetaHeader | [service.RequestMetaHeader](#service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. | | 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. |
| VerifyHeader | [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. | | 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. |
<a name="object.SearchRequest.Query"></a> <a name="object.SearchRequest.Query"></a>
@ -336,8 +336,8 @@ Range groups the parameters of object payload range.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| Version | [uint32](#uint32) | | | | version | [uint32](#uint32) | | |
| Filters | [SearchRequest.Query.Filter](#object.SearchRequest.Query.Filter) | repeated | | | filters | [SearchRequest.Query.Filter](#object.SearchRequest.Query.Filter) | repeated | |
<a name="object.SearchRequest.Query.Filter"></a> <a name="object.SearchRequest.Query.Filter"></a>
@ -348,9 +348,9 @@ Range groups the parameters of object payload range.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| matchType | [SearchRequest.Query.Filter.MatchType](#object.SearchRequest.Query.Filter.MatchType) | | | | match_type | [SearchRequest.Query.Filter.MatchType](#object.SearchRequest.Query.Filter.MatchType) | | |
| Name | [string](#string) | | | | name | [string](#string) | | |
| Value | [string](#string) | | | | value | [string](#string) | | |
<a name="object.SearchResponse"></a> <a name="object.SearchResponse"></a>
@ -361,7 +361,7 @@ Range groups the parameters of object payload range.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| IDList | [refs.ObjectID](#refs.ObjectID) | repeated | Carries list of object identifiers that match the search query. | | id_list | [refs.ObjectID](#refs.ObjectID) | repeated | Carries list of object identifiers that match the search query. |
<!-- end messages --> <!-- end messages -->
@ -373,8 +373,8 @@ Range groups the parameters of object payload range.
| Name | Number | Description | | Name | Number | Description |
| ---- | ------ | ----------- | | ---- | ------ | ----------- |
| MatchUnknown | 0 | | | MATCH_UNKNOWN | 0 | |
| StringEqual | 1 | | | STRING_EQUAL | 1 | |
<!-- end enums --> <!-- end enums -->
@ -412,12 +412,12 @@ the NeoFS sub-systems.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| integrity | [Header.Extended.Integrity](#object.Header.Extended.Integrity) | | Integrity carries object integrity evidence. | | integrity | [Header.Extended.Integrity](#object.Header.Extended.Integrity) | | integrity carries object integrity evidence. |
| Attributes | [Header.Extended.Attribute](#object.Header.Extended.Attribute) | repeated | Attributes carries list of the object attributes in a string key-value format. | | attributes | [Header.Extended.Attribute](#object.Header.Extended.Attribute) | repeated | attributes carries list of the object attributes in a string key-value format. |
| CreationEpoch | [uint64](#uint64) | | CreationEpoch carries number of NeoFS epoch on which the object was created. | | creation_epoch | [uint64](#uint64) | | creation_epoch carries number of NeoFS epoch on which the object was created. |
| tombstone | [Header.Extended.Tombstone](#object.Header.Extended.Tombstone) | | Tombstone marks the object to be deleted. | | tombstone | [Header.Extended.Tombstone](#object.Header.Extended.Tombstone) | | Tombstone marks the object to be deleted. |
| HomomorphicHash | [bytes](#bytes) | | HomomorphicHash carries homomorphic hash of the object payload. | | homomorphic_hash | [bytes](#bytes) | | homomorphic_hash carries homomorphic hash of the object payload. |
| storageGroup | [Header.Extended.StorageGroup](#object.Header.Extended.StorageGroup) | | StorageGroup marks an object containing information about a storage group. | | storage_group | [Header.Extended.StorageGroup](#object.Header.Extended.StorageGroup) | | StorageGroup marks an object containing information about a storage group. |
| split | [Header.Extended.Split](#object.Header.Extended.Split) | | Split carries the position of the object in the split hierarchy. | | split | [Header.Extended.Split](#object.Header.Extended.Split) | | Split carries the position of the object in the split hierarchy. |
@ -429,8 +429,8 @@ Attribute groups the parameters of the object attributes.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| Key | [string](#string) | | Key carries the string key to the object attribute. | | key | [string](#string) | | key carries the string key to the object attribute. |
| Value | [string](#string) | | Value carries the string value of the object attribute. | | value | [string](#string) | | value carries the string value of the object attribute. |
<a name="object.Header.Extended.Integrity"></a> <a name="object.Header.Extended.Integrity"></a>
@ -441,11 +441,11 @@ Integrity groups evidence of the integrity of an object's structure.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| PayloadChecksum | [bytes](#bytes) | | PayloadChecksum carries the checksum of object payload bytes. Changing any byte of the payload changes the checksum. It is calculated as a SHA-256 hash over payload bytes. | | payload_checksum | [bytes](#bytes) | | payload_checksum carries the checksum of object payload bytes. Changing any byte of the payload changes the checksum. It is calculated as a SHA-256 hash over payload bytes. |
| HeaderChecksum | [bytes](#bytes) | | HeaderChecksum carries checksum of the object header structure. It covers all object attributes. Changing any field of the object except CreatorKey and ChecksumSignature changes the checksum. PayloadChecksum and HeaderChecksum cannot be merged due to the need to verify the header in the absence of a payload (e.g. in object.Head rpc). It is calculated as a SHA-256 hash over marshaled object header with cut CreatorKey and ChecksumSignature. | | header_checksum | [bytes](#bytes) | | header_checksum carries checksum of the object header structure. It covers all object attributes. Changing any field of the object except CreatorKey and ChecksumSignature changes the checksum. payload_checksum and header_checksum cannot be merged due to the need to verify the header in the absence of a payload (e.g. in object.Head rpc). It is calculated as a SHA-256 hash over marshaled object header with cut creator_key and checksum_signature. |
| SessionToken | [service.Token](#service.Token) | | SessionToken carries token of the session within which the object was created. If session token is presented in object, it acts as the user's proof of the correctness of the CreatorKey. | | session_token | [service.Token](#service.Token) | | session_token carries token of the session within which the object was created. If session token is presented in object, it acts as the user's proof of the correctness of the creator_key. |
| CreatorKey | [bytes](#bytes) | | CreatorKey carries public key of the object creator in a binary format. | | creator_key | [bytes](#bytes) | | creator_key carries public key of the object creator in a binary format. |
| ChecksumSignature | [bytes](#bytes) | | ChecksumSignature carries signature of the structure checksum by the object creator. | | checksum_signature | [bytes](#bytes) | | checksum_signature carries signature of the structure checksum by the object creator. |
<a name="object.Header.Extended.Split"></a> <a name="object.Header.Extended.Split"></a>
@ -456,11 +456,11 @@ Split groups information about spawning the object through a payload splitting.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| Parent | [refs.ObjectID](#refs.ObjectID) | | Parent carries identifier of the origin object. | | parent | [refs.ObjectID](#refs.ObjectID) | | Parent carries identifier of the origin object. |
| Previous | [refs.ObjectID](#refs.ObjectID) | | Previous carries identifier of the left split neighbor. | | previous | [refs.ObjectID](#refs.ObjectID) | | Previous carries identifier of the left split neighbor. |
| Next | [refs.ObjectID](#refs.ObjectID) | | Previous carries identifier of the right split neighbor. | | next | [refs.ObjectID](#refs.ObjectID) | | Next carries identifier of the right split neighbor. |
| Children | [refs.ObjectID](#refs.ObjectID) | repeated | Children carries list of identifiers of the objects generated by splitting the current. | | children | [refs.ObjectID](#refs.ObjectID) | repeated | Children carries list of identifiers of the objects generated by splitting the current. |
| Origin | [Header](#object.Header) | | Origin carries the header of the origin object. | | origin | [Header](#object.Header) | | Origin carries the header of the origin object. |
<a name="object.Header.Extended.StorageGroup"></a> <a name="object.Header.Extended.StorageGroup"></a>
@ -486,9 +486,9 @@ Message fields are presented in all NeoFS objects.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| PayloadLength | [uint64](#uint64) | | PayloadLength carries length of the object payload. Each object has a fixed payload length since it's immutable. | | payload_length | [uint64](#uint64) | | payload_length carries length of the object payload. Each object has a fixed payload length since it's immutable. |
| Address | [refs.Address](#refs.Address) | | Address carries object address in the NeoFS system. It encapsulates the object and the container identifiers. | | address | [refs.Address](#refs.Address) | | address carries object address in the NeoFS system. It encapsulates the object and the container identifiers. |
| OwnerID | [refs.OwnerID](#refs.OwnerID) | | OwnerID carries identifier of the object owner. | | owner_id | [refs.OwnerID](#refs.OwnerID) | | owner_id carries identifier of the object owner. |
<a name="object.Object"></a> <a name="object.Object"></a>
@ -500,8 +500,8 @@ It consists of payload data with additional service information.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| Header | [Header](#object.Header) | | Header carries the object header. | | header | [Header](#object.Header) | | Header carries the object header. |
| Payload | [bytes](#bytes) | | Payload carries the object payload bytes. | | payload | [bytes](#bytes) | | Payload carries the object payload bytes. |
<!-- end messages --> <!-- end messages -->

10
proto-docs/refs.md
View file

@ -33,8 +33,8 @@ Address of object (container id + object id)
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| ContainerID | [ContainerID](#refs.ContainerID) | | ContainerID carries container identifier. | | container_id | [ContainerID](#refs.ContainerID) | | container_id carries container identifier. |
| ObjectID | [ObjectID](#refs.ObjectID) | | ObjectID carries object identifier. | | object_id | [ObjectID](#refs.ObjectID) | | object_id carries object identifier. |
<a name="refs.ContainerID"></a> <a name="refs.ContainerID"></a>
@ -45,7 +45,7 @@ ContainerID groups information about the NeoFS container identifier.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| Value | [bytes](#bytes) | | Value carries the container identifier in a binary format. | | value | [bytes](#bytes) | | value carries the container identifier in a binary format. |
<a name="refs.ObjectID"></a> <a name="refs.ObjectID"></a>
@ -56,7 +56,7 @@ ObjectID groups information about the NeoFS object identifier.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| Value | [bytes](#bytes) | | Value carries the object identifier in a binary format. | | value | [bytes](#bytes) | | value carries the object identifier in a binary format. |
<a name="refs.OwnerID"></a> <a name="refs.OwnerID"></a>
@ -67,7 +67,7 @@ OwnerID group information about the owner of the NeoFS container.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| Value | [bytes](#bytes) | | Value carries the identifier of the container owner in a binary format. | | value | [bytes](#bytes) | | value carries the identifier of the container owner in a binary format. |
<!-- end messages --> <!-- end messages -->

64
proto-docs/service.md
View file

@ -43,8 +43,8 @@ RequestMetaHeader contains information about request meta headers.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| TTL | [uint32](#uint32) | | Carries maximum number of nodes in the request route. | | ttl | [uint32](#uint32) | | Carries maximum number of nodes in the request route. |
| XHeaders | [RequestMetaHeader.XHeader](#service.RequestMetaHeader.XHeader) | repeated | Carries request X-Headers. | | x_headers | [RequestMetaHeader.XHeader](#service.RequestMetaHeader.XHeader) | repeated | Carries request X-Headers. |
<a name="service.RequestMetaHeader.XHeader"></a> <a name="service.RequestMetaHeader.XHeader"></a>
@ -55,8 +55,8 @@ RequestMetaHeader contains information about request meta headers.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| Key | [string](#string) | | Carries key to the X-Header. | | key | [string](#string) | | Carries key to the X-Header. |
| Value | [string](#string) | | Carries value of the X-Header. | | value | [string](#string) | | Carries value of the X-Header. |
<!-- end messages --> <!-- end messages -->
@ -81,9 +81,9 @@ BearerTokenMsg carries information about request ACL rules with limited lifetime
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| TokenInfo | [BearerTokenMsg.Info](#service.BearerTokenMsg.Info) | | TokenInfo is a grouped information about token | | token_info | [BearerTokenMsg.Info](#service.BearerTokenMsg.Info) | | token_info is a grouped information about token |
| OwnerKey | [bytes](#bytes) | | OwnerKey is a public key of the token owner | | owner_key | [bytes](#bytes) | | owner_key is a public key of the token owner |
| Signature | [bytes](#bytes) | | Signature is a signature of token information | | signature | [bytes](#bytes) | | Signature is a signature of token information |
<a name="service.BearerTokenMsg.Info"></a> <a name="service.BearerTokenMsg.Info"></a>
@ -94,9 +94,9 @@ BearerTokenMsg carries information about request ACL rules with limited lifetime
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| EACLTable | [acl.EACLTable](#acl.EACLTable) | | EACLTable carries table of extended ACL rules. | | eacl_table | [acl.EACLTable](#acl.EACLTable) | | EACLTable carries table of extended ACL rules. |
| OwnerID | [refs.OwnerID](#refs.OwnerID) | | OwnerID carries identifier of the token owner. | | owner_id | [refs.OwnerID](#refs.OwnerID) | | OwnerID carries identifier of the token owner. |
| ValidUntil | [uint64](#uint64) | | ValidUntil carries a last epoch of token lifetime | | valid_until | [uint64](#uint64) | | ValidUntil carries a last epoch of token lifetime |
<a name="service.RequestVerificationHeader"></a> <a name="service.RequestVerificationHeader"></a>
@ -107,9 +107,9 @@ RequestVerificationHeader is a set of signatures of every NeoFS Node that proces
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| Signatures | [RequestVerificationHeader.Signature](#service.RequestVerificationHeader.Signature) | repeated | Signatures is a set of signatures of every passed NeoFS Node | | signatures | [RequestVerificationHeader.Signature](#service.RequestVerificationHeader.Signature) | repeated | Signatures is a set of signatures of every passed NeoFS Node |
| Token | [Token](#service.Token) | | Token is a token of the session within which the request is sent | | token | [Token](#service.Token) | | Token is a token of the session within which the request is sent |
| Bearer | [BearerTokenMsg](#service.BearerTokenMsg) | | Bearer is a Bearer token of the request | | bearer | [BearerTokenMsg](#service.BearerTokenMsg) | | Bearer is a Bearer token of the request |
<a name="service.RequestVerificationHeader.Signature"></a> <a name="service.RequestVerificationHeader.Signature"></a>
@ -120,8 +120,8 @@ RequestVerificationHeader is a set of signatures of every NeoFS Node that proces
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| Key | [bytes](#bytes) | | Key is compressed public key used for signature. | | key | [bytes](#bytes) | | Key is compressed public key used for signature. |
| Sign | [bytes](#bytes) | | Sign is signature of the request or session key. | | sign | [bytes](#bytes) | | Sign is signature of the request or session key. |
<a name="service.Token"></a> <a name="service.Token"></a>
@ -132,8 +132,8 @@ User token granting rights for object manipulation
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| TokenInfo | [Token.Info](#service.Token.Info) | | TokenInfo is a grouped information about token | | token_info | [Token.Info](#service.Token.Info) | | token_info is a grouped information about token |
| Signature | [bytes](#bytes) | | Signature is a signature of session token information | | signature | [bytes](#bytes) | | Signature is a signature of session token information |
<a name="service.Token.Info"></a> <a name="service.Token.Info"></a>
@ -144,13 +144,13 @@ User token granting rights for object manipulation
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| ID | [bytes](#bytes) | | ID is a token identifier. valid UUIDv4 represented in bytes | | id | [bytes](#bytes) | | ID is a token identifier. valid UUIDv4 represented in bytes |
| OwnerID | [refs.OwnerID](#refs.OwnerID) | | OwnerID carries identifier of the manipulation object owner. | | owner_id | [refs.OwnerID](#refs.OwnerID) | | OwnerID carries identifier of the manipulation object owner. |
| verb | [Token.Info.Verb](#service.Token.Info.Verb) | | Verb is a type of request for which the token is issued | | verb | [Token.Info.Verb](#service.Token.Info.Verb) | | Verb is a type of request for which the token is issued |
| Address | [refs.Address](#refs.Address) | | Address is an object address for which token is issued | | address | [refs.Address](#refs.Address) | | Address is an object address for which token is issued |
| Lifetime | [TokenLifetime](#service.TokenLifetime) | | Lifetime is a lifetime of the session | | lifetime | [TokenLifetime](#service.TokenLifetime) | | Lifetime is a lifetime of the session |
| SessionKey | [bytes](#bytes) | | SessionKey is a public key of session key | | session_key | [bytes](#bytes) | | SessionKey is a public key of session key |
| OwnerKey | [bytes](#bytes) | | OwnerKey is a public key of the token owner | | owner_key | [bytes](#bytes) | | OwnerKey is a public key of the token owner |
<a name="service.TokenLifetime"></a> <a name="service.TokenLifetime"></a>
@ -161,8 +161,8 @@ TokenLifetime carries a group of lifetime parameters of the token
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| Created | [uint64](#uint64) | | Created carries an initial epoch of token lifetime | | created | [uint64](#uint64) | | created carries an initial epoch of token lifetime |
| ValidUntil | [uint64](#uint64) | | ValidUntil carries a last epoch of token lifetime | | valid_until | [uint64](#uint64) | | valid_until carries a last epoch of token lifetime |
<!-- end messages --> <!-- end messages -->
@ -174,13 +174,13 @@ Verb is an enumeration of session request types
| Name | Number | Description | | Name | Number | Description |
| ---- | ------ | ----------- | | ---- | ------ | ----------- |
| Put | 0 | Put refers to object.Put RPC call | | PUT | 0 | Put refers to object.Put RPC call |
| Get | 1 | Get refers to object.Get RPC call | | GET | 1 | Get refers to object.Get RPC call |
| Head | 2 | Head refers to object.Head RPC call | | HEAD | 2 | Head refers to object.Head RPC call |
| Search | 3 | Search refers to object.Search RPC call | | SEARCH | 3 | Search refers to object.Search RPC call |
| Delete | 4 | Delete refers to object.Delete RPC call | | DELETE | 4 | Delete refers to object.Delete RPC call |
| Range | 5 | Range refers to object.GetRange RPC call | | RANGE | 5 | Range refers to object.GetRange RPC call |
| RangeHash | 6 | RangeHash refers to object.GetRangeHash RPC call | | RANGEHASH | 6 | RangeHash refers to object.GetRangeHash RPC call |
<!-- end enums --> <!-- end enums -->

12
proto-docs/session.md
View file

@ -52,10 +52,10 @@ CreateRequest carries an information necessary for opening a session.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| OwnerID | [refs.OwnerID](#refs.OwnerID) | | Carries an identifier of a session initiator. | | owner_id | [refs.OwnerID](#refs.OwnerID) | | Carries an identifier of a session initiator. |
| Lifetime | [service.TokenLifetime](#service.TokenLifetime) | | Carries a lifetime of the session. | | lifetime | [service.TokenLifetime](#service.TokenLifetime) | | Carries a lifetime of the session. |
| MetaHeader | [service.RequestMetaHeader](#service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. | | 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. |
| VerifyHeader | [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. | | 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. |
<a name="session.CreateResponse"></a> <a name="session.CreateResponse"></a>
@ -66,8 +66,8 @@ CreateResponse carries an information about the opened session.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| ID | [bytes](#bytes) | | ID carries an identifier of session token. | | id | [bytes](#bytes) | | id carries an identifier of session token. |
| SessionKey | [bytes](#bytes) | | SessionKey carries a session public key. | | session_key | [bytes](#bytes) | | session_key carries a session public key. |
<!-- end messages --> <!-- end messages -->

8
proto-docs/storagegroup.md
View file

@ -31,10 +31,10 @@ The storage group consists of objects from single container.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| ValidationDataSize | [uint64](#uint64) | | ValidationDataSize carries the total size of the payloads of the storage group members. | | validation_data_size | [uint64](#uint64) | | validation_data_size carries the total size of the payloads of the storage group members. |
| ValidationHash | [bytes](#bytes) | | ValidationHash 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. | | 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. |
| ExpirationEpoch | [uint64](#uint64) | | ExpirationEpoch carries last NeoFS epoch number of the storage group lifetime. | | 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 | [refs.ObjectID](#refs.ObjectID) | repeated | Members carries the list of identifiers of the object storage group members. The list is strictly ordered. |
<!-- end messages --> <!-- end messages -->