From 5b8fecc93d82f499eb1a61278bfa69788a0d81cb Mon Sep 17 00:00:00 2001 From: alexvanin Date: Wed, 1 Apr 2020 18:48:49 +0300 Subject: [PATCH] docs: Add docs for new ACL package This commit adds auto-generated proto-docs page and ACL section in readme. --- README.md | 5 +++- proto-docs/acl.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 66 insertions(+), 1 deletion(-) create mode 100644 proto-docs/acl.md diff --git a/README.md b/README.md index e00551b..ea817f1 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ repository. Use them to integrate applications with NeoFS. This repository contains: -- 11 protocol buffers packages, +- 12 protocol buffers packages, - [auto-generated docs](proto-docs) for protocol buffers, - [manually written docs](docs) for developers (to be done). @@ -33,6 +33,9 @@ See: - [Accounting service](proto-docs/accounting.md#accounting.Accounting) - [Withdraw service](proto-docs/accounting.md#accounting.Withdraw) +#### ACL + +ACL package defines targets of access control rules. #### Bootstrap diff --git a/proto-docs/acl.md b/proto-docs/acl.md new file mode 100644 index 0000000..38f328b --- /dev/null +++ b/proto-docs/acl.md @@ -0,0 +1,62 @@ +# Protocol Documentation + + +## Table of Contents + +- [acl/types.proto](#acl/types.proto) + + + +- [Scalar Value Types](#scalar-value-types) + + + + +

Top

+ +## acl/types.proto + + + + + + + + + +### 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. | + + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ Type | Java Type | Python Type | +| ----------- | ----- | -------- | --------- | ----------- | +| double | | double | double | float | +| float | | float | float | float | +| 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 | +| 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 | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | +| sfixed32 | Always four bytes. | int32 | int | int | +| sfixed64 | Always eight bytes. | int64 | long | int/long | +| bool | | bool | boolean | boolean | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | +