Mirroristas/etcd
2
0
Fork 0
mirror of https://github.com/etcd-io/etcd.git synced 2024-09-27 06:25:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1926 from jainvipin/master

Browse Source 
minor fix for #1786
This commit is contained in:
Xiang Li 2014-12-13 16:26:59 -08:00
commit e40a53b534
1 changed files with 22 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
Documentation/api.md
View File

@ -706,35 +706,51 @@ curl -L http://127.0.0.1:4001/v2/keys/?recursive=true
### Deleting a Directory ### Deleting a Directory
Now let's try to delete the directory `/foo_dir`. Now let's try to delete the directory `/dir`
You can remove an empty directory using the `DELETE` verb and the `dir=true` parameter. You can remove an empty directory using the `DELETE` verb and the `dir=true` parameter. Following will succeed because `/dir` was empty
```sh ```sh
curl -L 'http://127.0.0.1:4001/v2/keys/foo_dir?dir=true' -XDELETE curl -L 'http://127.0.0.1:4001/v2/keys/dir?dir=true' -XDELETE
``` ```
```json ```json
{ {
"action": "delete", "action": "delete",
"node": { "node": {
"createdIndex": 30, "createdIndex": 30,
"dir": true, "dir": true,
"key": "/foo_dir", "key": "/dir",
"modifiedIndex": 31 "modifiedIndex": 31
}, },
"prevNode": { "prevNode": {
"createdIndex": 30, "createdIndex": 30,
"key": "/foo_dir", "key": "/dir",
"dir": true, "dir": true,
"modifiedIndex": 30 "modifiedIndex": 30
} }
} }
``` ```
However, deleting `/foo_dir` will result into an error because `/foo_dir` is not empty.
```sh
curl -L 'http://127.0.0.1:4001/v2/keys/foo_dir?dir=true' -XDELETE
```
```json
{
"errorCode":108,
"message":"Directory not empty",
"cause":"/foo_dir",
"index":2
}
```
To delete a directory that holds keys, you must add `recursive=true`. To delete a directory that holds keys, you must add `recursive=true`.
```sh ```sh
curl -L http://127.0.0.1:4001/v2/keys/dir?recursive=true -XDELETE curl -L http://127.0.0.1:4001/v2/keys/foo_dir?recursive=true -XDELETE
``` ```
```json ```json