Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/Add subnet messages #183

Merged
merged 2 commits into from
Nov 18, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions proto-docs/netmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. |


<a name="neo.fs.v2.netmap.Replica"></a>
Expand Down
16 changes: 16 additions & 0 deletions proto-docs/refs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)


Expand Down Expand Up @@ -149,6 +150,21 @@ Signature of something in NeoFS.
| sign | [bytes](#bytes) | | Signature |


<a name="neo.fs.v2.refs.SubnetID"></a>

### 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. |


<a name="neo.fs.v2.refs.Version"></a>

### Message Version
Expand Down
2 changes: 1 addition & 1 deletion proto-docs/session.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |


<a name="neo.fs.v2.session.ResponseVerificationHeader"></a>
Expand Down
6 changes: 3 additions & 3 deletions proto-docs/status.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. |


Expand Down Expand Up @@ -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. |



Expand Down
61 changes: 61 additions & 0 deletions proto-docs/subnet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Protocol Documentation
<a name="top"></a>

## Table of Contents

- [subnet/types.proto](#subnet/types.proto)

- Messages
- [SubnetInfo](#neo.fs.v2.subnet.SubnetInfo)


- [Scalar Value Types](#scalar-value-types)



<a name="subnet/types.proto"></a>
<p align="right"><a href="#top">Top</a></p>

## subnet/types.proto


<!-- end services -->


<a name="neo.fs.v2.subnet.SubnetInfo"></a>

### 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 |

<!-- end messages -->

<!-- end enums -->



## Scalar Value Types

| .proto Type | Notes | C++ Type | Java Type | Python Type |
| ----------- | ----- | -------- | --------- | ----------- |
| <a name="double" /> double | | double | double | float |
| <a name="float" /> float | | float | float | float |
| <a name="int32" /> 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 |
| <a name="int64" /> 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 |
| <a name="uint32" /> uint32 | Uses variable-length encoding. | uint32 | int | int/long |
| <a name="uint64" /> uint64 | Uses variable-length encoding. | uint64 | long | int/long |
| <a name="sint32" /> sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int |
| <a name="sint64" /> sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long |
| <a name="fixed32" /> fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int |
| <a name="fixed64" /> fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long |
| <a name="sfixed32" /> sfixed32 | Always four bytes. | int32 | int | int |
| <a name="sfixed64" /> sfixed64 | Always eight bytes. | int64 | long | int/long |
| <a name="bool" /> bool | | bool | boolean | boolean |
| <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode |
| <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str |

18 changes: 18 additions & 0 deletions subnet/types.proto
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
syntax = "proto3";

package neo.fs.v2.subnet;

option go_package = "github.com/nspcc-dev/neofs-api-go/v2/subnet/grpc;subnet";
option csharp_namespace = "Neo.FileStorage.API.Subnet";

import "refs/types.proto";

// NeoFS subnetwork description
message SubnetInfo {
// Unique subnet identifier. Missing ID is
// equivalent to zero (default subnetwork) ID.
neo.fs.v2.refs.SubnetID id = 1;

// Identifier of the subnetwork owner
neo.fs.v2.refs.OwnerID owner = 2;
}