openstack
/
openstacksdk
Code Issues Proposed changes

docs: Add missing docs for identity resources 

Change-Id: I895f47336471d64bad3a0dc1672c3b79e147a6e5
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
This commit is contained in:
Stephen Finucane 2023-08-11 18:07:43 +01:00
parent aa25cb2d61
commit 19ba0adc33
18 changed files with 223 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/source/user/resources/identity/index.rst
View File

@ -17,3 +17,11 @@ Identity v3 Resources
:glob:
v3/*
Other Resources
---------------
.. toctree::
:maxdepth: 1
version

13
doc/source/user/resources/identity/v3/application_credential.rst Normal file
View File

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

13
doc/source/user/resources/identity/v3/federation_protocol.rst Normal file
View File

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

13
doc/source/user/resources/identity/v3/identity_provider.rst Normal file
View File

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

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

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

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

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

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

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

13
doc/source/user/resources/identity/v3/registered_limit.rst Normal file
View File

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

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

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

13
doc/source/user/resources/identity/v3/role_assignment.rst Normal file
View File

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

13
doc/source/user/resources/identity/v3/role_domain_group_assignment.rst Normal file
View File

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

13
doc/source/user/resources/identity/v3/role_domain_user_assignment.rst Normal file
View File

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

13
doc/source/user/resources/identity/v3/role_project_group_assignment.rst Normal file
View File

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

13
doc/source/user/resources/identity/v3/role_project_user_assignment.rst Normal file
View File

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

13
doc/source/user/resources/identity/v3/role_system_group_assignment.rst Normal file
View File

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

13
doc/source/user/resources/identity/v3/role_system_user_assignment.rst Normal file
View File

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

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

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

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

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