openproject/lib/api/v3/help_texts/help_texts_api.rb

#-- copyright
# OpenProject is an open source project management software.
# Copyright (C) 2012-2021 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-2013 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 COPYRIGHT and LICENSE files for more details.
#++

require_dependency 'api/v3/help_texts/help_text_representer'
require_dependency 'api/v3/help_texts/help_text_collection_representer'

module API
  module V3
    module HelpTexts
      class HelpTextsAPI < ::API::OpenProjectAPI
        resources :help_texts do
          get do
            @entries = AttributeHelpText.visible(current_user)
            HelpTextCollectionRepresenter.new(@entries, self_link: api_v3_paths.help_texts, current_user: current_user)
          end

          route_param :id, type: Integer, desc: 'Help text ID' do
            after_validation do
              @help_text = AttributeHelpText.visible(current_user).find(params[:id])
            end

            get do
              HelpTextRepresenter.new(@help_text, current_user: current_user)
            end

            mount ::API::V3::Attachments::AttachmentsByHelpTextAPI
          end
        end
      end
    end
  end
end