diff --git a/bootstrap/service.proto b/bootstrap/service.proto deleted file mode 100644 index 6918bef..0000000 --- a/bootstrap/service.proto +++ /dev/null @@ -1,42 +0,0 @@ -syntax = "proto3"; -package bootstrap; -option go_package = "github.com/nspcc-dev/neofs-api-go/bootstrap"; -option csharp_namespace = "NeoFS.API.Bootstrap"; - -import "service/meta.proto"; -import "service/verify.proto"; -import "bootstrap/types.proto"; -import "github.com/gogo/protobuf/gogoproto/gogo.proto"; - -option (gogoproto.stable_marshaler_all) = true; - -// Bootstrap service allows neofs-node to connect to the network. Node should -// perform at least one bootstrap request in the epoch to stay in the network -// for the next epoch. -service Bootstrap { - // Process is method that allows to register node in the network and receive actual netmap - rpc Process(Request) returns (bootstrap.SpreadMap); -} - -message Request { - // Node state - enum State { - // used by default - Unknown = 0; - // used to inform that node online - Online = 1; - // used to inform that node offline - Offline = 2; - } - - // Type is NodeType, can be InnerRingNode (type=1) or StorageNode (type=2) - int32 type = 1 [(gogoproto.customname) = "Type" , (gogoproto.nullable) = false, (gogoproto.customtype) = "NodeType"]; - // Info contains information about node - bootstrap.NodeInfo info = 2 [(gogoproto.nullable) = false]; - // State contains node status - State state = 3; - // RequestMetaHeader contains information about request meta headers (should be embedded into message) - service.RequestMetaHeader Meta = 98 [(gogoproto.embed) = true, (gogoproto.nullable) = false]; - // RequestVerificationHeader is a set of signatures of every NeoFS Node that processed request (should be embedded into message) - service.RequestVerificationHeader Verify = 99 [(gogoproto.embed) = true, (gogoproto.nullable) = false]; -} diff --git a/proto-docs/bootstrap.md b/proto-docs/bootstrap.md index 11b4f23..fada056 100644 --- a/proto-docs/bootstrap.md +++ b/proto-docs/bootstrap.md @@ -3,14 +3,6 @@ ## Table of Contents -- [bootstrap/service.proto](#bootstrap/service.proto) - - Services - - [Bootstrap](#bootstrap.Bootstrap) - - - Messages - - [Request](#bootstrap.Request) - - - [bootstrap/types.proto](#bootstrap/types.proto) - Messages @@ -22,69 +14,6 @@ - -

Top

- -## bootstrap/service.proto - - - - - - -### Service "bootstrap.Bootstrap" -Bootstrap service allows neofs-node to connect to the network. Node should -perform at least one bootstrap request in the epoch to stay in the network -for the next epoch. - -``` -rpc Process(Request) returns (SpreadMap); - -``` - -#### Method Process - -Process is method that allows to register node in the network and receive actual netmap - -| Name | Input | Output | -| ---- | ----- | ------ | -| Process | [Request](#bootstrap.Request) | [SpreadMap](#bootstrap.SpreadMap) | - - - - - -### Message Request - - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| type | [int32](#int32) | | Type is NodeType, can be InnerRingNode (type=1) or StorageNode (type=2) | -| info | [NodeInfo](#bootstrap.NodeInfo) | | Info contains information about node | -| state | [Request.State](#bootstrap.Request.State) | | State contains node status | -| Meta | [service.RequestMetaHeader](#service.RequestMetaHeader) | | RequestMetaHeader contains information about request meta headers (should be embedded into message) | -| Verify | [service.RequestVerificationHeader](#service.RequestVerificationHeader) | | RequestVerificationHeader is a set of signatures of every NeoFS Node that processed request (should be embedded into message) | - - - - - - -### Request.State -Node state - -| Name | Number | Description | -| ---- | ------ | ----------- | -| Unknown | 0 | used by default | -| Online | 1 | used to inform that node online | -| Offline | 2 | used to inform that node offline | - - - - - -

Top