Skip to content

Feature | Add openapi documentation for SummitAdministratorPermissionGroup #403

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
smarcet merged 2 commits into from
Nov 13, 2025
+385 −17
Merged

Feature | Add openapi documentation for SummitAdministratorPermissionGroup #403

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f02d109
feat: Add openapi documentation for SummitAdministratorPermissionGroup
andrestejerina97 Nov 13, 2025
0029ae5
fix: change http verb
andrestejerina97 Nov 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
296 changes: 279 additions & 17 deletions ...Controllers/Apis/Protected/Main/OAuth2SummitAdministratorPermissionGroupApiController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,11 @@
**/

use App\Http\Exceptions\HTTP403ForbiddenException;
use App\Models\Foundation\Main\IGroup;
use App\Models\Foundation\Main\Repositories\ISummitAdministratorPermissionGroupRepository;
use App\ModelSerializers\ISummitAttendeeTicketSerializerTypes;
use App\Services\Model\ISummitAdministratorPermissionGroupService;
use App\Security\SummitScopes;
use Illuminate\Support\Facades\Log;
use models\exceptions\EntityNotFoundException;
use models\exceptions\ValidationException;
Expand All @@ -24,6 +26,8 @@
use models\utils\IEntity;
use Exception;
use ModelSerializers\SerializerRegistry;
use OpenApi\Attributes as OA;
use Symfony\Component\HttpFoundation\Response;
use utils\Filter;
use utils\FilterElement;

Expand Down Expand Up @@ -67,6 +71,50 @@ public function __construct

use GetEntity;

#[OA\Get(
path: "/api/v1/summit-administrator-groups",
description: "required-groups " . IGroup::SuperAdmins . ", " . IGroup::Administrators,
summary: "Get all summit administrator permission groups",
security: [['summit_admin_groups_oauth2' => [
SummitScopes::ReadSummitAdminGroups,
]]],
tags: ["SummitAdministratorPermissionGroups"],
x: [
'required-groups' => [
IGroup::SuperAdmins,
IGroup::Administrators,
]
],
parameters: [
new OA\Parameter(
name: "page",
description: "Page number",
in: "query",
required: false,
schema: new OA\Schema(type: "integer", default: 1)
),
new OA\Parameter(
name: "per_page",
description: "Items per page",
in: "query",
required: false,
schema: new OA\Schema(type: "integer", default: 10)
),
new OA\Parameter(name: "filter", description: "Filter", in: "query", required: false, schema: new OA\Schema(type: "string")),
new OA\Parameter(name: "order", description: "Order", in: "query", required: false, schema: new OA\Schema(type: "string")),
],
responses: [
new OA\Response(
response: Response::HTTP_OK,
description: "OK",
content: new OA\JsonContent(ref: "#/components/schemas/SummitAdministratorPermissionGroupList")
),
new OA\Response(response: Response::HTTP_BAD_REQUEST, description: "Bad Request"),
new OA\Response(response: Response::HTTP_UNAUTHORIZED, description: "Unauthorized"),
new OA\Response(response: Response::HTTP_FORBIDDEN, description: "Forbidden"),
new OA\Response(response: Response::HTTP_INTERNAL_SERVER_ERROR, description: "Server Error"),
]
)]
function getAll()
{
return $this->_getAll(
Expand Down Expand Up @@ -107,9 +155,32 @@ function () {
);
}

/**
* @inheritDoc
*/
#[OA\Post(
path: "/api/v1/summit-administrator-groups",
summary: "Create a new summit administrator permission group",
security: [['summit_admin_groups_oauth2' => [
SummitScopes::WriteSummitAdminGroups,
]]],
tags: ["SummitAdministratorPermissionGroups"],
requestBody: new OA\RequestBody(
required: true,
content: new OA\JsonContent(
ref: "#/components/schemas/CreateSummitAdministratorPermissionGroup"
)
),
responses: [
new OA\Response(
response: Response::HTTP_CREATED,
description: "Created",
content: new OA\JsonContent(ref: "#/components/schemas/SummitAdministratorPermissionGroup")
),
new OA\Response(response: Response::HTTP_BAD_REQUEST, description: "Bad Request"),
new OA\Response(response: Response::HTTP_UNAUTHORIZED, description: "Unauthorized"),
new OA\Response(response: Response::HTTP_FORBIDDEN, description: "Forbidden"),
new OA\Response(response: Response::HTTP_PRECONDITION_FAILED, description: "Validation Error"),
new OA\Response(response: Response::HTTP_INTERNAL_SERVER_ERROR, description: "Server Error"),
]
)]
function getAddValidationRules(array $payload): array
{
return [
Expand All @@ -127,25 +198,64 @@ protected function addEntity(array $payload): IEntity
return $this->service->create($payload);
}

/**
* @inheritDoc
*/
protected function deleteEntity(int $id): void
{
$this->service->delete($id);
}

/**
* @inheritDoc
*/
#[OA\Get(
path: "/api/v1/summit-administrator-groups/{id}",
summary: "Get a summit administrator permission group by ID",
security: [['summit_admin_groups_oauth2' => [
SummitScopes::ReadSummitAdminGroups,
]]],
tags: ["SummitAdministratorPermissionGroups"],
parameters: [
new OA\Parameter(name: "id", description: "Permission Group ID", in: "path", required: true, schema: new OA\Schema(type: "integer")),
],
responses: [
new OA\Response(
response: Response::HTTP_OK,
description: "OK",
content: new OA\JsonContent(ref: "#/components/schemas/SummitAdministratorPermissionGroup")
),
new OA\Response(response: Response::HTTP_BAD_REQUEST, description: "Bad Request"),
new OA\Response(response: Response::HTTP_UNAUTHORIZED, description: "Unauthorized"),
new OA\Response(response: Response::HTTP_FORBIDDEN, description: "Forbidden"),
new OA\Response(response: Response::HTTP_NOT_FOUND, description: "Not found"),
new OA\Response(response: Response::HTTP_INTERNAL_SERVER_ERROR, description: "Server Error"),
]
)]
protected function getEntity(int $id): IEntity
{
return $this->repository->getById($id);
}

/**
* @inheritDoc
*/
#[OA\Put(
path: "/api/v1/summit-administrator-groups/{id}",
summary: "Update a summit administrator permission group",
security: [['summit_admin_groups_oauth2' => [
SummitScopes::WriteSummitAdminGroups,
]]],
tags: ["SummitAdministratorPermissionGroups"],
parameters: [
new OA\Parameter(name: "id", description: "Permission Group ID", in: "path", required: true, schema: new OA\Schema(type: "integer")),
],
requestBody: new OA\RequestBody(
required: true,
content: new OA\JsonContent(
ref: "#/components/schemas/UpdateSummitAdministratorPermissionGroup"
)
),
responses: [
new OA\Response(
response: Response::HTTP_OK,
description: "OK",
content: new OA\JsonContent(ref: "#/components/schemas/SummitAdministratorPermissionGroup")
),
new OA\Response(response: Response::HTTP_BAD_REQUEST, description: "Bad Request"),
new OA\Response(response: Response::HTTP_UNAUTHORIZED, description: "Unauthorized"),
new OA\Response(response: Response::HTTP_FORBIDDEN, description: "Forbidden"),
new OA\Response(response: Response::HTTP_NOT_FOUND, description: "Not found"),
new OA\Response(response: Response::HTTP_PRECONDITION_FAILED, description: "Validation Error"),
new OA\Response(response: Response::HTTP_INTERNAL_SERVER_ERROR, description: "Server Error"),
]
)]
function getUpdateValidationRules(array $payload): array
{
return [
Expand All @@ -163,6 +273,62 @@ protected function updateEntity($id, array $payload): IEntity
return $this->service->update($id, $payload);
}

#[OA\Delete(
path: "/api/v1/summit-administrator-groups/{id}",
summary: "Delete a summit administrator permission group",
security: [['summit_admin_groups_oauth2' => [
SummitScopes::WriteSummitAdminGroups,
]]],
tags: ["SummitAdministratorPermissionGroups"],
parameters: [
new OA\Parameter(name: "id", description: "Permission Group ID", in: "path", required: true, schema: new OA\Schema(type: "integer")),
],
responses: [
new OA\Response(response: Response::HTTP_NO_CONTENT, description: "No Content"),
new OA\Response(response: Response::HTTP_BAD_REQUEST, description: "Bad Request"),
new OA\Response(response: Response::HTTP_UNAUTHORIZED, description: "Unauthorized"),
new OA\Response(response: Response::HTTP_FORBIDDEN, description: "Forbidden"),
new OA\Response(response: Response::HTTP_NOT_FOUND, description: "Not found"),
new OA\Response(response: Response::HTTP_INTERNAL_SERVER_ERROR, description: "Server Error"),
]
)]
protected function deleteEntity(int $id): void
{
$this->service->delete($id);
}

#[OA\Put(
path: "/api/v1/summit-administrator-groups/{id}/members/{member_id}",
description: "required-groups " . IGroup::SuperAdmins . ", " . IGroup::Administrators,
summary: "Add member to permission group",
security: [['summit_admin_groups_oauth2' => [
SummitScopes::WriteSummitAdminGroups,
]]],
tags: ["SummitAdministratorPermissionGroups"],
x: [
'required-groups' => [
IGroup::SuperAdmins,
IGroup::Administrators,
]
],
parameters: [
new OA\Parameter(name: "id", description: "Permission Group ID", in: "path", required: true, schema: new OA\Schema(type: "integer")),
new OA\Parameter(name: "member_id", description: "Member ID", in: "path", required: true, schema: new OA\Schema(type: "integer")),
],
responses: [
new OA\Response(
response: Response::HTTP_OK,
description: "OK",
content: new OA\JsonContent(ref: "#/components/schemas/SummitAdministratorPermissionGroup")
),
new OA\Response(response: Response::HTTP_BAD_REQUEST, description: "Bad Request"),
new OA\Response(response: Response::HTTP_UNAUTHORIZED, description: "Unauthorized"),
new OA\Response(response: Response::HTTP_FORBIDDEN, description: "Forbidden"),
new OA\Response(response: Response::HTTP_NOT_FOUND, description: "Not found"),
new OA\Response(response: Response::HTTP_PRECONDITION_FAILED, description: "Validation Error"),
new OA\Response(response: Response::HTTP_INTERNAL_SERVER_ERROR, description: "Server Error"),
]
)]
public function addMember($id, $member_id)
{
try {
Expand All @@ -189,6 +355,38 @@ public function addMember($id, $member_id)
}
}

#[OA\Delete(
path: "/api/v1/summit-administrator-groups/{id}/members/{member_id}",
description: "required-groups " . IGroup::SuperAdmins . ", " . IGroup::Administrators,
summary: "Remove member from permission group",
security: [['summit_admin_groups_oauth2' => [
SummitScopes::WriteSummitAdminGroups,
]]],
tags: ["SummitAdministratorPermissionGroups"],
x: [
'required-groups' => [
IGroup::SuperAdmins,
IGroup::Administrators,
]
],
parameters: [
new OA\Parameter(name: "id", description: "Permission Group ID", in: "path", required: true, schema: new OA\Schema(type: "integer")),
new OA\Parameter(name: "member_id", description: "Member ID", in: "path", required: true, schema: new OA\Schema(type: "integer")),
],
responses: [
new OA\Response(
response: Response::HTTP_OK,
description: "OK",
content: new OA\JsonContent(ref: "#/components/schemas/SummitAdministratorPermissionGroup")
),
new OA\Response(response: Response::HTTP_BAD_REQUEST, description: "Bad Request"),
new OA\Response(response: Response::HTTP_UNAUTHORIZED, description: "Unauthorized"),
new OA\Response(response: Response::HTTP_FORBIDDEN, description: "Forbidden"),
new OA\Response(response: Response::HTTP_NOT_FOUND, description: "Not found"),
new OA\Response(response: Response::HTTP_PRECONDITION_FAILED, description: "Validation Error"),
new OA\Response(response: Response::HTTP_INTERNAL_SERVER_ERROR, description: "Server Error"),
]
)]
public function removeMember($id, $member_id)
{
try {
Expand All @@ -215,6 +413,38 @@ public function removeMember($id, $member_id)
}
}

#[OA\Put(
path: "/api/v1/summit-administrator-groups/{id}/summits/{summit_id}",
description: "required-groups " . IGroup::SuperAdmins . ", " . IGroup::Administrators,
summary: "Add summit to permission group",
security: [['summit_admin_groups_oauth2' => [
SummitScopes::WriteSummitAdminGroups,
]]],
tags: ["SummitAdministratorPermissionGroups"],
x: [
'required-groups' => [
IGroup::SuperAdmins,
IGroup::Administrators,
]
],
parameters: [
new OA\Parameter(name: "id", description: "Permission Group ID", in: "path", required: true, schema: new OA\Schema(type: "integer")),
new OA\Parameter(name: "summit_id", description: "Summit ID", in: "path", required: true, schema: new OA\Schema(type: "integer")),
],
responses: [
new OA\Response(
response: Response::HTTP_OK,
description: "OK",
content: new OA\JsonContent(ref: "#/components/schemas/SummitAdministratorPermissionGroup")
),
new OA\Response(response: Response::HTTP_BAD_REQUEST, description: "Bad Request"),
new OA\Response(response: Response::HTTP_UNAUTHORIZED, description: "Unauthorized"),
new OA\Response(response: Response::HTTP_FORBIDDEN, description: "Forbidden"),
new OA\Response(response: Response::HTTP_NOT_FOUND, description: "Not found"),
new OA\Response(response: Response::HTTP_PRECONDITION_FAILED, description: "Validation Error"),
new OA\Response(response: Response::HTTP_INTERNAL_SERVER_ERROR, description: "Server Error"),
]
)]
public function addSummit($id, $summit_id)
{
try {
Expand All @@ -241,6 +471,38 @@ public function addSummit($id, $summit_id)
}
}

#[OA\Delete(
path: "/api/v1/summit-administrator-groups/{id}/summits/{summit_id}",
description: "required-groups " . IGroup::SuperAdmins . ", " . IGroup::Administrators,
summary: "Remove summit from permission group",
security: [['summit_admin_groups_oauth2' => [
SummitScopes::WriteSummitAdminGroups,
]]],
tags: ["SummitAdministratorPermissionGroups"],
x: [
'required-groups' => [
IGroup::SuperAdmins,
IGroup::Administrators,
]
],
parameters: [
new OA\Parameter(name: "id", description: "Permission Group ID", in: "path", required: true, schema: new OA\Schema(type: "integer")),
new OA\Parameter(name: "summit_id", description: "Summit ID", in: "path", required: true, schema: new OA\Schema(type: "integer")),
],
responses: [
new OA\Response(
response: Response::HTTP_OK,
description: "OK",
content: new OA\JsonContent(ref: "#/components/schemas/SummitAdministratorPermissionGroup")
),
new OA\Response(response: Response::HTTP_BAD_REQUEST, description: "Bad Request"),
new OA\Response(response: Response::HTTP_UNAUTHORIZED, description: "Unauthorized"),
new OA\Response(response: Response::HTTP_FORBIDDEN, description: "Forbidden"),
new OA\Response(response: Response::HTTP_NOT_FOUND, description: "Not found"),
new OA\Response(response: Response::HTTP_PRECONDITION_FAILED, description: "Validation Error"),
new OA\Response(response: Response::HTTP_INTERNAL_SERVER_ERROR, description: "Server Error"),
]
)]
public function removeSummit($id, $summit_id)
{
try {
Expand Down
24 changes: 24 additions & 0 deletions app/Swagger/Security/SummitAdminGroupsOauth2.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<?php
namespace App\Swagger\schemas;
use App\Security\SummitScopes;

use OpenApi\Attributes as OA;

#[
OA\SecurityScheme(
type: 'oauth2',
securityScheme: 'summit_admin_groups_oauth2',
flows: [
new OA\Flow(
authorizationUrl: L5_SWAGGER_CONST_AUTH_URL,
tokenUrl: L5_SWAGGER_CONST_TOKEN_URL,
flow: 'authorizationCode',
scopes: [
SummitScopes::ReadSummitAdminGroups => 'Read Summit Administrator Groups',
SummitScopes::WriteSummitAdminGroups => 'Write Summit Administrator Groups',
],
),
],
)
]
class SummitAdminGroupsAuthSchema{}
Loading