TrueCloudLab/frostfs-api
34
1
Fork 18
Code Issues 14 Pull requests 3 Releases Activity Actions

[#150] *: Write status-related docs

Browse source 
Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
This commit is contained in:
Leonard Lyubich 2021-11-12 19:10:39 +03:00 • committed by LeL
parent f55f83fb24
commit 7ea5a1d2f1
15 changed files with 395 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

10
proto-docs/netmap.md
View file

@ -66,6 +66,11 @@ want to get recent information directly, or to talk to the node not yet
present in `Network Map` to find out what API version can be used for
further communication. Can also be used to check if node is up and running.
Statuses:
- **OK** (0, SECTION_SUCCESS):
information about the server has been successfully read;
- Common failures (SECTION_FAILURE_COMMON).
| Name | Input | Output |
| ---- | ----- | ------ |
| LocalNodeInfo | [LocalNodeInfoRequest](#neo.fs.v2.netmap.LocalNodeInfoRequest) | [LocalNodeInfoResponse](#neo.fs.v2.netmap.LocalNodeInfoResponse) |
@ -73,6 +78,11 @@ further communication. Can also be used to check if node is up and running.
Read recent information about the NeoFS network.
Statuses:
- **OK** (0, SECTION_SUCCESS):
information about the current network state has been successfully read;
- Common failures (SECTION_FAILURE_COMMON).
| Name | Input | Output |
| ---- | ----- | ------ |
| NetworkInfo | [NetworkInfoRequest](#neo.fs.v2.netmap.NetworkInfoRequest) | [NetworkInfoResponse](#neo.fs.v2.netmap.NetworkInfoResponse) |