From 7f59b8aaeb605f055a61bd0c327f5d84da772d0b Mon Sep 17 00:00:00 2001 From: Dmitrii Stepanov Date: Mon, 17 Apr 2023 10:32:18 +0300 Subject: [PATCH] [#25] subnet: Drop fields and types Signed-off-by: Dmitrii Stepanov --- CHANGELOG.md | 1 + container/types.proto | 4 -- netmap/types.proto | 14 ------- proto-docs/container.md | 92 ++++++++++++++++++++--------------------- proto-docs/netmap.md | 78 +++++++++++++++------------------- proto-docs/refs.md | 44 +++++++------------- proto-docs/subnet.md | 61 --------------------------- refs/types.proto | 10 ----- subnet/types.proto | 18 -------- 9 files changed, 93 insertions(+), 229 deletions(-) delete mode 100644 proto-docs/subnet.md delete mode 100644 subnet/types.proto diff --git a/CHANGELOG.md b/CHANGELOG.md index 542f6e5..91ebf2f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,7 @@ ### Removed - Reputation system (#22) +- All `subnet` related fields and types (#25) ## [2.14.0] - 2022-09-23 - Anmado (안마도, 鞍馬島) diff --git a/container/types.proto b/container/types.proto index 17ce39c..5f7f76b 100644 --- a/container/types.proto +++ b/container/types.proto @@ -37,10 +37,6 @@ message Container { // // There are some "well-known" attributes affecting system behaviour: // - // * [ __SYSTEM__SUBNET ] \ - // (`__NEOFS__SUBNET` is deprecated) \ - // String ID of a container's storage subnet. Any container can be attached to - // one subnet only. // * [ __SYSTEM__NAME ] \ // (`__NEOFS__NAME` is deprecated) \ // String of a human-friendly container name registered as a domain in diff --git a/netmap/types.proto b/netmap/types.proto index 8b317dc..fb5cf82 100644 --- a/netmap/types.proto +++ b/netmap/types.proto @@ -5,8 +5,6 @@ package neo.fs.v2.netmap; option go_package = "git.frostfs.info/TrueCloudLab/frostfs-api-go/v2/netmap/grpc;netmap"; option csharp_namespace = "Neo.FileStorage.API.Netmap"; -import "refs/types.proto"; - // Operations on filters enum Operation { // No Operation defined @@ -121,10 +119,6 @@ message PlacementPolicy { // List of named filters to reference in selectors repeated Filter filters = 4 [json_name = "filters"]; - - // Subnetwork ID to select nodes from. Zero subnet (default) represents - // all of the nodes which didn't explicitly opt out of membership. - refs.SubnetID subnet_id = 5 [json_name = "subnetId"]; } // NeoFS node description @@ -164,14 +158,6 @@ message NodeInfo { // attributes it's a string presenting floating point number with comma or // point delimiter for decimal part. In the Network Map it will be saved as // 64-bit unsigned integer representing number of minimal token fractions. - // * [ __SYSTEM__SUBNET_%s ] \ - // (`__NEOFS__SUBNET_%s` is deprecated) \ - // `True` or `False`. Defines if the node is included in the `%s` subnetwork - // or not. `%s` must be an existing subnetwork's ID (non-negative integer number). - // A node can be included in more than one subnetwork and, therefore, can contain - // more than one subnet attribute. A missing attribute is equivalent to the - // presence of the attribute with `False` value (except default zero subnetwork - // (with `%s` == 0) for which missing attribute means inclusion in that network). // * UN-LOCODE \ // Node's geographic location in // [UN/LOCODE](https://www.unece.org/cefact/codesfortrade/codes_index.html) diff --git a/proto-docs/container.md b/proto-docs/container.md index aae323d..6368889 100644 --- a/proto-docs/container.md +++ b/proto-docs/container.md @@ -3,50 +3,50 @@ ## Table of Contents -- [container/service.proto](#container/service.proto) - - Services - - [ContainerService](#neo.fs.v2.container.ContainerService) - - - Messages - - [AnnounceUsedSpaceRequest](#neo.fs.v2.container.AnnounceUsedSpaceRequest) - - [AnnounceUsedSpaceRequest.Body](#neo.fs.v2.container.AnnounceUsedSpaceRequest.Body) - - [AnnounceUsedSpaceRequest.Body.Announcement](#neo.fs.v2.container.AnnounceUsedSpaceRequest.Body.Announcement) - - [AnnounceUsedSpaceResponse](#neo.fs.v2.container.AnnounceUsedSpaceResponse) - - [AnnounceUsedSpaceResponse.Body](#neo.fs.v2.container.AnnounceUsedSpaceResponse.Body) - - [DeleteRequest](#neo.fs.v2.container.DeleteRequest) - - [DeleteRequest.Body](#neo.fs.v2.container.DeleteRequest.Body) - - [DeleteResponse](#neo.fs.v2.container.DeleteResponse) - - [DeleteResponse.Body](#neo.fs.v2.container.DeleteResponse.Body) - - [GetExtendedACLRequest](#neo.fs.v2.container.GetExtendedACLRequest) - - [GetExtendedACLRequest.Body](#neo.fs.v2.container.GetExtendedACLRequest.Body) - - [GetExtendedACLResponse](#neo.fs.v2.container.GetExtendedACLResponse) - - [GetExtendedACLResponse.Body](#neo.fs.v2.container.GetExtendedACLResponse.Body) - - [GetRequest](#neo.fs.v2.container.GetRequest) - - [GetRequest.Body](#neo.fs.v2.container.GetRequest.Body) - - [GetResponse](#neo.fs.v2.container.GetResponse) - - [GetResponse.Body](#neo.fs.v2.container.GetResponse.Body) - - [ListRequest](#neo.fs.v2.container.ListRequest) - - [ListRequest.Body](#neo.fs.v2.container.ListRequest.Body) - - [ListResponse](#neo.fs.v2.container.ListResponse) - - [ListResponse.Body](#neo.fs.v2.container.ListResponse.Body) - - [PutRequest](#neo.fs.v2.container.PutRequest) - - [PutRequest.Body](#neo.fs.v2.container.PutRequest.Body) - - [PutResponse](#neo.fs.v2.container.PutResponse) - - [PutResponse.Body](#neo.fs.v2.container.PutResponse.Body) - - [SetExtendedACLRequest](#neo.fs.v2.container.SetExtendedACLRequest) - - [SetExtendedACLRequest.Body](#neo.fs.v2.container.SetExtendedACLRequest.Body) - - [SetExtendedACLResponse](#neo.fs.v2.container.SetExtendedACLResponse) - - [SetExtendedACLResponse.Body](#neo.fs.v2.container.SetExtendedACLResponse.Body) - - -- [container/types.proto](#container/types.proto) - - - Messages - - [Container](#neo.fs.v2.container.Container) - - [Container.Attribute](#neo.fs.v2.container.Container.Attribute) - - -- [Scalar Value Types](#scalar-value-types) +- [Protocol Documentation](#protocol-documentation) + - [Table of Contents](#table-of-contents) + - [container/service.proto](#containerserviceproto) + - [Service "neo.fs.v2.container.ContainerService"](#service-neofsv2containercontainerservice) + - [Method Put](#method-put) + - [Method Delete](#method-delete) + - [Method Get](#method-get) + - [Method List](#method-list) + - [Method SetExtendedACL](#method-setextendedacl) + - [Method GetExtendedACL](#method-getextendedacl) + - [Method AnnounceUsedSpace](#method-announceusedspace) + - [Message AnnounceUsedSpaceRequest](#message-announceusedspacerequest) + - [Message AnnounceUsedSpaceRequest.Body](#message-announceusedspacerequestbody) + - [Message AnnounceUsedSpaceRequest.Body.Announcement](#message-announceusedspacerequestbodyannouncement) + - [Message AnnounceUsedSpaceResponse](#message-announceusedspaceresponse) + - [Message AnnounceUsedSpaceResponse.Body](#message-announceusedspaceresponsebody) + - [Message DeleteRequest](#message-deleterequest) + - [Message DeleteRequest.Body](#message-deleterequestbody) + - [Message DeleteResponse](#message-deleteresponse) + - [Message DeleteResponse.Body](#message-deleteresponsebody) + - [Message GetExtendedACLRequest](#message-getextendedaclrequest) + - [Message GetExtendedACLRequest.Body](#message-getextendedaclrequestbody) + - [Message GetExtendedACLResponse](#message-getextendedaclresponse) + - [Message GetExtendedACLResponse.Body](#message-getextendedaclresponsebody) + - [Message GetRequest](#message-getrequest) + - [Message GetRequest.Body](#message-getrequestbody) + - [Message GetResponse](#message-getresponse) + - [Message GetResponse.Body](#message-getresponsebody) + - [Message ListRequest](#message-listrequest) + - [Message ListRequest.Body](#message-listrequestbody) + - [Message ListResponse](#message-listresponse) + - [Message ListResponse.Body](#message-listresponsebody) + - [Message PutRequest](#message-putrequest) + - [Message PutRequest.Body](#message-putrequestbody) + - [Message PutResponse](#message-putresponse) + - [Message PutResponse.Body](#message-putresponsebody) + - [Message SetExtendedACLRequest](#message-setextendedaclrequest) + - [Message SetExtendedACLRequest.Body](#message-setextendedaclrequestbody) + - [Message SetExtendedACLResponse](#message-setextendedaclresponse) + - [Message SetExtendedACLResponse.Body](#message-setextendedaclresponsebody) + - [container/types.proto](#containertypesproto) + - [Message Container](#message-container) + - [Message Container.Attribute](#message-containerattribute) + - [Scalar Value Types](#scalar-value-types) @@ -587,10 +587,6 @@ values will be considered invalid. There are some "well-known" attributes affecting system behaviour: -* [ __SYSTEM__SUBNET ] \ - (`__NEOFS__SUBNET` is deprecated) \ - String ID of a container's storage subnet. Any container can be attached to - one subnet only. * [ __SYSTEM__NAME ] \ (`__NEOFS__NAME` is deprecated) \ String of a human-friendly container name registered as a domain in diff --git a/proto-docs/netmap.md b/proto-docs/netmap.md index 1467a5d..19b8bd2 100644 --- a/proto-docs/netmap.md +++ b/proto-docs/netmap.md @@ -3,41 +3,40 @@ ## Table of Contents -- [netmap/service.proto](#netmap/service.proto) - - Services - - [NetmapService](#neo.fs.v2.netmap.NetmapService) - - - Messages - - [LocalNodeInfoRequest](#neo.fs.v2.netmap.LocalNodeInfoRequest) - - [LocalNodeInfoRequest.Body](#neo.fs.v2.netmap.LocalNodeInfoRequest.Body) - - [LocalNodeInfoResponse](#neo.fs.v2.netmap.LocalNodeInfoResponse) - - [LocalNodeInfoResponse.Body](#neo.fs.v2.netmap.LocalNodeInfoResponse.Body) - - [NetmapSnapshotRequest](#neo.fs.v2.netmap.NetmapSnapshotRequest) - - [NetmapSnapshotRequest.Body](#neo.fs.v2.netmap.NetmapSnapshotRequest.Body) - - [NetmapSnapshotResponse](#neo.fs.v2.netmap.NetmapSnapshotResponse) - - [NetmapSnapshotResponse.Body](#neo.fs.v2.netmap.NetmapSnapshotResponse.Body) - - [NetworkInfoRequest](#neo.fs.v2.netmap.NetworkInfoRequest) - - [NetworkInfoRequest.Body](#neo.fs.v2.netmap.NetworkInfoRequest.Body) - - [NetworkInfoResponse](#neo.fs.v2.netmap.NetworkInfoResponse) - - [NetworkInfoResponse.Body](#neo.fs.v2.netmap.NetworkInfoResponse.Body) - - -- [netmap/types.proto](#netmap/types.proto) - - - Messages - - [Filter](#neo.fs.v2.netmap.Filter) - - [Netmap](#neo.fs.v2.netmap.Netmap) - - [NetworkConfig](#neo.fs.v2.netmap.NetworkConfig) - - [NetworkConfig.Parameter](#neo.fs.v2.netmap.NetworkConfig.Parameter) - - [NetworkInfo](#neo.fs.v2.netmap.NetworkInfo) - - [NodeInfo](#neo.fs.v2.netmap.NodeInfo) - - [NodeInfo.Attribute](#neo.fs.v2.netmap.NodeInfo.Attribute) - - [PlacementPolicy](#neo.fs.v2.netmap.PlacementPolicy) - - [Replica](#neo.fs.v2.netmap.Replica) - - [Selector](#neo.fs.v2.netmap.Selector) - - -- [Scalar Value Types](#scalar-value-types) +- [Protocol Documentation](#protocol-documentation) + - [Table of Contents](#table-of-contents) + - [netmap/service.proto](#netmapserviceproto) + - [Service "neo.fs.v2.netmap.NetmapService"](#service-neofsv2netmapnetmapservice) + - [Method LocalNodeInfo](#method-localnodeinfo) + - [Method NetworkInfo](#method-networkinfo) + - [Method NetmapSnapshot](#method-netmapsnapshot) + - [Message LocalNodeInfoRequest](#message-localnodeinforequest) + - [Message LocalNodeInfoRequest.Body](#message-localnodeinforequestbody) + - [Message LocalNodeInfoResponse](#message-localnodeinforesponse) + - [Message LocalNodeInfoResponse.Body](#message-localnodeinforesponsebody) + - [Message NetmapSnapshotRequest](#message-netmapsnapshotrequest) + - [Message NetmapSnapshotRequest.Body](#message-netmapsnapshotrequestbody) + - [Message NetmapSnapshotResponse](#message-netmapsnapshotresponse) + - [Message NetmapSnapshotResponse.Body](#message-netmapsnapshotresponsebody) + - [Message NetworkInfoRequest](#message-networkinforequest) + - [Message NetworkInfoRequest.Body](#message-networkinforequestbody) + - [Message NetworkInfoResponse](#message-networkinforesponse) + - [Message NetworkInfoResponse.Body](#message-networkinforesponsebody) + - [netmap/types.proto](#netmaptypesproto) + - [Message Filter](#message-filter) + - [Message Netmap](#message-netmap) + - [Message NetworkConfig](#message-networkconfig) + - [Message NetworkConfig.Parameter](#message-networkconfigparameter) + - [Message NetworkInfo](#message-networkinfo) + - [Message NodeInfo](#message-nodeinfo) + - [Message NodeInfo.Attribute](#message-nodeinfoattribute) + - [Message PlacementPolicy](#message-placementpolicy) + - [Message Replica](#message-replica) + - [Message Selector](#message-selector) + - [Clause](#clause) + - [NodeInfo.State](#nodeinfostate) + - [Operation](#operation) + - [Scalar Value Types](#scalar-value-types) @@ -399,14 +398,6 @@ explicitly set: attributes it's a string presenting floating point number with comma or point delimiter for decimal part. In the Network Map it will be saved as 64-bit unsigned integer representing number of minimal token fractions. -* [ __SYSTEM__SUBNET_%s ] \ - (`__NEOFS__SUBNET_%s` is deprecated) \ - `True` or `False`. Defines if the node is included in the `%s` subnetwork - or not. `%s` must be an existing subnetwork's ID (non-negative integer number). - A node can be included in more than one subnetwork and, therefore, can contain - more than one subnet attribute. A missing attribute is equivalent to the - presence of the attribute with `False` value (except default zero subnetwork - (with `%s` == 0) for which missing attribute means inclusion in that network). * UN-LOCODE \ Node's geographic location in [UN/LOCODE](https://www.unece.org/cefact/codesfortrade/codes_index.html) @@ -468,7 +459,6 @@ 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 651822f..7d66e5a 100644 --- a/proto-docs/refs.md +++ b/proto-docs/refs.md @@ -3,21 +3,20 @@ ## Table of Contents -- [refs/types.proto](#refs/types.proto) - - - Messages - - [Address](#neo.fs.v2.refs.Address) - - [Checksum](#neo.fs.v2.refs.Checksum) - - [ContainerID](#neo.fs.v2.refs.ContainerID) - - [ObjectID](#neo.fs.v2.refs.ObjectID) - - [OwnerID](#neo.fs.v2.refs.OwnerID) - - [Signature](#neo.fs.v2.refs.Signature) - - [SignatureRFC6979](#neo.fs.v2.refs.SignatureRFC6979) - - [SubnetID](#neo.fs.v2.refs.SubnetID) - - [Version](#neo.fs.v2.refs.Version) - - -- [Scalar Value Types](#scalar-value-types) +- [Protocol Documentation](#protocol-documentation) + - [Table of Contents](#table-of-contents) + - [refs/types.proto](#refstypesproto) + - [Message Address](#message-address) + - [Message Checksum](#message-checksum) + - [Message ContainerID](#message-containerid) + - [Message ObjectID](#message-objectid) + - [Message OwnerID](#message-ownerid) + - [Message Signature](#message-signature) + - [Message SignatureRFC6979](#message-signaturerfc6979) + - [Message Version](#message-version) + - [ChecksumType](#checksumtype) + - [SignatureScheme](#signaturescheme) + - [Scalar Value Types](#scalar-value-types) @@ -164,21 +163,6 @@ RFC 6979 signature. | sign | [bytes](#bytes) | | Deterministic ECDSA with SHA-256 hashing | - - -### Message SubnetID -NeoFS subnetwork identifier. - -String representation of a value is base-10 integer. - -JSON representation is an object containing a single `value` number field. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| value | [fixed32](#fixed32) | | 4-byte integer subnetwork identifier. | - - ### Message Version diff --git a/proto-docs/subnet.md b/proto-docs/subnet.md deleted file mode 100644 index a766dc6..0000000 --- a/proto-docs/subnet.md +++ /dev/null @@ -1,61 +0,0 @@ -# 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 | - diff --git a/refs/types.proto b/refs/types.proto index 054443e..2f94dd2 100644 --- a/refs/types.proto +++ b/refs/types.proto @@ -77,16 +77,6 @@ message OwnerID { bytes value = 1 [json_name = "value"]; } -// NeoFS subnetwork identifier. -// -// String representation of a value is base-10 integer. -// -// JSON representation is an object containing a single `value` number field. -message SubnetID { - // 4-byte integer subnetwork identifier. - fixed32 value = 1 [json_name = "value"]; -} - // API version used by a node. // // String presentation is a Semantic Versioning 2.0.0 compatible version string diff --git a/subnet/types.proto b/subnet/types.proto deleted file mode 100644 index cc9cae3..0000000 --- a/subnet/types.proto +++ /dev/null @@ -1,18 +0,0 @@ -syntax = "proto3"; - -package neo.fs.v2.subnet; - -option go_package = "git.frostfs.info/TrueCloudLab/frostfs-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; -}