Apply suggestions from code review

Add first batch of changes to be incorporated.

Co-authored-by: Kate <26026535+provokateurin@users.noreply.github.com>
Signed-off-by: Christian Wolf <github@christianwolf.email>
This commit is contained in:
Christian Wolf
2025-02-28 18:05:11 +01:00
committed by GitHub
parent 17043e2dd4
commit 5435dcd708
2 changed files with 3 additions and 3 deletions

View File

@@ -478,7 +478,7 @@ For ``OCSController`` classes and their methods, :ref:`responders <controller-re
The ``OCSController`` class have however automatically two responders pre-installed:
Both JSON (``application/json``) and XML (``text/xml``) are generated on-the-fly depending on the request by the browser/user.
To select the output format, the ``?format=`` query parameter or the ``Accept`` header of the request work out of the box, no intervention is required.
It is advised to prefer the header generally, as this is the more programmatic way.
It is advised to prefer the header generally, as this is the more standardized way.
In order to make routing work for OCS routes you need to add :ref:`a separate 'ocs' entry<routes_ocs>` to the routing table in ``appinfo/routes.php`` of your app.
Inside these, there are the same information as there are for normal routes.
@@ -883,7 +883,7 @@ Here is the example from :ref:`OCS controllers <ocscontroller>`:
}
The ``#[NoAdminRequired]`` is needed here as normal users should be able to access the data in fact.
The ``#[NoAdminRequired]`` is needed here as normal users should be able to access the data.
It can be left out in case only the admin user should be able to access the data.
The CSRF check is still active.
Thus, the client must obey the corresponding requirements.

View File

@@ -44,7 +44,7 @@ Additionally, the route must be configured to be an OCS route in the router.
To do so, you use the ``ocs`` key in the ``routes.php`` file instead of the key ``routes``.
The rest of the structure is the same.
You can of course combine non-OCS with OCS routes.
You can of course have both index.php and OCS routes.
.. code-block:: php