yahoo-eng-team team mailing list archive

[Jorge Cardoso <jorge.cardoso.pt@xxxxxxxxx>]

Public bug reported:


The file glanceclient/v1/images.py has the following documentation:

def list(self, **kwargs):
        """Get a list of images.
        :param page_size: number of items to request in each paginated request
        :param limit: maximum number of images to return
        :param marker: begin returning images that appear later in the image
                       list than that represented by this image id
        :param filters: dict of direct comparison filters that mimics the
                        structure of an image object
        :param owner: If provided, only images with this owner (tenant id)
                      will be listed. An empty string ('') matches ownerless
                      images.
        :param return_request_id: If an empty list is provided, populate this
                              list with the request ID value from the header
                              x-openstack-request-id
        :rtype: list of :class:`Image`
        """

Nonetheless, the parameter 'return_request_id' used within **kwargs is
'return_req_id' and not  'return_request_id' (see line 246)

** 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/1573049

Title:
  documentation glanceclient images list v1

Status in Glance:
  New

Bug description:
  
  The file glanceclient/v1/images.py has the following documentation:

  def list(self, **kwargs):
          """Get a list of images.
          :param page_size: number of items to request in each paginated request
          :param limit: maximum number of images to return
          :param marker: begin returning images that appear later in the image
                         list than that represented by this image id
          :param filters: dict of direct comparison filters that mimics the
                          structure of an image object
          :param owner: If provided, only images with this owner (tenant id)
                        will be listed. An empty string ('') matches ownerless
                        images.
          :param return_request_id: If an empty list is provided, populate this
                                list with the request ID value from the header
                                x-openstack-request-id
          :rtype: list of :class:`Image`
          """

  Nonetheless, the parameter 'return_request_id' used within **kwargs is
  'return_req_id' and not  'return_request_id' (see line 246)

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