Merge "Add docs for Image v1 and v2 resources"

openstack/image/v1/image.py

@@ -27,20 +27,45 @@ class Image(resource.Resource):
     allow_delete = True
     allow_list = True
 
-    # Properties
+    #: Hash of the image data used. The Image service uses this value
+    #: for verification.
     checksum = resource.prop('checksum')
+    #: The container format refers to whether the VM image is in a file
+    #: format that also contains metadata about the actual VM.
+    #: Container formats include OVF and Amazon AMI. In addition,
+    #: a VM image might not have a container format - instead,
+    #: the image is just a blob of unstructured data.
     container_format = resource.prop('container_format')
+    #: A URL to copy an image from
     copy_from = resource.prop('copy_from')
+    #: Valid values are: aki, ari, ami, raw, iso, vhd, vdi, qcow2, or vmdk.
+    #: The disk format of a VM image is the format of the underlying
+    #: disk image. Virtual appliance vendors have different formats for
+    #: laying out the information contained in a VM disk image.
     disk_format = resource.prop('disk_format')
+    #: ``True`` if this is a public image.
     is_public = resource.prop('is_public')
+    #: A location for the image identified by a URI
     location = resource.prop('location')
+    #: The minimum disk size in GB that is required to boot the image.
     min_disk = resource.prop('min_disk')
+    #: The minimum amount of RAM in MB that is required to boot the image.
     min_ram = resource.prop('min_ram')
+    #: Name for the image. Note that the name of an image is not unique
+    #: to a Glance node. The API cannot expect users to know the names
+    #: of images owned by others.
     name = resource.prop('name')
+    #: The ID of the owner, or tenant, of the image.
     owner = resource.prop('owner')
+    #: Properties, if any, that are associated with the image.
     properties = resource.prop('properties')
+    #: Defines whether the image can be deleted.
     protected = resource.prop('protected')
+    #: The size of the image data, in bytes.
     size = resource.prop('size')
+    #: The image status.
     status = resource.prop('status')
+    #: The timestamp when this image was created.
     created_at = resource.prop('created_at')
+    #: The timestamp when this image was last updated.
     updated_at = resource.prop('updated_at')

openstack/image/v2/image.py

@@ -28,17 +28,39 @@ class Image(resource.Resource):
     patch_update = True
 
     # Properties
+    #: Hash of the image data used. The Image service uses this value
+    #: for verification.
     checksum = resource.prop('checksum')
+    #: The container format refers to whether the VM image is in a file
+    #: format that also contains metadata about the actual VM.
+    #: Container formats include OVF and Amazon AMI. In addition,
+    #: a VM image might not have a container format - instead,
+    #: the image is just a blob of unstructured data.
     container_format = resource.prop('container_format')
+    #: The date and time when the image was created.
     created_at = resource.prop('created_at')
+    #: Valid values are: aki, ari, ami, raw, iso, vhd, vdi, qcow2, or vmdk.
+    #: The disk format of a VM image is the format of the underlying
+    #: disk image. Virtual appliance vendors have different formats
+    #: for laying out the information contained in a VM disk image.
     disk_format = resource.prop('disk_format')
+    #: The minimum disk size in GB that is required to boot the image.
     min_disk = resource.prop('min_disk')
+    #: The name of the image.
     name = resource.prop('name')
+    #: The ID of the owner, or tenant, of the image.
     owner = resource.prop('owner')
+    #: Properties, if any, that are associated with the image.
     properties = resource.prop('properties')
+    #: Defines whether the image can be deleted.
     protected = resource.prop('protected', type=bool)
+    #: The image status.
     status = resource.prop('status')
+    #: Tags, if any, that are associated with the image.
     tags = resource.prop('tags')
+    #: The date and time when the image was updated.
     updated_at = resource.prop('updated_at')
+    #: The virtual size of the image.
     virtual_size = resource.prop('virtual_size')
+    #: The image visibility.
     visibility = resource.prop('visibility')

openstack/image/v2/member.py

@@ -28,7 +28,11 @@ class Member(resource.Resource):
     allow_list = True
 
     # Properties
+    #: The date and time when the member was created.
     created_at = resource.prop('created_at')
+    #: Image ID stored through the image API. Typically a UUID.
     image_id = resource.prop('image_id')
+    #: The status of the image.
     status = resource.prop('status')
+    #: The date and time when the member was updated.
     updated_at = resource.prop('updated_at')