From f9c26b5039f5a377d9618deecbccd4665d3e59c5 Mon Sep 17 00:00:00 2001
From: Dionysis Grigoropoulos <dgrig@grnet.gr>
Date: Wed, 17 Sep 2014 12:56:13 +0300
Subject: [PATCH] docs: Update BlockStorage API guide
According to the Cinder API documentation the GET /snapshots and GET
/snapshots/detail call should return the same detailed results. Cyclades
behave correctly on this matter, but the BlockStorage API guide contains
incorrect and misleading examples.
This commit fixes the above issue.
---
docs/blockstorage-api-guide.rst | 22 ++++++++++++++++++----
1 file changed, 18 insertions(+), 4 deletions(-)
diff --git a/docs/blockstorage-api-guide.rst b/docs/blockstorage-api-guide.rst
index b06834aa6..f3093e659 100644
--- a/docs/blockstorage-api-guide.rst
+++ b/docs/blockstorage-api-guide.rst
@@ -668,7 +668,7 @@ List all snapshots related to the user.
URI Method Cyclades OS/Block Storage
====================== ====== ======== ==========
``/snapshots`` GET β β
-``/snapshotss/detail`` GET β β
+``/snapshots/detail`` GET β β
====================== ====== ======== ==========
* Both requests return a list of snapshots. The first returns just ``id``,
@@ -727,18 +727,32 @@ The snapshot attributes are listed `here <#snapshot-ref>`_
],
"id": "42",
"display_name": "Snapshot One",
+ "status": "ACTIVE",
+ "size": 2,
+ "display_description": null,
+ "created_at": "2014-05-19T19:52:04.949734",
+ "metadata": {},
+ "volume_id": "123",
+ "os-extended-snapshot-attribute:progress": "100%"
}, {
"links": [
{
- "href": "https://example.org/cyclades/v2/snapshots/42",
+ "href": "https://example.org/cyclades/v2/snapshots/43",
"rel": "self"
}, {
- "href": "https://example.org/cyclades/v2/snapshots/42",
+ "href": "https://example.org/cyclades/v2/snapshots/43",
"rel": "bookmark"
}
],
- "id": "42",
+ "id": "43",
"display_name": "Snapshot Two",
+ "status": "ACTIVE",
+ "size": 3,
+ "display_description": null,
+ "created_at": "2014-05-20T19:52:04.949734",
+ "metadata": {},
+ "volume_id": "124",
+ "os-extended-snapshot-attribute:progress": "100%"
}
]
}
--
GitLab