[#28377] - [4.0] Allow extensions to add custom data to other extensions in the API
- Fixed in Code Base
- 6 Apr 2020
- Medium
- Build: 4.0-dev
- # 28377
- Diff
- wilsonge:feature/api-custom-relations
User tests: Successful: Unsuccessful:
Pull Request for Issue #26925 .
Summary of Changes
Adds plugin events to allow extensions to add custom properties to the API Response. Right now this deliberately doesn't allow modification of the existing properties but that will presumably come in the future as the data stabilizes.
Also has some small cleanups to the Joomla Serializer as I went through this.
Testing Instructions
Install this extension (enabling it etc) and check that the retrieving an article through the API includes extra properties. There should be one relation and one custom property added to the response.
EDIT: I've also tried to doc blocks in the plugin to explain the options and what you can do
Documentation Changes Required
Needs to be documented how to add these properties (using the plugin as the example)
//cc @nikosdion
| Status | New | ⇒ | Pending |
joomla-cms-bot
- | Category | ⇒ | Libraries |
| Labels |
Added:
?
?
|
||
| Title |
|
||||||
ok so i've tested this pr and it works as it has been described
but maybe i'm too naive
till now i'm still harding finding without proper docs how this is intented to work with differnt use cases
"text":"<p>Art1<\/p> ","tags":[],"customPropertyToRender":1}}],"meta":{"total-pages":1}}
So the property looks fine. The relation you'll only see if you go to a single item view (which according to the JSON API spec is the only time your going to see it).
till now i'm still harding finding without proper docs how this is intented to work with differnt use cases
What are you looking for? There is already a limited selection of docs pages. https://docs.joomla.org/Category:Joomla!_Api I need to know what you are missing.
@nikosdion are you going to be able to test this in the near future - appreciate with things so much in flux at the moment it's hard - trying to get this in so I can start to write some docs up about integrating with the API
I have tested this item
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/28377.
@nikosdion are you going to have time to test this one or should i just get it in and let you test in a nightly whenever you the time?
Sorry for the delay. We were having some trouble with the power and Internet connection. I'll try to find some time until Sunday evening. If you don't hear back from me by Monday assume I can't test it within a realistic amount of time.
No worries! Good luck getting things sorted!
| Status | Pending | ⇒ | Fixed in Code Base |
| Closed_Date | 0000-00-00 00:00:00 | ⇒ | 2020-04-06 08:52:23 |
| Closed_By | ⇒ | wilsonge |
My first impression is that it's pretty much what we discussed.
However, reading code is one thing, executing it is another. I'll definitely take a look over the weekend when I have more time; I'm currently in the tail end of a major JavaScript refactoring while trying to also deal with the second order effects of the “social distancing” measures due to the CoViD-19 outbreak.
Stay home and stay safe, mate.