openstack/openstacksdk
Code Issues Proposed changes

doc: fix volume size unit documentation to GiB

Browse Source 
The SDK documentation used "GB" while the Cinder API documentation specifies "GiB".

This change aligns the SDK with the API reference for consistency.

Change-Id: I3961fd21b549b9588140b3418e5b5562dbe85ef3
Signed-off-by: choieastsea <choieastsea@gmail.com>
This commit is contained in:
choieastsea
2025-09-11 00:27:33 +09:00
parent cd16bc0c9b
commit 1e58bc4944
6 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
openstack/block_storage/v2/quota_class_set.py
View File

@@ -22,16 +22,16 @@ class QuotaClassSet(resource.Resource):
allow_commit = True
# Properties
#: The size (GB) of backups that are allowed for each project.
#: The size (GiB) of backups that are allowed for each project.
backup_gigabytes = resource.Body('backup_gigabytes', type=int)
#: The number of backups that are allowed for each project.
backups = resource.Body('backups', type=int)
#: The size (GB) of volumes and snapshots that are allowed for each
#: The size (GiB) of volumes and snapshots that are allowed for each
#: project.
gigabytes = resource.Body('gigabytes', type=int)
#: The number of groups that are allowed for each project.
groups = resource.Body('groups', type=int)
#: The size (GB) of volumes in request that are allowed for each volume.
#: The size (GiB) of volumes in request that are allowed for each volume.
per_volume_gigabytes = resource.Body('per_volume_gigabytes', type=int)
#: The number of snapshots that are allowed for each project.
snapshots = resource.Body('snapshots', type=int)

2
openstack/block_storage/v2/snapshot.py
View File

@@ -44,7 +44,7 @@ class Snapshot(resource.Resource, metadata.MetadataMixin):
#: Indicate whether to create snapshot, even if the volume is attached.
#: Default is ``False``. *Type: bool*
is_forced = resource.Body("force", type=format.BoolStr)
#: The size of the volume, in GBs.
#: The size of the volume, in gibibytes (GiB).
size = resource.Body("size", type=int)
#: The current status of this snapshot. Potential values are creating,
#: available, deleting, error, and error_deleting.

2
openstack/block_storage/v2/volume.py
View File

@@ -76,7 +76,7 @@ class Volume(resource.Resource, metadata.MetadataMixin):
replication_status = resource.Body("replication_status")
#: Scheduler hints for the volume
scheduler_hints = resource.Body('OS-SCH-HNT:scheduler_hints', type=dict)
#: The size of the volume, in GBs. *Type: int*
#: The size of the volume, in gibibytes (GiB). *Type: int*
size = resource.Body("size", type=int)
#: To create a volume from an existing snapshot, specify the ID of
#: the existing volume snapshot. If specified, the volume is created

4
openstack/block_storage/v3/quota_class_set.py
View File

@@ -22,11 +22,11 @@ class QuotaClassSet(resource.Resource):
allow_commit = True
# Properties
#: The size (GB) of backups that are allowed for each project.
#: The size (GiB) of backups that are allowed for each project.
backup_gigabytes = resource.Body('backup_gigabytes', type=int)
#: The number of backups that are allowed for each project.
backups = resource.Body('backups', type=int)
#: The size (GB) of volumes and snapshots that are allowed for each
#: The size (GiB) of volumes and snapshots that are allowed for each
#: project.
gigabytes = resource.Body('gigabytes', type=int)
#: The number of groups that are allowed for each project.

2
openstack/block_storage/v3/snapshot.py
View File

@@ -66,7 +66,7 @@ class Snapshot(resource.Resource, metadata.MetadataMixin):
progress = resource.Body("os-extended-snapshot-attributes:progress")
#: The project ID this snapshot is associated with.
project_id = resource.Body("os-extended-snapshot-attributes:project_id")
#: The size of the volume, in GBs.
#: The size of the volume, in gibibytes (GiB).
size = resource.Body("size", type=int)
#: The current status of this snapshot. Potential values are creating,
#: available, deleting, error, and error_deleting.

2
openstack/block_storage/v3/volume.py
View File

@@ -112,7 +112,7 @@ class Volume(resource.Resource, metadata.MetadataMixin):
#: locks, and null means to always use locks. Look at os-brick's
#: guard_connection context manager. Default=True. (since 3.48)
shared_targets = resource.Body("shared_targets", type=bool)
#: The size of the volume, in GBs.
#: The size of the volume, in gibibytes (GiB).
size = resource.Body("size", type=int)
#: To create a volume from an existing snapshot, specify the ID of
#: the existing volume snapshot. If specified, the volume is created