Image schemas

1. image_schema()

Shows a dict schema document that represents an image entity.

Parameters: None

Return value: Dict

Return value example:

Dict:
{u'name': u'images', u'links': [{u'href': u'{first}', u'rel': u'first'}, {u'href': u'{next}', u'rel': u'next'}, {u'href': u'{schema}', u'rel': u'describedby'}], u'properties': {u'images': {u'items': {u'additionalProperties': {u'type': u'string'}, u'name': u'image', u'links': [{u'href': u'{self}', u'rel': u'self'}, {u'href': u'{file}', u'rel': u'enclosure'}, {u'href': u'{schema}', u'rel': u'describedby'}], u'properties': {u'container_format': {u'enum': [None, u'ami', u'ari', u'aki', u'bare', u'ovf', u'ova'], u'type': [u'null', u'string'], u'description': u'Format of the container'}, u'min_ram': {u'type': u'integer', u'description': u'Amount of ram (in MB) required to boot image.'}, u'ramdisk_id': {u'pattern': u'^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$', u'type': [u'null', u'string'], u'description': u'ID of image stored in Glance that should be used as the ramdisk when booting an AMI-style image.', u'is_base': False}, u'locations': {u'items': {u'required': [u'url', u'metadata'], u'type': u'object', u'properties': {u'url': {u'type': u'string', u'maxLength': 255}, u'metadata': {u'type': u'object'}}}, u'type': u'array', u'description': u'A set of URLs to access the image file kept in external store'}, u'file': {u'type': u'string', u'description': u'(READ-ONLY)'}, u'owner': {u'type': [u'null', u'string'], u'description': u'Owner of the image', u'maxLength':255},u'id':{u'pattern':u'^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$', u'type': u'string', u'description': u'An identifier for the image'}, u'size': {u'type': [u'null', u'integer'], u'description': u'Size of image file in bytes (READ-ONLY)'}, u'os_distro': {u'type': u'string', u'description': u'Common name of operating system distribution as specified in http://docs.openstack.org/trunk/openstack-compute/admin/content/adding-images.html', u'is_base': False}, u'self': {u'type': u'string', u'description': u'(READ-ONLY)'}, u'disk_format': {u'enum': [None, u'ami', u'ari', u'aki', u'vhd', u'vmdk', u'raw', u'qcow2', u'vdi', u'iso'], u'type': [u'null', u'string'], u'description': u'Format of the disk'}, u'os_version': {u'type': u'string', u'description': u'Operating system version as specified by the distributor', u'is_base': False}, u'direct_url': {u'type': u'string', u'description': u'URL to access the image file kept in external store (READ-ONLY)'}, u'schema': {u'type': u'string', u'description': u'(READ-ONLY)'}, u'status': {u'enum': [u'queued', u'saving', u'active', u'killed', u'deleted', u'pending_delete', u'deactivated'], u'type': u'string', u'description': u'Status of the image (READ-ONLY)'}, u'tags': {u'items': {u'type': u'string', u'maxLength': 255}, u'type': u'array', u'description': u'List of strings related to the image'}, u'kernel_id': {u'pattern': u'^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$', u'type': [u'null', u'string'], u'description': u'ID of image stored in Glance that should be used as the kernel when booting an AMI-style image.', u'is_base': False}, u'visibility': {u'enum': [u'public', u'private'], u'type': u'string', u'description': u'Scope of image accessibility'}, u'updated_at': {u'type': u'string', u'description': u'Date and time of the last image modification (READ-ONLY)'}, u'min_disk': {u'type': u'integer', u'description': u'Amount of disk space (in GB) required to boot image.'}, u'virtual_size': {u'type': [u'null', u'integer'], u'description': u'Virtual size of image in bytes (READ-ONLY)'}, u'instance_uuid': {u'type': u'string', u'description': u'ID of instance used to create this image.', u'is_base': False}, u'name': {u'type': [u'null', u'string'], u'description': u'Descriptive name for the image', u'maxLength': 255}, u'checksum': {u'type': [u'null', u'string'], u'description': u'md5 hash of image contents. (READ-ONLY)', u'maxLength': 32}, u'created_at': {u'type': u'string', u'description': u'Date and time of image registration (READ-ONLY)'}, u'protected': {u'type': u'boolean', u'description': u'If true, image will not be deletable.'}, u'architecture': {u'type': u'string', u'description': u'Operating system architecture as specified in http://docs.openstack.org/trunk/openstack-compute/admin/content/adding-images.html', u'is_base': False}}}, u'type': u'array'}, u'next': {u'type': u'string'}, u'first': {u'type': u'string'}, u'schema': {u'type': u'string'}}}

2. images_schema()

Shows a dict schema document that represents an images entity.

Parameters: None

Return value: Dict

Return value example:

Dict
{
  ‘additionalProperties’:{}
  ‘name’:’images’,
  …
}

3. member_schema()

Shows a dict schema document that represents a member entity.

Parameters: None

Return value: Dict

Return value example:

Dict
{
  ‘additionalProperties’:{}
  ‘name’:’member’,
  …
}

4. members_schema()

Shows a dict schema document that represents a members entity.

Parameters: None

Return value: Dict

Return value example:

Dict
{
  ‘additionalProperties’:{}
  ‘name’:’members’,
  …
}