[6.0] Tag history endpoint

[alikon]

Summary of Changes

added endpoints for tags history

• GET v1/tags/:id/contenthistory
• PATCH v1/tags/:id/contenthistory/keep
• DELETE 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:

• id for /v1/tag/:id/contenthistory is the contenthistory id and NOT the tag.id
• PATCH is only available for the attribute keep_forever with /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

[muhme]

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.

[alikon]

yes, of course
but i'll be slow, i'm short in free time currently

[richard67]

@alikon We have discussed this PR among release managers and decided to move it to 6.0-dev as it's a new feature, so I've just rebased your PR. Now it shows 2 unrelated changes, but these will disappear after the next upmerge and branch update.

[muhme]

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 GET has "keep_forever" : 1 set
• ✅ 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 meta
  • PATCH /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:

• id for /tags/:id/contenthistory is the contenthistory and NOT the tag.id
• PATCH is only available for the attribute keep_forever with /v1/tags/:id/contenthistory/keep

---

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

Files

• api_tag_contenthistory_test.sh.txt
• api_tag_contenthistory_test.log

[alikon]

for the DELETE of a non existent item see #45589

for the GET it is the current behaviour of contenthistory not only for tags

for the PATCH need some more free time to check