openstack/openstacksdk
Code Issues Proposed changes

Identity resource doc framework

Browse Source 
Change-Id: Id4185095824c683cc88c4ca4b52b272de8c962bc
This commit is contained in:
Terry Howe 2015-05-22 15:55:07 -07:00
parent 25049be285
commit e2303f60b1
15 changed files with 183 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/source/users/index.rst
View File

@ -96,6 +96,7 @@ The following services have exposed *Resource* classes.
Compute <resources/compute/index>
Database <resources/database/index>
Identity <resources/identity/index>
Network <resources/network/index>
Object Store <resources/object_store/index>
Volume <resources/volume/index>

26
doc/source/users/resources/identity/index.rst Normal file
View File

@ -0,0 +1,26 @@
Identity v2 Resources
=====================
.. toctree::
:maxdepth: 1
v2/extension
v2/role
v2/tenant
v2/user
Identity v3 Resources
=====================
.. toctree::
:maxdepth: 1
v3/credential
v3/domain
v3/endpoint
v3/group
v3/policy
v3/project
v3/service
v3/trust
v3/user

12
doc/source/users/resources/identity/v2/extension.rst Normal file
View File

@ -0,0 +1,12 @@
openstack.identity.v2.extension
===============================
.. automodule:: openstack.identity.v2.extension
The Extension Class
-------------------
The ``Extension`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.identity.v2.extension.Extension
:members:

12
doc/source/users/resources/identity/v2/role.rst Normal file
View File

@ -0,0 +1,12 @@
openstack.identity.v2.role
==========================
.. automodule:: openstack.identity.v2.role
The Role Class
--------------
The ``Role`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.identity.v2.role.Role
:members:

12
doc/source/users/resources/identity/v2/tenant.rst Normal file
View File

@ -0,0 +1,12 @@
openstack.identity.v2.tenant
============================
.. automodule:: openstack.identity.v2.tenant
The Tenant Class
----------------
The ``Tenant`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.identity.v2.tenant.Tenant
:members:

12
doc/source/users/resources/identity/v2/user.rst Normal file
View File

@ -0,0 +1,12 @@
openstack.identity.v2.user
==========================
.. automodule:: openstack.identity.v2.user
The User Class
--------------
The ``User`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.identity.v2.user.User
:members:

12
doc/source/users/resources/identity/v3/credential.rst Normal file
View File

@ -0,0 +1,12 @@
openstack.identity.v3.credential
================================
.. automodule:: openstack.identity.v3.credential
The Credential Class
--------------------
The ``Credential`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.identity.v3.credential.Credential
:members:

12
doc/source/users/resources/identity/v3/domain.rst Normal file
View File

@ -0,0 +1,12 @@
openstack.identity.v3.domain
============================
.. automodule:: openstack.identity.v3.domain
The Domain Class
----------------
The ``Domain`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.identity.v3.domain.Domain
:members:

12
doc/source/users/resources/identity/v3/endpoint.rst Normal file
View File

@ -0,0 +1,12 @@
openstack.identity.v3.endpoint
==============================
.. automodule:: openstack.identity.v3.endpoint
The Endpoint Class
------------------
The ``Endpoint`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.identity.v3.endpoint.Endpoint
:members:

12
doc/source/users/resources/identity/v3/group.rst Normal file
View File

@ -0,0 +1,12 @@
openstack.identity.v3.group
===========================
.. automodule:: openstack.identity.v3.group
The Group Class
---------------
The ``Group`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.identity.v3.group.Group
:members:

12
doc/source/users/resources/identity/v3/policy.rst Normal file
View File

@ -0,0 +1,12 @@
openstack.identity.v3.policy
============================
.. automodule:: openstack.identity.v3.policy
The Policy Class
----------------
The ``Policy`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.identity.v3.policy.Policy
:members:

12
doc/source/users/resources/identity/v3/project.rst Normal file
View File

@ -0,0 +1,12 @@
openstack.identity.v3.project
=============================
.. automodule:: openstack.identity.v3.project
The Project Class
-----------------
The ``Project`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.identity.v3.project.Project
:members:

12
doc/source/users/resources/identity/v3/service.rst Normal file
View File

@ -0,0 +1,12 @@
openstack.identity.v3.service
=============================
.. automodule:: openstack.identity.v3.service
The Service Class
-----------------
The ``Service`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.identity.v3.service.Service
:members:

12
doc/source/users/resources/identity/v3/trust.rst Normal file
View File

@ -0,0 +1,12 @@
openstack.identity.v3.trust
===========================
.. automodule:: openstack.identity.v3.trust
The Trust Class
---------------
The ``Trust`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.identity.v3.trust.Trust
:members:

12
doc/source/users/resources/identity/v3/user.rst Normal file
View File

@ -0,0 +1,12 @@
openstack.identity.v3.user
==========================
.. automodule:: openstack.identity.v3.user
The User Class
--------------
The ``User`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.identity.v3.user.User
:members: