From ad5126f53fcdc4d75312145c4fe9adddd77fa44e Mon Sep 17 00:00:00 2001 From: Leonard Lyubich Date: Thu, 6 Aug 2020 02:28:57 +0300 Subject: [PATCH] session: Tidy up the format Signed-off-by: Leonard Lyubich --- proto-docs/session.md | 18 +++++++++--------- session/service.proto | 27 ++++++++++++++++----------- 2 files changed, 25 insertions(+), 20 deletions(-) diff --git a/proto-docs/session.md b/proto-docs/session.md index 8ce09a0..0976757 100644 --- a/proto-docs/session.md +++ b/proto-docs/session.md @@ -36,7 +36,7 @@ rpc Create(CreateRequest) returns (CreateResponse); #### Method Create -Create opens new session between the client and the server +Create opens new session between the client and the server. | Name | Input | Output | | ---- | ----- | ------ | @@ -47,27 +47,27 @@ Create opens new session between the client and the server ### Message CreateRequest -CreateRequest carries an information necessary for opening a session +CreateRequest carries an information necessary for opening a session. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| OwnerID | [refs.OwnerID](#refs.OwnerID) | | OwnerID carries an identifier of a session initiator. | -| Lifetime | [service.TokenLifetime](#service.TokenLifetime) | | Lifetime carries a lifetime of the session | -| 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) | +| OwnerID | [refs.OwnerID](#refs.OwnerID) | | Carries an identifier of a session initiator. | +| Lifetime | [service.TokenLifetime](#service.TokenLifetime) | | Carries a lifetime of the session. | +| MetaHeader | [service.RequestMetaHeader](#service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. | +| VerifyHeader | [service.RequestVerificationHeader](#service.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | ### Message CreateResponse -CreateResponse carries an information about the opened session +CreateResponse carries an information about the opened session. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| ID | [bytes](#bytes) | | ID carries an identifier of session token | -| SessionKey | [bytes](#bytes) | | SessionKey carries a session public key | +| ID | [bytes](#bytes) | | ID carries an identifier of session token. | +| SessionKey | [bytes](#bytes) | | SessionKey carries a session public key. | diff --git a/session/service.proto b/session/service.proto index 3619a22..cd11589 100644 --- a/session/service.proto +++ b/session/service.proto @@ -1,5 +1,7 @@ syntax = "proto3"; + package session; + option go_package = "github.com/nspcc-dev/neofs-api-go/session"; option csharp_namespace = "NeoFS.API.Session"; @@ -8,29 +10,32 @@ import "service/verify.proto"; import "refs/types.proto"; service Session { - // Create opens new session between the client and the server + // Create opens new session between the client and the server. rpc Create (CreateRequest) returns (CreateResponse); } -// CreateRequest carries an information necessary for opening a session +// CreateRequest carries an information necessary for opening a session. message CreateRequest { - // OwnerID carries an identifier of a session initiator. + // Carries an identifier of a session initiator. refs.OwnerID OwnerID = 1; - // Lifetime carries a lifetime of the session + // Carries a lifetime of the session. service.TokenLifetime Lifetime = 2; - // RequestMetaHeader contains information about request meta headers (should be embedded into message) - service.RequestMetaHeader Meta = 98; - // RequestVerificationHeader is a set of signatures of every NeoFS Node that processed request (should be embedded into message) - service.RequestVerificationHeader Verify = 99; + // Carries request meta information. Header data is used only to regulate message + // transport and does not affect request execution. + service.RequestMetaHeader MetaHeader = 98; + + // Carries request verification information. This header is used to authenticate + // the nodes of the message route and check the correctness of transmission. + service.RequestVerificationHeader VerifyHeader = 99; } -// CreateResponse carries an information about the opened session +// CreateResponse carries an information about the opened session. message CreateResponse { - // ID carries an identifier of session token + // ID carries an identifier of session token. bytes ID = 1; - // SessionKey carries a session public key + // SessionKey carries a session public key. bytes SessionKey = 2; }