[4.0] Add author to output and filter options to com_content API

[wilsonge]

Summary of Changes

• Allows relations to be shown in the list view of the API
• Adds filters for author id, category id, state and search into the articles api (for now starting with these and we can expand and move them to other components)
• Adds author relationship to the output of articles
• Fixes category relationship being shown as an articles type instead of categories type

Testing Instructions

1. Test the filters endpoint with e.g.

JROOT_URL/api/index.php/v1/content/article?filter[search]=tag

which will search for the string 'tag'

JROOT_URL/api/index.php/v1/content/article?filter[state]=0

will search for unpublished articles

2. Test the relationships for category and author are output in both the item and list views of the article output and have the correct type.

Documentation Changes Required

Yes:

1. How to implement filters in APIs
2. What filters are available in core components

[wilsonge]

@alikon this should port over some of the work you were doing on filters

[alikon]

@wilsonge please have a look at this silly one #28384 to prevent conflict

[alikon]

a couple of things :

• should not this show a conflict file cause of [4.0][api][com_content] remove notice when Multilingual #28384 touching api/components/com_content/src/View/Articles/JsonapiView.php

• calling JROOT_URL/api/index.php/v1/content/article?filter[state]=0 without unpublished give me this response

{
  "links": {
    "self": "http:\/\/localhost\/jbs4\/api\/index.php\/v1\/content\/article?filter%5Bstate%5D=0",
    "first": "http:\/\/localhost\/jbs4\/api\/index.php\/v1\/content\/article?filter[state]=0&page[offset]=0&page[limit]=20",
    "next": "http:\/\/localhost\/jbs4\/api\/index.php\/v1\/content\/article?filter[state]=0&page[offset]=-20&page[limit]=20",
    "previous": "http:\/\/localhost\/jbs4\/api\/index.php\/v1\/content\/article?filter[state]=0&page[offset]=0&page[limit]=20",
    "last": "http:\/\/localhost\/jbs4\/api\/index.php\/v1\/content\/article?filter[state]=0&page[offset]=-20&page[limit]=20"
  },
  "data": [],
  "meta": {
    "total-pages": 0
  }
}

should not it be something like this ?

{
  "errors": [
    {
      "title": "Resource not found",
      "code": 404
    }
  ]
}

[alikon]

a funny thing is that we have relations on the api response and not in the database 🤣

[wilsonge]

should not this show a conflict file cause of #28384 touching api/components/com_content/src/View/Articles/JsonapiView.php

No because it's different lines in the file - if i'd modified the same lines of code as you it would cause a conflicts

calling JROOT_URL/api/index.php/v1/content/article?filter[state]=0 without unpublished give me this response

In my opinion no - because the URL is valid - it's just no data matches the filter criteria.

[alikon]

thanks for reply
it works well so let's move on

[alikon]

I have tested this item ✅ successfully on 759417d

---

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

[alikon]

tip for those who want to search on content (fulltext) suppose you would search for word mundi

the call is:
JROOT_URL/api/index.php/v1/content/article?filter[search]=CONTENT:mundi

[wilsonge]

@alikon can you do the language PR as it's own thing and let's discuss there whether to use PK or the language code for filtering

[alikon]

yes for sure

[alikon]

see #28406