Browse Source

Merge pull request #5153 from gyuho/api_doc

*: change Protocol Buffer documentation title
Gyu-Ho Lee 9 years ago
parent
commit
f73cdf4035
2 changed files with 45 additions and 45 deletions
  1. 44 44
      Documentation/api_reference_v3.md
  2. 1 1
      scripts/genproto.sh

+ 44 - 44
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 |
+
+
+

+ 1 - 1
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"