プロジェクト

全般

プロフィール

Vote #74914

未完了

Allow configuration of API limit instead of hardcoding at 100

Admin Redmine さんが3ヶ月前に追加. 3ヶ月前に更新.

ステータス:
New
優先度:
通常
担当者:
-
カテゴリ:
REST API_32
開始日:
2022/05/09
期日:
進捗率:

0%

予定工数:
category_id:
32
version_id:
32
issue_org_id:
16069
author_id:
92844
assigned_to_id:
0
comments:
39
status_id:
1
tracker_id:
3
plus1:
16
affected_version:
closed_on:
affected_version_id:
ステータス-->[New]

説明

The below tested patch makes the previously harcoded limit of 100 items in a RESTful API response configurable in the Administration GUI. The default value is still 100. This is based on 2.4.1.stable.

This is quite useful since it is nice and simple to just get the full response in a single page rather than having to traverse pagination, and a limit of a bit more than 100 is still very performant for many sites -- the limit beyond which performance starts to degrade really depends on the particular site's usage, so should be controllable by the local administrator.

Index: app/controllers/application_controller.rb

--- app/controllers/application_controller.rb (.../trunk/app) (revision 13385)
+++ app/controllers/application_controller.rb (.../branches/code-8112/app) (revision 13389)
@@ -519,8 +519,8 @@
limit = options[:limit].to_i
if limit < 1
limit = 25

  • elsif limit > 100
  • limit = 100
  • elsif limit > Setting.api_limit.to_i
  • limit = Setting.api_limit.to_i end if offset.nil? && options[:page].present? offset = (options[:page].to_i - 1) * limit Index: app/views/settings/_general.html.erb =================================================================== --- app/views/settings/_general.html.erb (.../trunk/app) (revision 13385) +++ app/views/settings/_general.html.erb (.../branches/code-8112/app) (revision 13389) @@ -24,6 +24,8 @@

<%= setting_select :wiki_compression, 'Gzip', 'gzip', :blank => :label_none %>

+<%= setting_text_field :api_limit, :size => 6 %>
+
<%= setting_text_field :feeds_limit, :size => 6 %>

<%= setting_text_field :file_max_size_displayed, :size => 6 %> <%= l(:"number.human.storage_units.units.kb") %>

Index: config/settings.yml

--- config/settings.yml (revision 13387)
+++ config/settings.yml (revision 13389)
@@ -73,6 +73,9 @@
default: localhost:3000
protocol:
default: http
+api_limit:

  • format: int
  • default: 100 feeds_limit: format: int default: 15 Index: config/locales/en.yml =================================================================== --- config/locales/en.yml (revision 13387) +++ config/locales/en.yml (revision 13389) @@ -352,6 +352,7 @@ setting_host_name: Host name and path setting_text_formatting: Text formatting setting_wiki_compression: Wiki history compression
  • setting_api_limit: Maximum number of items returned in a JSON/XML API response setting_feeds_limit: Maximum number of items in Atom feeds setting_default_projects_public: New projects are public by default setting_autofetch_changesets: Fetch commits automatically

journals

Is there anything I can do to help move this patch forward?
--------------------------------------------------------------------------------
+1
--------------------------------------------------------------------------------
+1
--------------------------------------------------------------------------------

--------------------------------------------------------------------------------
The user should not be able to set the value of API limit smaller than 100.
Probably some clients suppose that the value is always 100, smaller limit may affect compatibility with such clients.

--------------------------------------------------------------------------------
We would also appreciate higher values than 100. Some of our tools need to load all items visible to a user and therefore need to split the requests.
--------------------------------------------------------------------------------
+1
--------------------------------------------------------------------------------

--------------------------------------------------------------------------------
Too sad, this patch was shifted.
What is the reason?

We're really waiting for this patch and all seems to be done. Am I wrong?
--------------------------------------------------------------------------------
+1
--------------------------------------------------------------------------------

--------------------------------------------------------------------------------
+1

Hi,
This request was posted 2 years ago, so what's up?
--------------------------------------------------------------------------------
+1
--------------------------------------------------------------------------------

--------------------------------------------------------------------------------
Is there anything wrong/non-ideal with this patch which means that it has not been integrated?
--------------------------------------------------------------------------------
+1
--------------------------------------------------------------------------------

--------------------------------------------------------------------------------

--------------------------------------------------------------------------------
What happened to this patch? Nothing?
--------------------------------------------------------------------------------
+1
--------------------------------------------------------------------------------
Silence... :(
--------------------------------------------------------------------------------
+1

I think that it should be changeable by the responsibility of the system administrator.

There are many configuration items in the world system that may cause troubles due to setting change contents.
Since there are cases where it is necessary to change these items, it is made public after clearly stating that there is a risk when changing.

It is enough to specify the following points.

If you change the default value, there is a possibility of trouble in the operation of REST using application.
The operation verification responsibility is on Redmine system administrator who changed.

--------------------------------------------------------------------------------
+1
--------------------------------------------------------------------------------
+1
--------------------------------------------------------------------------------
+1
--------------------------------------------------------------------------------
+1
--------------------------------------------------------------------------------
+1
--------------------------------------------------------------------------------
+1
--------------------------------------------------------------------------------

--------------------------------------------------------------------------------
Russian translation of:
> setting_api_limit: Maximum number of items returned in a JSON/XML API response
is
> setting_api_limit: Максимальное количество элементов, передаваемых в ответе JSON/XML API
--------------------------------------------------------------------------------
What blocks this change?
--------------------------------------------------------------------------------
+1
--------------------------------------------------------------------------------
meineerde from IRC #redmine@freenode ask me to describe my use-case.
Sorry for my poor english, but I try to explain why this feature is important for me.

We are using Redmine for manage projects - tasks, issues, bugtracker. 10-20 active projects with hundreds active issues and 100+ active users - employees and customers. Employees are using "Spent time" in issues to record work time for every issue every day. The employees' salary depends on those records.
We have developed application on Java+Tomcat for create reports with values from "Spent time" fields. It using REST API to get values:
<pre>http://redmine.host/time_entries.json?spent_on=><BEGIN_OF_MONTH|END_OF_MONTH&offset=N&limit=10000</pre>
For example to get 20000 objects - 200 requests in ~3 minutes even on localhost. But it's faster with limit 10000 - ~20 seconds only.
After end of each month 10+ project managers (I'm one of them) using this application to create reports for each project. The employees salary calculated from this reports. Every mouth we have thousands of "Spent time" entries. It's too long for users wait several minutes for "simple" report, and even more - some browsers timedout connection during this time…

Please, commit this patch!
--------------------------------------------------------------------------------
Looks good. We've wrote a patch based on Domingo Galdos' one (Patch 0001) with Juno NISHIZAKI, sanak and me on Redmine patch meeting 4th.

The changes are as follows:
* Added a test. (Patch 0002)
* Moved the configuration value form from the "General" tab to the "API" tab and shorten the label name. (Patch 0003, 0004)
* In the current implementation, if the limit parameter is less than 1, Redmine sets limit to 25. the limit is less than 25, the conditional statement is modified to be replaced by another one. (Patch 0005)

Go MAEDA wrote:

>The user should not be able to set the value of API limit smaller than 100.
>Probably some clients suppose that the value is always 100, smaller limit may affect compatibility with such clients.

Sounds reasonable, but currently the setting page doesn't have any validations. Do you have any good idea to apply the constraint?
--------------------------------------------------------------------------------
vzvu 3k6k wrote:
> Go MAEDA wrote:
>
> >The user should not be able to set the value of API limit smaller than 100.
> >Probably some clients suppose that the value is always 100, smaller limit may affect compatibility with such clients.
>
> Sounds reasonable, but currently the setting page doesn't have any validations. Do you have any good idea to apply the constraint?

The attached patch adds validation, though it may not be the best way to write it.
--------------------------------------------------------------------------------
The final result of the patch series posted by vzvu 3k6k and Mizuki looks good to me and all the tests pass: https://gitlab.com/redmine-org/redmine/-/pipelines/207877707

I propose to evaluate this for 4.2.0, but we should have Jean-Philippe agree on this because he rejected the patch some time ago. The feature is useful, for sure.
--------------------------------------------------------------------------------
I need this. To get more than 100 items.
--------------------------------------------------------------------------------

--------------------------------------------------------------------------------


related_issues

duplicates,Closed,7539,Rest-API limit of items not 100, but changeable by the administrator
duplicates,Closed,25555,Make api paging limit configurable
duplicates,Closed,26553,Overly restricted number of ReST results
duplicates,Closed,33526,Add possibility to configure limit used to retrieve objects for an API response

Admin Redmine さんが3ヶ月前に更新

  • カテゴリREST API_32 にセット
  • 対象バージョンCandidate for next major release_32 にセット

他の形式にエクスポート: Atom PDF

いいね!0
いいね!0