python-cratonclient/doc/source/v1-api-documentation.rst
Ian Cordasco 4c4f679fbd Add documentation for using Craton Python API
This adds some basic documentation describing how to authenticate
against Craton and provides some preliminary auto-generated
documentation of objects.

Change-Id: I2692a80785662e3193e56b62ed78cbe8de9f6e51
2016-11-15 15:26:48 -06:00

26 lines
731 B
ReStructuredText

======================
v1 API Documentation
======================
.. autoclass:: cratonclient.session.Session
.. autoclass:: cratonclient.v1.client.Client
.. autoclass:: cratonclient.v1.cells.Cell
:members: get, delete, human_id, is_loaded
.. autoclass:: cratonclient.v1.cells.CellManager
:members: create, delete, get, list, update
.. autoclass:: cratonclient.v1.hosts.Host
:members: get, delete, human_id, is_loaded
.. autoclass:: cratonclient.v1.hosts.HostManager
:members: create, delete, get, list, update
.. autoclass:: cratonclient.v1.regions.Region
:members: get, delete, human_id, is_loaded
.. autoclass:: cratonclient.v1.regions.RegionManager
:members: create, delete, get, list, update