openstack
/
openstacksdk
Code Issues Proposed changes

docs: Add missing docs for block storage resources 

Change-Id: I6f6c2b1cec5d4273d27fa0a109dbd49579686251
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
This commit is contained in:
Stephen Finucane 2023-08-17 10:42:08 +01:00
parent d06ac50e7d
commit c0f2aee724
12 changed files with 169 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
doc/source/user/resources/block_storage/index.rst
View File

@ -1,19 +1,20 @@
Block Storage Resources
=======================
Block Storage v2 Resources
--------------------------
.. toctree::
:maxdepth: 1
:glob:
v2/backup
v2/quota_set
v2/snapshot
v2/type
v2/volume
v2/*
v3/backup
v3/quota_set
v3/snapshot
v3/type
v3/volume
v3/service
v3/block_storage_summary
Block Storage v3 Resources
--------------------------
.. toctree::
:maxdepth: 1
:glob:
v3/*

12
doc/source/user/resources/block_storage/v2/stats.rst Normal file
View File

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

13
doc/source/user/resources/block_storage/v3/availability_zone.rst Normal file
View File

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

12
doc/source/user/resources/block_storage/v3/capabilities.rst Normal file
View File

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

12
doc/source/user/resources/block_storage/v3/extension.rst Normal file
View File

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

12
doc/source/user/resources/block_storage/v3/group.rst Normal file
View File

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

13
doc/source/user/resources/block_storage/v3/group_snapshot.rst Normal file
View File

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

12
doc/source/user/resources/block_storage/v3/group_type.rst Normal file
View File

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

37
doc/source/user/resources/block_storage/v3/limits.rst Normal file
View File

@ -0,0 +1,37 @@
openstack.block_storage.v3.limits
=================================
.. automodule:: openstack.block_storage.v3.limits
The AbsoluteLimit Class
-----------------------
The ``AbsoluteLimit`` class inherits from
:class:`~openstack.resource.Resource`.
.. autoclass:: openstack.block_storage.v3.limits.AbsoluteLimit
:members:
The Limit Class
---------------
The ``Limit`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.block_storage.v3.limits.Limit
:members:
The RateLimit Class
-------------------
The ``RateLimit`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.block_storage.v3.limits.RateLimit
:members:
The RateLimits Class
--------------------
The ``RateLimits`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.block_storage.v3.limits.RateLimits
:members:

13
doc/source/user/resources/block_storage/v3/resource_filter.rst Normal file
View File

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

12
doc/source/user/resources/block_storage/v3/stats.rst Normal file
View File

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

8
doc/source/user/resources/block_storage/v3/type.rst
View File

@ -11,3 +11,11 @@ The ``Type`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.block_storage.v3.type.Type
:members:
The TypeEncryption Class
------------------------
The ``TypeEncryption`` class inherits from
:class:`~openstack.resource.Resource`.
.. autoclass:: openstack.block_storage.v3.type.TypeEncryption
:members: