centersl/nextcloud-docs
1
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2026-03-27 13:38:39 +07:00
Code Issues Packages Projects Releases Wiki Activity

chore: Apply suggestions from review

Browse Source 
Co-authored-by: Kate <26026535+provokateurin@users.noreply.github.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
This commit is contained in:
Josh
2026-02-19 14:56:19 -05:00
committed by GitHub
parent b20825beef
commit 2f189a0902
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
developer_manual/client_apis/OCS/ocs-openapi.rst
View File

@@ -52,7 +52,7 @@ In brief:
* Prefer OCS endpoints (``OCSController`` + ``DataResponse``) for public APIs
* Add explicit types everywhere (parameters, helper methods, and return types)
* Use ``null`` (or ``\stdClass``) to represent an empty JSON object
* Use ``\stdClass`` to represent an empty JSON object
* In OCS endpoints, only throw OCS*Exceptions
* Keep response shapes consistent across status-code groups (2xx together, 4xx together)
* Use ``setHeaders()`` instead of ``addHeader()``
@@ -656,7 +656,7 @@ Constants are available in ``OCP\AppFramework\Http\Attribute\OpenAPI::SCOPE_*``
A controller and methods can have multiple scopes, however when a method has the attribute set,
all scopes from the controller are ignored.
Methods that require admin permissions due to missing ``#[NoAdminRequired]`` or ``#[PublicPage]`` attribute or the
Methods that require admin permissions due to missing ``#[NoAdminRequired]`` or a present ``#[PublicPage]`` attribute or the
matching annotation, default to the ``OpenAPI::SCOPE_ADMINISTRATION`` scope.
.. code-block:: php
@@ -705,7 +705,7 @@ It will only work with that file name at that location.
*/
class ResponseDefinitions {}
The name of every type definition must start with the *readable app ID* as expected by theopenapi-extractor.
The name of every type definition must start with the *readable app ID* as expected by the openapi-extractor.
This is a TitleCase / normalized form used to namespace types per app (for example, the app ``Tables``
uses types like ``TablesColumn``.