forked from TrueCloudLab/frostfs-api
e09a560d57
Add detail for `WRONG_MAGIC_NUMBER` status code which carries the correct magic of the served network served. Clients will be able to fix incorrect magic and re-send the request. ID is 0, binary format is uint64 in big-endian. Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
89 lines
3.2 KiB
Protocol Buffer
89 lines
3.2 KiB
Protocol Buffer
syntax = "proto3";
|
|
|
|
package neo.fs.v2.status;
|
|
|
|
option go_package = "github.com/nspcc-dev/neofs-api-go/v2/status/grpc;status";
|
|
option csharp_namespace = "Neo.FileStorage.API.Status";
|
|
|
|
// Declares the general format of the status returns of the NeoFS RPC protocol.
|
|
// Status is present in all response messages. Each RPC of NeoFS protocol
|
|
// describes the possible outcomes and details of the operation.
|
|
//
|
|
// Each status is assigned a one-to-one numeric code. Any unique result of an
|
|
// operation in NeoFS is unambiguously associated with the code value.
|
|
//
|
|
// Numerical set of codes is split into 1024-element sections. An enumeration
|
|
// is defined for each section. Values can be referred to in the following ways:
|
|
//
|
|
// * numerical value ranging from 0 to 4,294,967,295 (global code);
|
|
//
|
|
// * values from enumeration (local code). The formula for the ratio of the
|
|
// local code (`L`) of a defined section (`S`) to the global one (`G`):
|
|
// `G = 1024 * S + L`.
|
|
//
|
|
// All outcomes are divided into successful and failed, which corresponds
|
|
// to the success or failure of the operation. The definition of success
|
|
// follows from the semantics of RPC and the description of its purpose.
|
|
// The server must not attach code that is the opposite of outcome type.
|
|
//
|
|
// See the set of return codes in the description for calls.
|
|
//
|
|
// Each status can carry developer-facing error message. It should be human
|
|
// readable text in English. The server should not transmit (and the client
|
|
// should not expect) useful information in the message. Field `details`
|
|
// should make the return more detailed.
|
|
message Status {
|
|
// The status code
|
|
uint32 code = 1;
|
|
|
|
// Developer-facing error message
|
|
string message = 2;
|
|
|
|
// Return detail. It contains additional information that can be used to
|
|
// analyze the response. Each code defines a set of details that can be
|
|
// attached to a status. Client should not handle details that are not
|
|
// covered by the code.
|
|
message Detail {
|
|
// Detail ID. The identifier is required to determine the binary format
|
|
// of the detail and how to decode it.
|
|
uint32 id = 1;
|
|
|
|
// Binary status detail. Must follow the format associated with ID.
|
|
// The possibility of missing a value must be explicitly allowed.
|
|
bytes value = 2;
|
|
}
|
|
|
|
// Data detailing the outcome of the operation. Must be unique by ID.
|
|
repeated Detail details = 3;
|
|
}
|
|
|
|
// Section identifiers.
|
|
enum Section {
|
|
// Successful return codes.
|
|
SECTION_SUCCESS = 0;
|
|
|
|
// Failure codes regardless of the operation.
|
|
SECTION_FAILURE_COMMON = 1;
|
|
}
|
|
|
|
// Section of NeoFS successful return codes.
|
|
enum Success {
|
|
// [**0**] Default success. Not detailed.
|
|
// If the server cannot match successful outcome to the code, it should
|
|
// use this code.
|
|
OK = 0;
|
|
}
|
|
|
|
// Section of failed statuses independent of the operation.
|
|
enum CommonFail {
|
|
// [**1024**] Internal server error, default failure. Not detailed.
|
|
// If the server cannot match failed outcome to the code, it should
|
|
// use this code.
|
|
INTERNAL = 0;
|
|
|
|
// [**1025**] Wrong magic of the NeoFS network.
|
|
// Details:
|
|
// - [**0**] Magic number of the served NeoFS network (big-endian 64-bit
|
|
// unsigned integer).
|
|
WRONG_MAGIC_NUMBER = 1;
|
|
}
|