Files
openproject/app/services/mcp_tools/search_versions.rb
T
Eric Schubert 887ded5714 [#71358] fixed version read model usage
- improved description of API spec
2026-02-12 13:13:11 +01:00

79 lines
2.7 KiB
Ruby

# frozen_string_literal: true
#-- copyright
# OpenProject is an open source project management software.
# Copyright (C) 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.
#++
module McpTools
class SearchVersions < Base
default_title "Search versions"
default_description "Search versions matching all of the passed input parameters. " \
"Parameters not passed are ignored. Results are limited to a maximum " \
"of #{page_size} versions. To get the rest of the results, call the tool again with a" \
"page number of 2 or higher."
name "search_versions"
annotations read_only: true, idempotent: true, destructive: false
enable_pagination
filter :name, filter_class: Queries::Versions::Filters::NameFilter, operator: "~"
filter :sharing
input_schema(
type: :object,
properties: {
name: { type: "string", description: "Name of the version. Accepts partial version names, not case-sensitive." },
sharing: {
type: "string",
enum: Version::VERSION_SHARINGS,
description: "The indicator of how the version is shared between projects."
}
}
)
output_schema(
type: :object,
required: ["items"],
properties: {
items: {
type: :array,
items: JsonSchemaLoader.new.load("version_read_model")
}
}
)
def call(page: nil, **filters)
filtered = apply_filters(Version.visible, filters)
versions = apply_pagination(filtered, page)
{
items: versions.map { |v| API::V3::Versions::VersionRepresenter.create(v, current_user:) }
}
end
end
end