[4.0][webservice][com_installer] add filtering of data by alikon · Pull Request #32769 · joomla/joomla-cms

alikon · 2021-03-21T07:19:29Z

Summary of Changes

add filtering of data

Testing Instructions

GET {{base_path}}/api/index.php/v1/installer/manage?core=true/false
GET {{base_path}}/api/index.php/v1/installer/manage?status=0/1
GET {{base_path}}/api/index.php/v1/installer/manage?type=component/plugin/module/template

Actual result BEFORE applying this Pull Request

N/A

Expected result AFTER applying this Pull Request

{
    "links": {
        "self": "https://demo4.loc/api/index.php/v1/installer/manage?core=0"
    },
    "data": [
        {
            "type": "manage",
            "id": "224",
            "attributes": {
                "name": "Action Log - Akeeba Backup",
                "type": "plugin",
                "folder": "actionlog",
                "client_id": "0",
                "status": "0",
                "version": "8.0.1",
                "id": "224"
            }
        },
        {
            "type": "manage",
            "id": "220",
            "attributes": {
                "name": "Akeeba Backup",
                "type": "component",
                "folder": "",
                "client_id": "1",
                "status": "1",
                "version": "8.0.1",
                "id": "220"
            }
        },
        {
            "type": "manage",
            "id": "225",
            "attributes": {
                "name": "Akeeba Backup package",
                "type": "package",
                "folder": "",
                "client_id": "0",
                "status": "1",
                "version": "8.0.1",
                "id": "225"
            }
        },
        {
            "type": "manage",
            "id": "221",
            "attributes": {
                "name": "Console - Akeeba Backup",
                "type": "plugin",
                "folder": "console",
                "client_id": "0",
                "status": "1",
                "version": "8.0.1",
                "id": "221"
            }
        },
        {
            "type": "manage",
            "id": "226",
            "attributes": {
                "name": "file_fef",
                "type": "file",
                "folder": "",
                "client_id": "0",
                "status": "1",
                "version": "2.0.1",
                "id": "226"
            }
        },
        {
            "type": "manage",
            "id": "219",
            "attributes": {
                "name": "file_fof40",
                "type": "file",
                "folder": "",
                "client_id": "0",
                "status": "1",
                "version": "4.0.2",
                "id": "219"
            }
        },
        {
            "type": "manage",
            "id": "218",
            "attributes": {
                "name": "Joomla! Patch Tester",
                "type": "component",
                "folder": "",
                "client_id": "1",
                "status": "1",
                "version": "4.0.1",
                "id": "218"
            }
        },
        {
            "type": "manage",
            "id": "222",
            "attributes": {
                "name": "Quick Icon - Akeeba Backup Notification",
                "type": "plugin",
                "folder": "quickicon",
                "client_id": "0",
                "status": "1",
                "version": "8.0.1",
                "id": "222"
            }
        },
        {
            "type": "manage",
            "id": "217",
            "attributes": {
                "name": "Sample Data - Testing",
                "type": "plugin",
                "folder": "sampledata",
                "client_id": "0",
                "status": "0",
                "version": "4.0.0",
                "id": "217"
            }
        },
        {
            "type": "manage",
            "id": "223",
            "attributes": {
                "name": "System - Backup on update",
                "type": "plugin",
                "folder": "system",
                "client_id": "0",
                "status": "0",
                "version": "8.0.1",
                "id": "223"
            }
        }
    ],
    "meta": {
        "total-pages": 1
    }
}

Documentation Changes Required

api/components/com_installer/src/Controller/ManageController.php

Co-authored-by: Richard Fath <richard67@users.noreply.github.com>

api/components/com_installer/src/Controller/ManageController.php

Co-authored-by: Quy <quy@fluxbb.org>

Quy · 2021-03-25T00:53:01Z

For core, should all entries be displayed if true/false is not entered?

alikon · 2021-03-25T07:21:19Z

when core is omitted it works like before ie all items are returned

Quy · 2021-03-25T14:46:33Z

core=0 returns entries. Should it?

alikon · 2021-03-27T07:51:40Z

no
better a 400

{
    "errors": [
        {
            "title": "Invalid field: core",
            "code": 400
        }
    ]
}

Quy · 2021-03-28T12:11:24Z

It is not a consistent to show an error vs. the following.

In this example, a 2 is added at the end.

{
    "links": {
        "self": "http://localhost/joomla-cms-4.0-dev/api/index.php/v1/installer/manage?type=component2"
    },
    "data": [],
    "meta": {
        "total-pages": 0
    }
}

alikon · 2021-03-29T06:49:24Z

these are different things
it has been requested to manage core like boolean hence the check (invalid field)
but for type it's a string so 0 found it's a correct response

anibalsanchez · 2021-04-23T18:10:13Z

I think that the GET verb is wrong in the REST API controller Installer.

/installer is not a data entity. It is a controller/helper itself that provides the behaviour, actions.

It looks odd calling an action with a GET. /installer/manage is a method, so for clarity, it is better if it is called with a POST (even if it doesn't persist a change).

So, if everything that Installer does is managing, then the method manage must return different types of data based on a control parameter. If we follow the Joomla practice, it should have a task parameter to return data or persist changes.

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

alikon · 2021-04-24T07:32:56Z

beyond the scope of this pr

anibalsanchez · 2021-04-24T10:33:47Z

Thinking twice about the API for extensions, it is not right to publish the "Installer" /installer. It is not the right semantic.

Check the documentation https://docs.joomla.org/J4.x:Joomla_Core_APIs. The entry points are always entities.

It is better to manage the extensions as /api/index.php/v1/extensions/...

For instance, to install an extension you should do a POST /api/index.php/v1/extensions/install.

wilsonge · 2021-04-25T22:39:56Z

@anibalsanchez i agree with you - however Nicola is also correct that his pr is just adding filters to an existing endpoint - so can you create a separate issue to track your comment - and I'll try and work on it

alikon · 2021-05-09T07:37:21Z

merged in #33339

add filtering of data

05084fb

joomla-cms-bot added the PR-4.0-dev label Mar 21, 2021

wilsonge reviewed Mar 21, 2021

View reviewed changes

api/components/com_installer/src/Controller/ManageController.php Outdated Show resolved Hide resolved

wilsonge reviewed Mar 21, 2021

View reviewed changes

api/components/com_installer/src/Controller/ManageController.php Outdated Show resolved Hide resolved

rdeutz added this to the Joomla 4.0.1 milestone Mar 22, 2021

alikon added 2 commits March 22, 2021 08:39

STRING

831f9ba

Bool

af83376

richard67 reviewed Mar 23, 2021

View reviewed changes

api/components/com_installer/src/Controller/ManageController.php Outdated Show resolved Hide resolved

Update api/components/com_installer/src/Controller/ManageController.php

84d61c5

Co-authored-by: Richard Fath <richard67@users.noreply.github.com>

Quy reviewed Mar 23, 2021

View reviewed changes

api/components/com_installer/src/Controller/ManageController.php Outdated Show resolved Hide resolved

Update api/components/com_installer/src/Controller/ManageController.php

b79c1d3

Co-authored-by: Quy <quy@fluxbb.org>

InvalidParameterException

b866051

$

271b92f

anibalsanchez mentioned this pull request Apr 26, 2021

Change the REST API endpoint for extensions from /installer to /extensions #33336

Closed

alikon mentioned this pull request Apr 26, 2021

[4.0] REST semantic Provide Sensible Resource Names #33339

Merged

alikon closed this May 9, 2021

alikon deleted the patch-81 branch May 9, 2021 07:39

wilsonge removed this from the Joomla 4.0.1 milestone Aug 23, 2021

Uh oh!

Conversation

alikon commented Mar 21, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary of Changes

Testing Instructions

Actual result BEFORE applying this Pull Request

Expected result AFTER applying this Pull Request

Documentation Changes Required

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Quy commented Mar 25, 2021

Uh oh!

alikon commented Mar 25, 2021

Uh oh!

Quy commented Mar 25, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

alikon commented Mar 27, 2021

Uh oh!

Quy commented Mar 28, 2021

Uh oh!

alikon commented Mar 29, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

anibalsanchez commented Apr 23, 2021

Uh oh!

alikon commented Apr 24, 2021

Uh oh!

anibalsanchez commented Apr 24, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wilsonge commented Apr 25, 2021

Uh oh!

alikon commented May 9, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

alikon commented Mar 21, 2021 •

edited

Loading

Quy commented Mar 25, 2021 •

edited

Loading

alikon commented Mar 29, 2021 •

edited

Loading

anibalsanchez commented Apr 24, 2021 •

edited

Loading