From 10b1ba7886ec8beac78f24aa7bdf0a4a88b228ff Mon Sep 17 00:00:00 2001 From: Anthony Romano Date: Fri, 19 May 2017 14:57:16 -0700 Subject: [PATCH] Documentation, scripts: regenerate protobuf docs with updated protodoc --- Documentation/dev-guide/api_concurrency_reference_v3.md | 4 ++-- Documentation/dev-guide/api_reference_v3.md | 8 ++------ scripts/genproto.sh | 2 +- 3 files changed, 5 insertions(+), 9 deletions(-) diff --git a/Documentation/dev-guide/api_concurrency_reference_v3.md b/Documentation/dev-guide/api_concurrency_reference_v3.md index cf534f4b6..9ae1dab75 100644 --- a/Documentation/dev-guide/api_concurrency_reference_v3.md +++ b/Documentation/dev-guide/api_concurrency_reference_v3.md @@ -6,7 +6,7 @@ This is a generated documentation. Please read the proto files for more. ##### service `Lock` (etcdserver/api/v3lock/v3lockpb/v3lock.proto) -for grpc-gateway The lock service exposes client-side locking facilities as a gRPC interface. +The lock service exposes client-side locking facilities as a gRPC interface. | Method | Request Type | Response Type | Description | | ------ | ------------ | ------------- | ----------- | @@ -51,7 +51,7 @@ for grpc-gateway The lock service exposes client-side locking facilities as a gR ##### service `Election` (etcdserver/api/v3election/v3electionpb/v3election.proto) -for grpc-gateway The election service exposes client-side election facilities as a gRPC interface. +The election service exposes client-side election facilities as a gRPC interface. | Method | Request Type | Response Type | Description | | ------ | ------------ | ------------- | ----------- | diff --git a/Documentation/dev-guide/api_reference_v3.md b/Documentation/dev-guide/api_reference_v3.md index a4ae43385..4c8419bd9 100644 --- a/Documentation/dev-guide/api_reference_v3.md +++ b/Documentation/dev-guide/api_reference_v3.md @@ -40,8 +40,6 @@ This is a generated documentation. Please read the proto files for more. ##### service `KV` (etcdserver/etcdserverpb/rpc.proto) -for grpc-gateway - | Method | Request Type | Response Type | Description | | ------ | ------------ | ------------- | ----------- | | Range | RangeRequest | RangeResponse | Range gets the keys in the range from the key-value store. | @@ -94,8 +92,6 @@ for grpc-gateway ##### message `AlarmRequest` (etcdserver/etcdserverpb/rpc.proto) -default, used to query if any alarm is active space quota is exhausted - | Field | Description | Type | | ----- | ----------- | ---- | | action | action is the kind of alarm request to issue. The action may GET alarm statuses, ACTIVATE an alarm, or DEACTIVATE a raised alarm. | AlarmAction | @@ -637,7 +633,7 @@ Empty field. | Field | Description | Type | | ----- | ----------- | ---- | -| key | default, no sorting lowest target value first highest target value first key is the first key for the range. If range_end is not given, the request only looks up key. | bytes | +| key | key is the first key for the range. If range_end is not given, the request only looks up key. | bytes | | range_end | range_end is the upper bound on the requested range [key, range_end). If range_end is '\0', the range is all keys >= key. If range_end is key plus one (e.g., "aa"+1 == "ab", "a\xff"+1 == "b"), then the range request gets all keys prefixed with key. If both key and range_end are '\0', then the range request returns all keys. | bytes | | limit | limit is a limit on the number of keys returned for the request. When limit is set to 0, it is treated as no limit. | int64 | | revision | revision is the point-in-time of the key-value store to use for the range. If revision is less or equal to zero, the range is over the newest key-value store. If the revision has been compacted, ErrCompacted is returned as a response. | int64 | @@ -770,7 +766,7 @@ From google paxosdb paper: Our implementation hinges around a powerful primitive | range_end | range_end is the end of the range [key, range_end) to watch. If range_end is not given, only the key argument is watched. If range_end is equal to '\0', all keys greater than or equal to the key argument are watched. If the range_end is one bit larger than the given key, then all keys with the prefix (the given key) will be watched. | bytes | | start_revision | start_revision is an optional revision to watch from (inclusive). No start_revision is "now". | int64 | | progress_notify | progress_notify is set so that the etcd server will periodically send a WatchResponse with no events to the new watcher if there are no recent events. It is useful when clients wish to recover a disconnected watcher starting from a recent known revision. The etcd server may decide how often it will send notifications based on current load. | bool | -| filters | filter out put event. filter out delete event. filters filter the events at server side before it sends back to the watcher. | (slice of) FilterType | +| filters | filters filter the events at server side before it sends back to the watcher. | (slice of) FilterType | | prev_kv | If prev_kv is set, created watcher gets the previous KV before the event happens. If the previous KV is already compacted, nothing will be returned. | bool | diff --git a/scripts/genproto.sh b/scripts/genproto.sh index 43c2fe9a0..85f73f67d 100755 --- a/scripts/genproto.sh +++ b/scripts/genproto.sh @@ -107,7 +107,7 @@ rm -rf Documentation/dev-guide/apispec/swagger/etcdserver/ if [ "$1" = "-g" ]; then echo "protodoc is auto-generating grpc API reference documentation..." go get -v -u github.com/coreos/protodoc - SHA_PROTODOC="f4164b1cce80b5eba4c835d08483f552dc568b7c" + SHA_PROTODOC="e901a6d4fa64c815acf117864521a8dadb11390f" PROTODOC_PATH="${GOPATH}/src/github.com/coreos/protodoc" pushd "${PROTODOC_PATH}" git reset --hard "${SHA_PROTODOC}"