diff --git a/apps/oauth2/lib/Controller/LoginRedirectorController.php b/apps/oauth2/lib/Controller/LoginRedirectorController.php index 57f18a97f85..7b83e39ca86 100644 --- a/apps/oauth2/lib/Controller/LoginRedirectorController.php +++ b/apps/oauth2/lib/Controller/LoginRedirectorController.php @@ -8,6 +8,7 @@ declare(strict_types=1); * @author Daniel Kesselberg * @author Lukas Reschke * @author Roeland Jago Douma + * @author Kate Döen * * @license GNU AGPL version 3 or any later version * @@ -30,8 +31,8 @@ namespace OCA\OAuth2\Controller; use OCA\OAuth2\Db\ClientMapper; use OCA\OAuth2\Exceptions\ClientNotFoundException; use OCP\AppFramework\Controller; +use OCP\AppFramework\Http; use OCP\AppFramework\Http\RedirectResponse; -use OCP\AppFramework\Http\Response; use OCP\AppFramework\Http\TemplateResponse; use OCP\IL10N; use OCP\IRequest; @@ -74,14 +75,19 @@ class LoginRedirectorController extends Controller { * @NoCSRFRequired * @UseSession * - * @param string $client_id - * @param string $state - * @param string $response_type - * @return Response + * Authorize the user + * + * @param string $client_id Client ID + * @param string $state State of the flow + * @param string $response_type Response type for the flow + * @return TemplateResponse|RedirectResponse + * + * 200: Client not found + * 303: Redirect to login URL */ public function authorize($client_id, $state, - $response_type): Response { + $response_type): TemplateResponse|RedirectResponse { try { $client = $this->clientMapper->getByIdentifier($client_id); } catch (ClientNotFoundException $e) { diff --git a/apps/oauth2/lib/Controller/OauthApiController.php b/apps/oauth2/lib/Controller/OauthApiController.php index e07a2c2de15..8cdd8132441 100644 --- a/apps/oauth2/lib/Controller/OauthApiController.php +++ b/apps/oauth2/lib/Controller/OauthApiController.php @@ -8,6 +8,7 @@ declare(strict_types=1); * @author Christoph Wurst * @author Lukas Reschke * @author Roeland Jago Douma + * @author Kate Döen * * @license GNU AGPL version 3 or any later version * @@ -66,12 +67,17 @@ class OauthApiController extends Controller { * @NoCSRFRequired * @BruteForceProtection(action=oauth2GetToken) * - * @param string $grant_type - * @param string $code - * @param string $refresh_token - * @param string $client_id - * @param string $client_secret - * @return JSONResponse + * Get a token + * + * @param string $grant_type Token type that should be granted + * @param string $code Code of the flow + * @param string $refresh_token Refresh token + * @param string $client_id Client ID + * @param string $client_secret Client secret + * @return JSONResponse|JSONResponse + * + * 200: Token returned + * 400: Getting token is not possible */ public function getToken($grant_type, $code, $refresh_token, $client_id, $client_secret): JSONResponse { diff --git a/apps/oauth2/openapi.json b/apps/oauth2/openapi.json index 57a7bee1a64..a9903ae3473 100644 --- a/apps/oauth2/openapi.json +++ b/apps/oauth2/openapi.json @@ -19,7 +19,7 @@ "scheme": "bearer" } }, - "schemas": [] + "schemas": {} }, "paths": { "/index.php/apps/oauth2/authorize": {