Joomla! Issue Tracker | Joomla! CMS #45142 - [6.0] Fixes the missing modified start and end date filter to articled API endpoint

Feature RTC Unit/System Tests Composer Dependency Changed NPM Resource Changed Webservices PR-6.0-dev

Fixed in Code Base
24 Mar 2025
Medium
Build: 5.3-dev
# 45142
Diff
Digital-Peak:api/content/modified

Pending

User tests: Successful: 0 Unsuccessful: 0

laoneo
15 Mar 2025

Summary of Changes

Adds two new filter options to the articles list endpoint. The new modified_start and modified_end filters do allow to fetch articles which are modified within a date range. This is a common use case in API's, as it allows consumers to fetch only the delta which has changed since the last sync and not always the full list of articles. The following example fetches only articles which are edited within February 2025:

GET /api/index.php/v1/content/articles?filter[modified_start]=2025-02-01&filter[modified_start]=2025-02-28

Testing Instructions

Create an article with the modified date before February 2025
Create an article with the modified date after February 2025

Use tools like postman to execute the following curl command against the joomla installation with the patch:

curl -g "https://{web site}/api/index.php/v1/content/articles?filter[modified_start]=2025-02-01&filter[modified_start]=2025-02-28" -H "Authorization: Bearer {your token}"

Actual result BEFORE applying this Pull Request

All articles are returned.

Expected result AFTER applying this Pull Request

Only the article which was modified after the first February is returned.

Link to documentations

Please select:

Documentation link for docs.joomla.org:
No documentation changes for docs.joomla.org needed
Pull Request link for manual.joomla.org:
No documentation changes for manual.joomla.org needed

25f6911 15 Mar 2025

Add modified start and end date filter to articled API endpoint

laoneo - open - 15 Mar 2025

laoneo - change - 15 Mar 2025

Status

New

⇒

Pending

joomla-cms-bot - change - 15 Mar 2025

Category

⇒

Administration com_content JavaScript Unit Tests

laoneo - change - 15 Mar 2025

The description was changed

laoneo - edited - 15 Mar 2025

b4c8ead 15 Mar 2025

clearer variables

laoneo - change - 15 Mar 2025

Labels

Added: Unit/System Tests PR-5.3-dev

laoneo - change - 16 Mar 2025

Title

…

[5.3] ~~Add~~ modified start and end date filter to articled API endpoint

[5.3] Fixes the missing modified start and end date filter to articled API endpoint

laoneo - edited - 16 Mar 2025

2493253 16 Mar 2025

prepared statement (#31)

laoneo - change - 16 Mar 2025

Labels

Added: Webservices

alikon - test_item - 16 Mar 2025 - Tested successfully

alikon - comment - 16 Mar 2025

I have tested this item ✅ successfully on 2493253

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/45142.}

exlemor - test_item - 16 Mar 2025 - Tested successfully

exlemor - comment - 16 Mar 2025

I have tested this item ✅ successfully on 2493253

Thanks to @alikon's and @richard67's help, I was able to successfully test this via Postman!

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/45142.}

QuyTon - change - 16 Mar 2025

Status

Pending

⇒

Ready to Commit

QuyTon - comment - 16 Mar 2025

RTC

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/45142.}

muhme - test_item - 16 Mar 2025 - Tested successfully

muhme - comment - 16 Mar 2025

I have tested this item ✅ successfully on 2493253

Tested with local Joomla 5.3-dev on macOS

Before applying this PR:
- Overall System Tests 538 passed
- Tested API with HTTP Status 200 (unknown filters are ignored)
  - curl -w "\nHTTP Status: %{http_code}\n" --header "X-Joomla-Token:${token}" "${baseUrl}/api/index.php/v1/content/articles"
  - curl -w "\nHTTP Status: %{http_code}\n" --header "X-Joomla-Token:${token}" "${baseUrl}/api/index.php/v1/content/articles?filter[modified_start]=2025-02-01&filter[modified_end]=2025-02-28"
After applying this PR with Patch Tester
- Overall System Tests 539 passed (including the new one)
- Created three articles january, february and march and changed modified date in database to 15th and time to 12:00:00
- checked
  - curl -w "\nHTTP Status: %{http_code}\n" --header "X-Joomla-Token:${token}" "${baseUrl}/api/index.php/v1/content/articles?filter[modified_start]=2025-02-01&filter[modified_end]=2025-02-28" # Get only february article
  - curl -w "\nHTTP Status: %{http_code}\n" --header "X-Joomla-Token:${token}" "${baseUrl}/api/index.php/v1/content/articles?filter[modified_start]=2025-01-01&filter[modified_end]=2025-04-01" # Get all three articles
  - curl -w "\nHTTP Status: %{http_code}\n" --header "X-Joomla-Token:${token}" "${baseUrl}/api/index.php/v1/content/articles?filter[modified_start]=2025-02-01" # February and March article
  - curl -w "\nHTTP Status: %{http_code}\n" --header "X-Joomla-Token:${token}" "${baseUrl}/api/index.php/v1/content/articles?filter[modified_end]=2025-02-01" # Only January article
  - curl -w "\nHTTP Status: %{http_code}\n" --header "X-Joomla-Token:${token}" "${baseUrl}/api/index.php/v1/content/articles?filter[modified_start]=2025-01-15%2012:00:00&filter[modified_end]=2025-03-15%2012:00:00" # All three articles
  - curl -w "\nHTTP Status: %{http_code}\n" --header "X-Joomla-Token:${token}" "${baseUrl}/api/index.php/v1/content/articles?filter[modified_start]=2025-01-15%2012:00:00&filter[modified_end]=2025-03-15%2011:59:59" # January + February article
  - curl -w "\nHTTP Status: %{http_code}\n" --header "X-Joomla-Token:${token}" "${baseUrl}/api/index.php/v1/content/articles?filter[modified_start]=2025-01-15%2012:00:00" # all three
  - curl -w "\nHTTP Status: %{http_code}\n" --header "X-Joomla-Token:${token}" "${baseUrl}/api/index.php/v1/content/articles?filter[modified_start]=2025-01-15%2012:00:01" # only februrary and march article
    _{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/45142.}