Browse Source

docs: clarify CAS/CAD do not work on directories

As noted in #4075. There are numerous style issues with this document
but I don't want to go down that rabbit hole so this is an attempt at a
minimally invasive clarification.
Jonathan Boulle 10 years ago
parent
commit
216c6674ed
1 changed files with 4 additions and 0 deletions
  1. 4 0
      Documentation/api.md

+ 4 - 0
Documentation/api.md

@@ -500,6 +500,8 @@ etcd can be used as a centralized coordination service in a cluster, and `Compar
 
 This command will set the value of a key only if the client-provided conditions are equal to the current conditions.
 
+_Note that `CompareAndSwap` does not work with [directories](#listing-a-directory). If an attempt is made to `CompareAndSwap` a directory, a 102 "Not a file" error will be returned._
+
 The current comparable conditions are:
 
 1. `prevValue` - checks the previous value of the key.
@@ -585,6 +587,8 @@ We successfully changed the value from "one" to "two" since we gave the correct
 
 This command will delete a key only if the client-provided conditions are equal to the current conditions.
 
+_Note that `CompareAndDelete` does not work with [directories](#listing-a-directory). If an attempt is made to `CompareAndDelete` a directory, a 102 "Not a file" error will be returned._
+
 The current comparable conditions are:
 
 1. `prevValue` - checks the previous value of the key.