Skip to content

Commit

Permalink
fix(dev): Use non-ambigous array syntax in OpenAPI tutorial
Browse files Browse the repository at this point in the history
Signed-off-by: provokateurin <[email protected]>
  • Loading branch information
provokateurin committed Sep 26, 2024
1 parent fbde3ad commit f92a6c8
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions developer_manual/client_apis/OCS/ocs-openapi.rst
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ For those endpoints returning ``[]`` in PHP is a problem because the consumer wi
If you are not able to use ``null`` for whatever reason, use ``new \stdClass()`` instead.
It will get correctly converted into ``{}`` in the JSON response on Nextcloud 28 and later.

If you are working with an existing API where you can not break compatibility, you can also type the result as ``array<empty>``.
If you are working with an existing API where you can not break compatibility, you can also type the result as ``list<empty>``.

.. collapse:: Examples

Expand Down Expand Up @@ -178,7 +178,7 @@ If you are working with an existing API where you can not break compatibility, y
}
/**
* @return DataResponse<Http::STATUS_OK, array<empty>, array{}>
* @return DataResponse<Http::STATUS_OK, list<empty>, array{}>
*/
public function someControllerMethod() {
...
Expand Down Expand Up @@ -719,7 +719,7 @@ Now you have to add the correct return type annotation:
class Capabilities implements ICapability {
/**
* @return array{todo: array{supported-operations: string[], emojis-supported: bool}}
* @return array{todo: array{supported-operations: list<string>, emojis-supported: bool}}
*/
public function getCapabilities() {
return [
Expand Down

0 comments on commit f92a6c8

Please sign in to comment.