[#56] object: Introduce Patch method
* Introduce rpc `Patch` and corresponding types; * Generate docs. Signed-off-by: Airat Arifullin <aarifullin@yadro.com> Signed-off-by: Airat Arifullin <aarifullin@yadro.com>
This commit is contained in:
Airat Arifullin
parent
428b4276e7
commit
c363a7e82d
2 changed files with 180 additions and 0 deletions
|
|
@ -817,3 +817,87 @@ message PutSingleResponse {
|
||||||
// transmission.
|
// transmission.
|
||||||
neo.fs.v2.session.ResponseVerificationHeader verify_header = 3;
|
neo.fs.v2.session.ResponseVerificationHeader verify_header = 3;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Object PATCH request
|
||||||
|
message PatchRequest {
|
||||||
|
// PATCH request body
|
||||||
|
message Body {
|
||||||
|
// Initial part of the patch stream. This part doesn't refer to any patch but only
|
||||||
|
// to specific info about the object for that patches are going to be applied.
|
||||||
|
message Init {
|
||||||
|
// The object's ID for which the patch is applied.
|
||||||
|
neo.fs.v2.refs.ObjectID object_id = 1;
|
||||||
|
|
||||||
|
// Object's Header
|
||||||
|
Header header = 2;
|
||||||
|
}
|
||||||
|
|
||||||
|
// The patch for attributes.
|
||||||
|
message AttributePatch {
|
||||||
|
// 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 = 1;
|
||||||
|
|
||||||
|
// 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.
|
||||||
|
bool replace_attributes = 2;
|
||||||
|
}
|
||||||
|
|
||||||
|
// The patch for the object's payload.
|
||||||
|
message PayloadPatch {
|
||||||
|
// 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 payload that is being appended to or that replaces the original payload on the given range.
|
||||||
|
bytes chunk = 2;
|
||||||
|
}
|
||||||
|
|
||||||
|
oneof patch_part {
|
||||||
|
// Initial part of the patch stream.
|
||||||
|
Init init = 1;
|
||||||
|
|
||||||
|
// The patch for attributes.
|
||||||
|
AttributePatch attr_patch = 2;
|
||||||
|
|
||||||
|
// The patch for the object's payload.
|
||||||
|
PayloadPatch payload_patch = 3;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Body for patch request message.
|
||||||
|
Body body = 1;
|
||||||
|
|
||||||
|
// Carries request meta information. Header data is used only to regulate
|
||||||
|
// message transport and does not affect request execution.
|
||||||
|
neo.fs.v2.session.RequestMetaHeader meta_header = 2;
|
||||||
|
|
||||||
|
// Carries request verification information. This header is used to
|
||||||
|
// authenticate the nodes of the message route and check the correctness of
|
||||||
|
// transmission.
|
||||||
|
neo.fs.v2.session.RequestVerificationHeader verify_header = 3;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Object PATCH response
|
||||||
|
message PatchResponse {
|
||||||
|
// PATCH response body
|
||||||
|
message Body {
|
||||||
|
// The object's ID for which the patch has been applied.
|
||||||
|
neo.fs.v2.refs.ObjectID object_id = 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Body for patch response message.
|
||||||
|
Body body = 1;
|
||||||
|
|
||||||
|
// Carries response meta information. Header data is used only to regulate
|
||||||
|
// 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.
|
||||||
|
neo.fs.v2.session.ResponseVerificationHeader verify_header = 3;
|
||||||
|
}
|
||||||
|
|
|
||||||
|
|
@ -30,6 +30,13 @@
|
||||||
- [HeadResponse](#neo.fs.v2.object.HeadResponse)
|
- [HeadResponse](#neo.fs.v2.object.HeadResponse)
|
||||||
- [HeadResponse.Body](#neo.fs.v2.object.HeadResponse.Body)
|
- [HeadResponse.Body](#neo.fs.v2.object.HeadResponse.Body)
|
||||||
- [HeaderWithSignature](#neo.fs.v2.object.HeaderWithSignature)
|
- [HeaderWithSignature](#neo.fs.v2.object.HeaderWithSignature)
|
||||||
|
- [PatchRequest](#neo.fs.v2.object.PatchRequest)
|
||||||
|
- [PatchRequest.Body](#neo.fs.v2.object.PatchRequest.Body)
|
||||||
|
- [PatchRequest.Body.AttributePatch](#neo.fs.v2.object.PatchRequest.Body.AttributePatch)
|
||||||
|
- [PatchRequest.Body.Init](#neo.fs.v2.object.PatchRequest.Body.Init)
|
||||||
|
- [PatchRequest.Body.PayloadPatch](#neo.fs.v2.object.PatchRequest.Body.PayloadPatch)
|
||||||
|
- [PatchResponse](#neo.fs.v2.object.PatchResponse)
|
||||||
|
- [PatchResponse.Body](#neo.fs.v2.object.PatchResponse.Body)
|
||||||
- [PutRequest](#neo.fs.v2.object.PutRequest)
|
- [PutRequest](#neo.fs.v2.object.PutRequest)
|
||||||
- [PutRequest.Body](#neo.fs.v2.object.PutRequest.Body)
|
- [PutRequest.Body](#neo.fs.v2.object.PutRequest.Body)
|
||||||
- [PutRequest.Body.Init](#neo.fs.v2.object.PutRequest.Body.Init)
|
- [PutRequest.Body.Init](#neo.fs.v2.object.PutRequest.Body.Init)
|
||||||
|
|
@ -691,6 +698,95 @@ following steps:
|
||||||
| signature | [neo.fs.v2.refs.Signature](#neo.fs.v2.refs.Signature) | | Signed `ObjectID` to verify full header's authenticity |
|
| signature | [neo.fs.v2.refs.Signature](#neo.fs.v2.refs.Signature) | | Signed `ObjectID` to verify full header's authenticity |
|
||||||
|
|
||||||
|
|
||||||
|
<a name="neo.fs.v2.object.PatchRequest"></a>
|
||||||
|
|
||||||
|
### Message PatchRequest
|
||||||
|
Object PATCH request
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| body | [PatchRequest.Body](#neo.fs.v2.object.PatchRequest.Body) | | Body for patch request message. |
|
||||||
|
| meta_header | [neo.fs.v2.session.RequestMetaHeader](#neo.fs.v2.session.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. |
|
||||||
|
| verify_header | [neo.fs.v2.session.RequestVerificationHeader](#neo.fs.v2.session.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
|
||||||
|
|
||||||
|
|
||||||
|
<a name="neo.fs.v2.object.PatchRequest.Body"></a>
|
||||||
|
|
||||||
|
### Message PatchRequest.Body
|
||||||
|
PATCH request body
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| init | [PatchRequest.Body.Init](#neo.fs.v2.object.PatchRequest.Body.Init) | | Initial part of the patch stream. |
|
||||||
|
| attr_patch | [PatchRequest.Body.AttributePatch](#neo.fs.v2.object.PatchRequest.Body.AttributePatch) | | The patch for attributes. |
|
||||||
|
| payload_patch | [PatchRequest.Body.PayloadPatch](#neo.fs.v2.object.PatchRequest.Body.PayloadPatch) | | The patch for the object's payload. |
|
||||||
|
|
||||||
|
|
||||||
|
<a name="neo.fs.v2.object.PatchRequest.Body.AttributePatch"></a>
|
||||||
|
|
||||||
|
### Message PatchRequest.Body.AttributePatch
|
||||||
|
The patch for attributes.
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| new_attributes | [Header.Attribute](#neo.fs.v2.object.Header.Attribute) | repeated | New attributes for the object. See `replace_attributes` flag usage to define how new attributes should be set. |
|
||||||
|
| replace_attributes | [bool](#bool) | | 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. |
|
||||||
|
|
||||||
|
|
||||||
|
<a name="neo.fs.v2.object.PatchRequest.Body.Init"></a>
|
||||||
|
|
||||||
|
### Message PatchRequest.Body.Init
|
||||||
|
Initial part of the patch stream. This part doesn't refer to any patch but only
|
||||||
|
to specific info about the object for that patches are going to be applied.
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| object_id | [neo.fs.v2.refs.ObjectID](#neo.fs.v2.refs.ObjectID) | | The object's ID for which the patch is applied. |
|
||||||
|
| header | [Header](#neo.fs.v2.object.Header) | | Object's Header |
|
||||||
|
|
||||||
|
|
||||||
|
<a name="neo.fs.v2.object.PatchRequest.Body.PayloadPatch"></a>
|
||||||
|
|
||||||
|
### Message PatchRequest.Body.PayloadPatch
|
||||||
|
The patch for the object's payload.
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| source_range | [Range](#neo.fs.v2.object.Range) | | 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. |
|
||||||
|
| chunk | [bytes](#bytes) | | The payload that is being appended to or that replaces the original payload on the given range. |
|
||||||
|
|
||||||
|
|
||||||
|
<a name="neo.fs.v2.object.PatchResponse"></a>
|
||||||
|
|
||||||
|
### Message PatchResponse
|
||||||
|
Object PATCH response
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| body | [PatchResponse.Body](#neo.fs.v2.object.PatchResponse.Body) | | Body for patch response message. |
|
||||||
|
| meta_header | [neo.fs.v2.session.ResponseMetaHeader](#neo.fs.v2.session.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. |
|
||||||
|
| verify_header | [neo.fs.v2.session.ResponseVerificationHeader](#neo.fs.v2.session.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
|
||||||
|
|
||||||
|
|
||||||
|
<a name="neo.fs.v2.object.PatchResponse.Body"></a>
|
||||||
|
|
||||||
|
### Message PatchResponse.Body
|
||||||
|
PATCH response body
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| object_id | [neo.fs.v2.refs.ObjectID](#neo.fs.v2.refs.ObjectID) | | The object's ID for which the patch has been applied. |
|
||||||
|
|
||||||
|
|
||||||
<a name="neo.fs.v2.object.PutRequest"></a>
|
<a name="neo.fs.v2.object.PutRequest"></a>
|
||||||
|
|
||||||
### Message PutRequest
|
### Message PutRequest
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue