mirrors/nextcloud-documentation
3
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2025-10-26 11:18:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #12231 from nextcloud/fix/dev/openapi-non-ambigous-array-syntax

Browse Source
This commit is contained in:
Kate 2024-09-26 12:46:56 +02:00 committed by GitHub
commit 173dba2351
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -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
@ -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() {
...
@ -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 [