e36f72d36d
When an user calls the GET on an ironic resource it returns MAX_LIMIT number of resources at a time along with a next url. The default MAX_LIMIT is 1000. If the user requested specific set of fields from ironic API using the fields query parameter (eg: /v1/resource?fields=f1,f2,f3) The next url returned by the API ignores fields query parameter. This results in fields missing from the results after MAX_LIMIT is reached. This change fixes this problem by passing the fields as parameter to collections.get_next method and using the fields argument to build the query parameter. Change-Id: I62b59e8148171c72de0ccf63a1517e754b520c76 Story: 2006721 Task: 37093
58 lines
2.0 KiB
Python
58 lines
2.0 KiB
Python
# Copyright 2013 Red Hat, Inc.
|
|
# All Rights Reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
from wsme import types as wtypes
|
|
|
|
from ironic import api
|
|
from ironic.api.controllers import base
|
|
from ironic.api.controllers import link
|
|
|
|
|
|
class Collection(base.APIBase):
|
|
|
|
next = wtypes.text
|
|
"""A link to retrieve the next subset of the collection"""
|
|
|
|
@property
|
|
def collection(self):
|
|
return getattr(self, self._type)
|
|
|
|
@classmethod
|
|
def get_key_field(cls):
|
|
return 'uuid'
|
|
|
|
def has_next(self, limit):
|
|
"""Return whether collection has more items."""
|
|
return len(self.collection) and len(self.collection) == limit
|
|
|
|
def get_next(self, limit, url=None, **kwargs):
|
|
"""Return a link to the next subset of the collection."""
|
|
if not self.has_next(limit):
|
|
return wtypes.Unset
|
|
|
|
resource_url = url or self._type
|
|
fields = kwargs.pop('fields', None)
|
|
# NOTE(saga): If fields argument is present in kwargs and not None. It
|
|
# is a list so convert it into a comma seperated string.
|
|
if fields:
|
|
kwargs['fields'] = ','.join(fields)
|
|
q_args = ''.join(['%s=%s&' % (key, kwargs[key]) for key in kwargs])
|
|
next_args = '?%(args)slimit=%(limit)d&marker=%(marker)s' % {
|
|
'args': q_args, 'limit': limit,
|
|
'marker': getattr(self.collection[-1], self.get_key_field())}
|
|
|
|
return link.Link.make_link('next', api.request.public_url,
|
|
resource_url, next_args).href
|