Docstrings for usability.
The keystoneclient docstrings should give guidance for an application developer to actually use the library. Here's a start. Partial-Bug: #1330769 Change-Id: I1a9434704d0cd6b58de76933ff78c8d5c0aa3e3b
This commit is contained in:

committed by
Marek Denis

parent
832d89681c
commit
d8408f6250
@@ -13,6 +13,15 @@
|
|||||||
# License for the specific language governing permissions and limitations
|
# License for the specific language governing permissions and limitations
|
||||||
# under the License.
|
# under the License.
|
||||||
|
|
||||||
|
"""The python bindings for the OpenStack Identity (Keystone) project.
|
||||||
|
|
||||||
|
See :py:class:`keystoneclient.v3.client.Client` for the Identity V3 client.
|
||||||
|
|
||||||
|
See :py:class:`keystoneclient.v2_0.client.Client` for the Identity V2.0 client.
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
|
|
||||||
import pbr.version
|
import pbr.version
|
||||||
|
|
||||||
|
|
||||||
|
@@ -89,6 +89,65 @@ class Client(httpclient.HTTPClient):
|
|||||||
>>> user = keystone.users.get(USER_ID)
|
>>> user = keystone.users.get(USER_ID)
|
||||||
>>> user.delete()
|
>>> user.delete()
|
||||||
|
|
||||||
|
Instances of this class have the following managers:
|
||||||
|
|
||||||
|
.. py:attribute:: credentials
|
||||||
|
|
||||||
|
:py:class:`keystoneclient.v3.credentials.CredentialManager`
|
||||||
|
|
||||||
|
.. py:attribute:: endpoint_filter
|
||||||
|
|
||||||
|
:py:class:`keystoneclient.v3.contrib.endpoint_filter.\
|
||||||
|
EndpointFilterManager`
|
||||||
|
|
||||||
|
.. py:attribute:: endpoints
|
||||||
|
|
||||||
|
:py:class:`keystoneclient.v3.endpoints.EndpointManager`
|
||||||
|
|
||||||
|
.. py:attribute:: domains
|
||||||
|
|
||||||
|
:py:class:`keystoneclient.v3.domains.DomainManager`
|
||||||
|
|
||||||
|
.. py:attribute:: federation
|
||||||
|
|
||||||
|
:py:class:`keystoneclient.v3.contrib.federation.core.FederationManager`
|
||||||
|
|
||||||
|
.. py:attribute:: groups
|
||||||
|
|
||||||
|
:py:class:`keystoneclient.v3.groups.GroupManager`
|
||||||
|
|
||||||
|
.. py:attribute:: oauth1
|
||||||
|
|
||||||
|
:py:class:`keystoneclient.v3.contrib.oauth1.core.OAuthManager`
|
||||||
|
|
||||||
|
.. py:attribute:: policies
|
||||||
|
|
||||||
|
:py:class:`keystoneclient.v3.policies.PolicyManager`
|
||||||
|
|
||||||
|
.. py:attribute:: regions
|
||||||
|
|
||||||
|
:py:class:`keystoneclient.v3.regions.RegionManager`
|
||||||
|
|
||||||
|
.. py:attribute:: role_assignments
|
||||||
|
|
||||||
|
:py:class:`keystoneclient.v3.role_assignments.RoleAssignmentManager`
|
||||||
|
|
||||||
|
.. py:attribute:: roles
|
||||||
|
|
||||||
|
:py:class:`keystoneclient.v3.roles.RoleManager`
|
||||||
|
|
||||||
|
.. py:attribute:: services
|
||||||
|
|
||||||
|
:py:class:`keystoneclient.v3.services.ServiceManager`
|
||||||
|
|
||||||
|
.. py:attribute:: users
|
||||||
|
|
||||||
|
:py:class:`keystoneclient.v3.users.UserManager`
|
||||||
|
|
||||||
|
.. py:attribute:: trusts
|
||||||
|
|
||||||
|
:py:class:`keystoneclient.v3.contrib.trusts.TrustManager`
|
||||||
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
version = 'v3'
|
version = 'v3'
|
||||||
|
Reference in New Issue
Block a user