ceph/doc/radosgw/swift/tutorial.rst
John Wilkins 3a377c44e1 doc: Overhauled Swift API documentation.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-07-17 21:28:59 -07:00

61 lines
3.2 KiB
ReStructuredText

==========
Tutorial
==========
The Swift-compatible API tutorials follow a simple container-based object
lifecycle. The first step requires you to setup a connection between your
client and the RADOS Gateway server. Then, you may follow a natural
container and object lifecycle, including adding and retrieving object
metadata. See example code for the following languages:
- `Java`_
- `Python`_
- `Ruby`_
.. ditaa:: +----------------------------+ +-----------------------------+
| | | |
| Create a Connection |------->| Create a Container |
| | | |
+----------------------------+ +-----------------------------+
|
+--------------------------------------+
|
v
+----------------------------+ +-----------------------------+
| | | |
| Create an Object |------->| Add/Update Object Metadata |
| | | |
+----------------------------+ +-----------------------------+
|
+--------------------------------------+
|
v
+----------------------------+ +-----------------------------+
| | | |
| List Owned Containers |------->| List a Container's Contents |
| | | |
+----------------------------+ +-----------------------------+
|
+--------------------------------------+
|
v
+----------------------------+ +-----------------------------+
| | | |
| Get an Object's Metadata |------->| Retrieve an Object |
| | | |
+----------------------------+ +-----------------------------+
|
+--------------------------------------+
|
v
+----------------------------+ +-----------------------------+
| | | |
| Delete an Object |------->| Delete a Container |
| | | |
+----------------------------+ +-----------------------------+
.. _Java: ../java
.. _Python: ../python
.. _Ruby: ../ruby