From c11991aff19c3fce142421f96f24c6be10d96fcd Mon Sep 17 00:00:00 2001 From: Pavel Karpy Date: Wed, 17 Nov 2021 23:54:32 +0300 Subject: [PATCH] [#183] doc: Regenerate docs Signed-off-by: Pavel Karpy --- proto-docs/netmap.md | 1 + proto-docs/refs.md | 16 ++++++++++++ proto-docs/session.md | 2 +- proto-docs/status.md | 6 ++--- proto-docs/subnet.md | 61 +++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 82 insertions(+), 4 deletions(-) create mode 100644 proto-docs/subnet.md diff --git a/proto-docs/netmap.md b/proto-docs/netmap.md index 6a9ceb7..6bb58ed 100644 --- a/proto-docs/netmap.md +++ b/proto-docs/netmap.md @@ -352,6 +352,7 @@ storage policy definition languages. | container_backup_factor | [uint32](#uint32) | | Container backup factor controls how deep NeoFS will search for nodes alternatives to include into container's nodes subset | | selectors | [Selector](#neo.fs.v2.netmap.Selector) | repeated | Set of Selectors to form the container's nodes subset | | filters | [Filter](#neo.fs.v2.netmap.Filter) | repeated | List of named filters to reference in selectors | +| subnet_id | [neo.fs.v2.refs.SubnetID](#neo.fs.v2.refs.SubnetID) | | Subnetwork ID to select nodes from. Zero subnet (default) represents all of the nodes which didn't explicitly opt out of membership. | diff --git a/proto-docs/refs.md b/proto-docs/refs.md index d423de5..e9e46d9 100644 --- a/proto-docs/refs.md +++ b/proto-docs/refs.md @@ -12,6 +12,7 @@ - [ObjectID](#neo.fs.v2.refs.ObjectID) - [OwnerID](#neo.fs.v2.refs.OwnerID) - [Signature](#neo.fs.v2.refs.Signature) + - [SubnetID](#neo.fs.v2.refs.SubnetID) - [Version](#neo.fs.v2.refs.Version) @@ -149,6 +150,21 @@ Signature of something in NeoFS. | sign | [bytes](#bytes) | | Signature | + + +### Message SubnetID +NeoFS subnetwork identifier. + +String representation of a value is base-10 integer. + +JSON representation is an object containing single `value` number field. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| value | [fixed32](#fixed32) | | 4-byte integer subnetwork identifier. | + + ### Message Version diff --git a/proto-docs/session.md b/proto-docs/session.md index 7fb532a..4e24e71 100644 --- a/proto-docs/session.md +++ b/proto-docs/session.md @@ -203,7 +203,7 @@ Information about the response | ttl | [uint32](#uint32) | | Maximum number of intermediate nodes in the request route | | x_headers | [XHeader](#neo.fs.v2.session.XHeader) | repeated | Response X-Headers | | origin | [ResponseMetaHeader](#neo.fs.v2.session.ResponseMetaHeader) | | `ResponseMetaHeader` of the origin request | -| status | [neo.fs.v2.status.Status](#neo.fs.v2.status.Status) | | Status return. | +| status | [neo.fs.v2.status.Status](#neo.fs.v2.status.Status) | | Status return | diff --git a/proto-docs/status.md b/proto-docs/status.md index 7df4ca0..c99e015 100644 --- a/proto-docs/status.md +++ b/proto-docs/status.md @@ -57,8 +57,8 @@ should make the return more detailed. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| code | [uint32](#uint32) | | The status code. | -| message | [string](#string) | | Developer-facing error message. | +| code | [uint32](#uint32) | | The status code | +| message | [string](#string) | | Developer-facing error message | | details | [Status.Detail](#neo.fs.v2.status.Status.Detail) | repeated | Data detailing the outcome of the operation. Must be unique by ID. | @@ -86,7 +86,7 @@ Section of failed statuses independent of the operation. | Name | Number | Description | | ---- | ------ | ----------- | -| INTERNAL | 0 | [**1024**] Internal server error, default failure. Not detailed.. If the server cannot match failed outcome to the code , it should use this code. | +| INTERNAL | 0 | [**1024**] Internal server error, default failure. Not detailed. If the server cannot match failed outcome to the code, it should use this code. | diff --git a/proto-docs/subnet.md b/proto-docs/subnet.md new file mode 100644 index 0000000..a766dc6 --- /dev/null +++ b/proto-docs/subnet.md @@ -0,0 +1,61 @@ +# Protocol Documentation + + +## Table of Contents + +- [subnet/types.proto](#subnet/types.proto) + + - Messages + - [SubnetInfo](#neo.fs.v2.subnet.SubnetInfo) + + +- [Scalar Value Types](#scalar-value-types) + + + + +

Top

+ +## subnet/types.proto + + + + + + + +### Message SubnetInfo +NeoFS subnetwork description + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [neo.fs.v2.refs.SubnetID](#neo.fs.v2.refs.SubnetID) | | Unique subnet identifier. Missing ID is equivalent to zero (default subnetwork) ID. | +| owner | [neo.fs.v2.refs.OwnerID](#neo.fs.v2.refs.OwnerID) | | Identifier of the subnetwork owner | + + + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ Type | Java Type | Python Type | +| ----------- | ----- | -------- | --------- | ----------- | +| double | | double | double | float | +| float | | float | float | float | +| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | +| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | +| sfixed32 | Always four bytes. | int32 | int | int | +| sfixed64 | Always eight bytes. | int64 | long | int/long | +| bool | | bool | boolean | boolean | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | +