docs: regenerate proto documentation
This commit is contained in:
parent
e333a13557
commit
27a129c795
7 changed files with 78 additions and 73 deletions
|
@ -87,7 +87,7 @@ Balance returns current balance status of the NeoFS user
|
|||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| OwnerID | [bytes](#bytes) | | OwnerID is a wallet address |
|
||||
| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node |
|
||||
| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node Deprecated: will be replaced with RequestMetaHeader (see develop branch) |
|
||||
|
||||
|
||||
<a name="accounting.BalanceResponse"></a>
|
||||
|
@ -362,7 +362,7 @@ Delete allows user to remove unused cheque
|
|||
| OwnerID | [bytes](#bytes) | | OwnerID is a wallet address |
|
||||
| MessageID | [bytes](#bytes) | | MessageID is a nonce for uniq request (UUIDv4) |
|
||||
| Signature | [bytes](#bytes) | | Signature is a signature of the sent request |
|
||||
| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node |
|
||||
| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node Deprecated: will be replaced with RequestMetaHeader (see develop branch) |
|
||||
|
||||
|
||||
<a name="accounting.DeleteResponse"></a>
|
||||
|
@ -382,7 +382,7 @@ DeleteResponse is empty
|
|||
| ----- | ---- | ----- | ----------- |
|
||||
| ID | [bytes](#bytes) | | ID is cheque identifier |
|
||||
| OwnerID | [bytes](#bytes) | | OwnerID is a wallet address |
|
||||
| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node |
|
||||
| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node Deprecated: will be replaced with RequestMetaHeader (see develop branch) |
|
||||
|
||||
|
||||
<a name="accounting.GetResponse"></a>
|
||||
|
@ -393,7 +393,7 @@ DeleteResponse is empty
|
|||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| Withdraw | [Item](#accounting.Item) | | Item is cheque with meta information |
|
||||
| Withdraw | [Item](#accounting.Item) | | Withdraw is cheque with meta information |
|
||||
|
||||
|
||||
<a name="accounting.Item"></a>
|
||||
|
@ -420,7 +420,7 @@ DeleteResponse is empty
|
|||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| OwnerID | [bytes](#bytes) | | OwnerID is a wallet address |
|
||||
| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node |
|
||||
| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node Deprecated: will be replaced with RequestMetaHeader (see develop branch) |
|
||||
|
||||
|
||||
<a name="accounting.ListResponse"></a>
|
||||
|
@ -431,7 +431,7 @@ DeleteResponse is empty
|
|||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| Items | [Item](#accounting.Item) | repeated | Item is a set of cheques with meta information |
|
||||
| Items | [Item](#accounting.Item) | repeated | Items is a set of cheques with meta information |
|
||||
|
||||
|
||||
<a name="accounting.PutRequest"></a>
|
||||
|
@ -447,7 +447,7 @@ DeleteResponse is empty
|
|||
| Height | [uint64](#uint64) | | Height is the neo blockchain height until the cheque is valid |
|
||||
| MessageID | [bytes](#bytes) | | MessageID is a nonce for uniq request (UUIDv4) |
|
||||
| Signature | [bytes](#bytes) | | Signature is a signature of the sent request |
|
||||
| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node |
|
||||
| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node Deprecated: will be replaced with RequestMetaHeader (see develop branch) |
|
||||
|
||||
|
||||
<a name="accounting.PutResponse"></a>
|
||||
|
|
|
@ -62,7 +62,7 @@ Process is method that allows to register node in the network and receive actual
|
|||
| ----- | ---- | ----- | ----------- |
|
||||
| type | [int32](#int32) | | Type is NodeType, can be InnerRingNode (type=1) or StorageNode (type=2) |
|
||||
| info | [NodeInfo](#bootstrap.NodeInfo) | | Info contains information about node |
|
||||
| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node |
|
||||
| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node Deprecated: will be replaced with RequestMetaHeader (see develop branch) |
|
||||
|
||||
<!-- end messages -->
|
||||
|
||||
|
|
|
@ -92,7 +92,7 @@ List returns all user's containers
|
|||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| CID | [bytes](#bytes) | | CID (container id) is a SHA256 hash of the container structure |
|
||||
| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node |
|
||||
| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node Deprecated: will be replaced with RequestMetaHeader (see develop branch) |
|
||||
| Signature | [bytes](#bytes) | | Signature of the container owner |
|
||||
|
||||
|
||||
|
@ -113,7 +113,7 @@ via consensus in inner ring nodes
|
|||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| CID | [bytes](#bytes) | | CID (container id) is a SHA256 hash of the container structure |
|
||||
| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node |
|
||||
| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node Deprecated: will be replaced with RequestMetaHeader (see develop branch) |
|
||||
|
||||
|
||||
<a name="container.GetResponse"></a>
|
||||
|
@ -136,7 +136,7 @@ via consensus in inner ring nodes
|
|||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| OwnerID | [bytes](#bytes) | | OwnerID is a wallet address |
|
||||
| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node |
|
||||
| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node Deprecated: will be replaced with RequestMetaHeader (see develop branch) |
|
||||
|
||||
|
||||
<a name="container.ListResponse"></a>
|
||||
|
@ -163,7 +163,7 @@ via consensus in inner ring nodes
|
|||
| OwnerID | [bytes](#bytes) | | OwnerID is a wallet address |
|
||||
| rules | [netmap.PlacementRule](#netmap.PlacementRule) | | Rules define storage policy for the object inside the container. |
|
||||
| Signature | [bytes](#bytes) | | Signature of the user (owner id) |
|
||||
| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node |
|
||||
| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node Deprecated: will be replaced with RequestMetaHeader (see develop branch) |
|
||||
|
||||
|
||||
<a name="container.PutResponse"></a>
|
||||
|
|
|
@ -147,10 +147,10 @@ calculated for XORed data.
|
|||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| Epoch | [uint64](#uint64) | | Epoch is set by user to 0, node set epoch to the actual value |
|
||||
| Epoch | [uint64](#uint64) | | Epoch is set by user to 0, node set epoch to the actual value Deprecated: will be replaced with RequestMetaHeader (see develop branch) |
|
||||
| Address | [refs.Address](#refs.Address) | | Address of object (container id + object id) |
|
||||
| OwnerID | [bytes](#bytes) | | OwnerID is a wallet address |
|
||||
| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node |
|
||||
| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node Deprecated: will be replaced with RequestMetaHeader (see develop branch) |
|
||||
| Token | [session.Token](#session.Token) | | Token with session public key and user's signature |
|
||||
|
||||
|
||||
|
@ -170,11 +170,11 @@ in distributed system.
|
|||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| Epoch | [uint64](#uint64) | | Epoch is set by user to 0, node set epoch to the actual value |
|
||||
| Epoch | [uint64](#uint64) | | Epoch is set by user to 0, node set epoch to the actual value Deprecated: will be replaced with RequestMetaHeader (see develop branch) |
|
||||
| Address | [refs.Address](#refs.Address) | | Address of object (container id + object id) |
|
||||
| Ranges | [Range](#object.Range) | repeated | Ranges of object's payload to calculate homomorphic hash |
|
||||
| Salt | [bytes](#bytes) | | Salt is used to XOR object's payload ranges before hashing, it can be nil |
|
||||
| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node |
|
||||
| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node Deprecated: will be replaced with RequestMetaHeader (see develop branch) |
|
||||
|
||||
|
||||
<a name="object.GetRangeHashResponse"></a>
|
||||
|
@ -185,7 +185,7 @@ in distributed system.
|
|||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| Hashes | [bytes](#bytes) | repeated | Homomorphic hashes of all ranges |
|
||||
| Hashes | [bytes](#bytes) | repeated | Hashes is a homomorphic hashes of all ranges |
|
||||
|
||||
|
||||
<a name="object.GetRangeRequest"></a>
|
||||
|
@ -196,10 +196,10 @@ in distributed system.
|
|||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| Epoch | [uint64](#uint64) | | Epoch is set by user to 0, node set epoch to the actual value |
|
||||
| Epoch | [uint64](#uint64) | | Epoch is set by user to 0, node set epoch to the actual value Deprecated: will be replaced with RequestMetaHeader (see develop branch) |
|
||||
| Address | [refs.Address](#refs.Address) | | Address of object (container id + object id) |
|
||||
| Ranges | [Range](#object.Range) | repeated | Ranges of object's payload to return |
|
||||
| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node |
|
||||
| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node Deprecated: will be replaced with RequestMetaHeader (see develop branch) |
|
||||
|
||||
|
||||
<a name="object.GetRangeResponse"></a>
|
||||
|
@ -221,9 +221,9 @@ in distributed system.
|
|||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| Epoch | [uint64](#uint64) | | Epoch is set by user to 0, node set epoch to the actual value |
|
||||
| Epoch | [uint64](#uint64) | | Epoch is set by user to 0, node set epoch to the actual value Deprecated: will be replaced with RequestMetaHeader (see develop branch) |
|
||||
| Address | [refs.Address](#refs.Address) | | Address of object (container id + object id) |
|
||||
| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node |
|
||||
| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node Deprecated: will be replaced with RequestMetaHeader (see develop branch) |
|
||||
|
||||
|
||||
<a name="object.GetResponse"></a>
|
||||
|
@ -246,10 +246,10 @@ in distributed system.
|
|||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| Epoch | [uint64](#uint64) | | Epoch is set by user to 0, node set epoch to the actual value |
|
||||
| Epoch | [uint64](#uint64) | | Epoch should be empty on user side, node sets epoch to the actual value Deprecated: will be replaced with RequestMetaHeader (see develop branch) |
|
||||
| Address | [refs.Address](#refs.Address) | | Address of object (container id + object id) |
|
||||
| FullHeaders | [bool](#bool) | | FullHeaders can be set true for extended headers in the object |
|
||||
| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node |
|
||||
| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node Deprecated: will be replaced with RequestMetaHeader (see develop branch) |
|
||||
|
||||
|
||||
<a name="object.HeadResponse"></a>
|
||||
|
@ -283,9 +283,9 @@ in distributed system.
|
|||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| Epoch | [uint64](#uint64) | | Epoch is set by user to 0, node set epoch to the actual value |
|
||||
| Epoch | [uint64](#uint64) | | Epoch is set by user to 0, node set epoch to the actual value Deprecated: will be replaced with RequestMetaHeader (see develop branch) |
|
||||
| Object | [Object](#object.Object) | | Object with at least container id and owner id fields |
|
||||
| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node |
|
||||
| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node Deprecated: will be replaced with RequestMetaHeader (see develop branch) |
|
||||
| Token | [session.Token](#session.Token) | | Token with session public key and user's signature |
|
||||
|
||||
|
||||
|
@ -308,11 +308,11 @@ in distributed system.
|
|||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| Epoch | [uint64](#uint64) | | Epoch is set by user to 0, node set epoch to the actual value |
|
||||
| Epoch | [uint64](#uint64) | | Epoch is set by user to 0, node set epoch to the actual value Deprecated: will be replaced with RequestMetaHeader (see develop branch) |
|
||||
| Version | [uint32](#uint32) | | Version of search query format |
|
||||
| ContainerID | [bytes](#bytes) | | ContainerID for searching the object |
|
||||
| Query | [bytes](#bytes) | | Query in the binary serialized format |
|
||||
| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node |
|
||||
| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node Deprecated: will be replaced with RequestMetaHeader (see develop branch) |
|
||||
|
||||
|
||||
<a name="object.SearchResponse"></a>
|
||||
|
@ -348,8 +348,8 @@ in distributed system.
|
|||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| UnixTime | [int64](#int64) | | Date of creation in unixtime format |
|
||||
| Epoch | [uint64](#uint64) | | Date of creation in NeoFS epochs |
|
||||
| UnixTime | [int64](#int64) | | UnixTime is a date of creation in unixtime format |
|
||||
| Epoch | [uint64](#uint64) | | Epoch is a date of creation in NeoFS epochs |
|
||||
|
||||
|
||||
<a name="object.Header"></a>
|
||||
|
@ -361,12 +361,12 @@ in distributed system.
|
|||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| Link | [Link](#object.Link) | | Link to other objects |
|
||||
| Redirect | [refs.Address](#refs.Address) | | RedirectNot used yet |
|
||||
| UserHeader | [UserHeader](#object.UserHeader) | | UserHeader defined by user |
|
||||
| Redirect | [refs.Address](#refs.Address) | | Redirect not used yet |
|
||||
| UserHeader | [UserHeader](#object.UserHeader) | | UserHeader is a set of KV headers defined by user |
|
||||
| Transform | [Transform](#object.Transform) | | Transform defines transform operation (e.g. payload split) |
|
||||
| Tombstone | [Tombstone](#object.Tombstone) | | Tombstone header that set up in deleted objects |
|
||||
| Verify | [session.VerificationHeader](#session.VerificationHeader) | | Verify header that contains session public key and user's signature |
|
||||
| HomoHash | [bytes](#bytes) | | Homomorphic hash of original object payload |
|
||||
| HomoHash | [bytes](#bytes) | | HomoHash is a homomorphic hash of original object payload |
|
||||
| PayloadChecksum | [bytes](#bytes) | | PayloadChecksum of actual object's payload |
|
||||
| Integrity | [IntegrityHeader](#object.IntegrityHeader) | | Integrity header with checksum of all above headers in the object |
|
||||
| StorageGroup | [StorageGroup](#object.StorageGroup) | | StorageGroup contains meta information for the data audit |
|
||||
|
@ -380,8 +380,8 @@ in distributed system.
|
|||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| HeadersChecksum | [bytes](#bytes) | | Checksum of all above headers in the object |
|
||||
| ChecksumSignature | [bytes](#bytes) | | User's signature of checksum to verify if it is correct |
|
||||
| HeadersChecksum | [bytes](#bytes) | | HeadersChecksum is a checksum of all above headers in the object |
|
||||
| ChecksumSignature | [bytes](#bytes) | | ChecksumSignature is an user's signature of checksum to verify if it is correct |
|
||||
|
||||
|
||||
<a name="object.Link"></a>
|
||||
|
@ -392,8 +392,8 @@ in distributed system.
|
|||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| type | [Link.Type](#object.Link.Type) | | Link type |
|
||||
| ID | [bytes](#bytes) | | Object id |
|
||||
| type | [Link.Type](#object.Link.Type) | | Type of link |
|
||||
| ID | [bytes](#bytes) | | ID is an object identifier, is a valid UUIDv4 |
|
||||
|
||||
|
||||
<a name="object.Object"></a>
|
||||
|
@ -404,9 +404,9 @@ in distributed system.
|
|||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| SystemHeader | [SystemHeader](#object.SystemHeader) | | System header |
|
||||
| Headers | [Header](#object.Header) | repeated | Extended headers |
|
||||
| Payload | [bytes](#bytes) | | Object's payload |
|
||||
| SystemHeader | [SystemHeader](#object.SystemHeader) | | SystemHeader describes system header |
|
||||
| Headers | [Header](#object.Header) | repeated | Headers describes a set of an extended headers |
|
||||
| Payload | [bytes](#bytes) | | Payload is an object's payload |
|
||||
|
||||
|
||||
<a name="object.Range"></a>
|
||||
|
@ -429,9 +429,9 @@ in distributed system.
|
|||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| ValidationDataSize | [uint64](#uint64) | | Size of the all object's payloads included into storage group |
|
||||
| ValidationHash | [bytes](#bytes) | | Homomorphic hash of all object's payloads included into storage group |
|
||||
| lifetime | [StorageGroup.Lifetime](#object.StorageGroup.Lifetime) | | Time until storage group is valid |
|
||||
| ValidationDataSize | [uint64](#uint64) | | ValidationDataSize is size of the all object's payloads included into storage group |
|
||||
| ValidationHash | [bytes](#bytes) | | ValidationHash is homomorphic hash of all object's payloads included into storage group |
|
||||
| lifetime | [StorageGroup.Lifetime](#object.StorageGroup.Lifetime) | | Lifetime is time until storage group is valid |
|
||||
|
||||
|
||||
<a name="object.StorageGroup.Lifetime"></a>
|
||||
|
@ -442,8 +442,8 @@ in distributed system.
|
|||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| unit | [StorageGroup.Lifetime.Unit](#object.StorageGroup.Lifetime.Unit) | | Lifetime type |
|
||||
| Value | [int64](#int64) | | Lifetime value |
|
||||
| unit | [StorageGroup.Lifetime.Unit](#object.StorageGroup.Lifetime.Unit) | | Unit is lifetime type |
|
||||
| Value | [int64](#int64) | | Value for lifetime |
|
||||
|
||||
|
||||
<a name="object.SystemHeader"></a>
|
||||
|
@ -455,11 +455,11 @@ in distributed system.
|
|||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| Version | [uint64](#uint64) | | Version of the object structure |
|
||||
| PayloadLength | [uint64](#uint64) | | Object payload length |
|
||||
| ID | [bytes](#bytes) | | ObjectID is a UUID |
|
||||
| PayloadLength | [uint64](#uint64) | | PayloadLength is an object payload length |
|
||||
| ID | [bytes](#bytes) | | ID is an object identifier, is a valid UUIDv4 |
|
||||
| OwnerID | [bytes](#bytes) | | OwnerID is a wallet address |
|
||||
| CID | [bytes](#bytes) | | ContainerID is a SHA256 hash of the container structure |
|
||||
| CreatedAt | [CreationPoint](#object.CreationPoint) | | Timestamp of object creation |
|
||||
| CID | [bytes](#bytes) | | CID is a SHA256 hash of the container structure (container identifier) |
|
||||
| CreatedAt | [CreationPoint](#object.CreationPoint) | | CreatedAt is a timestamp of object creation |
|
||||
|
||||
|
||||
<a name="object.Tombstone"></a>
|
||||
|
@ -521,9 +521,9 @@ in distributed system.
|
|||
|
||||
| Name | Number | Description |
|
||||
| ---- | ------ | ----------- |
|
||||
| Unlimited | 0 | Storage group always valid |
|
||||
| NeoFSEpoch | 1 | Storage group is valid until lifetime NeoFS epoch |
|
||||
| UnixTime | 2 | Storage group is valid until lifetime unix timestamp |
|
||||
| Unlimited | 0 | Unlimited set if storage group always valid |
|
||||
| NeoFSEpoch | 1 | NeoFSEpoch set if storage group is valid until lifetime NeoFS epoch |
|
||||
| UnixTime | 2 | UnixTime set if storage group is valid until lifetime unix timestamp |
|
||||
|
||||
|
||||
|
||||
|
@ -535,9 +535,9 @@ in distributed system.
|
|||
| Name | Number | Description |
|
||||
| ---- | ------ | ----------- |
|
||||
| Unknown | 0 | |
|
||||
| Split | 1 | Object created after payload split |
|
||||
| Sign | 2 | Object created after re-signing (doesn't used) |
|
||||
| Mould | 3 | Object created after filling missing headers in the object |
|
||||
| Split | 1 | Split sets when object created after payload split |
|
||||
| Sign | 2 | Sign sets when object created after re-signing (doesn't used) |
|
||||
| Mould | 3 | Mould sets when object created after filling missing headers in the object |
|
||||
|
||||
|
||||
<!-- end enums -->
|
||||
|
|
|
@ -52,12 +52,12 @@
|
|||
<a name="query.Filter.Type"></a>
|
||||
|
||||
### Filter.Type
|
||||
Type can be Exact or Regex
|
||||
|
||||
|
||||
| Name | Number | Description |
|
||||
| ---- | ------ | ----------- |
|
||||
| Exact | 0 | |
|
||||
| Regex | 1 | |
|
||||
| Exact | 0 | Exact sets when value of filter should be equal to the header value |
|
||||
| Regex | 1 | Regex sets when value of filter should match the header value by the regular expression |
|
||||
|
||||
|
||||
<!-- end enums -->
|
||||
|
|
|
@ -30,7 +30,7 @@ Address of object (container id + object id)
|
|||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| ObjectID | [bytes](#bytes) | | ObjectID is an object identifier |
|
||||
| ObjectID | [bytes](#bytes) | | ObjectID is an object identifier, valid UUIDv4 represented in bytes |
|
||||
| CID | [bytes](#bytes) | | CID is container identifier |
|
||||
|
||||
<!-- end messages -->
|
||||
|
|
|
@ -34,11 +34,7 @@
|
|||
<a name="session.Session"></a>
|
||||
|
||||
### Service "session.Session"
|
||||
Open a trusted session to manipulate an object. In order to put or
|
||||
delete object client have to obtain session token with trusted node.
|
||||
Trusted node will modify client's object (add missing headers, checksums,
|
||||
homomorphic hash) and sign id with session key. Session is established
|
||||
during 4-step handshake in one gRPC stream
|
||||
|
||||
|
||||
```
|
||||
rpc Create(stream CreateRequest) returns (stream CreateResponse);
|
||||
|
@ -47,7 +43,16 @@ rpc Create(stream CreateRequest) returns (stream CreateResponse);
|
|||
|
||||
#### Method Create
|
||||
|
||||
Create is a method that used to open a trusted session to manipulate
|
||||
an object. In order to put or delete object client have to obtain session
|
||||
token with trusted node. Trusted node will modify client's object
|
||||
(add missing headers, checksums, homomorphic hash) and sign id with
|
||||
session key. Session is established during 4-step handshake in one gRPC stream
|
||||
|
||||
- First client stream message SHOULD BE type of `CreateRequest_Init`.
|
||||
- First server stream message SHOULD BE type of `CreateResponse_Unsigned`.
|
||||
- Second client stream message SHOULD BE type of `CreateRequest_Signed`.
|
||||
- Second server stream message SHOULD BE type of `CreateResponse_Result`.
|
||||
|
||||
| Name | Input | Output |
|
||||
| ---- | ----- | ------ |
|
||||
|
@ -63,7 +68,7 @@ rpc Create(stream CreateRequest) returns (stream CreateResponse);
|
|||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| Init | [Token](#session.Token) | | Message to init session opening. Carry: owner of manipulation object; ID of manipulation object; token lifetime bounds. |
|
||||
| Init | [Token](#session.Token) | | Init is a message to initialize session opening. Carry: owner of manipulation object; ID of manipulation object; token lifetime bounds. |
|
||||
| Signed | [Token](#session.Token) | | Signed Init message response (Unsigned) from server with user private key |
|
||||
|
||||
|
||||
|
@ -76,7 +81,7 @@ rpc Create(stream CreateRequest) returns (stream CreateResponse);
|
|||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| Unsigned | [Token](#session.Token) | | Unsigned token with token ID and session public key generated on server side |
|
||||
| Result | [Token](#session.Token) | | Resulting token which can be used for object placing through an trusted intermediary |
|
||||
| Result | [Token](#session.Token) | | Result is a resulting token which can be used for object placing through an trusted intermediary |
|
||||
|
||||
<!-- end messages -->
|
||||
|
||||
|
@ -102,12 +107,12 @@ User token granting rights for object manipulation
|
|||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| Header | [VerificationHeader](#session.VerificationHeader) | | Header carries verification data of session key |
|
||||
| OwnerID | [bytes](#bytes) | | Owner of manipulation object |
|
||||
| FirstEpoch | [uint64](#uint64) | | Initial epoch of token lifetime |
|
||||
| LastEpoch | [uint64](#uint64) | | Last epoch of token lifetime |
|
||||
| ObjectID | [bytes](#bytes) | repeated | ID of manipulation object |
|
||||
| Signature | [bytes](#bytes) | | Token signature. Signed by owner of manipulation object |
|
||||
| ID | [bytes](#bytes) | | Token ID (UUID) |
|
||||
| OwnerID | [bytes](#bytes) | | OwnerID is an owner of manipulation object |
|
||||
| FirstEpoch | [uint64](#uint64) | | FirstEpoch is an initial epoch of token lifetime |
|
||||
| LastEpoch | [uint64](#uint64) | | LastEpoch is a last epoch of token lifetime |
|
||||
| ObjectID | [bytes](#bytes) | repeated | ObjectID is an object identifier of manipulation object |
|
||||
| Signature | [bytes](#bytes) | | Signature is a token signature, signed by owner of manipulation object |
|
||||
| ID | [bytes](#bytes) | | ID is a token identifier. valid UUIDv4 represented in bytes |
|
||||
|
||||
|
||||
<a name="session.VerificationHeader"></a>
|
||||
|
@ -118,8 +123,8 @@ User token granting rights for object manipulation
|
|||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| PublicKey | [bytes](#bytes) | | Session public key |
|
||||
| KeySignature | [bytes](#bytes) | | Session public key signature. Signed by trusted side |
|
||||
| PublicKey | [bytes](#bytes) | | PublicKey is a session public key |
|
||||
| KeySignature | [bytes](#bytes) | | KeySignature is a session public key signature. Signed by trusted side |
|
||||
|
||||
<!-- end messages -->
|
||||
|
||||
|
|
Loading…
Reference in a new issue