From 2751a10db603109b73c42c9e7d4afe1faeb554e5 Mon Sep 17 00:00:00 2001 From: Gyu-Ho Lee Date: Thu, 21 Apr 2016 19:58:41 -0700 Subject: [PATCH] *: change Protocol Buffer documentation title --- Documentation/api_reference_v3.md | 88 +++++++++++++++---------------- scripts/genproto.sh | 2 +- 2 files changed, 45 insertions(+), 45 deletions(-) diff --git a/Documentation/api_reference_v3.md b/Documentation/api_reference_v3.md index bb62e1290..239cbfc1c 100644 --- a/Documentation/api_reference_v3.md +++ b/Documentation/api_reference_v3.md @@ -1,47 +1,4 @@ -### Protocol Buffer API - - -##### 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 | - +### etcd API Reference ##### 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 | + + + diff --git a/scripts/genproto.sh b/scripts/genproto.sh index ae1058141..1a588bf19 100755 --- a/scripts/genproto.sh +++ b/scripts/genproto.sh @@ -76,7 +76,7 @@ if [ "$1" = "-g" ]; then popd 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" \ --message-only-from-this-file="etcdserver/etcdserverpb/rpc.proto"