forked from TrueCloudLab/frostfs-api
docs: regenerate files
This commit is contained in:
parent
096e7211b4
commit
c9edac72b4
2 changed files with 48 additions and 2 deletions
|
@ -297,7 +297,7 @@ in distributed system.
|
||||||
| ----- | ---- | ----- | ----------- |
|
| ----- | ---- | ----- | ----------- |
|
||||||
| Object | [Object](#object.Object) | | Object with at least container id and owner id fields |
|
| Object | [Object](#object.Object) | | Object with at least container id and owner id fields |
|
||||||
| Token | [session.Token](#session.Token) | | Token with session public key and user's signature |
|
| Token | [session.Token](#session.Token) | | Token with session public key and user's signature |
|
||||||
| CopiesNumber | [uint32](#uint32) | | Number of the object copies to store within RPC call (zero is processed according to the placement rules) |
|
| CopiesNumber | [uint32](#uint32) | | Number of the object copies to store within the RPC call (zero is processed according to the placement rules) |
|
||||||
|
|
||||||
|
|
||||||
<a name="object.PutResponse"></a>
|
<a name="object.PutResponse"></a>
|
||||||
|
|
|
@ -8,6 +8,8 @@
|
||||||
- [Status](#state.Status)
|
- [Status](#state.Status)
|
||||||
|
|
||||||
- Messages
|
- Messages
|
||||||
|
- [ChangeStateRequest](#state.ChangeStateRequest)
|
||||||
|
- [ChangeStateResponse](#state.ChangeStateResponse)
|
||||||
- [DumpRequest](#state.DumpRequest)
|
- [DumpRequest](#state.DumpRequest)
|
||||||
- [DumpResponse](#state.DumpResponse)
|
- [DumpResponse](#state.DumpResponse)
|
||||||
- [DumpVarsRequest](#state.DumpVarsRequest)
|
- [DumpVarsRequest](#state.DumpVarsRequest)
|
||||||
|
@ -34,7 +36,8 @@
|
||||||
<a name="state.Status"></a>
|
<a name="state.Status"></a>
|
||||||
|
|
||||||
### Service "state.Status"
|
### Service "state.Status"
|
||||||
Status service provides node's healthcheck and status info
|
Status service provides node's healthcheck and status info.
|
||||||
|
TODO: decide how to describe auth and were contains permissions.
|
||||||
|
|
||||||
```
|
```
|
||||||
rpc Netmap(NetmapRequest) returns (.bootstrap.SpreadMap);
|
rpc Netmap(NetmapRequest) returns (.bootstrap.SpreadMap);
|
||||||
|
@ -42,6 +45,7 @@ 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);
|
rpc DumpVars(DumpVarsRequest) returns (DumpVarsResponse);
|
||||||
|
rpc ChangeState(ChangeStateRequest) returns (ChangeStateResponse);
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -85,9 +89,38 @@ The request should be signed.
|
||||||
| Name | Input | Output |
|
| Name | Input | Output |
|
||||||
| ---- | ----- | ------ |
|
| ---- | ----- | ------ |
|
||||||
| DumpVars | [DumpVarsRequest](#state.DumpVarsRequest) | [DumpVarsResponse](#state.DumpVarsResponse) |
|
| DumpVars | [DumpVarsRequest](#state.DumpVarsRequest) | [DumpVarsResponse](#state.DumpVarsResponse) |
|
||||||
|
#### Method ChangeState
|
||||||
|
|
||||||
|
ChangeState allows to change current node state of node.
|
||||||
|
To permit access, used server config options.
|
||||||
|
The request should be signed.
|
||||||
|
|
||||||
|
| Name | Input | Output |
|
||||||
|
| ---- | ----- | ------ |
|
||||||
|
| ChangeState | [ChangeStateRequest](#state.ChangeStateRequest) | [ChangeStateResponse](#state.ChangeStateResponse) |
|
||||||
<!-- end services -->
|
<!-- end services -->
|
||||||
|
|
||||||
|
|
||||||
|
<a name="state.ChangeStateRequest"></a>
|
||||||
|
|
||||||
|
### Message ChangeStateRequest
|
||||||
|
ChangeStateRequest contains a new state of node.
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| state | [ChangeStateRequest.State](#state.ChangeStateRequest.State) | | State is a new state of node. |
|
||||||
|
| 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.ChangeStateResponse"></a>
|
||||||
|
|
||||||
|
### Message ChangeStateResponse
|
||||||
|
ChangeStateResponse is an empty response, that returns when RPC invoked without errors.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="state.DumpRequest"></a>
|
<a name="state.DumpRequest"></a>
|
||||||
|
|
||||||
### Message DumpRequest
|
### Message DumpRequest
|
||||||
|
@ -198,6 +231,19 @@ NetmapRequest message to request current node netmap
|
||||||
|
|
||||||
<!-- end messages -->
|
<!-- end messages -->
|
||||||
|
|
||||||
|
|
||||||
|
<a name="state.ChangeStateRequest.State"></a>
|
||||||
|
|
||||||
|
### ChangeStateRequest.State
|
||||||
|
|
||||||
|
|
||||||
|
| Name | Number | Description |
|
||||||
|
| ---- | ------ | ----------- |
|
||||||
|
| Unknown | 0 | Unknown is default value. Does nothing. |
|
||||||
|
| Online | 1 | Online used when need to set node to the online state. |
|
||||||
|
| Offline | 2 | Offline used when need to set node to the offline state. |
|
||||||
|
|
||||||
|
|
||||||
<!-- end enums -->
|
<!-- end enums -->
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue