Patch #6277: REST API for Search - Redmine

Patch #6277

REST API for Search

Added by Akiko Takano about 10 years ago. Updated over 4 years ago.

Status:

Closed

Start date:

2010-09-03

Priority:

Normal

Due date:

Assignee:

Jean-Philippe Lang

% Done:

Category:

REST API

Target version:

3.3.0

Description

Some CMS or Web Application have REST API or RSS/Atom API for search function.
Since search controller don't have to implement any update/delete/create function, I suppose only an xml template is required to support REST API.

This patch is over r4053.

search_rest_api.patch (1.21 KB) Akiko Takano, 2010-09-03 02:27

search_rest_api_trunk_r15148.patch (3.99 KB) Takenori TAKAKI, 2016-02-25 02:05

Related issues

Associated revisions

Revision 15262
Added by Jean-Philippe Lang over 4 years ago

REST API for Search (#6277).

Patch by Akiko Takano and Takenori TAKAKI.

Revision 15263
Added by Jean-Philippe Lang over 4 years ago

Missing fixtures (#6277).

Revision 15264
Added by Jean-Philippe Lang over 4 years ago

Handle search pagination with the REST API (#6277).

History

#1 Updated by Eric Davis about 10 years ago

Category set to REST API

I'll need some tests for this patch before it can be reviewed.

#2 Updated by Akiko Takano about 10 years ago

Thanks for your taking time to see it.
I hope to apply this feature to RedmineAir if implemented.

#3 Updated by Christian Baus about 7 years ago

+1 for this feature!!

i adapt the patch above for the current redmine version 2.3 and add some extension

Edit: app/controller/search_controller.rb (render part of index action)

    respond_to do |format|
        format.html { render 'search/index', :layout => !request.xhr? }
        format.api  { }
    end

Add: app/views/search/index.xml.builder

xml.instruct!
xml.search_results :type => 'array' do
  @results.each do |result|
          xml.result do
                xml.title       result.event_title
                xml.type        result.event_type
                xml.url url_for(result.event_url(:only_path => false))
        xml.description result.event_description
        xml.datetime    result.event_datetime

if result.class == Issue
        xml.id result.id
        xml.tracker_id result.tracker_id
        xml.project_id result.project_id
        xml.subject result.subject
        xml.category_id result.category_id
        xml.assigned_to_id result.assigned_to_id
        xml.priority_id result.priority_id
        xml.author_id result.author_id
        xml.created_at result.created_on
        xml.updated_at result.updated_on
        xml.status result.status
        xml.subject result.subject
end

if result.class == Project
        xml.id result.id
        xml.parent_id result.parent_id
        xml.created_at result.created_on
        xml.updated_at result.updated_on
        xml.status result.status
        xml.name result.name
        custom_field = result.available_custom_fields.select{|f|f.name.eql?("intranet_description")}.first

        if custom_field && custom_field.custom_values
                xml.intranet_description custom_field.custom_values.first.value
        else
                xml.intranet_description "" 
        end
end

    end
  end
end