Add documentation to KVPair

Based on discussions with @slackpad, some of the values in the KVPair are
ReadOnly. This commit updates the docs to reflect that.
This commit is contained in:
Seth Vargo 2016-09-26 10:07:00 -05:00
parent d1da2eff80
commit 227019ec59
No known key found for this signature in database
GPG Key ID: 905A90C2949E8787
1 changed files with 25 additions and 5 deletions

View File

@ -11,13 +11,33 @@ import (
// KVPair is used to represent a single K/V entry
type KVPair struct {
Key string
// Key is the name of the key. It is also part of the URL path when accessed
// via the API.
Key string
// CreateIndex holds the index corresponding the creation of this KVPair. This
// is a read-only field.
CreateIndex uint64
// ModifyIndex is used for the Check-And-Set operations.
ModifyIndex uint64
LockIndex uint64
Flags uint64
Value []byte
Session string
// LockIndex holds the index corresponding to a lock on this key, if any. This
// is a read-only field.
LockIndex uint64
// Flags are any user-defined flags on the key. It is up to the implementer
// to check these values, since Consul does not treat them specially.
Flags uint64
// Value is the value for the key. This can be any value, but it will be
// base64 encoded upon transport.
Value []byte
// Session is a string representing the name of the session. Any other
// interactions with this key over the same session must specify the same
// session name.
Session string
}
// KVPairs is a list of KVPair objects