← Back to branch summary

~hudson-openstack/glance/milestone-proposed

« back to all changes in this revision

Viewing changes to doc/source/registries.rst

  • Committer: Tarmac
  • Author(s): jaypipes at gmail
  • Date: 2011-05-25 20:37:10 UTC
  • mfrom: (126.3.4 docs)
  • Revision ID: tarmac-20110525203710-mia1w08aju55csmo
Documentation for new results filtering in the API and client.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/source/registries.rst
46
46
  PUT     /images/<ID>    Update metadata about an existing image
47
47
  DELETE  /images/<ID>    Remove an image's metadata from the registry
48
48
 
 
49
Filtering Images Returned via ``GET /images`` and ``GET /images/detail``
 
50
------------------------------------------------------------------------
 
51
 
 
52
Both the ``GET /images`` and ``GET /images/detail`` requests take query
 
53
parameters that serve to filter the returned list of images. The following
 
54
list details these query parameters.
 
55
 
 
56
* ``name=NAME``
 
57
 
 
58
  Filters images having a ``name`` attribute matching ``NAME``.
 
59
 
 
60
* ``container_format=FORMAT``
 
61
 
 
62
  Filters images having a ``container_format`` attribute matching ``FORMAT``
 
63
 
 
64
  For more information, see :doc:`About Disk and Container Formats <formats>`
 
65
 
 
66
* ``disk_format=FORMAT``
 
67
 
 
68
  Filters images having a ``disk_format`` attribute matching ``FORMAT``
 
69
 
 
70
  For more information, see :doc:`About Disk and Container Formats <formats>`
 
71
 
 
72
* ``status=STATUS``
 
73
 
 
74
  Filters images having a ``status`` attribute matching ``STATUS``
 
75
 
 
76
  For more information, see :doc:`About Image Statuses <statuses>`
 
77
 
 
78
* ``size_min=BYTES``
 
79
 
 
80
  Filters images having a ``size`` attribute greater than or equal to ``BYTES``
 
81
 
 
82
* ``size_max=BYTES``
 
83
 
 
84
  Filters images having a ``size`` attribute less than or equal to ``BYTES``
 
85
 
49
86
``POST /images``
50
87
----------------
51
88