[#44669] - [6.0] Tag history endpoint
- Pending
- Medium
- Build: 5.3-dev
- # 44669
- Diff
- alikon:tag-history-endpoint
User tests: Successful: Unsuccessful:
Summary of Changes
added endpoints for tags history
GET v1/tags/:id/contenthistoryPATCH v1/tags/:id/contenthistory/keepDELETE v1/tags/:id/contenthistory
Testing Instructions
npm cypress run --spec tests/System/integration/api/com_contenthistory/Tag.cy.js
Actual result BEFORE applying this Pull Request
N/A
Expected result AFTER applying this Pull Request
test + endpoint
Link to documentations
As discussed, this API enhancement will be documented first in https://manual.joomla.org/migrations/54-60/new-features, please note:
idfor/v1/tag/:id/contenthistoryis the contenthistory id and NOT thetag.idPATCHis only available for the attributekeep_foreverwith/v1/tag/:id/contenthistory/keep
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
| Status | New | ⇒ | Pending |
joomla-cms-bot
- | Category | ⇒ | Front End Plugins JavaScript Unit Tests |
| Labels |
Added:
Unit/System Tests
PR-5.3-dev
|
||
| Labels |
Added:
Documentation Required
Webservices
|
||
| Status | Pending | ⇒ | Closed |
| Closed_Date | 0000-00-00 00:00:00 | ⇒ | 2025-03-24 21:44:51 |
| Closed_By | ⇒ | alikon |
| Status | Closed | ⇒ | New |
| Closed_Date | 2025-03-24 21:44:51 | ⇒ | |
| Closed_By | alikon | ⇒ |
| Status | New | ⇒ | Pending |
| Title |
|
||||||
| Labels |
Added:
PR-5.4-dev
Removed: Documentation Required PR-5.3-dev |
||
yes, of course
but i'll be slow, i'm short in free time currently
| Category | Front End Plugins JavaScript Unit Tests | ⇒ | Administration Language & Strings Front End Plugins JavaScript Unit Tests |
| Title |
|
||||||
I have tested this item 🔴 unsuccessfully on 5933d36
I have tested with current 6.0-dev and curl command line (script and output will be attached to the PR)
- ✅ With wrong API token
- ✅
GET /v1/tags/:id/contenthistory-> 401 "Unauthorized" with error "Forbidden" - ✅
PATCH /v1/tags/:id/contenthistory/keep-> 401 "Unauthorized" with error "Forbidden" - ✅
DELETE /v1/tags/:id/contenthistory-> 401 "Unauthorized" with error "Forbidden"
- ✅
- ✅
GET /v1/tags/:id/contenthistory-> 200 "OK" and returning the entry in JSON format - ✅
PATCH /v1/tags/:id/contenthistory/keep-> 200 "OK" and empty return- ✅ And verified next
GEThas"keep_forever" : 1set
- ✅ And verified next
- ✅
DELETE /v1/tags/:id/contenthistory-> 204 "No Content" end no content returned - ❌ Non existing entries, expected is e.g. 404 "Not Found"
GET /v1/tags/4711/contenthistory-> 200 "OK" and json structure with self link and empty data and empty metaPATCH /v1/tags/4711/contenthistory/keep-> 400 "Bad Request" with JSON error "Changed the keep forever value for a history version."DELETE /v1/tags/4711/contenthistory-> 500 "Internal Server Error" with JSON error "RuntimeException"
Not tested was the following. Should this or something elso be tested next time?
- PATCH with malformed JSON
- PATCH with unsupported fields
The database was checked in parallel and regardless of this PR, the entries in the content history are not deleted when the tag is deleted and I will create an issue.
Notes on the documentation:
idfor/tags/:id/contenthistoryis the contenthistory and NOT thetag.idPATCHis only available for the attributekeep_foreverwith/v1/tags/:id/contenthistory/keep
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/44669.
Thank you @alikon for your contribution and for adding System Tests for the new REST API tag history functionality.
Is it possible to also test PATCH and DELETE requests in the System Tests after testing GET?
I would test in parallel with curl or postman and document this as the mentioned System Test spec is already included in the CI. And would ask around how to proceed with the documentation, e.g. there is no POST as the history entries are only created implicit.