forked from TrueCloudLab/frostfs-api
update proto docs
This commit is contained in:
parent
d8a0c287c4
commit
54060e29be
3 changed files with 63 additions and 2 deletions
|
@ -112,8 +112,7 @@ headers are also present.
|
||||||
|
|
||||||
Search objects in container. Version of query language format SHOULD BE
|
Search objects in container. Version of query language format SHOULD BE
|
||||||
set to 1. Search query represented in serialized format (see query
|
set to 1. Search query represented in serialized format (see query
|
||||||
package). Requested list can be restored by concatenation of addresses
|
package).
|
||||||
from all messages. Addresses from resulting list are expected to be unique.
|
|
||||||
|
|
||||||
| Name | Input | Output |
|
| Name | Input | Output |
|
||||||
| ---- | ----- | ------ |
|
| ---- | ----- | ------ |
|
||||||
|
@ -121,6 +120,8 @@ from all messages. Addresses from resulting list are expected to be unique.
|
||||||
#### Method GetRange
|
#### Method GetRange
|
||||||
|
|
||||||
GetRange of data payload. Range is a pair (offset, length).
|
GetRange of data payload. Range is a pair (offset, length).
|
||||||
|
Requested range can be restored by concatenation of all chunks
|
||||||
|
keeping receiving order.
|
||||||
|
|
||||||
| Name | Input | Output |
|
| Name | Input | Output |
|
||||||
| ---- | ----- | ------ |
|
| ---- | ----- | ------ |
|
||||||
|
@ -160,6 +161,10 @@ DeleteResponse is empty because we cannot guarantee permanent object removal
|
||||||
in distributed system.
|
in distributed system.
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| Meta | [service.ResponseMetaHeader](#service.ResponseMetaHeader) | | ResponseMetaHeader contains meta information based on request processing by server (should be embedded into message) |
|
||||||
|
|
||||||
|
|
||||||
<a name="object.GetRangeHashRequest"></a>
|
<a name="object.GetRangeHashRequest"></a>
|
||||||
|
|
||||||
|
@ -185,6 +190,7 @@ in distributed system.
|
||||||
| Field | Type | Label | Description |
|
| Field | Type | Label | Description |
|
||||||
| ----- | ---- | ----- | ----------- |
|
| ----- | ---- | ----- | ----------- |
|
||||||
| Hashes | [bytes](#bytes) | repeated | Hashes is a homomorphic hashes of all ranges |
|
| Hashes | [bytes](#bytes) | repeated | Hashes is a homomorphic hashes of all ranges |
|
||||||
|
| Meta | [service.ResponseMetaHeader](#service.ResponseMetaHeader) | | ResponseMetaHeader contains meta information based on request processing by server (should be embedded into message) |
|
||||||
|
|
||||||
|
|
||||||
<a name="object.GetRangeRequest"></a>
|
<a name="object.GetRangeRequest"></a>
|
||||||
|
@ -210,6 +216,7 @@ in distributed system.
|
||||||
| Field | Type | Label | Description |
|
| Field | Type | Label | Description |
|
||||||
| ----- | ---- | ----- | ----------- |
|
| ----- | ---- | ----- | ----------- |
|
||||||
| Fragment | [bytes](#bytes) | | Fragment of object's payload |
|
| Fragment | [bytes](#bytes) | | Fragment of object's payload |
|
||||||
|
| Meta | [service.ResponseMetaHeader](#service.ResponseMetaHeader) | | ResponseMetaHeader contains meta information based on request processing by server (should be embedded into message) |
|
||||||
|
|
||||||
|
|
||||||
<a name="object.GetRequest"></a>
|
<a name="object.GetRequest"></a>
|
||||||
|
@ -236,6 +243,7 @@ in distributed system.
|
||||||
| ----- | ---- | ----- | ----------- |
|
| ----- | ---- | ----- | ----------- |
|
||||||
| object | [Object](#object.Object) | | Object header and some payload |
|
| object | [Object](#object.Object) | | Object header and some payload |
|
||||||
| Chunk | [bytes](#bytes) | | Chunk of remaining payload |
|
| Chunk | [bytes](#bytes) | | Chunk of remaining payload |
|
||||||
|
| Meta | [service.ResponseMetaHeader](#service.ResponseMetaHeader) | | ResponseMetaHeader contains meta information based on request processing by server (should be embedded into message) |
|
||||||
|
|
||||||
|
|
||||||
<a name="object.HeadRequest"></a>
|
<a name="object.HeadRequest"></a>
|
||||||
|
@ -262,6 +270,7 @@ in distributed system.
|
||||||
| Field | Type | Label | Description |
|
| Field | Type | Label | Description |
|
||||||
| ----- | ---- | ----- | ----------- |
|
| ----- | ---- | ----- | ----------- |
|
||||||
| Object | [Object](#object.Object) | | Object without payload |
|
| Object | [Object](#object.Object) | | Object without payload |
|
||||||
|
| Meta | [service.ResponseMetaHeader](#service.ResponseMetaHeader) | | ResponseMetaHeader contains meta information based on request processing by server (should be embedded into message) |
|
||||||
|
|
||||||
|
|
||||||
<a name="object.PutRequest"></a>
|
<a name="object.PutRequest"></a>
|
||||||
|
@ -299,6 +308,7 @@ in distributed system.
|
||||||
| Field | Type | Label | Description |
|
| Field | Type | Label | Description |
|
||||||
| ----- | ---- | ----- | ----------- |
|
| ----- | ---- | ----- | ----------- |
|
||||||
| Address | [refs.Address](#refs.Address) | | Address of object (container id + object id) |
|
| Address | [refs.Address](#refs.Address) | | Address of object (container id + object id) |
|
||||||
|
| Meta | [service.ResponseMetaHeader](#service.ResponseMetaHeader) | | ResponseMetaHeader contains meta information based on request processing by server (should be embedded into message) |
|
||||||
|
|
||||||
|
|
||||||
<a name="object.SearchRequest"></a>
|
<a name="object.SearchRequest"></a>
|
||||||
|
@ -325,6 +335,7 @@ in distributed system.
|
||||||
| Field | Type | Label | Description |
|
| Field | Type | Label | Description |
|
||||||
| ----- | ---- | ----- | ----------- |
|
| ----- | ---- | ----- | ----------- |
|
||||||
| Addresses | [refs.Address](#refs.Address) | repeated | Addresses of found objects |
|
| Addresses | [refs.Address](#refs.Address) | repeated | Addresses of found objects |
|
||||||
|
| Meta | [service.ResponseMetaHeader](#service.ResponseMetaHeader) | | ResponseMetaHeader contains meta information based on request processing by server (should be embedded into message) |
|
||||||
|
|
||||||
<!-- end messages -->
|
<!-- end messages -->
|
||||||
|
|
||||||
|
|
|
@ -7,6 +7,7 @@
|
||||||
|
|
||||||
- Messages
|
- Messages
|
||||||
- [RequestMetaHeader](#service.RequestMetaHeader)
|
- [RequestMetaHeader](#service.RequestMetaHeader)
|
||||||
|
- [ResponseMetaHeader](#service.ResponseMetaHeader)
|
||||||
|
|
||||||
|
|
||||||
- [service/verify.proto](#service/verify.proto)
|
- [service/verify.proto](#service/verify.proto)
|
||||||
|
@ -43,6 +44,19 @@ RequestMetaHeader contains information about request meta headers
|
||||||
| Epoch | [uint64](#uint64) | | Epoch for user can be empty, because node sets epoch to the actual value |
|
| Epoch | [uint64](#uint64) | | Epoch for user can be empty, because node sets epoch to the actual value |
|
||||||
| Version | [uint32](#uint32) | | Version defines protocol version TODO: not used for now, should be implemented in future |
|
| Version | [uint32](#uint32) | | Version defines protocol version TODO: not used for now, should be implemented in future |
|
||||||
|
|
||||||
|
|
||||||
|
<a name="service.ResponseMetaHeader"></a>
|
||||||
|
|
||||||
|
### Message ResponseMetaHeader
|
||||||
|
ResponseMetaHeader contains meta information based on request processing by server
|
||||||
|
(should be embedded into message)
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| Epoch | [uint64](#uint64) | | Current NeoFS epoch on server |
|
||||||
|
| Version | [uint32](#uint32) | | Version defines protocol version TODO: not used for now, should be implemented in future |
|
||||||
|
|
||||||
<!-- end messages -->
|
<!-- end messages -->
|
||||||
|
|
||||||
<!-- end enums -->
|
<!-- end enums -->
|
||||||
|
|
|
@ -10,6 +10,8 @@
|
||||||
- Messages
|
- Messages
|
||||||
- [DumpRequest](#state.DumpRequest)
|
- [DumpRequest](#state.DumpRequest)
|
||||||
- [DumpResponse](#state.DumpResponse)
|
- [DumpResponse](#state.DumpResponse)
|
||||||
|
- [DumpVarsRequest](#state.DumpVarsRequest)
|
||||||
|
- [DumpVarsResponse](#state.DumpVarsResponse)
|
||||||
- [HealthRequest](#state.HealthRequest)
|
- [HealthRequest](#state.HealthRequest)
|
||||||
- [HealthResponse](#state.HealthResponse)
|
- [HealthResponse](#state.HealthResponse)
|
||||||
- [MetricsRequest](#state.MetricsRequest)
|
- [MetricsRequest](#state.MetricsRequest)
|
||||||
|
@ -39,6 +41,7 @@ rpc Netmap(NetmapRequest) returns (.bootstrap.SpreadMap);
|
||||||
rpc Metrics(MetricsRequest) returns (MetricsResponse);
|
rpc Metrics(MetricsRequest) returns (MetricsResponse);
|
||||||
rpc HealthCheck(HealthRequest) returns (HealthResponse);
|
rpc HealthCheck(HealthRequest) returns (HealthResponse);
|
||||||
rpc DumpConfig(DumpRequest) returns (DumpResponse);
|
rpc DumpConfig(DumpRequest) returns (DumpResponse);
|
||||||
|
rpc DumpVars(DumpVarsRequest) returns (DumpVarsResponse);
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -73,6 +76,15 @@ The request should be signed.
|
||||||
| Name | Input | Output |
|
| Name | Input | Output |
|
||||||
| ---- | ----- | ------ |
|
| ---- | ----- | ------ |
|
||||||
| DumpConfig | [DumpRequest](#state.DumpRequest) | [DumpResponse](#state.DumpResponse) |
|
| DumpConfig | [DumpRequest](#state.DumpRequest) | [DumpResponse](#state.DumpResponse) |
|
||||||
|
#### Method DumpVars
|
||||||
|
|
||||||
|
DumpVars returns debug variables for the current node.
|
||||||
|
To permit access, used server config options.
|
||||||
|
The request should be signed.
|
||||||
|
|
||||||
|
| Name | Input | Output |
|
||||||
|
| ---- | ----- | ------ |
|
||||||
|
| DumpVars | [DumpVarsRequest](#state.DumpVarsRequest) | [DumpVarsResponse](#state.DumpVarsResponse) |
|
||||||
<!-- end services -->
|
<!-- end services -->
|
||||||
|
|
||||||
|
|
||||||
|
@ -100,6 +112,30 @@ Config stored in JSON encoded into slice of bytes.
|
||||||
| Config | [bytes](#bytes) | | |
|
| Config | [bytes](#bytes) | | |
|
||||||
|
|
||||||
|
|
||||||
|
<a name="state.DumpVarsRequest"></a>
|
||||||
|
|
||||||
|
### Message DumpVarsRequest
|
||||||
|
DumpVarsRequest message to fetch current server debug variables.
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| 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) |
|
||||||
|
|
||||||
|
|
||||||
|
<a name="state.DumpVarsResponse"></a>
|
||||||
|
|
||||||
|
### Message DumpVarsResponse
|
||||||
|
DumpVarsResponse message contains current server debug variables.
|
||||||
|
Variables stored in JSON encoded into slice of bytes.
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| Variables | [bytes](#bytes) | | |
|
||||||
|
|
||||||
|
|
||||||
<a name="state.HealthRequest"></a>
|
<a name="state.HealthRequest"></a>
|
||||||
|
|
||||||
### Message HealthRequest
|
### Message HealthRequest
|
||||||
|
|
Loading…
Reference in a new issue