forked from TrueCloudLab/frostfs-api
[#49] Minor reformat
- Trying to move enums to the package level - Trying to keep all definitions in types.proto Signed-off-by: Stanislav Bogatyrev <stanislav@nspcc.ru>
This commit is contained in:
Stanislav Bogatyrev
Alex Vanin
parent
e63a482529
commit
7555e166b2
5 changed files with 134 additions and 131 deletions
|
|
@ -33,8 +33,8 @@ EACLRecord groups information about extended ACL rule.
|
|||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| operation | [EACLRecord.Operation](#neo.fs.v2.acl.EACLRecord.Operation) | | Operation carries type of operation. |
|
||||
| action | [EACLRecord.Action](#neo.fs.v2.acl.EACLRecord.Action) | | Action carries ACL target action. |
|
||||
| operation | [Operation](#neo.fs.v2.acl.Operation) | | Operation carries type of operation. |
|
||||
| action | [Action](#neo.fs.v2.acl.Action) | | Action carries ACL target action. |
|
||||
| filters | [EACLRecord.FilterInfo](#neo.fs.v2.acl.EACLRecord.FilterInfo) | repeated | filters carries set of filters. |
|
||||
| targets | [EACLRecord.TargetInfo](#neo.fs.v2.acl.EACLRecord.TargetInfo) | repeated | targets carries information about extended ACL target list. |
|
||||
|
||||
|
|
@ -47,8 +47,8 @@ FilterInfo groups information about filter.
|
|||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| header | [EACLRecord.FilterInfo.Header](#neo.fs.v2.acl.EACLRecord.FilterInfo.Header) | | Header carries type of header. |
|
||||
| match_type | [EACLRecord.FilterInfo.MatchType](#neo.fs.v2.acl.EACLRecord.FilterInfo.MatchType) | | MatchType carries type of match. |
|
||||
| header | [HeaderType](#neo.fs.v2.acl.HeaderType) | | Header carries type of header. |
|
||||
| match_type | [MatchType](#neo.fs.v2.acl.MatchType) | | MatchType carries type of match. |
|
||||
| header_name | [string](#string) | | header_name carries name of filtering header. |
|
||||
| header_val | [string](#string) | | header_val carries value of filtering header. |
|
||||
|
||||
|
|
@ -79,9 +79,9 @@ EACLRecord carries the information about extended ACL rules.
|
|||
<!-- end messages -->
|
||||
|
||||
|
||||
<a name="neo.fs.v2.acl.EACLRecord.Action"></a>
|
||||
<a name="neo.fs.v2.acl.Action"></a>
|
||||
|
||||
### EACLRecord.Action
|
||||
### Action
|
||||
Action is an enumeration of EACL actions.
|
||||
|
||||
| Name | Number | Description |
|
||||
|
|
@ -92,9 +92,9 @@ Action is an enumeration of EACL actions.
|
|||
|
||||
|
||||
|
||||
<a name="neo.fs.v2.acl.EACLRecord.FilterInfo.Header"></a>
|
||||
<a name="neo.fs.v2.acl.HeaderType"></a>
|
||||
|
||||
### EACLRecord.FilterInfo.Header
|
||||
### HeaderType
|
||||
Header is an enumeration of filtering header types.
|
||||
|
||||
| Name | Number | Description |
|
||||
|
|
@ -105,9 +105,9 @@ Header is an enumeration of filtering header types.
|
|||
|
||||
|
||||
|
||||
<a name="neo.fs.v2.acl.EACLRecord.FilterInfo.MatchType"></a>
|
||||
<a name="neo.fs.v2.acl.MatchType"></a>
|
||||
|
||||
### EACLRecord.FilterInfo.MatchType
|
||||
### MatchType
|
||||
MatchType is an enumeration of match types.
|
||||
|
||||
| Name | Number | Description |
|
||||
|
|
@ -118,9 +118,9 @@ MatchType is an enumeration of match types.
|
|||
|
||||
|
||||
|
||||
<a name="neo.fs.v2.acl.EACLRecord.Operation"></a>
|
||||
<a name="neo.fs.v2.acl.Operation"></a>
|
||||
|
||||
### EACLRecord.Operation
|
||||
### Operation
|
||||
Operation is an enumeration of operation types.
|
||||
|
||||
| Name | Number | Description |
|
||||
|
|
|
|||
|
|
@ -29,7 +29,6 @@
|
|||
- [HeadRequest.Body](#neo.fs.v2.object.HeadRequest.Body)
|
||||
- [HeadResponse](#neo.fs.v2.object.HeadResponse)
|
||||
- [HeadResponse.Body](#neo.fs.v2.object.HeadResponse.Body)
|
||||
- [HeadResponse.Body.ShortHeader](#neo.fs.v2.object.HeadResponse.Body.ShortHeader)
|
||||
- [PutRequest](#neo.fs.v2.object.PutRequest)
|
||||
- [PutRequest.Body](#neo.fs.v2.object.PutRequest.Body)
|
||||
- [PutRequest.Body.Init](#neo.fs.v2.object.PutRequest.Body.Init)
|
||||
|
|
@ -50,6 +49,7 @@
|
|||
- [Header.Attribute](#neo.fs.v2.object.Header.Attribute)
|
||||
- [Header.Split](#neo.fs.v2.object.Header.Split)
|
||||
- [Object](#neo.fs.v2.object.Object)
|
||||
- [ShortHeader](#neo.fs.v2.object.ShortHeader)
|
||||
|
||||
|
||||
- [Scalar Value Types](#scalar-value-types)
|
||||
|
|
@ -406,22 +406,7 @@ Response body
|
|||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| header | [Header](#neo.fs.v2.object.Header) | | Full object header |
|
||||
| short_header | [HeadResponse.Body.ShortHeader](#neo.fs.v2.object.HeadResponse.Body.ShortHeader) | | Short object header |
|
||||
|
||||
|
||||
<a name="neo.fs.v2.object.HeadResponse.Body.ShortHeader"></a>
|
||||
|
||||
### Message HeadResponse.Body.ShortHeader
|
||||
Short header fields
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| version | [neo.fs.v2.service.Version](#neo.fs.v2.service.Version) | | Object format version. |
|
||||
| creation_epoch | [uint64](#uint64) | | Epoch when the object was created |
|
||||
| owner_id | [neo.fs.v2.refs.OwnerID](#neo.fs.v2.refs.OwnerID) | | Object's owner |
|
||||
| object_type | [ObjectType](#neo.fs.v2.object.ObjectType) | | Type of the object payload content |
|
||||
| payload_length | [uint64](#uint64) | | Size of payload in bytes. 0xFFFFFFFFFFFFFFFF means `payload_length` is unknown |
|
||||
| short_header | [ShortHeader](#neo.fs.v2.object.ShortHeader) | | Short object header |
|
||||
|
||||
|
||||
<a name="neo.fs.v2.object.PutRequest"></a>
|
||||
|
|
@ -533,7 +518,7 @@ Filter structure
|
|||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| match_type | [SearchRequest.Body.Filter.MatchType](#neo.fs.v2.object.SearchRequest.Body.Filter.MatchType) | | Match type to use |
|
||||
| match_type | [MatchType](#neo.fs.v2.object.MatchType) | | Match type to use |
|
||||
| name | [string](#string) | | Header name to match |
|
||||
| value | [string](#string) | | Header value to match |
|
||||
|
||||
|
|
@ -563,18 +548,6 @@ Response body
|
|||
|
||||
<!-- end messages -->
|
||||
|
||||
|
||||
<a name="neo.fs.v2.object.SearchRequest.Body.Filter.MatchType"></a>
|
||||
|
||||
### SearchRequest.Body.Filter.MatchType
|
||||
Type of match expression
|
||||
|
||||
| Name | Number | Description |
|
||||
| ---- | ------ | ----------- |
|
||||
| MATCH_TYPE_UNSPECIFIED | 0 | Unknown. Not used |
|
||||
| STRING_EQUAL | 1 | Full string match |
|
||||
|
||||
|
||||
<!-- end enums -->
|
||||
|
||||
|
||||
|
|
@ -649,9 +622,36 @@ Object structure.
|
|||
| header | [Header](#neo.fs.v2.object.Header) | | Object metadata headers |
|
||||
| payload | [bytes](#bytes) | | Payload bytes. |
|
||||
|
||||
|
||||
<a name="neo.fs.v2.object.ShortHeader"></a>
|
||||
|
||||
### Message ShortHeader
|
||||
Short header fields
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| version | [neo.fs.v2.service.Version](#neo.fs.v2.service.Version) | | Object format version. |
|
||||
| creation_epoch | [uint64](#uint64) | | Epoch when the object was created |
|
||||
| owner_id | [neo.fs.v2.refs.OwnerID](#neo.fs.v2.refs.OwnerID) | | Object's owner |
|
||||
| object_type | [ObjectType](#neo.fs.v2.object.ObjectType) | | Type of the object payload content |
|
||||
| payload_length | [uint64](#uint64) | | Size of payload in bytes. 0xFFFFFFFFFFFFFFFF means `payload_length` is unknown |
|
||||
|
||||
<!-- end messages -->
|
||||
|
||||
|
||||
<a name="neo.fs.v2.object.MatchType"></a>
|
||||
|
||||
### MatchType
|
||||
Type of match expression
|
||||
|
||||
| Name | Number | Description |
|
||||
| ---- | ------ | ----------- |
|
||||
| MATCH_TYPE_UNSPECIFIED | 0 | Unknown. Not used |
|
||||
| STRING_EQUAL | 1 | Full string match |
|
||||
|
||||
|
||||
|
||||
<a name="neo.fs.v2.object.ObjectType"></a>
|
||||
|
||||
### ObjectType
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue