From fc170f56bfc994be0ff59e914d13bdb5c63f18bf Mon Sep 17 00:00:00 2001 From: Stanislav Bogatyrev Date: Wed, 19 Aug 2020 17:00:23 +0300 Subject: [PATCH] [#57] Merge service and session packages Merging session and service packages to increase clarity and reduce cross-dependencies. Signed-off-by: Stanislav Bogatyrev --- accounting/service.proto | 10 ++--- container/service.proto | 50 +++++++++++----------- object/service.proto | 58 +++++++++++++------------- proto-docs/accounting.md | 8 ++-- proto-docs/container.md | 48 +++++++++++----------- proto-docs/object.md | 56 ++++++++++++------------- proto-docs/session.md | 85 ++++++++++++++++++++++++++++++++++++-- service/types.proto | 89 ---------------------------------------- session/service.proto | 10 ++--- session/types.proto | 79 +++++++++++++++++++++++++++++++++++ 10 files changed, 280 insertions(+), 213 deletions(-) delete mode 100644 service/types.proto diff --git a/accounting/service.proto b/accounting/service.proto index 1af4641..ee2f10b 100644 --- a/accounting/service.proto +++ b/accounting/service.proto @@ -7,7 +7,7 @@ option csharp_namespace = "NeoFS.API.v2.Accounting"; import "accounting/types.proto"; import "refs/types.proto"; -import "service/types.proto"; +import "session/types.proto"; // The service provides methods for obtaining information // about the account balance in NeoFS system. @@ -35,12 +35,12 @@ message BalanceRequest { // Carries request meta information. Header data is used only to regulate // message transport and does not affect request execution. - neo.fs.v2.service.RequestMetaHeader meta_header = 2; + neo.fs.v2.session.RequestMetaHeader meta_header = 2; // Carries request verification information. This header is used to // authenticate the nodes of the message route and check the correctness // of transmission. - neo.fs.v2.service.RequestVerificationHeader verify_header = 3; + neo.fs.v2.session.RequestVerificationHeader verify_header = 3; } // Message defines the response body of Balance method. @@ -57,10 +57,10 @@ message BalanceResponse { // Carries response meta information. Header data is used only to regulate // message transport and does not affect request execution. - neo.fs.v2.service.ResponseMetaHeader meta_header = 2; + neo.fs.v2.session.ResponseMetaHeader meta_header = 2; // Carries response verification information. This header is used to // authenticate the nodes of the message route and check the correctness // of transmission. - neo.fs.v2.service.ResponseVerificationHeader verify_header = 3; + neo.fs.v2.session.ResponseVerificationHeader verify_header = 3; } diff --git a/container/service.proto b/container/service.proto index 5c08c40..0e89377 100644 --- a/container/service.proto +++ b/container/service.proto @@ -8,7 +8,7 @@ option csharp_namespace = "NeoFS.API.v2.Container"; import "acl/types.proto"; import "container/types.proto"; import "refs/types.proto"; -import "service/types.proto"; +import "session/types.proto"; // ContainerService provides API to access container smart-contract in morph chain // via NeoFS node. @@ -57,12 +57,12 @@ message PutRequest { // Carries request meta information. Header data is used only to regulate // message transport and does not affect request execution. - neo.fs.v2.service.RequestMetaHeader meta_header = 2; + neo.fs.v2.session.RequestMetaHeader meta_header = 2; // Carries request verification information. This header is used to // authenticate the nodes of the message route and check the correctness // of transmission. - neo.fs.v2.service.RequestVerificationHeader verify_header = 3; + neo.fs.v2.session.RequestVerificationHeader verify_header = 3; } // New NeoFS Container creation response @@ -77,12 +77,12 @@ message PutResponse { // Carries response meta information. Header data is used only to regulate // message transport and does not affect request execution. - neo.fs.v2.service.ResponseMetaHeader meta_header = 2; + neo.fs.v2.session.ResponseMetaHeader meta_header = 2; // Carries response verification information. This header is used to // authenticate the nodes of the message route and check the correctness // of transmission. - neo.fs.v2.service.ResponseVerificationHeader verify_header = 3; + neo.fs.v2.session.ResponseVerificationHeader verify_header = 3; } // Container removal request @@ -101,12 +101,12 @@ message DeleteRequest { // Carries request meta information. Header data is used only to regulate // message transport and does not affect request execution. - neo.fs.v2.service.RequestMetaHeader meta_header = 2; + neo.fs.v2.session.RequestMetaHeader meta_header = 2; // Carries request verification information. This header is used to // authenticate the nodes of the message route and check the correctness // of transmission. - neo.fs.v2.service.RequestVerificationHeader verify_header = 3; + neo.fs.v2.session.RequestVerificationHeader verify_header = 3; } // DeleteResponse is empty because delete operation is asynchronous and done @@ -119,12 +119,12 @@ message DeleteResponse { // Carries response meta information. Header data is used only to regulate // message transport and does not affect request execution. - neo.fs.v2.service.ResponseMetaHeader meta_header = 2; + neo.fs.v2.session.ResponseMetaHeader meta_header = 2; // Carries response verification information. This header is used to // authenticate the nodes of the message route and check the correctness // of transmission. - neo.fs.v2.service.ResponseVerificationHeader verify_header = 3; + neo.fs.v2.session.ResponseVerificationHeader verify_header = 3; } // Get container structure @@ -139,12 +139,12 @@ message GetRequest { // Carries request meta information. Header data is used only to regulate // message transport and does not affect request execution. - neo.fs.v2.service.RequestMetaHeader meta_header = 2; + neo.fs.v2.session.RequestMetaHeader meta_header = 2; // Carries request verification information. This header is used to // authenticate the nodes of the message route and check the correctness // of transmission. - neo.fs.v2.service.RequestVerificationHeader verify_header = 3; + neo.fs.v2.session.RequestVerificationHeader verify_header = 3; } // Get container structure @@ -159,12 +159,12 @@ message GetResponse { // Carries response meta information. Header data is used only to regulate // message transport and does not affect request execution. - neo.fs.v2.service.ResponseMetaHeader meta_header = 2; + neo.fs.v2.session.ResponseMetaHeader meta_header = 2; // Carries response verification information. This header is used to // authenticate the nodes of the message route and check the correctness // of transmission. - neo.fs.v2.service.ResponseVerificationHeader verify_header = 3; + neo.fs.v2.session.ResponseVerificationHeader verify_header = 3; } // List containers @@ -179,12 +179,12 @@ message ListRequest { // Carries request meta information. Header data is used only to regulate // message transport and does not affect request execution. - neo.fs.v2.service.RequestMetaHeader meta_header = 2; + neo.fs.v2.session.RequestMetaHeader meta_header = 2; // Carries request verification information. This header is used to // authenticate the nodes of the message route and check the correctness // of transmission. - neo.fs.v2.service.RequestVerificationHeader verify_header = 3; + neo.fs.v2.session.RequestVerificationHeader verify_header = 3; } // List containers @@ -200,12 +200,12 @@ message ListResponse { // Carries response meta information. Header data is used only to regulate // message transport and does not affect request execution. - neo.fs.v2.service.ResponseMetaHeader meta_header = 2; + neo.fs.v2.session.ResponseMetaHeader meta_header = 2; // Carries response verification information. This header is used to // authenticate the nodes of the message route and check the correctness // of transmission. - neo.fs.v2.service.ResponseVerificationHeader verify_header = 3; + neo.fs.v2.session.ResponseVerificationHeader verify_header = 3; } // Set Extended ACL @@ -223,12 +223,12 @@ message SetExtendedACLRequest { // Carries request meta information. Header data is used only to regulate // message transport and does not affect request execution. - neo.fs.v2.service.RequestMetaHeader meta_header = 2; + neo.fs.v2.session.RequestMetaHeader meta_header = 2; // Carries request verification information. This header is used to // authenticate the nodes of the message route and check the correctness // of transmission. - neo.fs.v2.service.RequestVerificationHeader verify_header = 3; + neo.fs.v2.session.RequestVerificationHeader verify_header = 3; } // Set Extended ACL @@ -241,12 +241,12 @@ message SetExtendedACLResponse { // Carries response meta information. Header data is used only to regulate // message transport and does not affect request execution. - neo.fs.v2.service.ResponseMetaHeader meta_header = 2; + neo.fs.v2.session.ResponseMetaHeader meta_header = 2; // Carries response verification information. This header is used to // authenticate the nodes of the message route and check the correctness // of transmission. - neo.fs.v2.service.ResponseVerificationHeader verify_header = 3; + neo.fs.v2.session.ResponseVerificationHeader verify_header = 3; } // Get Extended ACL @@ -262,12 +262,12 @@ message GetExtendedACLRequest { // Carries request meta information. Header data is used only to regulate // message transport and does not affect request execution. - neo.fs.v2.service.RequestMetaHeader meta_header = 2; + neo.fs.v2.session.RequestMetaHeader meta_header = 2; // Carries request verification information. This header is used to // authenticate the nodes of the message route and check the correctness // of transmission. - neo.fs.v2.service.RequestVerificationHeader verify_header = 3; + neo.fs.v2.session.RequestVerificationHeader verify_header = 3; } // Get Extended ACL @@ -285,10 +285,10 @@ message GetExtendedACLResponse { // Carries response meta information. Header data is used only to regulate // message transport and does not affect request execution. - neo.fs.v2.service.ResponseMetaHeader meta_header = 2; + neo.fs.v2.session.ResponseMetaHeader meta_header = 2; // Carries response verification information. This header is used to // authenticate the nodes of the message route and check the correctness // of transmission. - neo.fs.v2.service.ResponseVerificationHeader verify_header = 3; + neo.fs.v2.session.ResponseVerificationHeader verify_header = 3; } diff --git a/object/service.proto b/object/service.proto index dba34d6..15ce27f 100644 --- a/object/service.proto +++ b/object/service.proto @@ -7,7 +7,7 @@ option csharp_namespace = "NeoFS.API.v2.Object"; import "object/types.proto"; import "refs/types.proto"; -import "service/types.proto"; +import "session/types.proto"; // Object service provides API for manipulating with the object. service ObjectService { @@ -68,11 +68,11 @@ message GetRequest { // Carries request meta information. Header data is used only to regulate message // transport and does not affect request execution. - neo.fs.v2.service.RequestMetaHeader meta_header = 2; + neo.fs.v2.session.RequestMetaHeader meta_header = 2; // Carries request verification information. This header is used to authenticate // the nodes of the message route and check the correctness of transmission. - neo.fs.v2.service.RequestVerificationHeader verify_header = 3; + neo.fs.v2.session.RequestVerificationHeader verify_header = 3; } // get object response @@ -104,12 +104,12 @@ message GetResponse { // Carries response meta information. Header data is used only to regulate // message transport and does not affect request execution. - neo.fs.v2.service.ResponseMetaHeader meta_header = 2; + neo.fs.v2.session.ResponseMetaHeader meta_header = 2; // Carries response verification information. This header is used to // authenticate the nodes of the message route and check the correctness // of transmission. - neo.fs.v2.service.ResponseVerificationHeader verify_header = 3; + neo.fs.v2.session.ResponseVerificationHeader verify_header = 3; } // Put object request @@ -146,11 +146,11 @@ message PutRequest { // Carries request meta information. Header data is used only to regulate message // transport and does not affect request execution. - neo.fs.v2.service.RequestMetaHeader meta_header = 2; + neo.fs.v2.session.RequestMetaHeader meta_header = 2; // Carries request verification information. This header is used to authenticate // the nodes of the message route and check the correctness of transmission. - neo.fs.v2.service.RequestVerificationHeader verify_header = 3; + neo.fs.v2.session.RequestVerificationHeader verify_header = 3; } // Put object response @@ -166,12 +166,12 @@ message PutResponse { // Carries response meta information. Header data is used only to regulate // message transport and does not affect request execution. - neo.fs.v2.service.ResponseMetaHeader meta_header = 2; + neo.fs.v2.session.ResponseMetaHeader meta_header = 2; // Carries response verification information. This header is used to // authenticate the nodes of the message route and check the correctness // of transmission. - neo.fs.v2.service.ResponseVerificationHeader verify_header = 3; + neo.fs.v2.session.ResponseVerificationHeader verify_header = 3; } // Object Delete request @@ -186,11 +186,11 @@ message DeleteRequest { // Carries request meta information. Header data is used only to regulate message // transport and does not affect request execution. - neo.fs.v2.service.RequestMetaHeader meta_header = 2; + neo.fs.v2.session.RequestMetaHeader meta_header = 2; // Carries request verification information. This header is used to authenticate // the nodes of the message route and check the correctness of transmission. - neo.fs.v2.service.RequestVerificationHeader verify_header = 3; + neo.fs.v2.session.RequestVerificationHeader verify_header = 3; } // DeleteResponse is empty because we cannot guarantee permanent object removal @@ -204,12 +204,12 @@ message DeleteResponse { // Carries response meta information. Header data is used only to regulate // message transport and does not affect request execution. - neo.fs.v2.service.ResponseMetaHeader meta_header = 2; + neo.fs.v2.session.ResponseMetaHeader meta_header = 2; // Carries response verification information. This header is used to // authenticate the nodes of the message route and check the correctness // of transmission. - neo.fs.v2.service.ResponseVerificationHeader verify_header = 3; + neo.fs.v2.session.ResponseVerificationHeader verify_header = 3; } // Object head request @@ -232,11 +232,11 @@ message HeadRequest { // Carries request meta information. Header data is used only to regulate message // transport and does not affect request execution. - neo.fs.v2.service.RequestMetaHeader meta_header = 2; + neo.fs.v2.session.RequestMetaHeader meta_header = 2; // Carries request verification information. This header is used to authenticate // the nodes of the message route and check the correctness of transmission. - neo.fs.v2.service.RequestVerificationHeader verify_header = 3; + neo.fs.v2.session.RequestVerificationHeader verify_header = 3; } // Head response @@ -257,12 +257,12 @@ message HeadResponse { // Carries response meta information. Header data is used only to regulate // message transport and does not affect request execution. - neo.fs.v2.service.ResponseMetaHeader meta_header = 2; + neo.fs.v2.session.ResponseMetaHeader meta_header = 2; // Carries response verification information. This header is used to // authenticate the nodes of the message route and check the correctness // of transmission. - neo.fs.v2.service.ResponseVerificationHeader verify_header = 3; + neo.fs.v2.session.ResponseVerificationHeader verify_header = 3; } // Search objects request @@ -293,11 +293,11 @@ message SearchRequest { // Carries request meta information. Header data is used only to regulate message // transport and does not affect request execution. - neo.fs.v2.service.RequestMetaHeader meta_header = 2; + neo.fs.v2.session.RequestMetaHeader meta_header = 2; // Carries request verification information. This header is used to authenticate // the nodes of the message route and check the correctness of transmission. - neo.fs.v2.service.RequestVerificationHeader verify_header = 3; + neo.fs.v2.session.RequestVerificationHeader verify_header = 3; } // Search response @@ -312,12 +312,12 @@ message SearchResponse { // Carries response meta information. Header data is used only to regulate // message transport and does not affect request execution. - neo.fs.v2.service.ResponseMetaHeader meta_header = 2; + neo.fs.v2.session.ResponseMetaHeader meta_header = 2; // Carries response verification information. This header is used to // authenticate the nodes of the message route and check the correctness // of transmission. - neo.fs.v2.service.ResponseVerificationHeader verify_header = 3; + neo.fs.v2.session.ResponseVerificationHeader verify_header = 3; } // Range groups the parameters of object payload range. @@ -345,11 +345,11 @@ message GetRangeRequest { // Carries request meta information. Header data is used only to regulate message // transport and does not affect request execution. - neo.fs.v2.service.RequestMetaHeader meta_header = 2; + neo.fs.v2.session.RequestMetaHeader meta_header = 2; // Carries request verification information. This header is used to authenticate // the nodes of the message route and check the correctness of transmission. - neo.fs.v2.service.RequestVerificationHeader verify_header = 3; + neo.fs.v2.session.RequestVerificationHeader verify_header = 3; } // Get part of object's payload @@ -365,12 +365,12 @@ message GetRangeResponse { // Carries response meta information. Header data is used only to regulate // message transport and does not affect request execution. - neo.fs.v2.service.ResponseMetaHeader meta_header = 2; + neo.fs.v2.session.ResponseMetaHeader meta_header = 2; // Carries response verification information. This header is used to // authenticate the nodes of the message route and check the correctness // of transmission. - neo.fs.v2.service.ResponseVerificationHeader verify_header = 3; + neo.fs.v2.session.ResponseVerificationHeader verify_header = 3; } // Get hash of object's payload part @@ -394,11 +394,11 @@ message GetRangeHashRequest { // Carries request meta information. Header data is used only to regulate message // transport and does not affect request execution. - neo.fs.v2.service.RequestMetaHeader meta_header = 2; + neo.fs.v2.session.RequestMetaHeader meta_header = 2; // Carries request verification information. This header is used to authenticate // the nodes of the message route and check the correctness of transmission. - neo.fs.v2.service.RequestVerificationHeader verify_header = 3; + neo.fs.v2.session.RequestVerificationHeader verify_header = 3; } // Get hash of object's payload part @@ -416,10 +416,10 @@ message GetRangeHashResponse { // Carries response meta information. Header data is used only to regulate // message transport and does not affect request execution. - neo.fs.v2.service.ResponseMetaHeader meta_header = 2; + neo.fs.v2.session.ResponseMetaHeader meta_header = 2; // Carries response verification information. This header is used to // authenticate the nodes of the message route and check the correctness // of transmission. - neo.fs.v2.service.ResponseVerificationHeader verify_header = 3; + neo.fs.v2.session.ResponseVerificationHeader verify_header = 3; } diff --git a/proto-docs/accounting.md b/proto-docs/accounting.md index f29c60b..202d639 100644 --- a/proto-docs/accounting.md +++ b/proto-docs/accounting.md @@ -68,8 +68,8 @@ according to the requirements from the system specification. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | body | [BalanceRequest.Body](#neo.fs.v2.accounting.BalanceRequest.Body) | | Body of the balance request message. | -| meta_header | [neo.fs.v2.service.RequestMetaHeader](#neo.fs.v2.service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. | -| verify_header | [neo.fs.v2.service.RequestVerificationHeader](#neo.fs.v2.service.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | +| meta_header | [neo.fs.v2.session.RequestMetaHeader](#neo.fs.v2.session.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. | +| verify_header | [neo.fs.v2.session.RequestVerificationHeader](#neo.fs.v2.session.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | @@ -94,8 +94,8 @@ The amount of funds is calculated in decimal numbers. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | body | [BalanceResponse.Body](#neo.fs.v2.accounting.BalanceResponse.Body) | | Body of the balance response message. | -| meta_header | [neo.fs.v2.service.ResponseMetaHeader](#neo.fs.v2.service.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. | -| verify_header | [neo.fs.v2.service.ResponseVerificationHeader](#neo.fs.v2.service.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | +| meta_header | [neo.fs.v2.session.ResponseMetaHeader](#neo.fs.v2.session.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. | +| verify_header | [neo.fs.v2.session.ResponseVerificationHeader](#neo.fs.v2.session.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | diff --git a/proto-docs/container.md b/proto-docs/container.md index a36f4a6..587ddb2 100644 --- a/proto-docs/container.md +++ b/proto-docs/container.md @@ -133,8 +133,8 @@ Container removal request | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | body | [DeleteRequest.Body](#neo.fs.v2.container.DeleteRequest.Body) | | Body of container delete request message. | -| meta_header | [neo.fs.v2.service.RequestMetaHeader](#neo.fs.v2.service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. | -| verify_header | [neo.fs.v2.service.RequestVerificationHeader](#neo.fs.v2.service.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | +| meta_header | [neo.fs.v2.session.RequestMetaHeader](#neo.fs.v2.session.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. | +| verify_header | [neo.fs.v2.session.RequestVerificationHeader](#neo.fs.v2.session.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | @@ -159,8 +159,8 @@ via consensus in inner ring nodes | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | body | [DeleteResponse.Body](#neo.fs.v2.container.DeleteResponse.Body) | | Body of container delete response message. | -| meta_header | [neo.fs.v2.service.ResponseMetaHeader](#neo.fs.v2.service.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. | -| verify_header | [neo.fs.v2.service.ResponseVerificationHeader](#neo.fs.v2.service.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | +| meta_header | [neo.fs.v2.session.ResponseMetaHeader](#neo.fs.v2.session.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. | +| verify_header | [neo.fs.v2.session.ResponseVerificationHeader](#neo.fs.v2.session.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | @@ -179,8 +179,8 @@ Get Extended ACL | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | body | [GetExtendedACLRequest.Body](#neo.fs.v2.container.GetExtendedACLRequest.Body) | | Body of get extended acl request message. | -| meta_header | [neo.fs.v2.service.RequestMetaHeader](#neo.fs.v2.service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. | -| verify_header | [neo.fs.v2.service.RequestVerificationHeader](#neo.fs.v2.service.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | +| meta_header | [neo.fs.v2.session.RequestMetaHeader](#neo.fs.v2.session.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. | +| verify_header | [neo.fs.v2.session.RequestVerificationHeader](#neo.fs.v2.session.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | @@ -203,8 +203,8 @@ Get Extended ACL | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | body | [GetExtendedACLResponse.Body](#neo.fs.v2.container.GetExtendedACLResponse.Body) | | Body of get extended acl response message. | -| meta_header | [neo.fs.v2.service.ResponseMetaHeader](#neo.fs.v2.service.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. | -| verify_header | [neo.fs.v2.service.ResponseVerificationHeader](#neo.fs.v2.service.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | +| meta_header | [neo.fs.v2.session.ResponseMetaHeader](#neo.fs.v2.session.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. | +| verify_header | [neo.fs.v2.session.ResponseVerificationHeader](#neo.fs.v2.session.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | @@ -228,8 +228,8 @@ Get container structure | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | body | [GetRequest.Body](#neo.fs.v2.container.GetRequest.Body) | | Body of container get request message. | -| meta_header | [neo.fs.v2.service.RequestMetaHeader](#neo.fs.v2.service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. | -| verify_header | [neo.fs.v2.service.RequestVerificationHeader](#neo.fs.v2.service.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | +| meta_header | [neo.fs.v2.session.RequestMetaHeader](#neo.fs.v2.session.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. | +| verify_header | [neo.fs.v2.session.RequestVerificationHeader](#neo.fs.v2.session.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | @@ -252,8 +252,8 @@ Get container structure | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | body | [GetResponse.Body](#neo.fs.v2.container.GetResponse.Body) | | Body of container get response message. | -| meta_header | [neo.fs.v2.service.ResponseMetaHeader](#neo.fs.v2.service.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. | -| verify_header | [neo.fs.v2.service.ResponseVerificationHeader](#neo.fs.v2.service.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | +| meta_header | [neo.fs.v2.session.ResponseMetaHeader](#neo.fs.v2.session.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. | +| verify_header | [neo.fs.v2.session.ResponseVerificationHeader](#neo.fs.v2.session.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | @@ -276,8 +276,8 @@ List containers | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | body | [ListRequest.Body](#neo.fs.v2.container.ListRequest.Body) | | Body of list containers request message. | -| meta_header | [neo.fs.v2.service.RequestMetaHeader](#neo.fs.v2.service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. | -| verify_header | [neo.fs.v2.service.RequestVerificationHeader](#neo.fs.v2.service.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | +| meta_header | [neo.fs.v2.session.RequestMetaHeader](#neo.fs.v2.session.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. | +| verify_header | [neo.fs.v2.session.RequestVerificationHeader](#neo.fs.v2.session.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | @@ -300,8 +300,8 @@ List containers | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | body | [ListResponse.Body](#neo.fs.v2.container.ListResponse.Body) | | Body of list containers response message. | -| meta_header | [neo.fs.v2.service.ResponseMetaHeader](#neo.fs.v2.service.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. | -| verify_header | [neo.fs.v2.service.ResponseVerificationHeader](#neo.fs.v2.service.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | +| meta_header | [neo.fs.v2.session.ResponseMetaHeader](#neo.fs.v2.session.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. | +| verify_header | [neo.fs.v2.session.ResponseVerificationHeader](#neo.fs.v2.session.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | @@ -324,8 +324,8 @@ New NeoFS Container creation request | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | body | [PutRequest.Body](#neo.fs.v2.container.PutRequest.Body) | | Body of container put request message. | -| meta_header | [neo.fs.v2.service.RequestMetaHeader](#neo.fs.v2.service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. | -| verify_header | [neo.fs.v2.service.RequestVerificationHeader](#neo.fs.v2.service.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | +| meta_header | [neo.fs.v2.session.RequestMetaHeader](#neo.fs.v2.session.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. | +| verify_header | [neo.fs.v2.session.RequestVerificationHeader](#neo.fs.v2.session.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | @@ -349,8 +349,8 @@ New NeoFS Container creation response | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | body | [PutResponse.Body](#neo.fs.v2.container.PutResponse.Body) | | Body of container put response message. | -| meta_header | [neo.fs.v2.service.ResponseMetaHeader](#neo.fs.v2.service.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. | -| verify_header | [neo.fs.v2.service.ResponseVerificationHeader](#neo.fs.v2.service.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | +| meta_header | [neo.fs.v2.session.ResponseMetaHeader](#neo.fs.v2.session.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. | +| verify_header | [neo.fs.v2.session.ResponseVerificationHeader](#neo.fs.v2.session.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | @@ -373,8 +373,8 @@ Set Extended ACL | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | body | [SetExtendedACLRequest.Body](#neo.fs.v2.container.SetExtendedACLRequest.Body) | | Body of set extended acl request message. | -| meta_header | [neo.fs.v2.service.RequestMetaHeader](#neo.fs.v2.service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. | -| verify_header | [neo.fs.v2.service.RequestVerificationHeader](#neo.fs.v2.service.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | +| meta_header | [neo.fs.v2.session.RequestMetaHeader](#neo.fs.v2.session.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. | +| verify_header | [neo.fs.v2.session.RequestVerificationHeader](#neo.fs.v2.session.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | @@ -398,8 +398,8 @@ Set Extended ACL | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | body | [SetExtendedACLResponse.Body](#neo.fs.v2.container.SetExtendedACLResponse.Body) | | Body of set extended acl response message. | -| meta_header | [neo.fs.v2.service.ResponseMetaHeader](#neo.fs.v2.service.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. | -| verify_header | [neo.fs.v2.service.ResponseVerificationHeader](#neo.fs.v2.service.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | +| meta_header | [neo.fs.v2.session.ResponseMetaHeader](#neo.fs.v2.session.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. | +| verify_header | [neo.fs.v2.session.ResponseVerificationHeader](#neo.fs.v2.session.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | diff --git a/proto-docs/object.md b/proto-docs/object.md index 729b3ea..ce47f3e 100644 --- a/proto-docs/object.md +++ b/proto-docs/object.md @@ -159,8 +159,8 @@ Object Delete request | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | body | [DeleteRequest.Body](#neo.fs.v2.object.DeleteRequest.Body) | | Body of delete object request message. | -| meta_header | [neo.fs.v2.service.RequestMetaHeader](#neo.fs.v2.service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. | -| verify_header | [neo.fs.v2.service.RequestVerificationHeader](#neo.fs.v2.service.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | +| meta_header | [neo.fs.v2.session.RequestMetaHeader](#neo.fs.v2.session.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. | +| verify_header | [neo.fs.v2.session.RequestVerificationHeader](#neo.fs.v2.session.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | @@ -184,8 +184,8 @@ in distributed system. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | body | [DeleteResponse.Body](#neo.fs.v2.object.DeleteResponse.Body) | | Body of delete object response message. | -| meta_header | [neo.fs.v2.service.ResponseMetaHeader](#neo.fs.v2.service.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. | -| verify_header | [neo.fs.v2.service.ResponseVerificationHeader](#neo.fs.v2.service.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | +| meta_header | [neo.fs.v2.session.ResponseMetaHeader](#neo.fs.v2.session.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. | +| verify_header | [neo.fs.v2.session.ResponseVerificationHeader](#neo.fs.v2.session.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | @@ -204,8 +204,8 @@ Get hash of object's payload part | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | body | [GetRangeHashRequest.Body](#neo.fs.v2.object.GetRangeHashRequest.Body) | | Body of get range hash object request message. | -| meta_header | [neo.fs.v2.service.RequestMetaHeader](#neo.fs.v2.service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. | -| verify_header | [neo.fs.v2.service.RequestVerificationHeader](#neo.fs.v2.service.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | +| meta_header | [neo.fs.v2.session.RequestMetaHeader](#neo.fs.v2.session.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. | +| verify_header | [neo.fs.v2.session.RequestVerificationHeader](#neo.fs.v2.session.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | @@ -231,8 +231,8 @@ Get hash of object's payload part | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | body | [GetRangeHashResponse.Body](#neo.fs.v2.object.GetRangeHashResponse.Body) | | Body of get range hash object response message. | -| meta_header | [neo.fs.v2.service.ResponseMetaHeader](#neo.fs.v2.service.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. | -| verify_header | [neo.fs.v2.service.ResponseVerificationHeader](#neo.fs.v2.service.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | +| meta_header | [neo.fs.v2.session.ResponseMetaHeader](#neo.fs.v2.session.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. | +| verify_header | [neo.fs.v2.session.ResponseVerificationHeader](#neo.fs.v2.session.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | @@ -256,8 +256,8 @@ Request to get part of object's payload | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | body | [GetRangeRequest.Body](#neo.fs.v2.object.GetRangeRequest.Body) | | Body of get range object request message. | -| meta_header | [neo.fs.v2.service.RequestMetaHeader](#neo.fs.v2.service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. | -| verify_header | [neo.fs.v2.service.RequestVerificationHeader](#neo.fs.v2.service.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | +| meta_header | [neo.fs.v2.session.RequestMetaHeader](#neo.fs.v2.session.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. | +| verify_header | [neo.fs.v2.session.RequestVerificationHeader](#neo.fs.v2.session.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | @@ -281,8 +281,8 @@ Get part of object's payload | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | body | [GetRangeResponse.Body](#neo.fs.v2.object.GetRangeResponse.Body) | | Body of get range object response message. | -| meta_header | [neo.fs.v2.service.ResponseMetaHeader](#neo.fs.v2.service.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. | -| verify_header | [neo.fs.v2.service.ResponseVerificationHeader](#neo.fs.v2.service.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | +| meta_header | [neo.fs.v2.session.ResponseMetaHeader](#neo.fs.v2.session.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. | +| verify_header | [neo.fs.v2.session.ResponseVerificationHeader](#neo.fs.v2.session.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | @@ -305,8 +305,8 @@ Get object request | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | body | [GetRequest.Body](#neo.fs.v2.object.GetRequest.Body) | | Body of get object request message. | -| meta_header | [neo.fs.v2.service.RequestMetaHeader](#neo.fs.v2.service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. | -| verify_header | [neo.fs.v2.service.RequestVerificationHeader](#neo.fs.v2.service.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | +| meta_header | [neo.fs.v2.session.RequestMetaHeader](#neo.fs.v2.session.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. | +| verify_header | [neo.fs.v2.session.RequestVerificationHeader](#neo.fs.v2.session.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | @@ -330,8 +330,8 @@ get object response | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | body | [GetResponse.Body](#neo.fs.v2.object.GetResponse.Body) | | Body of get object response message. | -| meta_header | [neo.fs.v2.service.ResponseMetaHeader](#neo.fs.v2.service.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. | -| verify_header | [neo.fs.v2.service.ResponseVerificationHeader](#neo.fs.v2.service.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | +| meta_header | [neo.fs.v2.session.ResponseMetaHeader](#neo.fs.v2.session.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. | +| verify_header | [neo.fs.v2.session.ResponseVerificationHeader](#neo.fs.v2.session.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | @@ -368,8 +368,8 @@ Object head request | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | body | [HeadRequest.Body](#neo.fs.v2.object.HeadRequest.Body) | | Body of head object request message. | -| meta_header | [neo.fs.v2.service.RequestMetaHeader](#neo.fs.v2.service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. | -| verify_header | [neo.fs.v2.service.RequestVerificationHeader](#neo.fs.v2.service.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | +| meta_header | [neo.fs.v2.session.RequestMetaHeader](#neo.fs.v2.session.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. | +| verify_header | [neo.fs.v2.session.RequestVerificationHeader](#neo.fs.v2.session.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | @@ -394,8 +394,8 @@ Head response | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | body | [HeadResponse.Body](#neo.fs.v2.object.HeadResponse.Body) | | Body of head object response message. | -| meta_header | [neo.fs.v2.service.ResponseMetaHeader](#neo.fs.v2.service.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. | -| verify_header | [neo.fs.v2.service.ResponseVerificationHeader](#neo.fs.v2.service.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | +| meta_header | [neo.fs.v2.session.ResponseMetaHeader](#neo.fs.v2.session.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. | +| verify_header | [neo.fs.v2.session.ResponseVerificationHeader](#neo.fs.v2.session.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | @@ -419,8 +419,8 @@ Put object request | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | body | [PutRequest.Body](#neo.fs.v2.object.PutRequest.Body) | | Body of put object request message. | -| meta_header | [neo.fs.v2.service.RequestMetaHeader](#neo.fs.v2.service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. | -| verify_header | [neo.fs.v2.service.RequestVerificationHeader](#neo.fs.v2.service.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | +| meta_header | [neo.fs.v2.session.RequestMetaHeader](#neo.fs.v2.session.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. | +| verify_header | [neo.fs.v2.session.RequestVerificationHeader](#neo.fs.v2.session.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | @@ -458,8 +458,8 @@ Put object response | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | body | [PutResponse.Body](#neo.fs.v2.object.PutResponse.Body) | | Body of put object response message. | -| meta_header | [neo.fs.v2.service.ResponseMetaHeader](#neo.fs.v2.service.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. | -| verify_header | [neo.fs.v2.service.ResponseVerificationHeader](#neo.fs.v2.service.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | +| meta_header | [neo.fs.v2.session.ResponseMetaHeader](#neo.fs.v2.session.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. | +| verify_header | [neo.fs.v2.session.ResponseVerificationHeader](#neo.fs.v2.session.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | @@ -494,8 +494,8 @@ Search objects request | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | body | [SearchRequest.Body](#neo.fs.v2.object.SearchRequest.Body) | | Body of search object request message. | -| meta_header | [neo.fs.v2.service.RequestMetaHeader](#neo.fs.v2.service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. | -| verify_header | [neo.fs.v2.service.RequestVerificationHeader](#neo.fs.v2.service.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | +| meta_header | [neo.fs.v2.session.RequestMetaHeader](#neo.fs.v2.session.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. | +| verify_header | [neo.fs.v2.session.RequestVerificationHeader](#neo.fs.v2.session.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | @@ -533,8 +533,8 @@ Search response | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | body | [SearchResponse.Body](#neo.fs.v2.object.SearchResponse.Body) | | Body of search object response message. | -| meta_header | [neo.fs.v2.service.ResponseMetaHeader](#neo.fs.v2.service.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. | -| verify_header | [neo.fs.v2.service.ResponseVerificationHeader](#neo.fs.v2.service.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | +| meta_header | [neo.fs.v2.session.ResponseMetaHeader](#neo.fs.v2.session.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. | +| verify_header | [neo.fs.v2.session.ResponseVerificationHeader](#neo.fs.v2.session.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | diff --git a/proto-docs/session.md b/proto-docs/session.md index 81ec58e..9a6ee57 100644 --- a/proto-docs/session.md +++ b/proto-docs/session.md @@ -18,9 +18,14 @@ - Messages - [ObjectSessionContext](#neo.fs.v2.session.ObjectSessionContext) + - [RequestMetaHeader](#neo.fs.v2.session.RequestMetaHeader) + - [RequestVerificationHeader](#neo.fs.v2.session.RequestVerificationHeader) + - [ResponseMetaHeader](#neo.fs.v2.session.ResponseMetaHeader) + - [ResponseVerificationHeader](#neo.fs.v2.session.ResponseVerificationHeader) - [SessionToken](#neo.fs.v2.session.SessionToken) - [SessionToken.Body](#neo.fs.v2.session.SessionToken.Body) - [SessionToken.Body.TokenLifetime](#neo.fs.v2.session.SessionToken.Body.TokenLifetime) + - [XHeader](#neo.fs.v2.session.XHeader) - [Scalar Value Types](#scalar-value-types) @@ -64,8 +69,8 @@ CreateRequest carries an information necessary for opening a session. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | body | [CreateRequest.Body](#neo.fs.v2.session.CreateRequest.Body) | | Body of create session token request message. | -| meta_header | [neo.fs.v2.service.RequestMetaHeader](#neo.fs.v2.service.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. | -| verify_header | [neo.fs.v2.service.RequestVerificationHeader](#neo.fs.v2.service.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | +| meta_header | [RequestMetaHeader](#neo.fs.v2.session.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. | +| verify_header | [RequestVerificationHeader](#neo.fs.v2.session.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | @@ -89,8 +94,8 @@ CreateResponse carries an information about the opened session. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | body | [CreateResponse.Body](#neo.fs.v2.session.CreateResponse.Body) | | Body of create session token response message. | -| meta_header | [neo.fs.v2.service.ResponseMetaHeader](#neo.fs.v2.service.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. | -| verify_header | [neo.fs.v2.service.ResponseVerificationHeader](#neo.fs.v2.service.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | +| meta_header | [ResponseMetaHeader](#neo.fs.v2.session.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. | +| verify_header | [ResponseVerificationHeader](#neo.fs.v2.session.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. | @@ -131,6 +136,66 @@ Context information for Session Tokens related to ObjectService requests | address | [neo.fs.v2.refs.Address](#neo.fs.v2.refs.Address) | | Related Object address | + + +### Message RequestMetaHeader +Information about the request + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| version | [neo.fs.v2.refs.Version](#neo.fs.v2.refs.Version) | | Client API version. | +| epoch | [uint64](#uint64) | | Client local epoch number. Set to 0 if unknown. | +| ttl | [uint32](#uint32) | | Maximum number of nodes in the request route. | +| x_headers | [XHeader](#neo.fs.v2.session.XHeader) | repeated | Request X-Headers. | +| session_token | [SessionToken](#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](#neo.fs.v2.acl.BearerToken) | | Bearer is a Bearer token of the request | +| origin | [RequestMetaHeader](#neo.fs.v2.session.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](#neo.fs.v2.refs.Signature) | | Request Body signature. Should be generated once by request initiator. | +| meta_signature | [neo.fs.v2.refs.Signature](#neo.fs.v2.refs.Signature) | | Request Meta signature is added and signed by any intermediate node | +| origin_signature | [neo.fs.v2.refs.Signature](#neo.fs.v2.refs.Signature) | | Sign previous hops | +| origin | [RequestVerificationHeader](#neo.fs.v2.session.RequestVerificationHeader) | | Chain of previous hops signatures | + + + + +### Message ResponseMetaHeader +Information about the response + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| version | [neo.fs.v2.refs.Version](#neo.fs.v2.refs.Version) | | Server API version. | +| epoch | [uint64](#uint64) | | Server local epoch number. | +| ttl | [uint32](#uint32) | | Maximum number of nodes in the response route. | +| x_headers | [XHeader](#neo.fs.v2.session.XHeader) | repeated | Response X-Headers. | +| origin | [ResponseMetaHeader](#neo.fs.v2.session.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](#neo.fs.v2.refs.Signature) | | Response Body signature. Should be generated once by answering node. | +| meta_signature | [neo.fs.v2.refs.Signature](#neo.fs.v2.refs.Signature) | | Response Meta signature is added and signed by any intermediate node | +| origin_signature | [neo.fs.v2.refs.Signature](#neo.fs.v2.refs.Signature) | | Sign previous hops | +| origin | [ResponseVerificationHeader](#neo.fs.v2.session.ResponseVerificationHeader) | | Chain of previous hops signatures | + + ### Message SessionToken @@ -170,6 +235,18 @@ Lifetime parameters of the token. Filed names taken from rfc7519. | nbf | [uint64](#uint64) | | Not valid before Epoch | | iat | [uint64](#uint64) | | Issued at Epoch | + + + +### Message XHeader +Extended headers for Request/Response + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | Key of the X-Header. | +| value | [string](#string) | | Value of the X-Header. | + diff --git a/service/types.proto b/service/types.proto deleted file mode 100644 index 3f9db75..0000000 --- a/service/types.proto +++ /dev/null @@ -1,89 +0,0 @@ -syntax = "proto3"; - -package neo.fs.v2.service; - -option go_package = "github.com/nspcc-dev/neofs-api-go/v2/service/grpc;service"; -option csharp_namespace = "NeoFS.API.v2.Service"; - -import "acl/types.proto"; -import "refs/types.proto"; -import "session/types.proto"; - -// Extended headers for Request/Response -message XHeader { - // Key of the X-Header. - string key = 1; - - // Value of the X-Header. - string value = 2; -} - - -// Information about the request -message RequestMetaHeader { - // Client API version. - neo.fs.v2.refs.Version version = 1; - - // Client local epoch number. Set to 0 if unknown. - uint64 epoch = 2; - - // Maximum number of nodes in the request route. - uint32 ttl = 3; - - // Request X-Headers. - repeated XHeader x_headers = 4; - - // Token is a token of the session within which the request is sent - neo.fs.v2.session.SessionToken session_token = 5; - - // Bearer is a Bearer token of the request - neo.fs.v2.acl.BearerToken bearer_token = 6; - - // RequestMetaHeader of the origin request. - RequestMetaHeader origin = 7; -} - -// Information about the response -message ResponseMetaHeader { - // Server API version. - neo.fs.v2.refs.Version version = 1; - - // Server local epoch number. - uint64 epoch = 2; - - // Maximum number of nodes in the response route. - uint32 ttl = 3; - - // Response X-Headers. - repeated XHeader x_headers = 4; - - // Carries response meta header of the origin response. - ResponseMetaHeader origin = 5; -} - - -// Verification info for request signed by all intermediate nodes -message RequestVerificationHeader { - // Request Body signature. Should be generated once by request initiator. - neo.fs.v2.refs.Signature body_signature = 1; - // Request Meta signature is added and signed by any intermediate node - neo.fs.v2.refs.Signature meta_signature = 2; - // Sign previous hops - neo.fs.v2.refs.Signature origin_signature = 3; - - // Chain of previous hops signatures - RequestVerificationHeader origin = 4; -} - -// Verification info for response signed by all intermediate nodes -message ResponseVerificationHeader { - // Response Body signature. Should be generated once by answering node. - neo.fs.v2.refs.Signature body_signature = 1; - // Response Meta signature is added and signed by any intermediate node - neo.fs.v2.refs.Signature meta_signature = 2; - // Sign previous hops - neo.fs.v2.refs.Signature origin_signature = 3; - - // Chain of previous hops signatures - ResponseVerificationHeader origin = 4; -} diff --git a/session/service.proto b/session/service.proto index f04ebb7..5ecfe52 100644 --- a/session/service.proto +++ b/session/service.proto @@ -6,7 +6,7 @@ option go_package = "github.com/nspcc-dev/neofs-api-go/v2/session/grpc;session"; option csharp_namespace = "NeoFS.API.v2.Session"; import "refs/types.proto"; -import "service/types.proto"; +import "session/types.proto"; // Create Session record on Node side service SessionService { @@ -28,11 +28,11 @@ message CreateRequest { // Carries request meta information. Header data is used only to regulate message // transport and does not affect request execution. - neo.fs.v2.service.RequestMetaHeader meta_header = 2; + neo.fs.v2.session.RequestMetaHeader meta_header = 2; // Carries request verification information. This header is used to authenticate // the nodes of the message route and check the correctness of transmission. - neo.fs.v2.service.RequestVerificationHeader verify_header = 3; + neo.fs.v2.session.RequestVerificationHeader verify_header = 3; } // CreateResponse carries an information about the opened session. @@ -51,10 +51,10 @@ message CreateResponse { // Carries response meta information. Header data is used only to regulate // message transport and does not affect request execution. - neo.fs.v2.service.ResponseMetaHeader meta_header = 2; + neo.fs.v2.session.ResponseMetaHeader meta_header = 2; // Carries response verification information. This header is used to // authenticate the nodes of the message route and check the correctness // of transmission. - neo.fs.v2.service.ResponseVerificationHeader verify_header = 3; + neo.fs.v2.session.ResponseVerificationHeader verify_header = 3; } diff --git a/session/types.proto b/session/types.proto index 84ba10c..0f21b93 100644 --- a/session/types.proto +++ b/session/types.proto @@ -6,6 +6,7 @@ option go_package = "github.com/nspcc-dev/neofs-api-go/v2/session/grpc;session"; option csharp_namespace = "NeoFS.API.v2.Session"; import "refs/types.proto"; +import "acl/types.proto"; // Context information for Session Tokens related to ObjectService requests message ObjectSessionContext { @@ -81,3 +82,81 @@ message SessionToken { // Signature is a signature of session token information neo.fs.v2.refs.Signature signature = 2; } + +// Extended headers for Request/Response +message XHeader { + // Key of the X-Header. + string key = 1; + + // Value of the X-Header. + string value = 2; +} + + +// Information about the request +message RequestMetaHeader { + // Client API version. + neo.fs.v2.refs.Version version = 1; + + // Client local epoch number. Set to 0 if unknown. + uint64 epoch = 2; + + // Maximum number of nodes in the request route. + uint32 ttl = 3; + + // Request X-Headers. + repeated XHeader x_headers = 4; + + // Token is a token of the session within which the request is sent + SessionToken session_token = 5; + + // Bearer is a Bearer token of the request + neo.fs.v2.acl.BearerToken bearer_token = 6; + + // RequestMetaHeader of the origin request. + RequestMetaHeader origin = 7; +} + +// Information about the response +message ResponseMetaHeader { + // Server API version. + neo.fs.v2.refs.Version version = 1; + + // Server local epoch number. + uint64 epoch = 2; + + // Maximum number of nodes in the response route. + uint32 ttl = 3; + + // Response X-Headers. + repeated XHeader x_headers = 4; + + // Carries response meta header of the origin response. + ResponseMetaHeader origin = 5; +} + +// Verification info for request signed by all intermediate nodes +message RequestVerificationHeader { + // Request Body signature. Should be generated once by request initiator. + neo.fs.v2.refs.Signature body_signature = 1; + // Request Meta signature is added and signed by any intermediate node + neo.fs.v2.refs.Signature meta_signature = 2; + // Sign previous hops + neo.fs.v2.refs.Signature origin_signature = 3; + + // Chain of previous hops signatures + RequestVerificationHeader origin = 4; +} + +// Verification info for response signed by all intermediate nodes +message ResponseVerificationHeader { + // Response Body signature. Should be generated once by answering node. + neo.fs.v2.refs.Signature body_signature = 1; + // Response Meta signature is added and signed by any intermediate node + neo.fs.v2.refs.Signature meta_signature = 2; + // Sign previous hops + neo.fs.v2.refs.Signature origin_signature = 3; + + // Chain of previous hops signatures + ResponseVerificationHeader origin = 4; +}