frostfs-api/proto-docs/service.md
Stanislav Bogatyrev 579a618f72 docs: Update docs with new token locations
Signed-off-by: Stanislav Bogatyrev <stanislav@nspcc.ru>
2020-08-18 18:31:36 +03:00

5.9 KiB

Protocol Documentation

Table of Contents

Top

service/types.proto

Message RequestMetaHeader

Information about the request

Field Type Label Description
version neo.fs.v2.refs.Version Client API version.
epoch uint64 Client local epoch number. Set to 0 if unknown.
ttl uint32 Maximum number of nodes in the request route.
x_headers XHeader repeated Request X-Headers.
session_token neo.fs.v2.session.SessionToken Token is a token of the session within which the request is sent
bearer_token neo.fs.v2.acl.BearerToken Bearer is a Bearer token of the request
origin RequestMetaHeader RequestMetaHeader of the origin request.

Message RequestVerificationHeader

Verification info for request signed by all intermediate nodes

Field Type Label Description
body_signature neo.fs.v2.refs.Signature Request Body signature. Should be generated once by request initiator.
meta_signature neo.fs.v2.refs.Signature Request Meta signature is added and signed by any intermediate node
origin_signature neo.fs.v2.refs.Signature Sign previous hops
origin RequestVerificationHeader Chain of previous hops signatures

Message ResponseMetaHeader

Information about the response

Field Type Label Description
version neo.fs.v2.refs.Version Server API version.
epoch uint64 Server local epoch number.
ttl uint32 Maximum number of nodes in the response route.
x_headers XHeader repeated Response X-Headers.
origin ResponseMetaHeader Carries response meta header of the origin response.

Message ResponseVerificationHeader

Verification info for response signed by all intermediate nodes

Field Type Label Description
body_signature neo.fs.v2.refs.Signature Response Body signature. Should be generated once by answering node.
meta_signature neo.fs.v2.refs.Signature Response Meta signature is added and signed by any intermediate node
origin_signature neo.fs.v2.refs.Signature Sign previous hops
origin ResponseVerificationHeader Chain of previous hops signatures

Message XHeader

Extended headers for Request/Response

Field Type Label Description
key string Key of the X-Header.
value string Value of the X-Header.

Scalar Value Types

.proto Type Notes C++ Type Java Type Python Type
double double double float
float float float float
int32 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. int32 int int
int64 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long int/long
uint32 Uses variable-length encoding. uint32 int int/long
uint64 Uses variable-length encoding. uint64 long int/long
sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int
sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long
sfixed32 Always four bytes. int32 int int
sfixed64 Always eight bytes. int64 long int/long
bool bool boolean boolean
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode
bytes May contain any arbitrary sequence of bytes. string ByteString str