realloc/frostfs-api
1
0
Fork 0
forked from TrueCloudLab/frostfs-api
Code Issues Pull requests Projects Releases Packages Wiki Activity

[#37] docs: Regenerate markdown docs

Browse source 
Signed-off-by: Stanislav Bogatyrev <stanislav@nspcc.ru>
This commit is contained in:
Stanislav Bogatyrev 2020-08-11 18:49:56 +03:00 • committed by Stanislav Bogatyrev
parent cfd24944a4
commit a77480582d
5 changed files with 650 additions and 221 deletions
Download patch file Download diff file Expand all files Collapse all files

30
proto-docs/session.md
View file

@ -9,7 +9,9 @@
- Messages
- [CreateRequest](#session.CreateRequest)
- [CreateRequest.Body](#session.CreateRequest.Body)
- [CreateResponse](#session.CreateResponse)
- [CreateResponse.Body](#session.CreateResponse.Body)
- [Scalar Value Types](#scalar-value-types)
@ -52,18 +54,42 @@ CreateRequest carries an information necessary for opening a session.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| owner_id | [refs.OwnerID](#refs.OwnerID) | | Carries an identifier of a session initiator. |
| lifetime | [service.TokenLifetime](#service.TokenLifetime) | | Carries a lifetime of the session. |
| body | [CreateRequest.Body](#session.CreateRequest.Body) | | Body of create session token request message. |
| meta_header | [service.RequestMetaHeader](#service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. |
| verify_header | [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.CreateRequest.Body"></a>
### Message CreateRequest.Body
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| owner_id | [refs.OwnerID](#refs.OwnerID) | | Carries an identifier of a session initiator. |
| lifetime | [service.TokenLifetime](#service.TokenLifetime) | | Carries a lifetime of the session. |
<a name="session.CreateResponse"></a>
### Message CreateResponse
CreateResponse carries an information about the opened session.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| body | [CreateResponse.Body](#session.CreateResponse.Body) | | Body of create session token response message. |
| meta_header | [service.ResponseMetaHeader](#service.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. |
| verify_header | [service.ResponseVerificationHeader](#service.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
<a name="session.CreateResponse.Body"></a>
### Message CreateResponse.Body
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| id | [bytes](#bytes) | | id carries an identifier of session token. |