fix(openapi): Improve wordings of docs

Signed-off-by: Joas Schilling <coding@schilljs.com>
This commit is contained in:
Joas Schilling 2023-11-17 11:11:39 +01:00
parent 3933d1946b
commit f736767435
No known key found for this signature in database
GPG key ID: 74434EFE0D2E2205
5 changed files with 8 additions and 6 deletions

View file

@ -135,7 +135,7 @@ class FilesIntegrationController extends OCSController {
}
/**
* Returns the token of the room associated to the file id of the given
* Returns the token of the room associated to the file of the given
* share token
*
* This is the counterpart of self::getRoomByFileId() for share tokens

View file

@ -54,7 +54,7 @@ class PublicShareAuthController extends OCSController {
}
/**
* Creates a new room for requesting the password of a share
* Creates a new room for video verification (requesting the password of a share)
*
* The new room is a public room associated with a "share:password" object
* with the ID of the share token. Unlike normal rooms in which the owner is

View file

@ -268,7 +268,9 @@ class RoomController extends AEnvironmentAwareController {
}
/**
* Get all (for moderators and in case of "free selection") or the assigned breakout room
* Get breakout rooms
*
* All for moderators and in case of "free selection", or the assigned breakout room for other participants
*
* @return DataResponse<Http::STATUS_OK, TalkRoom[], array{}>|DataResponse<Http::STATUS_BAD_REQUEST, array{error: string}, array{}>
*

View file

@ -120,7 +120,7 @@ class SettingsController extends OCSController {
}
/**
* Update SIP settings
* Update SIP bridge settings
*
* @param string[] $sipGroups New SIP groups
* @param string $dialInInfo New dial info

View file

@ -51,7 +51,7 @@ class TempAvatarController extends OCSController {
}
/**
* Upload a temporary avatar
* Upload your avatar as a user
*
* @return DataResponse<Http::STATUS_OK, array<empty>, array{}>|DataResponse<Http::STATUS_BAD_REQUEST, array{message: string}, array{}>
*
@ -125,7 +125,7 @@ class TempAvatarController extends OCSController {
}
/**
* Delete a temporary avatar
* Delete your avatar as a user
*
* @return DataResponse<Http::STATUS_OK|Http::STATUS_BAD_REQUEST, array<empty>, array{}>
*