openproject/lib/api/v3/users/paginated_user_collection_representer.rb

#-- encoding: UTF-8

#-- copyright
# OpenProject is an open source project management software.
# Copyright (C) 2012-2020 the OpenProject GmbH
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License version 3.
#
# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
# Copyright (C) 2006-2017 Jean-Philippe Lang
# Copyright (C) 2010-2013 the ChiliProject Team
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
#
# See docs/COPYRIGHT.rdoc for more details.
#++

# TODO: this is to be removed or rather the UserCollectionRepresenter is
# to be turned into an OffsetPaginatedCollection representer.
# It is not possible to do that right now as we do not have a
# solution for an accessible autocompleter drop down widget. We therefore
# have to fetch all users when we want to present them inside of a drop down.

module API
  module V3
    module Users
      class PaginatedUserCollectionRepresenter < ::API::Decorators::OffsetPaginatedCollection
        include API::V3::Principals::GroupOrUserElements
      end
    end
  end
end