openproject/lib/api/v3/queries/schemas/query_schema_representer.rb

#-- encoding: UTF-8
#-- copyright
# OpenProject is a project management system.
# Copyright (C) 2012-2017 the OpenProject Foundation (OPF)
#
# 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 doc/COPYRIGHT.rdoc for more details.
#++

require 'roar/decorator'
require 'roar/json/hal'

module API
  module V3
    module Queries
      module Schemas
        class QuerySchemaRepresenter < ::API::Decorators::SchemaRepresenter
          def initialize(represented, form_embedded: false, self_link: nil)
            super(represented,
                  current_user: nil,
                  form_embedded: form_embedded,
                  self_link: self_link)
          end

          schema :id,
                 type: 'Integer',
                 visibility: false

          schema :name,
                 type: 'String',
                 writable: true,
                 min_length: 1,
                 max_length: 255,
                 visibility: false

          schema :user,
                 type: 'User',
                 has_default: true,
                 visibility: false

          schema :project,
                 type: 'Project',
                 required: false,
                 writable: true,
                 visibility: false

          schema :public,
                 type: 'Boolean',
                 required: false,
                 writable: true,
                 has_default: true,
                 visibility: false

          schema :sums,
                 type: 'Boolean',
                 required: false,
                 writable: true,
                 has_default: true,
                 visibility: false

          schema :starred,
                 type: 'Boolean',
                 required: false,
                 writable: true,
                 has_default: true,
                 visibility: false

          schema :columns,
                 type: '[]QueryColumn',
                 required: false,
                 writable: true,
                 has_default: true,
                 visibility: false

          schema :filters,
                 type: '[]QueryFilterInstance',
                 required: false,
                 writable: true,
                 has_default: true,
                 visibility: false

          schema :group_by,
                 type: '[]QueryGroupBy',
                 required: false,
                 writable: true,
                 visibility: false

          schema :sort_by,
                 type: '[]QuerySortBy',
                 required: false,
                 writable: true,
                 has_default: true,
                 visibility: false

          schema :results,
                 type: 'WorkPackageCollection',
                 required: false,
                 writable: false,
                 visibility: false

          def self.represented_class
            Query
          end
        end
      end
    end
  end
end