client: document MembersAPI/KeysAPI constructors

This commit is contained in:
Brian Waldon 2015-01-27 13:51:07 -08:00 committed by Yicheng Qin
parent e885c6c5f4
commit aee95468ba
2 changed files with 7 additions and 0 deletions

View File

@ -39,10 +39,15 @@ var (
defaultV2KeysPrefix = "/v2/keys"
)
// NewKeysAPI builds a KeysAPI that interacts with etcd's key-value
// API over HTTP.
func NewKeysAPI(c Client) KeysAPI {
return NewKeysAPIWithPrefix(c, defaultV2KeysPrefix)
}
// NewKeysAPIWithPrefix acts like NewKeysAPI, but allows the caller
// to provide a custom base URL path. This should only be used in
// very rare cases.
func NewKeysAPIWithPrefix(c Client, p string) KeysAPI {
return &httpKeysAPI{
client: c,

View File

@ -31,6 +31,8 @@ var (
defaultV2MembersPrefix = "/v2/members"
)
// NewMembersAPI constructs a new MembersAPI that uses HTTP to
// interact with etcd's membership API.
func NewMembersAPI(c Client) MembersAPI {
return &httpMembersAPI{
client: c,