← Back to team overview

yahoo-eng-team team mailing list archive

  1. yahoo-eng-team team
  2. Mailing list archive
  3. Message #25306

[Bug 1399779] [NEW] Update glance REST api docs

  Thread Previous • Date Previous • • Thread Next 
Public bug reported:

The glance version 2 API docs are not up to date:
http://developer.openstack.org/api-ref-image-v2.html

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

** Affects: glance
     Importance: Undecided
         Status: New

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to Glance.
https://bugs.launchpad.net/bugs/1399779

Title:
  Update glance REST api docs

Status in OpenStack Image Registry and Delivery Service (Glance):
  New

Bug description:
  The glance version 2 API docs are not up to date:
  http://developer.openstack.org/api-ref-image-v2.html

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

To manage notifications about this bug go to:
https://bugs.launchpad.net/glance/+bug/1399779/+subscriptions

Follow ups

References

  Thread Previous • Date Previous • • Thread Next