Reorganize identity docs
This change organizes the identity docs by topic rather than letting autodoc organize methods by the order they appear in the _proxy.py file. Change-Id: I991b810bad8e5932764186e52970748d47e0e4b4
This commit is contained in:
		| @@ -75,7 +75,8 @@ but listed below are the ones provided by this SDK by default. | ||||
|    Cluster <proxies/cluster> | ||||
|    Compute <proxies/compute> | ||||
|    Database <proxies/database> | ||||
|    Identity <proxies/identity> | ||||
|    Identity v2 <proxies/identity_v2> | ||||
|    Identity v3 <proxies/identity_v3> | ||||
|    Image v1 <proxies/image_v1> | ||||
|    Image v2 <proxies/image_v2> | ||||
|    Key Manager <proxies/key_manager> | ||||
|   | ||||
| @@ -1,33 +0,0 @@ | ||||
| Identity API v2 | ||||
| =============== | ||||
|  | ||||
| For details on how to use identity, see :doc:`/users/guides/identity` | ||||
|  | ||||
| .. automodule:: openstack.identity.v2._proxy | ||||
|  | ||||
| The Identity v2 Class | ||||
| --------------------- | ||||
|  | ||||
| The identity high-level interface is available through the ``identity`` | ||||
| member of a :class:`~openstack.connection.Connection` object.  The | ||||
| ``identity`` member will only be added if the service is detected. | ||||
|  | ||||
| .. autoclass:: openstack.identity.v2._proxy.Proxy | ||||
|    :members: | ||||
|  | ||||
| Identity API v3 | ||||
| =============== | ||||
|  | ||||
| For details on how to use identity, see :doc:`/users/guides/identity` | ||||
|  | ||||
| .. automodule:: openstack.identity.v3._proxy | ||||
|  | ||||
| The Identity v3 Class | ||||
| --------------------- | ||||
|  | ||||
| The identity high-level interface is available through the ``identity`` | ||||
| member of a :class:`~openstack.connection.Connection` object.  The | ||||
| ``identity`` member will only be added if the service is detected. | ||||
|  | ||||
| .. autoclass:: openstack.identity.v3._proxy.Proxy | ||||
|    :members: | ||||
							
								
								
									
										49
									
								
								doc/source/users/proxies/identity_v2.rst
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										49
									
								
								doc/source/users/proxies/identity_v2.rst
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,49 @@ | ||||
| Identity API v2 | ||||
| =============== | ||||
|  | ||||
| For details on how to use identity, see :doc:`/users/guides/identity` | ||||
|  | ||||
| .. automodule:: openstack.identity.v2._proxy | ||||
|  | ||||
| The Identity v2 Class | ||||
| --------------------- | ||||
|  | ||||
| The identity high-level interface is available through the ``identity`` | ||||
| member of a :class:`~openstack.connection.Connection` object.  The | ||||
| ``identity`` member will only be added if the service is detected. | ||||
|  | ||||
| User Operations | ||||
| ^^^^^^^^^^^^^^^ | ||||
|  | ||||
| .. autoclass:: openstack.identity.v2._proxy.Proxy | ||||
|  | ||||
|    .. automethod:: openstack.identity.v2._proxy.Proxy.create_user | ||||
|    .. automethod:: openstack.identity.v2._proxy.Proxy.update_user | ||||
|    .. automethod:: openstack.identity.v2._proxy.Proxy.delete_user | ||||
|    .. automethod:: openstack.identity.v2._proxy.Proxy.get_user | ||||
|    .. automethod:: openstack.identity.v2._proxy.Proxy.find_user | ||||
|    .. automethod:: openstack.identity.v2._proxy.Proxy.users | ||||
|  | ||||
| Role Operations | ||||
| ^^^^^^^^^^^^^^^ | ||||
|  | ||||
| .. autoclass:: openstack.identity.v2._proxy.Proxy | ||||
|  | ||||
|    .. automethod:: openstack.identity.v2._proxy.Proxy.create_role | ||||
|    .. automethod:: openstack.identity.v2._proxy.Proxy.update_role | ||||
|    .. automethod:: openstack.identity.v2._proxy.Proxy.delete_role | ||||
|    .. automethod:: openstack.identity.v2._proxy.Proxy.get_role | ||||
|    .. automethod:: openstack.identity.v2._proxy.Proxy.find_role | ||||
|    .. automethod:: openstack.identity.v2._proxy.Proxy.roles | ||||
|  | ||||
| Tenant Operations | ||||
| ^^^^^^^^^^^^^^^^^ | ||||
|  | ||||
| .. autoclass:: openstack.identity.v2._proxy.Proxy | ||||
|  | ||||
|    .. automethod:: openstack.identity.v2._proxy.Proxy.create_tenant | ||||
|    .. automethod:: openstack.identity.v2._proxy.Proxy.update_tenant | ||||
|    .. automethod:: openstack.identity.v2._proxy.Proxy.delete_tenant | ||||
|    .. automethod:: openstack.identity.v2._proxy.Proxy.get_tenant | ||||
|    .. automethod:: openstack.identity.v2._proxy.Proxy.find_tenant | ||||
|    .. automethod:: openstack.identity.v2._proxy.Proxy.tenants | ||||
							
								
								
									
										146
									
								
								doc/source/users/proxies/identity_v3.rst
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										146
									
								
								doc/source/users/proxies/identity_v3.rst
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,146 @@ | ||||
| Identity API v3 | ||||
| =============== | ||||
|  | ||||
| For details on how to use identity, see :doc:`/users/guides/identity` | ||||
|  | ||||
| .. automodule:: openstack.identity.v3._proxy | ||||
|  | ||||
| The Identity v3 Class | ||||
| --------------------- | ||||
|  | ||||
| The identity high-level interface is available through the ``identity`` | ||||
| member of a :class:`~openstack.connection.Connection` object.  The | ||||
| ``identity`` member will only be added if the service is detected. | ||||
|  | ||||
| Credential Operations | ||||
| ^^^^^^^^^^^^^^^^^^^^^ | ||||
|  | ||||
| .. autoclass:: openstack.identity.v3._proxy.Proxy | ||||
|  | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.create_credential | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.update_credential | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.delete_credential | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.get_credential | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.find_credential | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.credentials | ||||
|  | ||||
| Domain Operations | ||||
| ^^^^^^^^^^^^^^^^^ | ||||
|  | ||||
| .. autoclass:: openstack.identity.v3._proxy.Proxy | ||||
|  | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.create_domain | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.update_domain | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.delete_domain | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.get_domain | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.find_domain | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.domains | ||||
|  | ||||
| Endpoint Operations | ||||
| ^^^^^^^^^^^^^^^^^^^ | ||||
|  | ||||
| .. autoclass:: openstack.identity.v3._proxy.Proxy | ||||
|  | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.create_endpoint | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.update_endpoint | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.delete_endpoint | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.get_endpoint | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.find_endpoint | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.endpoints | ||||
|  | ||||
| Group Operations | ||||
| ^^^^^^^^^^^^^^^^ | ||||
|  | ||||
| .. autoclass:: openstack.identity.v3._proxy.Proxy | ||||
|  | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.create_group | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.update_group | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.delete_group | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.get_group | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.find_group | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.groups | ||||
|  | ||||
| Policy Operations | ||||
| ^^^^^^^^^^^^^^^^^ | ||||
|  | ||||
| .. autoclass:: openstack.identity.v3._proxy.Proxy | ||||
|  | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.create_policy | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.update_policy | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.delete_policy | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.get_policy | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.find_policy | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.policies | ||||
|  | ||||
| Project Operations | ||||
| ^^^^^^^^^^^^^^^^^^ | ||||
|  | ||||
| .. autoclass:: openstack.identity.v3._proxy.Proxy | ||||
|  | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.create_project | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.update_project | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.delete_project | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.get_project | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.find_project | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.projects | ||||
|  | ||||
| Region Operations | ||||
| ^^^^^^^^^^^^^^^^^ | ||||
|  | ||||
| .. autoclass:: openstack.identity.v3._proxy.Proxy | ||||
|  | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.create_region | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.update_region | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.delete_region | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.get_region | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.find_region | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.regions | ||||
|  | ||||
| Role Operations | ||||
| ^^^^^^^^^^^^^^^ | ||||
|  | ||||
| .. autoclass:: openstack.identity.v3._proxy.Proxy | ||||
|  | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.create_role | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.update_role | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.delete_role | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.get_role | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.find_role | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.roles | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.role_assignments | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.role_assignments_filter | ||||
|  | ||||
| Service Operations | ||||
| ^^^^^^^^^^^^^^^^^^ | ||||
|  | ||||
| .. autoclass:: openstack.identity.v3._proxy.Proxy | ||||
|  | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.create_service | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.update_service | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.delete_service | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.get_service | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.find_service | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.services | ||||
|  | ||||
| Trust Operations | ||||
| ^^^^^^^^^^^^^^^^ | ||||
|  | ||||
| .. autoclass:: openstack.identity.v3._proxy.Proxy | ||||
|  | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.create_trust | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.delete_trust | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.get_trust | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.find_trust | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.trusts | ||||
|  | ||||
| User Operations | ||||
| ^^^^^^^^^^^^^^^ | ||||
|  | ||||
| .. autoclass:: openstack.identity.v3._proxy.Proxy | ||||
|  | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.create_user | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.update_user | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.delete_user | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.get_user | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.find_user | ||||
|    .. automethod:: openstack.identity.v3._proxy.Proxy.users | ||||
		Reference in New Issue
	
	Block a user
	 Brian Curtin
					Brian Curtin