feat(occ): Add commands to list all routes and match a single one by nickvergessen · Pull Request #53669 · nextcloud/server

nickvergessen · 2025-06-24T21:46:00Z

Match a route

-v for path and requirements of parameters
--method to specify HTTP method

$ occ router:match '/ocs/v2.php/apps/activity/api/v2/activity/{filter}' +------------------------------+----------+-----------------+-----------+
| route | appid | controller | method |
+------------------------------+----------+-----------------+-----------+
| ocs.activity.apiv2.getfilter | activity | APIv2Controller | getFilter |
+------------------------------+----------+-----------------+-----------+
$ occ router:match '/ocs/v2.php/apps/activity/api/v2/remote/1234567890' -v --method POST
+---------------------------------------------+----------+--------------------------+-----------------+-------------------------------------------------+--------------+
| route | appid | controller | method | path | requirements |
+---------------------------------------------+----------+--------------------------+-----------------+-------------------------------------------------+--------------+
| ocs.activity.remoteactivity.receiveactivity | activity | RemoteActivityController | receiveActivity | /ocs/v2.php/apps/activity/api/v2/remote/{token} | [] |
+---------------------------------------------+----------+--------------------------+-----------------+-------------------------------------------------+--------------+

List all routes (of apps)

-v for requirements of parameters
--ocs to only list OCS routes
--index to only list index.php routes
Optional argument list of apps

$ occ router:list notifications -v
+-----------------------------------------------+---------+-------------------------------------------------------------------------------+--------------------------------------+
| route | request | path | requirements |
+-----------------------------------------------+---------+-------------------------------------------------------------------------------+--------------------------------------+
| notifications.api.generatenotification | POST | /ocs/v2.php/apps/notifications/api/{apiVersion}/admin_notifications/{userId} | {"apiVersion":"(v1|v2)"} |
| notifications.api.generatenotificationv3 | POST | /ocs/v2.php/apps/notifications/api/{apiVersion3}/admin_notifications/{userId} | {"apiVersion3":"(v3)"} |
| notifications.api.selftestpush | POST | /ocs/v2.php/apps/notifications/api/{apiVersion3}/test/self | {"apiVersion3":"(v3)"} |
| notifications.endpoint.confirmidsforuser | POST | /ocs/v2.php/apps/notifications/api/{apiVersion}/notifications/exists | {"apiVersion":"(v1|v2)"} |
| notifications.endpoint.deleteallnotifications | DELETE | /ocs/v2.php/apps/notifications/api/{apiVersion}/notifications | {"apiVersion":"(v1|v2)"} |
| notifications.endpoint.deletenotification | DELETE | /ocs/v2.php/apps/notifications/api/{apiVersion}/notifications/{id} | {"apiVersion":"(v1|v2)","id":"\\d+"} |
| notifications.endpoint.getnotification | GET | /ocs/v2.php/apps/notifications/api/{apiVersion}/notifications/{id} | {"apiVersion":"(v1|v2)","id":"\\d+"} |
| notifications.endpoint.listnotifications | GET | /ocs/v2.php/apps/notifications/api/{apiVersion}/notifications | {"apiVersion":"(v1|v2)"} |
| notifications.push.registerdevice | POST | /ocs/v2.php/apps/notifications/api/{apiVersion}/push | {"apiVersion":"(v2)"} |
| notifications.push.removedevice | DELETE | /ocs/v2.php/apps/notifications/api/{apiVersion}/push | {"apiVersion":"(v2)"} |
| notifications.settings.admin | POST | /ocs/v2.php/apps/notifications/api/{apiVersion}/settings/admin | {"apiVersion":"(v2)"} |
| notifications.settings.personal | POST | /ocs/v2.php/apps/notifications/api/{apiVersion}/settings | {"apiVersion":"(v2)"} |
+-----------------------------------------------+---------+-------------------------------------------------------------------------------+--------------------------------------+
$ occ router:list activity
+-----------------------------------------+---------+----------------------------------------------------+
| route | request | path |
+-----------------------------------------+---------+----------------------------------------------------+
| activity.activities.index | GET | /apps/activity/ |
| activity.activities.showlist | GET | /apps/activity/{filter} |
| activity.apiv1.get | GET | /ocs/v2.php/cloud/activity |
| activity.apiv2.getdefault | GET | /ocs/v2.php/apps/activity/api/v2/activity |
| activity.apiv2.getfilter | GET | /ocs/v2.php/apps/activity/api/v2/activity/{filter} |
| activity.apiv2.listfilters | GET | /ocs/v2.php/apps/activity/api/v2/activity/filters |
| activity.feed.show | GET | /apps/activity/rss.php |
| activity.remoteactivity.receiveactivity | POST | /ocs/v2.php/apps/activity/api/v2/remote/{token} |
| activity.settings.admin | POST | /apps/activity/settings/admin |
| activity.settings.feed | POST | /apps/activity/settings/feed |
| activity.settings.personal | POST | /apps/activity/settings |
+-----------------------------------------+---------+----------------------------------------------------+
$ occ router:list activity --ocs
+-----------------------------------------+---------+----------------------------------------------------+
| route | request | path |
+-----------------------------------------+---------+----------------------------------------------------+
| activity.apiv1.get | GET | /ocs/v2.php/cloud/activity |
| activity.apiv2.getdefault | GET | /ocs/v2.php/apps/activity/api/v2/activity |
| activity.apiv2.getfilter | GET | /ocs/v2.php/apps/activity/api/v2/activity/{filter} |
| activity.apiv2.listfilters | GET | /ocs/v2.php/apps/activity/api/v2/activity/filters |
| activity.remoteactivity.receiveactivity | POST | /ocs/v2.php/apps/activity/api/v2/remote/{token} |
+-----------------------------------------+---------+----------------------------------------------------+
$ occ router:list activity --index
+------------------------------+---------+-------------------------------+
| route | request | path |
+------------------------------+---------+-------------------------------+
| activity.activities.index | GET | /apps/activity/ |
| activity.activities.showlist | GET | /apps/activity/{filter} |
| activity.feed.show | GET | /apps/activity/rss.php |
| activity.settings.admin | POST | /apps/activity/settings/admin |
| activity.settings.feed | POST | /apps/activity/settings/feed |
| activity.settings.personal | POST | /apps/activity/settings |
+------------------------------+---------+-------------------------------+

Checklist

Code is properly formatted
Sign-off message is added to all commits
Tests (unit, integration, api and/or acceptance) are included
Screenshots before/after for front-end changes
Documentation (manuals or wiki) has been updated or is not required
Backports requested where applicable (ex: critical bugfixes)

Signed-off-by: Joas Schilling <coding@schilljs.com>

nickvergessen · 2025-06-25T07:35:08Z

/backport to stable31

nickvergessen added this to the Nextcloud 32 milestone Jun 24, 2025

nickvergessen self-assigned this Jun 24, 2025

nickvergessen requested a review from a team as a code owner June 24, 2025 21:46

nickvergessen requested review from artonge, come-nc and leftybournes and removed request for a teamJune 24, 2025 21:46

nickvergessen added enhancement 3. to review Waiting for reviews technical debt 🧱 🤔🚀 labels Jun 24, 2025

nickvergessen requested review from a team and provokateurin June 24, 2025 21:46

nickvergessen force-pushed the feat/noid/add-command-to-list-all-routes branch from df45317 to cd52d1bCompare June 24, 2025 21:51

provokateurin reviewed Jun 24, 2025
View reviewed changes

Comment threadcore/Command/Router/MatchRoute.php Outdated
Comment threadcore/Command/Router/MatchRoute.php
Comment threadcore/Command/Router/ListRoutes.php

feat(occ): Add commands to list all routes and match a single one
a957e3a
Signed-off-by: Joas Schilling <coding@schilljs.com>

nickvergessen force-pushed the feat/noid/add-command-to-list-all-routes branch from cd52d1b to a957e3aCompare June 25, 2025 06:20

nickvergessen requested a review from provokateurin June 25, 2025 06:20

nickvergessen added the pending documentation This pull request needs an associated documentation update label Jun 25, 2025

provokateurin approved these changes Jun 25, 2025
View reviewed changes

AndyScherzinger approved these changes Jun 25, 2025
View reviewed changes

nickvergessen merged commit 06ebbb6 into masterJun 25, 2025

nickvergessen deleted the feat/noid/add-command-to-list-all-routes branch June 25, 2025 07:34

backportbotBot added the backport-request label Jun 25, 2025

backportbotBot mentioned this pull request Jun 25, 2025
[stable31] feat(occ): Add commands to list all routes and match a single one #53672
Merged
2 tasks

backportbotBot removed the backport-request label Jun 25, 2025

kesselb mentioned this pull request Jun 25, 2025
feat: add OCC command to list all routes (incl. fixing the Router) #52919
Closed
4 tasks

skjnldsv mentioned this pull request Aug 19, 2025
32.0.0 beta 1 #54502
Merged

skjnldsv modified the milestones: Nextcloud 32, Nextcloud 33 Sep 28, 2025

skjnldsv modified the milestones: Nextcloud 33, Nextcloud 32 Oct 2, 2025

Navigation Menu

Uh oh!

Uh oh!

feat(occ): Add commands to list all routes and match a single one - #53669

feat(occ): Add commands to list all routes and match a single one#53669
nickvergessen merged 1 commit into
masterfrom
feat/noid/add-command-to-list-all-routes

nickvergessen commented Jun 24, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nickvergessen commented Jun 25, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Uh oh!

Conversation

nickvergessen commented Jun 24, 2025

Match a route

List all routes (of apps)

Checklist

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nickvergessen commented Jun 25, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants