carpawell/frostfs-api
1
0
Fork 0
forked from TrueCloudLab/frostfs-api
Code Issues Pull requests Projects Releases Packages Wiki Activity

acl: Tidy up the format

Browse source 
Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
This commit is contained in:
Leonard Lyubich 2020-08-06 01:10:09 +03:00 committed by Stanislav Bogatyrev
parent d38377793a
commit fca07c84d6
2 changed files with 7 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
acl/types.proto
View file

@ -1,5 +1,7 @@
syntax = "proto3"; syntax = "proto3";
package acl; package acl;
option go_package = "github.com/nspcc-dev/neofs-api-go/acl"; option go_package = "github.com/nspcc-dev/neofs-api-go/acl";
option csharp_namespace = "NeoFS.API.Acl"; option csharp_namespace = "NeoFS.API.Acl";
@ -11,18 +13,14 @@ enum Target {
Unknown = 0; Unknown = 0;
// User target rule is applied if sender is the owner of the container. // User target rule is applied if sender is the owner of the container.
User = 1; User = 1;
// System target rule is applied if sender is the storage node within the // System target rule is applied if sender is the storage node within the
// container or inner ring node. // container or inner ring node.
System = 2; System = 2;
// Others target rule is applied if sender is not user or system target. // Others target rule is applied if sender is not user or system target.
Others = 3; Others = 3;
// PubKey target rule is applied if sender has public key provided in
// extended ACL.
PubKey = 4;
} }
// EACLRecord groups information about extended ACL rule. // EACLRecord groups information about extended ACL rule.
@ -102,6 +100,7 @@ message EACLRecord {
message EACLTable { message EACLTable {
// Carries identifier of the container that should use given access control rules. // Carries identifier of the container that should use given access control rules.
refs.ContainerID ContainerID = 1 [json_name="ContainerID"]; refs.ContainerID ContainerID = 1 [json_name="ContainerID"];
// Records carries list of extended ACL rule records. // Records carries list of extended ACL rule records.
repeated EACLRecord Records = 2 [json_name="Records"]; repeated EACLRecord Records = 2 [json_name="Records"];
} }

3
proto-docs/acl.md
View file

@ -73,7 +73,7 @@ EACLRecord carries the information about extended ACL rules.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| ContainerID | [bytes](#bytes) | | ContainerID of the container that should use given access control rules. | | ContainerID | [refs.ContainerID](#refs.ContainerID) | | Carries identifier of the container that should use given access control rules. |
| Records | [EACLRecord](#acl.EACLRecord) | repeated | Records carries list of extended ACL rule records. | | Records | [EACLRecord](#acl.EACLRecord) | repeated | Records carries list of extended ACL rule records. |
<!-- end messages --> <!-- end messages -->
@ -148,7 +148,6 @@ Target of the access control rule in access control list.
| User | 1 | User target rule is applied if sender is the owner of the container. | | 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. | | 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. | | 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 --> <!-- end enums -->