diff --git a/.gitignore b/.gitignore index c6ef218..485dee6 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1 @@ .idea - diff --git a/CHANGELOG.md b/CHANGELOG.md index ee28fa6..70ceb4a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -61,7 +61,7 @@ Network magic, main status codes, object locks and notifications. - `LOCK` value of `object.Type` enum (#194) - `Lock` message with payload content of `LOCK` objects (#194) - `LOCKED` and `LOCK_NON_REGULAR_OBJECT` status codes to `Object` section (#194) -- `scheme` field of type `SignatureScheme` to `Signature` message which determines +- `scheme` field of type `SignatureScheme` to `Signature` message which determines signature scheme (#55) - `SignatureRFC6979` message (#203) @@ -166,8 +166,8 @@ values in the objects. ### Changed -- Clarified processing of empty search query in `object.Search` RPC. -- Specified connection of tombstone expiration value with well-known +- Clarified processing of empty search query in `object.Search` RPC. +- Specified connection of tombstone expiration value with well-known `__NEOFS__EXPIRATION_EPOCH` object attribute. ## [2.3.0] - 2021-02-11 - Seonyudo (선유도, 仙遊島) diff --git a/apemanager/service.proto b/apemanager/service.proto index 7ff23a7..166ba4d 100644 --- a/apemanager/service.proto +++ b/apemanager/service.proto @@ -168,4 +168,4 @@ message ListChainsResponse { // authenticate the nodes of the message route and check the correctness of // transmission. neo.fs.v2.session.ResponseVerificationHeader verify_header = 3; -} \ No newline at end of file +} diff --git a/object/service.proto b/object/service.proto index dc39c1c..2c53297 100644 --- a/object/service.proto +++ b/object/service.proto @@ -285,16 +285,20 @@ service ObjectService { rpc PutSingle(PutSingleRequest) returns (PutSingleResponse); // Patch the object. Request uses gRPC stream. First message must set - // the address of the object that is going to get patched. If the object's attributes - // are patched, then these attrubutes must be set only within the first stream message. + // the address of the object that is going to get patched. If the object's + // attributes are patched, then these attrubutes must be set only within the + // first stream message. // - // If the patch request is performed by NOT the object's owner but if the actor has the permission - // to perform the patch, then `OwnerID` of the object is changed. In this case the object's owner - // loses the object's ownership after the patch request is successfully done. + // If the patch request is performed by NOT the object's owner but if the + // actor has the permission to perform the patch, then `OwnerID` of the object + // is changed. In this case the object's owner loses the object's ownership + // after the patch request is successfully done. // - // As objects are content-addressable the patching causes new object ID generation for the patched object. - // This object id is set witihn `PatchResponse`. But the object id may remain unchanged in such cases: - // 1. The chunk of the applying patch contains the same value as the object's payload within the same range; + // As objects are content-addressable the patching causes new object ID + // generation for the patched object. This object id is set witihn + // `PatchResponse`. But the object id may remain unchanged in such cases: + // 1. The chunk of the applying patch contains the same value as the object's + // payload within the same range; // 2. The patch that reverts the changes applied by preceding patch; // 3. The application of the same patches for the object a few times. // @@ -870,25 +874,29 @@ message PatchRequest { // The address of the object that is requested to get patched. neo.fs.v2.refs.Address address = 1; - // New attributes for the object. See `replace_attributes` flag usage to define how - // new attributes should be set. + // New attributes for the object. See `replace_attributes` flag usage to + // define how new attributes should be set. repeated neo.fs.v2.object.Header.Attribute new_attributes = 2; - // If this flag is set, then the object's attributes will be entirely replaced by `new_attributes` list. - // The empty `new_attributes` list with `replace_attributes = true` just resets attributes list for the object. + // If this flag is set, then the object's attributes will be entirely + // replaced by `new_attributes` list. The empty `new_attributes` list with + // `replace_attributes = true` just resets attributes list for the object. // - // Default `false` value for this flag means the attributes will be just merged. If the incoming `new_attributes` - // list contains already existing key, then it just replaces it while merging the lists. + // Default `false` value for this flag means the attributes will be just + // merged. If the incoming `new_attributes` list contains already existing + // key, then it just replaces it while merging the lists. bool replace_attributes = 3; - // The patch for the object's payload. + // The patch for the object's payload. message Patch { - // The range of the source object for which the payload is replaced by the patch's chunk. - // If the range's `length = 0`, then the patch's chunk is just appended to the original payload - // starting from the `offest` without any replace. + // The range of the source object for which the payload is replaced by the + // patch's chunk. If the range's `length = 0`, then the patch's chunk is + // just appended to the original payload starting from the `offest` + // without any replace. Range source_range = 1; - // The chunk that is being appended to or that replaces the original payload on the given range. + // The chunk that is being appended to or that replaces the original + // payload on the given range. bytes chunk = 2; } @@ -913,8 +921,8 @@ message PatchRequest { message PatchResponse { // PATCH response body message Body { - // The object ID of the saved patched object. - neo.fs.v2.refs.ObjectID object_id = 1; + // The object ID of the saved patched object. + neo.fs.v2.refs.ObjectID object_id = 1; } // Body for patch response message. @@ -924,7 +932,8 @@ message PatchResponse { // message transport and does not affect request execution. neo.fs.v2.session.ResponseMetaHeader meta_header = 2; - // Carries response verification information. This header is used to authenticate - // the nodes of the message route and check the correctness of transmission. + // Carries response verification information. This header is used to + // authenticate the nodes of the message route and check the correctness of + // transmission. neo.fs.v2.session.ResponseVerificationHeader verify_header = 3; } diff --git a/object/types.proto b/object/types.proto index b25e792..be8f348 100644 --- a/object/types.proto +++ b/object/types.proto @@ -275,4 +275,4 @@ message ECInfo { } // Chunk stored on the node. repeated Chunk chunks = 1; -} \ No newline at end of file +} diff --git a/proto-docs/accounting.md b/proto-docs/accounting.md index a23a63c..cdc82a1 100644 --- a/proto-docs/accounting.md +++ b/proto-docs/accounting.md @@ -6,19 +6,19 @@ - [accounting/service.proto](#accounting/service.proto) - Services - [AccountingService](#neo.fs.v2.accounting.AccountingService) - + - Messages - [BalanceRequest](#neo.fs.v2.accounting.BalanceRequest) - [BalanceRequest.Body](#neo.fs.v2.accounting.BalanceRequest.Body) - [BalanceResponse](#neo.fs.v2.accounting.BalanceResponse) - [BalanceResponse.Body](#neo.fs.v2.accounting.BalanceResponse.Body) - + - [accounting/types.proto](#accounting/types.proto) - Messages - [Decimal](#neo.fs.v2.accounting.Decimal) - + - [Scalar Value Types](#scalar-value-types) @@ -170,4 +170,3 @@ description. | 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/proto-docs/acl.md b/proto-docs/acl.md index 19c1a8d..bac7747 100644 --- a/proto-docs/acl.md +++ b/proto-docs/acl.md @@ -14,7 +14,7 @@ - [EACLRecord.Filter](#neo.fs.v2.acl.EACLRecord.Filter) - [EACLRecord.Target](#neo.fs.v2.acl.EACLRecord.Target) - [EACLTable](#neo.fs.v2.acl.EACLTable) - + - [Scalar Value Types](#scalar-value-types) @@ -282,4 +282,3 @@ Target role of the access control rule in access control list. | 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/proto-docs/ape.md b/proto-docs/ape.md index b101c83..39bc946 100644 --- a/proto-docs/ape.md +++ b/proto-docs/ape.md @@ -8,7 +8,7 @@ - Messages - [Chain](#frostfs.v2.ape.Chain) - [ChainTarget](#frostfs.v2.ape.ChainTarget) - + - [Scalar Value Types](#scalar-value-types) @@ -85,4 +85,3 @@ TargetType is a type target to which a rule chain is defined. | 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/proto-docs/apemanager.md b/proto-docs/apemanager.md index 5d0e2e6..c1cb682 100644 --- a/proto-docs/apemanager.md +++ b/proto-docs/apemanager.md @@ -6,7 +6,7 @@ - [apemanager/service.proto](#apemanager/service.proto) - Services - [APEManagerService](#frostfs.v2.apemanager.APEManagerService) - + - Messages - [AddChainRequest](#frostfs.v2.apemanager.AddChainRequest) - [AddChainRequest.Body](#frostfs.v2.apemanager.AddChainRequest.Body) @@ -20,7 +20,7 @@ - [RemoveChainRequest.Body](#frostfs.v2.apemanager.RemoveChainRequest.Body) - [RemoveChainResponse](#frostfs.v2.apemanager.RemoveChainResponse) - [RemoveChainResponse.Body](#frostfs.v2.apemanager.RemoveChainResponse.Body) - + - [Scalar Value Types](#scalar-value-types) @@ -267,4 +267,3 @@ operation could not be performed is an error returning to a client. | 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/proto-docs/container.md b/proto-docs/container.md index b568eed..3df304f 100644 --- a/proto-docs/container.md +++ b/proto-docs/container.md @@ -6,7 +6,7 @@ - [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) @@ -37,14 +37,14 @@ - [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) @@ -654,4 +654,3 @@ And some well-known attributes used by applications only: | 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/proto-docs/lock.md b/proto-docs/lock.md index ae74c5b..ba23306 100644 --- a/proto-docs/lock.md +++ b/proto-docs/lock.md @@ -7,7 +7,7 @@ - Messages - [Lock](#neo.fs.v2.lock.Lock) - + - [Scalar Value Types](#scalar-value-types) @@ -61,4 +61,3 @@ a lock object via ObjectService.Delete RPC call. | 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/proto-docs/netmap.md b/proto-docs/netmap.md index fb4eccb..cbf5593 100644 --- a/proto-docs/netmap.md +++ b/proto-docs/netmap.md @@ -6,7 +6,7 @@ - [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) @@ -20,7 +20,7 @@ - [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) @@ -35,7 +35,7 @@ - [PlacementPolicy](#neo.fs.v2.netmap.PlacementPolicy) - [Replica](#neo.fs.v2.netmap.Replica) - [Selector](#neo.fs.v2.netmap.Selector) - + - [Scalar Value Types](#scalar-value-types) @@ -575,4 +575,3 @@ Operations on filters | 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/proto-docs/object.md b/proto-docs/object.md index f353b3f..27981e5 100644 --- a/proto-docs/object.md +++ b/proto-docs/object.md @@ -6,7 +6,7 @@ - [object/service.proto](#object/service.proto) - Services - [ObjectService](#neo.fs.v2.object.ObjectService) - + - Messages - [DeleteRequest](#neo.fs.v2.object.DeleteRequest) - [DeleteRequest.Body](#neo.fs.v2.object.DeleteRequest.Body) @@ -50,7 +50,7 @@ - [SearchRequest.Body.Filter](#neo.fs.v2.object.SearchRequest.Body.Filter) - [SearchResponse](#neo.fs.v2.object.SearchResponse) - [SearchResponse.Body](#neo.fs.v2.object.SearchResponse.Body) - + - [object/types.proto](#object/types.proto) @@ -64,7 +64,7 @@ - [Object](#neo.fs.v2.object.Object) - [ShortHeader](#neo.fs.v2.object.ShortHeader) - [SplitInfo](#neo.fs.v2.object.SplitInfo) - + - [Scalar Value Types](#scalar-value-types) @@ -133,7 +133,7 @@ Statuses: - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \ object container not found; - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \ - access to container is denied; + access to container is denied; - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \ provided session token has expired. @@ -210,7 +210,7 @@ Statuses: - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \ object container not found; - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \ - access to container is denied; + access to container is denied; - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \ provided session token has expired. @@ -244,7 +244,7 @@ Statuses: - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \ object container not found; - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \ - access to container is denied; + access to container is denied; - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \ provided session token has expired. @@ -274,7 +274,7 @@ Statuses: - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \ search container not found; - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \ - access to container is denied; + access to container is denied; - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \ provided session token has expired. @@ -315,7 +315,7 @@ Statuses: - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \ object container not found; - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \ - access to container is denied; + access to container is denied; - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \ provided session token has expired. @@ -354,7 +354,7 @@ Statuses: - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \ object container not found; - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \ - access to container is denied; + access to container is denied; - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \ provided session token has expired. @@ -390,7 +390,7 @@ Statuses: - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \ object storage container not found; - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \ - access to container is denied; + access to container is denied; - **TOKEN_NOT_FOUND** (4096, SECTION_SESSION): \ (for trusted object preparation) session private key does not exist or has @@ -412,7 +412,7 @@ to perform the patch, then `OwnerID` of the object is changed. In this case the loses the object's ownership after the patch request is successfully done. As objects are content-addressable the patching causes new object ID generation for the patched object. -This object id is set witihn `PatchResponse`. But the object id may remain unchanged in such cases: +This object id is set witihn `PatchResponse`. But the object id may remain unchanged in such cases: 1. The chunk of the applying patch contains the same value as the object's payload within the same range; 2. The patch that reverts the changes applied by preceding patch; 3. The application of the same patches for the object a few times. @@ -1319,4 +1319,3 @@ String presentation of object type is the same as definition: | 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/proto-docs/refs.md b/proto-docs/refs.md index e27d4ba..5b559d3 100644 --- a/proto-docs/refs.md +++ b/proto-docs/refs.md @@ -14,7 +14,7 @@ - [Signature](#neo.fs.v2.refs.Signature) - [SignatureRFC6979](#neo.fs.v2.refs.SignatureRFC6979) - [Version](#neo.fs.v2.refs.Version) - + - [Scalar Value Types](#scalar-value-types) @@ -230,4 +230,3 @@ pair. | 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/proto-docs/session.md b/proto-docs/session.md index 699a907..36a73ea 100644 --- a/proto-docs/session.md +++ b/proto-docs/session.md @@ -6,13 +6,13 @@ - [session/service.proto](#session/service.proto) - Services - [SessionService](#neo.fs.v2.session.SessionService) - + - Messages - [CreateRequest](#neo.fs.v2.session.CreateRequest) - [CreateRequest.Body](#neo.fs.v2.session.CreateRequest.Body) - [CreateResponse](#neo.fs.v2.session.CreateResponse) - [CreateResponse.Body](#neo.fs.v2.session.CreateResponse.Body) - + - [session/types.proto](#session/types.proto) @@ -28,7 +28,7 @@ - [SessionToken.Body](#neo.fs.v2.session.SessionToken.Body) - [SessionToken.Body.TokenLifetime](#neo.fs.v2.session.SessionToken.Body.TokenLifetime) - [XHeader](#neo.fs.v2.session.XHeader) - + - [Scalar Value Types](#scalar-value-types) @@ -364,4 +364,3 @@ Object request verbs | 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/proto-docs/status.md b/proto-docs/status.md index 6444072..373a7a7 100644 --- a/proto-docs/status.md +++ b/proto-docs/status.md @@ -8,7 +8,7 @@ - Messages - [Status](#neo.fs.v2.status.Status) - [Status.Detail](#neo.fs.v2.status.Status.Detail) - + - [Scalar Value Types](#scalar-value-types) @@ -195,4 +195,3 @@ Section of NeoFS successful return codes. | 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/proto-docs/tombstone.md b/proto-docs/tombstone.md index 7a7761b..268e9a2 100644 --- a/proto-docs/tombstone.md +++ b/proto-docs/tombstone.md @@ -7,7 +7,7 @@ - Messages - [Tombstone](#neo.fs.v2.tombstone.Tombstone) - + - [Scalar Value Types](#scalar-value-types) @@ -60,4 +60,3 @@ purged from the NeoFS network. | 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/status/types.proto b/status/types.proto index 49c784f..302a11b 100644 --- a/status/types.proto +++ b/status/types.proto @@ -159,4 +159,4 @@ enum Session { enum APEManager { // [**5120**] The operation is denied by APE manager. APE_MANAGER_ACCESS_DENIED = 0; -} \ No newline at end of file +}