Feat | Add OpenAPI documentation for OAuth2RocketChatSSOApiController v1 (#112)

* feat: Add OpenAPI documentation for OAuth2RocketChatSSOApiController v1 api routes

* chore: Add PR requested changes

* chore: Add PR requested changes

Author: matiasperrone-exo

app/Http/Controllers/Api/OAuth2/OAuth2RocketChatSSOApiController.php

@@ -1,4 +1,5 @@
-<?php namespace App\Http\Controllers\Api\OAuth2;
+<?php
+namespace App\Http\Controllers\Api\OAuth2;
 /**
  * Copyright 2020 OpenStack Foundation
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -17,6 +18,9 @@
 use models\exceptions\ValidationException;
 use OAuth2\IResourceServerContext;
 use Utils\Services\ILogService;
+use App\libs\OAuth2\IUserScopes;
+use OpenApi\Attributes as OA;
+use Symfony\Component\HttpFoundation\Response as HttpResponse;
 /**
  * Class OAuth2RocketChatSSOApiController
  * @package App\Http\Controllers\Api\OAuth2
@@ -33,31 +37,68 @@ public function __construct
         IRocketChatSSOService $service,
         IResourceServerContext $resource_server_context,
         ILogService $log_service
-    )
-    {
+    ) {
         parent::__construct($resource_server_context, $log_service);
         $this->service = $service;
     }
 
+
+    #[OA\Get(
+        path: '/api/v1/sso/rocket-chat/{forum_slug}/profile',
+        operationId: 'getRocketChatUserProfile',
+        summary: 'Get Rocket Chat user profile for a forum.',
+        description: 'Returns Rocket Chat user profile data for the authenticated user in the context of the specified forum. The content of the response is defined by "data" portion of the Rocket Chat login endpoint response structure',
+        security: [['OAuth2RocketChatSSOSecurity' => [IUserScopes::SSO]]],
+        tags: ['Rocket Chat SSO'],
+        parameters: [
+            new OA\Parameter(
+                name: 'forum_slug',
+                description: 'Forum slug',
+                in: 'path',
+                required: true,
+                schema: new OA\Schema(type: 'string')
+            ),
+        ],
+        responses: [
+            new OA\Response(
+                response: HttpResponse::HTTP_OK,
+                description: 'OK, returns Rocket Chat user profile data on login success',
+                content: new OA\JsonContent(
+                    // The content of the response is defined by "data" portion of
+                    // the Rocket Chat login endpoint response structure
+                    ref: '#/components/schemas/RocketChatUserProfile',
+                )
+            ),
+            new OA\Response(
+                response: HttpResponse::HTTP_NOT_FOUND,
+                description: 'Not Found'
+            ),
+            new OA\Response(
+                response: HttpResponse::HTTP_PRECONDITION_FAILED,
+                description: 'Validation Error'
+            ),
+            new OA\Response(
+                response: HttpResponse::HTTP_INTERNAL_SERVER_ERROR,
+                description: 'Server Error'
+            ),
+        ]
+    )]
     /**
      * @param string $forum_slug
      * @return \Illuminate\Http\JsonResponse|mixed
      */
-    public function getUserProfile(string $forum_slug){
-        try{
+    public function getUserProfile(string $forum_slug)
+    {
+        try {
             $profile = $this->service->getUserProfile($forum_slug);
             return $this->ok($profile->serialize());
-        }
-        catch (ValidationException $ex) {
+        } catch (ValidationException $ex) {
             Log::warning($ex);
             return $this->error412([$ex->getMessage()]);
-        }
-        catch(EntityNotFoundException $ex)
-        {
+        } catch (EntityNotFoundException $ex) {
             Log::warning($ex);
-            return $this->error404(['message'=> $ex->getMessage()]);
-        }
-        catch (\Exception $ex) {
+            return $this->error404(['message' => $ex->getMessage()]);
+        } catch (\Exception $ex) {
             Log::error($ex);
             return $this->error500($ex);
         }

app/Swagger/Models/RocketChatUserProfileSchema.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace App\Swagger\schemas;
+
+use OpenApi\Attributes as OA;
+
+#[OA\Schema(
+    schema: 'RocketChatUserProfile',
+    type: 'object',
+    additionalProperties: true,
+    description: 'Rocket Chat SSO user profile. The response structure is the "data" portion of the Rocket Chat /api/v1/login endpoint response and is defined by the external Rocket Chat server.'
+)]
+class RocketChatUserProfileSchema
+{
+}

app/Swagger/Security/OAuth2RocketChatSSOApiControllerSecuritySchema.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace App\Swagger\schemas;
+
+use App\libs\OAuth2\IUserScopes;
+use OpenApi\Attributes as OA;
+
+#[OA\SecurityScheme(
+    securityScheme: 'OAuth2RocketChatSSOSecurity',
+    type: 'oauth2',
+    description: 'OAuth2 authentication for Rocket Chat SSO endpoints',
+    flows: [
+        new OA\Flow(
+            flow: 'authorizationCode',
+            authorizationUrl: L5_SWAGGER_CONST_AUTH_URL,
+            tokenUrl: L5_SWAGGER_CONST_TOKEN_URL,
+            scopes: [IUserScopes::SSO => 'Single Sign-On access']
+        ),
+    ]
+)]
+class OAuth2RocketChatSSOApiControllerSecuritySchema
+{
+}