Skip to content

Deprecate rangehash, replace range with parameterized get #389

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.

Sign up for GitHub

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

Merged
roman-khimov merged 2 commits into from
May 6, 2026
Merged

Deprecate rangehash, replace range with parameterized get #389

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fffef53
object: deprecate GetRangeHash API
roman-khimov Apr 22, 2026
2d63ae2
object: extend Get with range data, deprecate GetRange
roman-khimov Apr 22, 2026
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
4 changes: 2 additions & 2 deletions acl/types.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,10 @@ enum Operation {
// Search
SEARCH = 5;

// GetRange
// GetRange. DEPRECATED: use parameterized Get instead.
GETRANGE = 6;

// GetRangeHash
// GetRangeHash. DEPRECATED: should not be used.
GETRANGEHASH = 7;
}

Expand Down
11 changes: 11 additions & 0 deletions object/service.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,8 @@ service ObjectService {
// restored by concatenation of all received payload chunks keeping the receiving
// order.
//
// DEPRECATED: use `Get` with `range` (and `payload_only` if needed) parameter.
//
// Extended headers can change `GetRange` behaviour:
// * __NEOFS__NETMAP_EPOCH \
// Will use the requsted version of Network Map for object placement
Expand Down Expand Up @@ -218,6 +220,8 @@ service ObjectService {
// length) tuples. Hashes order in response corresponds to the ranges order in
// the request. Note that hash is calculated for XORed data.
//
// DEPRECATED: no valid use cases.
//
// Extended headers can change `GetRangeHash` behaviour:
// * __NEOFS__NETMAP_EPOCH \
// Will use the requsted version of Network Map for object placement
Expand Down Expand Up @@ -282,6 +286,13 @@ message GetRequest {
// If `raw` flag is set, request will work only with objects that are
// physically stored on the peer node
bool raw = 2;

// Requested payload range (whole payload if not specified).
Range range = 3;

// If set, makes Get return payload only, completely omitting Init response
// message with header data.
bool payload_only = 4;
Comment thread
roman-khimov marked this conversation as resolved.
}
// Body of get object request message.
Body body = 1;
Expand Down
4 changes: 2 additions & 2 deletions proto-docs/acl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,8 +233,8 @@ request.
| PUT | 3 | Put |
| DELETE | 4 | Delete |
| SEARCH | 5 | Search |
| GETRANGE | 6 | GetRange |
| GETRANGEHASH | 7 | GetRangeHash |
| GETRANGE | 6 | GetRange. DEPRECATED: use parameterized Get instead. |
| GETRANGEHASH | 7 | GetRangeHash. DEPRECATED: should not be used. |



Expand Down
6 changes: 6 additions & 0 deletions proto-docs/object.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,6 +290,8 @@ Like in `Get` method, the response uses gRPC stream. Requested range can be
restored by concatenation of all received payload chunks keeping the receiving
order.

DEPRECATED: use `Get` with `range` (and `payload_only` if needed) parameter.

Extended headers can change `GetRange` behaviour:
* __NEOFS__NETMAP_EPOCH \
Will use the requsted version of Network Map for object placement
Expand Down Expand Up @@ -327,6 +329,8 @@ applying XOR operation with the provided `salt`. Ranges are set of (offset,
length) tuples. Hashes order in response corresponds to the ranges order in
the request. Note that hash is calculated for XORed data.

DEPRECATED: no valid use cases.

Extended headers can change `GetRangeHash` behaviour:
* __NEOFS__NETMAP_EPOCH \
Will use the requsted version of Network Map for object placement
Expand Down Expand Up @@ -577,6 +581,8 @@ GET Object request body
| ----- | ---- | ----- | ----------- |
| address | [neo.fs.v2.refs.Address](#neo.fs.v2.refs.Address) | | Address of the requested object |
| raw | [bool](#bool) | | If `raw` flag is set, request will work only with objects that are physically stored on the peer node |
| range | [Range](#neo.fs.v2.object.Range) | | Requested payload range (whole payload if not specified). |
| payload_only | [bool](#bool) | | If set, makes Get return payload only, completely omitting Init response message with header data. |


<a name="neo.fs.v2.object.GetResponse"></a>
Expand Down
4 changes: 2 additions & 2 deletions proto-docs/session.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -438,8 +438,8 @@ container service operations.
| OBJECT_HEAD | 3 | Refers to object.Head RPC call |
| OBJECT_SEARCH | 4 | Refers to object.Search RPC call |
| OBJECT_DELETE | 5 | Refers to object.Delete RPC call |
| OBJECT_RANGE | 6 | Refers to object.GetRange RPC call |
| OBJECT_RANGEHASH | 7 | Refers to object.GetRangeHash RPC call |
| OBJECT_RANGE | 6 | Refers to object.GetRange RPC call. DEPRECATED: use parameterized Get instead. |
| OBJECT_RANGEHASH | 7 | Refers to object.GetRangeHash RPC call. DEPRECATED: should not be used. |
| CONTAINER_PUT | 8 | Refers to container.Put RPC call |
| CONTAINER_DELETE | 9 | Refers to container.Delete RPC call |
| CONTAINER_SETEACL | 10 | Refers to container.SetExtendedACL RPC call |
Expand Down
4 changes: 2 additions & 2 deletions session/types.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@ enum Verb {
// Refers to object.Delete RPC call
OBJECT_DELETE = 5;

// Refers to object.GetRange RPC call
// Refers to object.GetRange RPC call. DEPRECATED: use parameterized Get instead.
OBJECT_RANGE = 6;

// Refers to object.GetRangeHash RPC call
// Refers to object.GetRangeHash RPC call. DEPRECATED: should not be used.
OBJECT_RANGEHASH = 7;

// Container operations
Expand Down
Loading