Commit 6ac08f4b authored by Ilias Tsitsimpis's avatar Ilias Tsitsimpis
Browse files

astakosclient: Documentation changes

* Document 3 new AstakosClient Exceptions
* Change package name from snf-astakos-client to astakosclient
parent ff0b2de4
.. _snf-astakos-client: .. _astakosclient:
Component snf-astakos-client Component astakosclient
^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The Synnefo component :ref:`snf-astakos-client <snf-astakos-client>` defines a The Synnefo component :ref:`astakosclient <astakosclient>` defines a
default client for the :ref:`Astakos <astakos>` service. It is designed to be default client for the :ref:`Astakos <astakos>` service. It is designed to be
simple and minimal, hence easy to debug and test. simple and minimal, hence easy to debug and test.
...@@ -184,8 +184,15 @@ Exceptions and Errors ...@@ -184,8 +184,15 @@ Exceptions and Errors
*exception* **AstakosClientException** *exception* **AstakosClientException**
Raised in case of an error. It contains an error message and the Raised in case of an error. It contains an error message and the
corresponding http status code. Other exceptions raise by astakosclient corresponding http status code. Other exceptions raised by
module are derived from this one. astakosclient module are derived from this one.
*exception* **BadValue**
A redefinition of ValueError exception under AstakosClientException.
*exception* **InvalidResponse**
This exception is raised whenever the server's response is not
valid json (cannot be parsed by simplejson library).
*exception* **BadRequest** *exception* **BadRequest**
Raised in case of a Bad Request, with status 400. Raised in case of a Bad Request, with status 400.
...@@ -200,6 +207,9 @@ Exceptions and Errors ...@@ -200,6 +207,9 @@ Exceptions and Errors
*exception* **NotFound** *exception* **NotFound**
The server has not found anything matching the Request-URI. Status 404. The server has not found anything matching the Request-URI. Status 404.
*exception* **QuotaLimit**
Quantity fell below zero or exceeded capacity in one of the holdings.
*exception* **NoUserName** *exception* **NoUserName**
Raised by getDisplayName and getServiceDisplayName when an invalid Raised by getDisplayName and getServiceDisplayName when an invalid
UUID was given. UUID was given.
......
...@@ -123,7 +123,7 @@ They are also available from our apt repository: ``apt.okeanos.grnet.gr`` ...@@ -123,7 +123,7 @@ They are also available from our apt repository: ``apt.okeanos.grnet.gr``
* `snf-pithos-webclient <http://docs.dev.grnet.gr/pithos-webclient/latest/index.html>`_ * `snf-pithos-webclient <http://docs.dev.grnet.gr/pithos-webclient/latest/index.html>`_
* `snf-cyclades-app <http://docs.dev.grnet.gr/snf-cyclades-app/latest/index.html>`_ * `snf-cyclades-app <http://docs.dev.grnet.gr/snf-cyclades-app/latest/index.html>`_
* `snf-cyclades-gtools <http://docs.dev.grnet.gr/snf-cyclades-gtools/latest/index.html>`_ * `snf-cyclades-gtools <http://docs.dev.grnet.gr/snf-cyclades-gtools/latest/index.html>`_
* `snf-astakos-client <http://docs.dev.grnet.gr/snf-astakos-client/latest/index.html>`_ * `astakosclient <http://docs.dev.grnet.gr/astakosclient/latest/index.html>`_
* `snf-vncauthproxy <https://code.grnet.gr/projects/vncauthproxy>`_ * `snf-vncauthproxy <https://code.grnet.gr/projects/vncauthproxy>`_
* `snf-image <https://code.grnet.gr/projects/snf-image/wiki/>`_ * `snf-image <https://code.grnet.gr/projects/snf-image/wiki/>`_
* `snf-image-creator <http://docs.dev.grnet.gr/snf-image-creator/latest/index.html>`_ * `snf-image-creator <http://docs.dev.grnet.gr/snf-image-creator/latest/index.html>`_
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment