forked from TrueCloudLab/frostfs-api
docs: Add docs for new ACL package
This commit adds auto-generated proto-docs page and ACL section in readme.
This commit is contained in:
parent
afd55ac90b
commit
5b8fecc93d
2 changed files with 66 additions and 1 deletions
|
@ -16,7 +16,7 @@ repository. Use them to integrate applications with NeoFS.
|
||||||
|
|
||||||
This repository contains:
|
This repository contains:
|
||||||
|
|
||||||
- 11 protocol buffers packages,
|
- 12 protocol buffers packages,
|
||||||
- [auto-generated docs](proto-docs) for protocol buffers,
|
- [auto-generated docs](proto-docs) for protocol buffers,
|
||||||
- [manually written docs](docs) for developers (to be done).
|
- [manually written docs](docs) for developers (to be done).
|
||||||
|
|
||||||
|
@ -33,6 +33,9 @@ See:
|
||||||
- [Accounting service](proto-docs/accounting.md#accounting.Accounting)
|
- [Accounting service](proto-docs/accounting.md#accounting.Accounting)
|
||||||
- [Withdraw service](proto-docs/accounting.md#accounting.Withdraw)
|
- [Withdraw service](proto-docs/accounting.md#accounting.Withdraw)
|
||||||
|
|
||||||
|
#### ACL
|
||||||
|
|
||||||
|
ACL package defines targets of access control rules.
|
||||||
|
|
||||||
#### Bootstrap
|
#### Bootstrap
|
||||||
|
|
||||||
|
|
62
proto-docs/acl.md
Normal file
62
proto-docs/acl.md
Normal file
|
@ -0,0 +1,62 @@
|
||||||
|
# Protocol Documentation
|
||||||
|
<a name="top"></a>
|
||||||
|
|
||||||
|
## Table of Contents
|
||||||
|
|
||||||
|
- [acl/types.proto](#acl/types.proto)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
- [Scalar Value Types](#scalar-value-types)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="acl/types.proto"></a>
|
||||||
|
<p align="right"><a href="#top">Top</a></p>
|
||||||
|
|
||||||
|
## acl/types.proto
|
||||||
|
|
||||||
|
|
||||||
|
<!-- end services -->
|
||||||
|
|
||||||
|
<!-- end messages -->
|
||||||
|
|
||||||
|
|
||||||
|
<a name="acl.Target"></a>
|
||||||
|
|
||||||
|
### Target
|
||||||
|
Target of the access control rule in access control list.
|
||||||
|
|
||||||
|
| Name | Number | Description |
|
||||||
|
| ---- | ------ | ----------- |
|
||||||
|
| Unknown | 0 | Unknown target, default value. |
|
||||||
|
| User | 1 | User target rule is applied if sender is the owner of the container. |
|
||||||
|
| System | 2 | System target rule is applied if sender is the storage node within the container or inner ring node. |
|
||||||
|
| Others | 3 | Others target rule is applied if sender is not user or system target. |
|
||||||
|
| PubKey | 4 | PubKey target rule is applied if sender has public key provided in extended ACL. |
|
||||||
|
|
||||||
|
|
||||||
|
<!-- end enums -->
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Scalar Value Types
|
||||||
|
|
||||||
|
| .proto Type | Notes | C++ Type | Java Type | Python Type |
|
||||||
|
| ----------- | ----- | -------- | --------- | ----------- |
|
||||||
|
| <a name="double" /> double | | double | double | float |
|
||||||
|
| <a name="float" /> float | | float | float | float |
|
||||||
|
| <a name="int32" /> int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int |
|
||||||
|
| <a name="int64" /> int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long |
|
||||||
|
| <a name="uint32" /> uint32 | Uses variable-length encoding. | uint32 | int | int/long |
|
||||||
|
| <a name="uint64" /> uint64 | Uses variable-length encoding. | uint64 | long | int/long |
|
||||||
|
| <a name="sint32" /> sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int |
|
||||||
|
| <a name="sint64" /> sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long |
|
||||||
|
| <a name="fixed32" /> fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int |
|
||||||
|
| <a name="fixed64" /> fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long |
|
||||||
|
| <a name="sfixed32" /> sfixed32 | Always four bytes. | int32 | int | int |
|
||||||
|
| <a name="sfixed64" /> sfixed64 | Always eight bytes. | int64 | long | int/long |
|
||||||
|
| <a name="bool" /> bool | | bool | boolean | boolean |
|
||||||
|
| <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode |
|
||||||
|
| <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str |
|
||||||
|
|
Loading…
Reference in a new issue