mirrors/etcd
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

*: change Protocol Buffer documentation title

Browse Source
This commit is contained in:
Gyu-Ho Lee 2016-04-21 19:58:41 -07:00
parent fdf6335416
commit 2751a10db6
2 changed files with 45 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

88
Documentation/api_reference_v3.md
View File

@ -1,47 +1,4 @@
### Protocol Buffer API ### etcd API Reference
##### message `Lease` (lease/leasepb/lease.proto)
| Field | Description | Type |
| ----- | ----------- | ---- |
| ID | | int64 |
| TTL | | int64 |
##### message `Permission` (auth/authpb/auth.proto)
Permission is a single entity
| Field | Description | Type |
| ----- | ----------- | ---- |
| key | | bytes |
| permType | | Type |
##### message `Role` (auth/authpb/auth.proto)
Role is a single entry in the bucket authRoles
| Field | Description | Type |
| ----- | ----------- | ---- |
| name | | bytes |
| keyPermission | | (slice of) Permission |
##### message `User` (auth/authpb/auth.proto)
User is a single entry in the bucket authUsers
| Field | Description | Type |
| ----- | ----------- | ---- |
| name | | bytes |
| password | | bytes |
| roles | | (slice of) string |
##### service `Auth` (etcdserver/etcdserverpb/rpc.proto) ##### service `Auth` (etcdserver/etcdserverpb/rpc.proto)
@ -769,3 +726,46 @@ From google paxosdb paper: Our implementation hinges around a powerful primitive
##### message `Lease` (lease/leasepb/lease.proto)
| Field | Description | Type |
| ----- | ----------- | ---- |
| ID | | int64 |
| TTL | | int64 |
##### message `Permission` (auth/authpb/auth.proto)
Permission is a single entity
| Field | Description | Type |
| ----- | ----------- | ---- |
| key | | bytes |
| permType | | Type |
##### message `Role` (auth/authpb/auth.proto)
Role is a single entry in the bucket authRoles
| Field | Description | Type |
| ----- | ----------- | ---- |
| name | | bytes |
| keyPermission | | (slice of) Permission |
##### message `User` (auth/authpb/auth.proto)
User is a single entry in the bucket authUsers
| Field | Description | Type |
| ----- | ----------- | ---- |
| name | | bytes |
| password | | bytes |
| roles | | (slice of) string |

2
scripts/genproto.sh
View File

@ -76,7 +76,7 @@ if [ "$1" = "-g" ]; then
popd popd
protodoc --directories="etcdserver/etcdserverpb=service_message,storage/storagepb=service_message,lease/leasepb=service_message,auth/authpb=service_message" \ protodoc --directories="etcdserver/etcdserverpb=service_message,storage/storagepb=service_message,lease/leasepb=service_message,auth/authpb=service_message" \
--title="Protocol Buffer API" \ --title="etcd API Reference" \
--output="Documentation/api_reference_v3.md" \ --output="Documentation/api_reference_v3.md" \
--message-only-from-this-file="etcdserver/etcdserverpb/rpc.proto" --message-only-from-this-file="etcdserver/etcdserverpb/rpc.proto"