Skip to content

Commit

Permalink
Merge pull request #13792 from nextcloud/dependabot/composer/vendor-b…
Browse files Browse the repository at this point in the history
…in/openapi-extractor/nextcloud/openapi-extractor-1.2.2
  • Loading branch information
dependabot[bot] authored Dec 2, 2024
2 parents 099d03a + 1498740 commit 68b2250
Show file tree
Hide file tree
Showing 22 changed files with 68 additions and 68 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
use OCA\Talk\Room;
use OCP\AppFramework\OCSController;

abstract class AEnvironmentAwareController extends OCSController {
abstract class AEnvironmentAwareOCSController extends OCSController {
protected int $apiVersion = 1;
protected ?Room $room = null;
protected ?Participant $participant = null;
Expand Down
2 changes: 1 addition & 1 deletion lib/Controller/AvatarController.php
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
/**
* @psalm-import-type TalkRoom from ResponseDefinitions
*/
class AvatarController extends AEnvironmentAwareController {
class AvatarController extends AEnvironmentAwareOCSController {
public function __construct(
string $appName,
IRequest $request,
Expand Down
2 changes: 1 addition & 1 deletion lib/Controller/BanController.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
/**
* @psalm-import-type TalkBan from ResponseDefinitions
*/
class BanController extends AEnvironmentAwareController {
class BanController extends AEnvironmentAwareOCSController {
public function __construct(
string $appName,
IRequest $request,
Expand Down
2 changes: 1 addition & 1 deletion lib/Controller/BotController.php
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
* @psalm-import-type TalkBot from ResponseDefinitions
* @psalm-import-type TalkBotWithDetails from ResponseDefinitions
*/
class BotController extends AEnvironmentAwareController {
class BotController extends AEnvironmentAwareOCSController {
public function __construct(
string $appName,
IRequest $request,
Expand Down
2 changes: 1 addition & 1 deletion lib/Controller/BreakoutRoomController.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
/**
* @psalm-import-type TalkRoom from ResponseDefinitions
*/
class BreakoutRoomController extends AEnvironmentAwareController {
class BreakoutRoomController extends AEnvironmentAwareOCSController {
public function __construct(
string $appName,
IRequest $request,
Expand Down
8 changes: 4 additions & 4 deletions lib/Controller/CallController.php
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
/**
* @psalm-import-type TalkCallPeer from ResponseDefinitions
*/
class CallController extends AEnvironmentAwareController {
class CallController extends AEnvironmentAwareOCSController {

public function __construct(
string $appName,
Expand Down Expand Up @@ -282,7 +282,7 @@ protected function validateRecordingConsent(bool $recordingConsent): void {
}

/**
* Join call on the host server using the session id of the federated user.
* Join call on the host server using the session id of the federated user
*
* @param string $sessionId Federated session id to join with
* @param int<0, 15>|null $flags In-Call flags
Expand Down Expand Up @@ -449,7 +449,7 @@ public function updateCallFlags(int $flags): DataResponse {

/**
* Update the in-call flags on the host server using the session id of the
* federated user.
* federated user
*
* @param string $sessionId Federated session id to update the flags with
* @param int<0, 15> $flags New flags
Expand Down Expand Up @@ -531,7 +531,7 @@ public function leaveCall(bool $all = false): DataResponse {

/**
* Leave a call on the host server using the session id of the federated
* user.
* user
*
* @param string $sessionId Federated session id to leave with
* @return DataResponse<Http::STATUS_OK|Http::STATUS_NOT_FOUND, null, array{}>
Expand Down
2 changes: 1 addition & 1 deletion lib/Controller/ChatController.php
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@
* @psalm-import-type TalkRichObjectParameter from ResponseDefinitions
* @psalm-import-type TalkRoom from ResponseDefinitions
*/
class ChatController extends AEnvironmentAwareController {
class ChatController extends AEnvironmentAwareOCSController {
/** @var string[] */
protected array $guestNames;

Expand Down
2 changes: 1 addition & 1 deletion lib/Controller/GuestController.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
use OCP\AppFramework\Http\DataResponse;
use OCP\IRequest;

class GuestController extends AEnvironmentAwareController {
class GuestController extends AEnvironmentAwareOCSController {

public function __construct(
string $appName,
Expand Down
2 changes: 1 addition & 1 deletion lib/Controller/MatterbridgeController.php
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
* @psalm-import-type TalkMatterbridgeProcessState from ResponseDefinitions
* @psalm-import-type TalkMatterbridgeWithProcessState from ResponseDefinitions
*/
class MatterbridgeController extends AEnvironmentAwareController {
class MatterbridgeController extends AEnvironmentAwareOCSController {

public function __construct(
string $appName,
Expand Down
2 changes: 1 addition & 1 deletion lib/Controller/PollController.php
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
* @psalm-import-type TalkPoll from ResponseDefinitions
* @psalm-import-type TalkPollDraft from ResponseDefinitions
*/
class PollController extends AEnvironmentAwareController {
class PollController extends AEnvironmentAwareOCSController {

public function __construct(
string $appName,
Expand Down
2 changes: 1 addition & 1 deletion lib/Controller/ReactionController.php
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
/**
* @psalm-import-type TalkReaction from ResponseDefinitions
*/
class ReactionController extends AEnvironmentAwareController {
class ReactionController extends AEnvironmentAwareOCSController {

public function __construct(
string $appName,
Expand Down
2 changes: 1 addition & 1 deletion lib/Controller/RecordingController.php
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
use OCP\IRequest;
use Psr\Log\LoggerInterface;

class RecordingController extends AEnvironmentAwareController {
class RecordingController extends AEnvironmentAwareOCSController {
public function __construct(
string $appName,
IRequest $request,
Expand Down
6 changes: 3 additions & 3 deletions lib/Controller/RoomController.php
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@
* @psalm-import-type TalkParticipant from ResponseDefinitions
* @psalm-import-type TalkRoom from ResponseDefinitions
*/
class RoomController extends AEnvironmentAwareController {
class RoomController extends AEnvironmentAwareOCSController {
protected array $commonReadMessages = [];

public function __construct(
Expand Down Expand Up @@ -1771,7 +1771,7 @@ public function joinRoom(string $token, string $password = '', bool $force = tru
}

/**
* Join room on the host server using the session id of the federated user.
* Join room on the host server using the session id of the federated user
*
* The session id can be null only for requests from Talk < 20.
*
Expand Down Expand Up @@ -2058,7 +2058,7 @@ public function leaveRoom(string $token): DataResponse {
}

/**
* Leave room on the host server using the session id of the federated user.
* Leave room on the host server using the session id of the federated user
*
* @param string $token Token of the room
* @param string $sessionId Federated session id to leave with
Expand Down
32 changes: 16 additions & 16 deletions lib/Middleware/InjectionMiddleware.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

namespace OCA\Talk\Middleware;

use OCA\Talk\Controller\AEnvironmentAwareController;
use OCA\Talk\Controller\AEnvironmentAwareOCSController;
use OCA\Talk\Exceptions\CannotReachRemoteException;
use OCA\Talk\Exceptions\ForbiddenException;
use OCA\Talk\Exceptions\ParticipantNotFoundException;
Expand Down Expand Up @@ -86,7 +86,7 @@ public function __construct(
* @throws RoomNotFoundException
*/
public function beforeController(Controller $controller, string $methodName): void {
if (!$controller instanceof AEnvironmentAwareController) {
if (!$controller instanceof AEnvironmentAwareOCSController) {
return;
}

Expand Down Expand Up @@ -173,10 +173,10 @@ protected function readSessionIdParameterFromAttributes(array $attributes): ?str
}

/**
* @param AEnvironmentAwareController $controller
* @param AEnvironmentAwareOCSController $controller
* @throws ForbiddenException
*/
protected function getRoom(AEnvironmentAwareController $controller): void {
protected function getRoom(AEnvironmentAwareOCSController $controller): void {
$token = $this->request->getParam('token');
$room = $this->manager->getRoomByToken($token);
$controller->setRoom($room);
Expand All @@ -185,11 +185,11 @@ protected function getRoom(AEnvironmentAwareController $controller): void {
}

/**
* @param AEnvironmentAwareController $controller
* @param AEnvironmentAwareOCSController $controller
* @param bool $moderatorRequired
* @throws NotAModeratorException
*/
protected function getLoggedIn(AEnvironmentAwareController $controller, bool $moderatorRequired): void {
protected function getLoggedIn(AEnvironmentAwareOCSController $controller, bool $moderatorRequired): void {
$token = $this->request->getParam('token');
$sessionId = $this->talkSession->getSessionForRoom($token);
$room = $this->manager->getRoomForUserByToken($token, $this->userId, $sessionId);
Expand All @@ -206,14 +206,14 @@ protected function getLoggedIn(AEnvironmentAwareController $controller, bool $mo
}

/**
* @param AEnvironmentAwareController $controller
* @param AEnvironmentAwareOCSController $controller
* @param bool $moderatorRequired
* @param bool $requireListedWhenNoParticipant
* @throws NotAModeratorException
* @throws ParticipantNotFoundException
*/
protected function getLoggedInOrGuest(
AEnvironmentAwareController $controller,
AEnvironmentAwareOCSController $controller,
bool $moderatorRequired,
bool $requireListedWhenNoParticipant = false,
bool $requireFederationWhenNotLoggedIn = false,
Expand Down Expand Up @@ -281,11 +281,11 @@ protected function getLoggedInOrGuest(
}

/**
* @param AEnvironmentAwareController $controller
* @param AEnvironmentAwareOCSController $controller
* @throws RoomNotFoundException
* @throws ParticipantNotFoundException
*/
protected function getRoomByInvite(AEnvironmentAwareController $controller): void {
protected function getRoomByInvite(AEnvironmentAwareOCSController $controller): void {
if ($this->userId === null) {
throw new ParticipantNotFoundException('No user available');
}
Expand All @@ -309,21 +309,21 @@ protected function getRoomByInvite(AEnvironmentAwareController $controller): voi
}

/**
* @param AEnvironmentAwareController $controller
* @param AEnvironmentAwareOCSController $controller
* @throws FederationUnsupportedFeatureException
*/
protected function checkFederationSupport(AEnvironmentAwareController $controller): void {
protected function checkFederationSupport(AEnvironmentAwareOCSController $controller): void {
$room = $controller->getRoom();
if ($room instanceof Room && $room->isFederatedConversation()) {
throw new FederationUnsupportedFeatureException();
}
}

/**
* @param AEnvironmentAwareController $controller
* @param AEnvironmentAwareOCSController $controller
* @throws ReadOnlyException
*/
protected function checkReadOnlyState(AEnvironmentAwareController $controller): void {
protected function checkReadOnlyState(AEnvironmentAwareOCSController $controller): void {
$room = $controller->getRoom();
if (!$room instanceof Room || $room->getReadOnly() === Room::READ_ONLY) {
throw new ReadOnlyException();
Expand All @@ -336,7 +336,7 @@ protected function checkReadOnlyState(AEnvironmentAwareController $controller):
/**
* @throws PermissionsException
*/
protected function checkPermission(AEnvironmentAwareController $controller, string $permission): void {
protected function checkPermission(AEnvironmentAwareOCSController $controller, string $permission): void {
$participant = $controller->getParticipant();
if (!$participant instanceof Participant) {
throw new PermissionsException();
Expand All @@ -353,7 +353,7 @@ protected function checkPermission(AEnvironmentAwareController $controller, stri
/**
* @throws LobbyException
*/
protected function checkLobbyState(AEnvironmentAwareController $controller): void {
protected function checkLobbyState(AEnvironmentAwareOCSController $controller): void {
try {
$this->getLoggedInOrGuest($controller, true);
return;
Expand Down
4 changes: 2 additions & 2 deletions openapi-federation.json
Original file line number Diff line number Diff line change
Expand Up @@ -1641,7 +1641,7 @@
"/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/federation/active": {
"post": {
"operationId": "room-join-federated-room",
"summary": "Join room on the host server using the session id of the federated user.",
"summary": "Join room on the host server using the session id of the federated user",
"description": "The session id can be null only for requests from Talk < 20.",
"tags": [
"room"
Expand Down Expand Up @@ -1778,7 +1778,7 @@
},
"delete": {
"operationId": "room-leave-federated-room",
"summary": "Leave room on the host server using the session id of the federated user.",
"summary": "Leave room on the host server using the session id of the federated user",
"tags": [
"room"
],
Expand Down
10 changes: 5 additions & 5 deletions openapi-full.json
Original file line number Diff line number Diff line change
Expand Up @@ -4650,7 +4650,7 @@
"/ocs/v2.php/apps/spreed/api/{apiVersion}/call/{token}/federation": {
"post": {
"operationId": "call-join-federated-call",
"summary": "Join call on the host server using the session id of the federated user.",
"summary": "Join call on the host server using the session id of the federated user",
"tags": [
"call"
],
Expand Down Expand Up @@ -4836,7 +4836,7 @@
},
"put": {
"operationId": "call-update-federated-call-flags",
"summary": "Update the in-call flags on the host server using the session id of the federated user.",
"summary": "Update the in-call flags on the host server using the session id of the federated user",
"tags": [
"call"
],
Expand Down Expand Up @@ -5004,7 +5004,7 @@
},
"delete": {
"operationId": "call-leave-federated-call",
"summary": "Leave a call on the host server using the session id of the federated user.",
"summary": "Leave a call on the host server using the session id of the federated user",
"tags": [
"call"
],
Expand Down Expand Up @@ -19021,7 +19021,7 @@
"/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/federation/active": {
"post": {
"operationId": "room-join-federated-room",
"summary": "Join room on the host server using the session id of the federated user.",
"summary": "Join room on the host server using the session id of the federated user",
"description": "The session id can be null only for requests from Talk < 20.",
"tags": [
"room"
Expand Down Expand Up @@ -19158,7 +19158,7 @@
},
"delete": {
"operationId": "room-leave-federated-room",
"summary": "Leave room on the host server using the session id of the federated user.",
"summary": "Leave room on the host server using the session id of the federated user",
"tags": [
"room"
],
Expand Down
6 changes: 3 additions & 3 deletions openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -4537,7 +4537,7 @@
"/ocs/v2.php/apps/spreed/api/{apiVersion}/call/{token}/federation": {
"post": {
"operationId": "call-join-federated-call",
"summary": "Join call on the host server using the session id of the federated user.",
"summary": "Join call on the host server using the session id of the federated user",
"tags": [
"call"
],
Expand Down Expand Up @@ -4723,7 +4723,7 @@
},
"put": {
"operationId": "call-update-federated-call-flags",
"summary": "Update the in-call flags on the host server using the session id of the federated user.",
"summary": "Update the in-call flags on the host server using the session id of the federated user",
"tags": [
"call"
],
Expand Down Expand Up @@ -4891,7 +4891,7 @@
},
"delete": {
"operationId": "call-leave-federated-call",
"summary": "Leave a call on the host server using the session id of the federated user.",
"summary": "Leave a call on the host server using the session id of the federated user",
"tags": [
"call"
],
Expand Down
4 changes: 2 additions & 2 deletions src/types/openapi/openapi-federation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -126,11 +126,11 @@ export type paths = {
get?: never;
put?: never;
/**
* Join room on the host server using the session id of the federated user.
* Join room on the host server using the session id of the federated user
* @description The session id can be null only for requests from Talk < 20.
*/
post: operations["room-join-federated-room"];
/** Leave room on the host server using the session id of the federated user. */
/** Leave room on the host server using the session id of the federated user */
delete: operations["room-leave-federated-room"];
options?: never;
head?: never;
Expand Down
Loading

0 comments on commit 68b2250

Please sign in to comment.