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

session: Tidy up the format

Browse source 
Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
This commit is contained in:
Leonard Lyubich 2020-08-06 02:28:57 +03:00 • committed by Stanislav Bogatyrev
parent 0ca83fcef6
commit ad5126f53f
2 changed files with 25 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

18
proto-docs/session.md
View file

@ -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
<a name="session.CreateRequest"></a>
### 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. |
<a name="session.CreateResponse"></a>
### 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. |
<!-- end messages -->