Skip to content

Commit 2f189a0

Browse files
chore: Apply suggestions from review
Co-authored-by: Kate <26026535+provokateurin@users.noreply.github.com> Signed-off-by: Josh <josh.t.richards@gmail.com>
1 parent b20825b commit 2f189a0

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

developer_manual/client_apis/OCS/ocs-openapi.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ In brief:
5252

5353
* Prefer OCS endpoints (``OCSController`` + ``DataResponse``) for public APIs
5454
* Add explicit types everywhere (parameters, helper methods, and return types)
55-
* Use ``null`` (or ``\stdClass``) to represent an empty JSON object
55+
* Use ``\stdClass`` to represent an empty JSON object
5656
* In OCS endpoints, only throw OCS*Exceptions
5757
* Keep response shapes consistent across status-code groups (2xx together, 4xx together)
5858
* Use ``setHeaders()`` instead of ``addHeader()``
@@ -656,7 +656,7 @@ Constants are available in ``OCP\AppFramework\Http\Attribute\OpenAPI::SCOPE_*``
656656
A controller and methods can have multiple scopes, however when a method has the attribute set,
657657
all scopes from the controller are ignored.
658658

659-
Methods that require admin permissions due to missing ``#[NoAdminRequired]`` or ``#[PublicPage]`` attribute or the
659+
Methods that require admin permissions due to missing ``#[NoAdminRequired]`` or a present ``#[PublicPage]`` attribute or the
660660
matching annotation, default to the ``OpenAPI::SCOPE_ADMINISTRATION`` scope.
661661

662662
.. code-block:: php
@@ -705,7 +705,7 @@ It will only work with that file name at that location.
705705
*/
706706
class ResponseDefinitions {}
707707
708-
The name of every type definition must start with the *readable app ID* as expected by theopenapi-extractor.
708+
The name of every type definition must start with the *readable app ID* as expected by the openapi-extractor.
709709
This is a TitleCase / normalized form used to namespace types per app (for example, the app ``Tables``
710710
uses types like ``TablesColumn``.
711711

0 commit comments

Comments
 (0)