Skip to content

Commit 1bc50fc

Browse files
committed
[nspcc-dev#227] *: Regenerate docs
Signed-off-by: Pavel Karpy <carpawell@nspcc.ru>
1 parent 2f52216 commit 1bc50fc

File tree

13 files changed

+214
-141
lines changed

13 files changed

+214
-141
lines changed

proto-docs/accounting.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Accounting service provides methods for interaction with NeoFS sidechain via
3939
other NeoFS nodes to get information about the account balance. Deposit and
4040
Withdraw operations can't be implemented here, as they require Mainnet NeoFS
4141
smart contract invocation. Transfer operations between internal NeoFS
42-
accounts are possible, if both use the same token type.
42+
accounts are possible if both use the same token type.
4343

4444
```
4545
rpc Balance(BalanceRequest) returns (BalanceResponse);
@@ -77,7 +77,7 @@ BalanceRequest message
7777
<a name="neo.fs.v2.accounting.BalanceRequest.Body"></a>
7878

7979
### Message BalanceRequest.Body
80-
To indicate the account for which the balance is requested, it's identifier
80+
To indicate the account for which the balance is requested, its identifier
8181
is used. It can be any existing account in NeoFS sidechain `Balance` smart
8282
contract. If omitted, client implementation MUST set it to the request's
8383
signer `OwnerID`.
@@ -105,7 +105,7 @@ BalanceResponse message
105105

106106
### Message BalanceResponse.Body
107107
The amount of funds in GAS token for the `OwnerID`'s account requested.
108-
Balance is `Decimal` format to avoid precision issues with rounding.
108+
Balance is given in the `Decimal` format to avoid precision issues with rounding.
109109

110110

111111
| Field | Type | Label | Description |
@@ -141,7 +141,7 @@ description.
141141

142142
| Field | Type | Label | Description |
143143
| ----- | ---- | ----- | ----------- |
144-
| value | [int64](#int64) | | Number in smallest Token fractions. |
144+
| value | [int64](#int64) | | Number in the smallest Token fractions. |
145145
| precision | [uint32](#uint32) | | Precision value indicating how many smallest fractions can be in one integer. |
146146

147147
<!-- end messages -->

proto-docs/acl.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ like [JWT](https://jwt.io), it has a limited lifetime and scope, hence can be
3838
used in the similar use cases, like providing authorisation to externally
3939
authenticated party.
4040

41-
BearerToken can be issued only by container's owner and must be signed using
42-
the key associated with container's `OwnerID`.
41+
BearerToken can be issued only by the container's owner and must be signed using
42+
the key associated with the container's `OwnerID`.
4343

4444

4545
| Field | Type | Label | Description |
@@ -51,14 +51,14 @@ the key associated with container's `OwnerID`.
5151
<a name="neo.fs.v2.acl.BearerToken.Body"></a>
5252

5353
### Message BearerToken.Body
54-
Bearer Token body structure contains Extended ACL table issued by container
55-
owner with additional information preventing token's abuse.
54+
Bearer Token body structure contains Extended ACL table issued by the container
55+
owner with additional information preventing token abuse.
5656

5757

5858
| Field | Type | Label | Description |
5959
| ----- | ---- | ----- | ----------- |
60-
| eacl_table | [EACLTable](#neo.fs.v2.acl.EACLTable) | | Table of Extended ACL rules to use instead of the ones attached to the container |
61-
| owner_id | [neo.fs.v2.refs.OwnerID](#neo.fs.v2.refs.OwnerID) | | `OwnerID` to whom the token was issued. Must match the request originator's `OwnerID`. If empty, any token bearer will be accepted. |
60+
| eacl_table | [EACLTable](#neo.fs.v2.acl.EACLTable) | | Table of Extended ACL rules to use instead of the ones attached to the container. If it contains `container_id` field, bearer token is only valid for this specific container. Otherwise, any container of the same owner is allowed. |
61+
| owner_id | [neo.fs.v2.refs.OwnerID](#neo.fs.v2.refs.OwnerID) | | `OwnerID` defines to whom the token was issued. It must match the request originator's `OwnerID`. If empty, any token bearer will be accepted. |
6262
| lifetime | [BearerToken.Body.TokenLifetime](#neo.fs.v2.acl.BearerToken.Body.TokenLifetime) | | Token expiration and valid time period parameters |
6363

6464

@@ -93,7 +93,7 @@ Describes a single eACL rule.
9393
<a name="neo.fs.v2.acl.EACLRecord.Filter"></a>
9494

9595
### Message EACLRecord.Filter
96-
Filter to check particular properties of the request or object.
96+
Filter to check particular properties of the request or the object.
9797

9898
By default `key` field refers to the corresponding object's `Attribute`.
9999
Some Object's header fields can also be accessed by adding `$Object:`
@@ -149,15 +149,15 @@ keys to match.
149149
<a name="neo.fs.v2.acl.EACLTable"></a>
150150

151151
### Message EACLTable
152-
Extended ACL rules table. Defined a list of ACL rules additionally to Basic
153-
ACL. Extended ACL rules can be attached to the container and can be updated
152+
Extended ACL rules table. A list of ACL rules defined additionally to Basic
153+
ACL. Extended ACL rules can be attached to a container and can be updated
154154
or may be defined in `BearerToken` structure. Please see the corresponding
155-
NeoFS Technical Specification's section for detailed description.
155+
NeoFS Technical Specification section for detailed description.
156156

157157

158158
| Field | Type | Label | Description |
159159
| ----- | ---- | ----- | ----------- |
160-
| version | [neo.fs.v2.refs.Version](#neo.fs.v2.refs.Version) | | eACL format version. Effectively the version of API library used to create eACL Table. |
160+
| version | [neo.fs.v2.refs.Version](#neo.fs.v2.refs.Version) | | eACL format version. Effectively, the version of API library used to create eACL Table. |
161161
| container_id | [neo.fs.v2.refs.ContainerID](#neo.fs.v2.refs.ContainerID) | | Identifier of the container that should use given access control rules |
162162
| records | [EACLRecord](#neo.fs.v2.acl.EACLRecord) | repeated | List of Extended ACL rules |
163163

@@ -233,8 +233,8 @@ Target role of the access control rule in access control list.
233233
| ---- | ------ | ----------- |
234234
| ROLE_UNSPECIFIED | 0 | Unspecified role, default value |
235235
| USER | 1 | User target rule is applied if sender is the owner of the container |
236-
| SYSTEM | 2 | System target rule is applied if sender is the storage node within the container or inner ring node |
237-
| OTHERS | 3 | Others target rule is applied if sender is not user nor system target |
236+
| SYSTEM | 2 | System target rule is applied if sender is a storage node within the container or an inner ring node |
237+
| OTHERS | 3 | Others target rule is applied if sender is neither a user nor a system target |
238238

239239

240240
<!-- end enums -->

proto-docs/audit.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ generated separately.
3131

3232
| Field | Type | Label | Description |
3333
| ----- | ---- | ----- | ----------- |
34-
| version | [neo.fs.v2.refs.Version](#neo.fs.v2.refs.Version) | | Data Audit Result format version. Effectively the version of API library used to report DataAuditResult structure. |
34+
| version | [neo.fs.v2.refs.Version](#neo.fs.v2.refs.Version) | | Data Audit Result format version. Effectively, the version of API library used to report DataAuditResult structure. |
3535
| audit_epoch | [fixed64](#fixed64) | | Epoch number when the Data Audit was conducted |
3636
| container_id | [neo.fs.v2.refs.ContainerID](#neo.fs.v2.refs.ContainerID) | | Container under audit |
3737
| public_key | [bytes](#bytes) | | Public key of the auditing InnerRing node in a binary format |
@@ -40,9 +40,9 @@ generated separately.
4040
| retries | [uint32](#uint32) | | Number of retries done at PoR stage |
4141
| pass_sg | [neo.fs.v2.refs.ObjectID](#neo.fs.v2.refs.ObjectID) | repeated | List of Storage Groups that passed audit PoR stage |
4242
| fail_sg | [neo.fs.v2.refs.ObjectID](#neo.fs.v2.refs.ObjectID) | repeated | List of Storage Groups that failed audit PoR stage |
43-
| hit | [uint32](#uint32) | | Number of sampled objects under audit placed in an optimal way according to the containers placement policy when checking PoP |
44-
| miss | [uint32](#uint32) | | Number of sampled objects under audit placed in suboptimal way according to the containers placement policy, but still at a satisfactory level when checking PoP |
45-
| fail | [uint32](#uint32) | | Number of sampled objects under audit stored in a way not confirming placement policy or not found at all when checking PoP |
43+
| hit | [uint32](#uint32) | | Number of sampled objects under the audit placed in an optimal way according to the containers placement policy when checking PoP |
44+
| miss | [uint32](#uint32) | | Number of sampled objects under the audit placed in suboptimal way according to the containers placement policy, but still at a satisfactory level when checking PoP |
45+
| fail | [uint32](#uint32) | | Number of sampled objects under the audit stored inconsistently with the placement policy or not found at all when checking PoP |
4646
| pass_nodes | [bytes](#bytes) | repeated | List of storage node public keys that passed at least one PDP |
4747
| fail_nodes | [bytes](#bytes) | repeated | List of storage node public keys that failed at least one PDP |
4848

proto-docs/container.md

Lines changed: 34 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ rpc AnnounceUsedSpace(AnnounceUsedSpaceRequest) returns (AnnounceUsedSpaceRespon
8181

8282
`Put` invokes `Container` smart contract's `Put` method and returns
8383
response immediately. After a new block is issued in sidechain, request is
84-
verified by Inner Ring nodes. After one more block in sidechain, container
84+
verified by Inner Ring nodes. After one more block in sidechain, the container
8585
is added into smart contract storage.
8686

8787
Statuses:
@@ -96,7 +96,7 @@ Statuses:
9696

9797
`Delete` invokes `Container` smart contract's `Delete` method and returns
9898
response immediately. After a new block is issued in sidechain, request is
99-
verified by Inner Ring nodes. After one more block in sidechain, container
99+
verified by Inner Ring nodes. After one more block in sidechain, the container
100100
is added into smart contract storage.
101101

102102
Statuses:
@@ -136,7 +136,7 @@ Statuses:
136136
#### Method SetExtendedACL
137137

138138
Invokes 'SetEACL' method of 'Container` smart contract and returns response
139-
immediately. After one more block in sidechain, Extended ACL changes are
139+
immediately. After one more block in sidechain, changes in an Extended ACL are
140140
added into smart contract storage.
141141

142142
Statuses:
@@ -164,7 +164,7 @@ Statuses:
164164
| GetExtendedACL | [GetExtendedACLRequest](#neo.fs.v2.container.GetExtendedACLRequest) | [GetExtendedACLResponse](#neo.fs.v2.container.GetExtendedACLResponse) |
165165
#### Method AnnounceUsedSpace
166166

167-
Announce container used space values for P2P synchronization.
167+
Announces the space values used by the container for P2P synchronization.
168168

169169
Statuses:
170170
- **OK** (0, SECTION_SUCCESS): \
@@ -198,20 +198,20 @@ Container used space announcement body.
198198

199199
| Field | Type | Label | Description |
200200
| ----- | ---- | ----- | ----------- |
201-
| announcements | [AnnounceUsedSpaceRequest.Body.Announcement](#neo.fs.v2.container.AnnounceUsedSpaceRequest.Body.Announcement) | repeated | List of announcements. If nodes share several containers, then announcements transferred in a batch. |
201+
| announcements | [AnnounceUsedSpaceRequest.Body.Announcement](#neo.fs.v2.container.AnnounceUsedSpaceRequest.Body.Announcement) | repeated | List of announcements. If nodes share several containers, announcements are transferred in a batch. |
202202

203203

204204
<a name="neo.fs.v2.container.AnnounceUsedSpaceRequest.Body.Announcement"></a>
205205

206206
### Message AnnounceUsedSpaceRequest.Body.Announcement
207-
Announcement contains used space information about single container.
207+
Announcement contains used space information for a single container.
208208

209209

210210
| Field | Type | Label | Description |
211211
| ----- | ---- | ----- | ----------- |
212-
| epoch | [uint64](#uint64) | | Epoch number for which container size estimation was produced. |
212+
| epoch | [uint64](#uint64) | | Epoch number for which the container size estimation was produced. |
213213
| container_id | [neo.fs.v2.refs.ContainerID](#neo.fs.v2.refs.ContainerID) | | Identifier of the container. |
214-
| used_space | [uint64](#uint64) | | Used space is a sum of object payload sizes of specified container, stored in the node. It must not include inhumed objects. |
214+
| used_space | [uint64](#uint64) | | Used space is a sum of object payload sizes of a specified container, stored in the node. It must not include inhumed objects. |
215215

216216

217217
<a name="neo.fs.v2.container.AnnounceUsedSpaceResponse"></a>
@@ -251,8 +251,8 @@ Container removal request
251251
<a name="neo.fs.v2.container.DeleteRequest.Body"></a>
252252

253253
### Message DeleteRequest.Body
254-
Container removal request body has a signed `ContainerID` as a proof of
255-
container owner's intent. The signature will be verified by `Container`
254+
Container removal request body has signed `ContainerID` as a proof of
255+
the container owner's intent. The signature will be verified by `Container`
256256
smart contract, so signing algorithm must be supported by NeoVM.
257257

258258

@@ -324,9 +324,9 @@ Get Extended ACL
324324
<a name="neo.fs.v2.container.GetExtendedACLResponse.Body"></a>
325325

326326
### Message GetExtendedACLResponse.Body
327-
Get Extended ACL Response body can be empty if the requested container did
328-
not have Extended ACL Table attached or Extended ACL was not allowed at
329-
container creation.
327+
Get Extended ACL Response body can be empty if the requested container does
328+
not have Extended ACL Table attached or Extended ACL has not been allowed at
329+
the time of container creation.
330330

331331

332332
| Field | Type | Label | Description |
@@ -377,14 +377,14 @@ Get container structure
377377

378378
### Message GetResponse.Body
379379
Get container response body does not have container structure signature. It
380-
was already verified on container creation.
380+
has been already verified upon container creation.
381381

382382

383383
| Field | Type | Label | Description |
384384
| ----- | ---- | ----- | ----------- |
385385
| container | [Container](#neo.fs.v2.container.Container) | | Requested container structure |
386386
| signature | [neo.fs.v2.refs.SignatureRFC6979](#neo.fs.v2.refs.SignatureRFC6979) | | Signature of a stable-marshalled container according to RFC-6979. |
387-
| session_token | [neo.fs.v2.session.SessionToken](#neo.fs.v2.session.SessionToken) | | Session token if the container was created within a session |
387+
| session_token | [neo.fs.v2.session.SessionToken](#neo.fs.v2.session.SessionToken) | | Session token if the container has been created within the session |
388388

389389

390390
<a name="neo.fs.v2.container.ListRequest"></a>
@@ -483,7 +483,7 @@ New NeoFS Container creation response
483483
Container put response body contains information about the newly registered
484484
container as seen by `Container` smart contract. `ContainerID` can be
485485
calculated beforehand from the container structure and compared to the one
486-
returned here to make sure everything was done as expected.
486+
returned here to make sure everything has been done as expected.
487487

488488

489489
| Field | Type | Label | Description |
@@ -513,7 +513,7 @@ reference. It will be taken from `EACLTable.container_id` field.
513513

514514
| Field | Type | Label | Description |
515515
| ----- | ---- | ----- | ----------- |
516-
| eacl | [neo.fs.v2.acl.EACLTable](#neo.fs.v2.acl.EACLTable) | | Extended ACL table to set for container |
516+
| eacl | [neo.fs.v2.acl.EACLTable](#neo.fs.v2.acl.EACLTable) | | Extended ACL table to set for the container |
517517
| signature | [neo.fs.v2.refs.SignatureRFC6979](#neo.fs.v2.refs.SignatureRFC6979) | | Signature of stable-marshalled Extended ACL table according to RFC-6979. |
518518

519519

@@ -534,7 +534,7 @@ Set Extended ACL
534534

535535
### Message SetExtendedACLResponse.Body
536536
`SetExtendedACLResponse` has an empty body because the operation is
537-
asynchronous and update should be reflected in `Container` smart contract's
537+
asynchronous and the update should be reflected in `Container` smart contract's
538538
storage after next block is issued in sidechain.
539539

540540

@@ -558,16 +558,16 @@ storage after next block is issued in sidechain.
558558
### Message Container
559559
Container is a structure that defines object placement behaviour. Objects can
560560
be stored only within containers. They define placement rule, attributes and
561-
access control information. ID of the container is a 32 byte long SHA256 hash
561+
access control information. An ID of a container is a 32 byte long SHA256 hash
562562
of stable-marshalled container message.
563563

564564

565565
| Field | Type | Label | Description |
566566
| ----- | ---- | ----- | ----------- |
567-
| version | [neo.fs.v2.refs.Version](#neo.fs.v2.refs.Version) | | Container format version. Effectively the version of API library used to create container. |
567+
| version | [neo.fs.v2.refs.Version](#neo.fs.v2.refs.Version) | | Container format version. Effectively, the version of API library used to create the container. |
568568
| owner_id | [neo.fs.v2.refs.OwnerID](#neo.fs.v2.refs.OwnerID) | | Identifier of the container owner |
569569
| nonce | [bytes](#bytes) | | Nonce is a 16 byte UUIDv4, used to avoid collisions of `ContainerID`s |
570-
| basic_acl | [uint32](#uint32) | | `BasicACL` contains access control rules for owner, system, others groups and permission bits for `BearerToken` and `Extended ACL` |
570+
| basic_acl | [uint32](#uint32) | | `BasicACL` contains access control rules for the owner, system and others groups, as well as permission bits for `BearerToken` and `Extended ACL` |
571571
| attributes | [Container.Attribute](#neo.fs.v2.container.Container.Attribute) | repeated | Attributes represent immutable container's meta data |
572572
| placement_policy | [neo.fs.v2.netmap.PlacementPolicy](#neo.fs.v2.netmap.PlacementPolicy) | | Placement policy for the object inside the container |
573573

@@ -576,8 +576,8 @@ of stable-marshalled container message.
576576

577577
### Message Container.Attribute
578578
`Attribute` is a user-defined Key-Value metadata pair attached to the
579-
container. Container attributes are immutable. They are set at container
580-
creation and can never be added or updated.
579+
container. Container attributes are immutable. They are set at the moment of
580+
container creation and can never be added or updated.
581581

582582
Key name must be a container-unique valid UTF-8 string. Value can't be
583583
empty. Containers with duplicated attribute names or attributes with empty
@@ -586,14 +586,20 @@ values will be considered invalid.
586586
There are some "well-known" attributes affecting system behaviour:
587587

588588
* __NEOFS__SUBNET \
589-
String ID of container's storage subnet. Container can be attached to
590-
only one subnet.
589+
String ID of a container's storage subnet. Any container can be attached to
590+
one subnet only.
591591
* __NEOFS__NAME \
592-
String of human-friendly container name registered as the domain in
592+
String of a human-friendly container name registered as a domain in
593593
NNS contract.
594594
* __NEOFS__ZONE \
595-
String of zone for `__NEOFS__NAME`. Used as TLD of domain name in NNS
596-
contract. If zone is not specified, use default zone: `container`.
595+
String of a zone for `__NEOFS__NAME`. Used as a TLD of a domain name in NNS
596+
contract. If no zone is specified, use default zone: `container`.
597+
* __NEOFS__DISABLE_HOMOMORPHIC_HASHING \
598+
Disables homomorphic hashing for the container if the value equals "true" string.
599+
Any other values are interpreted as missing attribute. Container could be
600+
accepted in a NeoFS network only if the global network hashing configuration
601+
value corresponds with that attribute's value. After container inclusion, network
602+
setting is ignored.
597603

598604
And some well-known attributes used by applications only:
599605

proto-docs/lock.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,10 @@
2525
<a name="neo.fs.v2.lock.Lock"></a>
2626

2727
### Message Lock
28-
Lock objects protects a list of objects from being deleted. Lifetime of the
28+
Lock objects protects a list of objects from being deleted. The lifetime of a
2929
lock object is limited similar to regular objects in
30-
`__NEOFS__EXPIRATION_EPOCH` attribute.
30+
`__NEOFS__EXPIRATION_EPOCH` attribute. Lock object MUST have expiration epoch.
31+
It is impossible to delete a lock object via ObjectService.Delete RPC call.
3132

3233

3334
| Field | Type | Label | Description |

0 commit comments

Comments
 (0)