Feat | Add OpenAPI documentation for OAuth2GroupApiController

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

@@ -1,4 +1,5 @@
-<?php namespace App\Http\Controllers\Api\OAuth2;
+<?php
+namespace App\Http\Controllers\Api\OAuth2;
 /**
  * Copyright 2025 OpenStack Foundation
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -14,8 +15,11 @@
 
 use App\Http\Controllers\GetAllTrait;
 use App\libs\Auth\Repositories\IGroupRepository;
+use App\libs\OAuth2\IGroupScopes;
 use App\ModelSerializers\SerializerRegistry;
 use OAuth2\IResourceServerContext;
+use OpenApi\Attributes as OA;
+use Symfony\Component\HttpFoundation\Response;
 use Utils\Services\ILogService;
 
 /**
@@ -27,7 +31,7 @@ final class OAuth2GroupApiController extends OAuth2ProtectedController
     use GetAllTrait;
 
     /**
-     * OAuth2UserApiController constructor.
+     * OAuth2GroupApiController constructor.
      * @param IGroupRepository $repository
      * @param IResourceServerContext $resource_server_context
      * @param ILogService $log_service
@@ -37,12 +41,61 @@ public function __construct
         IGroupRepository $repository,
         IResourceServerContext $resource_server_context,
         ILogService $log_service,
-    )
-    {
+    ) {
         parent::__construct($resource_server_context, $log_service);
         $this->repository = $repository;
     }
 
+    #[OA\Get(
+        path: '/api/v1/groups',
+        operationId: 'getGroups',
+        summary: 'Get all groups',
+        description: 'Retrieves a paginated list of groups with optional filtering and ordering. No route-level middleware enforcement; requires valid OAuth2 bearer token only.',
+        security: [['OAuth2GroupsSecurity' => [IGroupScopes::ReadAll]]],
+        tags: ['Groups'],
+        parameters: [
+            new OA\Parameter(
+                name: 'page',
+                in: 'query',
+                description: 'Page number for pagination',
+                required: false,
+                schema: new OA\Schema(type: 'integer', minimum: 1, default: 1, example: 1)
+            ),
+            new OA\Parameter(
+                name: 'per_page',
+                in: 'query',
+                description: 'Number of items per page',
+                required: false,
+                schema: new OA\Schema(type: 'integer', minimum: 5, maximum: 100, default: 5, example: 10)
+            ),
+            new OA\Parameter(
+                name: 'filter',
+                in: 'query',
+                description: 'Filter criteria. Supported filters: slug== (exact match). Example: filter=slug==administrators',
+                required: false,
+                schema: new OA\Schema(type: 'string', example: 'slug==administrators')
+            ),
+            new OA\Parameter(
+                name: 'order',
+                in: 'query',
+                description: 'Ordering criteria. Supported fields: id, name, slug. Use + for ascending, - for descending. Example: +name or -id',
+                required: false,
+                schema: new OA\Schema(type: 'string', example: '+name')
+            )
+        ],
+        responses: [
+            new OA\Response(
+                response: Response::HTTP_OK,
+                description: 'Successful response with paginated groups',
+                content: new OA\JsonContent(ref: '#/components/schemas/PaginatedGroupResponse')
+            ),
+            new OA\Response(response: Response::HTTP_UNAUTHORIZED, description: 'Unauthorized'),
+            new OA\Response(response: Response::HTTP_FORBIDDEN, description: 'Forbidden - insufficient scope'),
+            new OA\Response(response: Response::HTTP_NOT_FOUND, description: 'Not Found'),
+            new OA\Response(response: Response::HTTP_PRECONDITION_FAILED, description: 'Validation failed, invalid filter or order parameter'),
+            new OA\Response(response: Response::HTTP_INTERNAL_SERVER_ERROR, description: 'Server error')
+        ]
+    )]
     protected function getAllSerializerType(): string
     {
         return SerializerRegistry::SerializerType_Public;

app/Swagger/Models/GroupSchema.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace App\Swagger\schemas;
+
+use OpenApi\Attributes as OA;
+
+#[OA\Schema(
+    schema: 'Group',
+    type: 'object',
+    description: 'Group API response - serialized representation of a group',
+    allOf: [
+        new OA\Schema(ref: '#/components/schemas/Base'),
+        new OA\Schema(
+            type: 'object',
+            properties: [
+                new OA\Property(property: 'name', type: 'string', description: 'Group name', example: 'Administrators'),
+                new OA\Property(property: 'slug', type: 'string', description: 'Group slug for URL-friendly identification', example: 'administrators'),
+                new OA\Property(property: 'active', type: 'boolean', description: 'Whether the group is active', example: true),
+                new OA\Property(property: 'default', type: 'boolean', description: 'Whether this is a default group', example: false),
+            ]
+        )
+    ]
+)]
+class GroupSchema {}

app/Swagger/OAuth2GroupApiControllerSchemas.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace App\Swagger\schemas;
+
+use OpenApi\Attributes as OA;
+
+#[OA\Schema(
+    schema: 'PaginatedGroupResponse',
+    type: 'object',
+    description: 'Paginated list of groups',
+    allOf: [
+        new OA\Schema(ref: '#/components/schemas/PaginateDataSchemaResponse'),
+        new OA\Schema(
+            type: 'object',
+            properties: [
+                new OA\Property(
+                    property: 'data',
+                    type: 'array',
+                    description: 'Array of group objects',
+                    items: new OA\Items(ref: '#/components/schemas/Group')
+                )
+            ]
+        )
+    ]
+)]
+class PaginatedGroupResponseSchema {}

app/Swagger/Security/OAuth2GroupApiControllerSecuritySchema.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace App\Swagger\schemas;
+
+use App\libs\OAuth2\IGroupScopes;
+use OpenApi\Attributes as OA;
+
+#[OA\SecurityScheme(
+    securityScheme: 'OAuth2GroupsSecurity',
+    type: 'oauth2',
+    description: 'OAuth2 authentication for Group endpoints',
+    flows: [
+        new OA\Flow(
+            flow: 'authorizationCode',
+            authorizationUrl: L5_SWAGGER_CONST_AUTH_URL,
+            tokenUrl: L5_SWAGGER_CONST_TOKEN_URL,
+            scopes: [
+                IGroupScopes::ReadAll => 'Read all groups',
+                IGroupScopes::Write => 'Write group',
+            ]
+        ),
+    ]
+)]
+class OAuth2GroupApiControllerSecuritySchema
+{
+}