orikik/frostfs-api
1
0
Fork 0
forked from TrueCloudLab/frostfs-api
Code Pull requests 1 Activity Actions

[#38] docs: update docs after object type changes

Browse source 
Signed-off-by: Stanislav Bogatyrev <stanislav@nspcc.ru>
This commit is contained in:
Stanislav Bogatyrev 2020-08-11 16:04:54 +03:00 committed by Stanislav Bogatyrev
parent 818ec7f0dc
commit 658bc45fb9
4 changed files with 34 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
proto-docs/acl.md
View file

@ -101,8 +101,7 @@ Header is an enumeration of filtering header types.
| ---- | ------ | ----------- |
| HEADER_UNKNOWN | 0 | |
| REQUEST | 1 | |
| OBJECT_SYSTEM | 2 | |
| OBJECT_USER | 3 | |
| OBJECT | 2 | |

4
proto-docs/refs.md
View file

@ -40,7 +40,7 @@ Address of object (container id + object id)
<a name="refs.ContainerID"></a>
### Message ContainerID
ContainerID groups information about the NeoFS container identifier.
NeoFS container identifier.
| Field | Type | Label | Description |
@ -51,7 +51,7 @@ ContainerID groups information about the NeoFS container identifier.
<a name="refs.ObjectID"></a>
### Message ObjectID
ObjectID groups information about the NeoFS object identifier.
NeoFS object identifier.
| Field | Type | Label | Description |

46
proto-docs/service.md
View file

@ -8,6 +8,7 @@
- Messages
- [RequestMetaHeader](#service.RequestMetaHeader)
- [RequestMetaHeader.XHeader](#service.RequestMetaHeader.XHeader)
- [Version](#service.Version)
- [service/verify.proto](#service/verify.proto)
@ -16,9 +17,9 @@
- [BearerTokenMsg](#service.BearerTokenMsg)
- [BearerTokenMsg.Info](#service.BearerTokenMsg.Info)
- [RequestVerificationHeader](#service.RequestVerificationHeader)
- [RequestVerificationHeader.Signature](#service.RequestVerificationHeader.Signature)
- [SessionToken](#service.SessionToken)
- [SessionToken.Info](#service.SessionToken.Info)
- [Signature](#service.Signature)
- [TokenLifetime](#service.TokenLifetime)
@ -58,6 +59,18 @@ RequestMetaHeader contains information about request meta headers.
| key | [string](#string) | | Carries key to the X-Header. |
| value | [string](#string) | | Carries value of the X-Header. |
<a name="service.Version"></a>
### Message Version
Represents API version used by node.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| major | [uint32](#uint32) | | Major API version. |
| minor | [uint32](#uint32) | | Minor API version. |
<!-- end messages -->
<!-- end enums -->
@ -102,28 +115,17 @@ BearerTokenMsg carries information about request ACL rules with limited lifetime
<a name="service.RequestVerificationHeader"></a>
### Message RequestVerificationHeader
RequestVerificationHeader is a set of signatures of every NeoFS Node that processed request.
RequestVerificationHeader is a set of signatures of every NeoFS Node that
processed request.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| signatures | [RequestVerificationHeader.Signature](#service.RequestVerificationHeader.Signature) | repeated | Signatures is a set of signatures of every passed NeoFS Node |
| signatures | [Signature](#service.Signature) | repeated | Signatures is a set of signatures of every passed NeoFS Node |
| token | [SessionToken](#service.SessionToken) | | Token is a token of the session within which the request is sent |
| bearer | [BearerTokenMsg](#service.BearerTokenMsg) | | Bearer is a Bearer token of the request |
<a name="service.RequestVerificationHeader.Signature"></a>
### Message RequestVerificationHeader.Signature
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| key | [bytes](#bytes) | | Key is compressed public key used for signature. |
| sign | [bytes](#bytes) | | Sign is signature of the request or session key. |
<a name="service.SessionToken"></a>
### Message SessionToken
@ -145,7 +147,7 @@ Represents the NeoFS session token.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| id | [bytes](#bytes) | | ID is a token identifier. valid UUIDv4 represented in bytes |
| owner_id | [refs.OwnerID](#refs.OwnerID) | | OwnerID carries identifier of the session author. |
| owner_id | [refs.OwnerID](#refs.OwnerID) | | OwnerID carries identifier of the session initiator. |
| verb | [SessionToken.Info.Verb](#service.SessionToken.Info.Verb) | | Verb is a type of request for which the token is issued |
| lifetime | [TokenLifetime](#service.TokenLifetime) | | Lifetime is a lifetime of the session |
| session_key | [bytes](#bytes) | | SessionKey is a public key of session key |
@ -153,6 +155,18 @@ Represents the NeoFS session token.
| object_address | [refs.Address](#refs.Address) | | object_address represents the object session context. |
<a name="service.Signature"></a>
### Message Signature
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| key | [bytes](#bytes) | | Public key used for signing. |
| sign | [bytes](#bytes) | | Signature |
<a name="service.TokenLifetime"></a>
### Message TokenLifetime

2
proto-docs/storagegroup.md
View file

@ -32,7 +32,7 @@ The storage group consists of objects from single container.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| validation_data_size | [uint64](#uint64) | | validation_data_size carries the total size of the payloads of the storage group members. |
| validation_hash | [bytes](#bytes) | | validation_hash carries homomorphic hash from the concatenation of the payloads of the storage group members. The order of concatenation is the same as the order of the members in the Members field. |
| validation_hash | [bytes](#bytes) | | validation_hash carries homomorphic hash from the concatenation of the payloads of the storage group members The order of concatenation is the same as the order of the members in the Members field. |
| expiration_epoch | [uint64](#uint64) | | expiration_epoch carries last NeoFS epoch number of the storage group lifetime. |
| members | [refs.ObjectID](#refs.ObjectID) | repeated | Members carries the list of identifiers of the object storage group members. The list is strictly ordered. |