Skip to content

Feature | Add openapi documentation for OAuth2SummitSubmittersApiController #457

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
Dec 8, 2025
Merged

Feature | Add openapi documentation for OAuth2SummitSubmittersApiController #457

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
49a3bef
feat: Add openapi documentation for OAuth2SummitSubmittersApiController
andrestejerina97 Nov 13, 2025
ef215f7
chore: rename tag
matiasperrone Dec 8, 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
191 changes: 178 additions & 13 deletions app/Http/Controllers/Apis/Protected/Summit/OAuth2SummitSubmittersApiController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
**/

use App\ModelSerializers\IMemberSerializerTypes;
use App\Models\Foundation\Main\IGroup;
use App\Security\SummitScopes;
use Illuminate\Support\Facades\Request;
use models\main\IMemberRepository;
use models\oauth2\IResourceServerContext;
Expand All @@ -21,6 +23,8 @@
use utils\Filter;
use utils\FilterParser;
use utils\PagingInfo;
use OpenApi\Attributes as OA;
use Symfony\Component\HttpFoundation\Response;

/**
* Class OAuth2SummitSubmittersApiController
Expand Down Expand Up @@ -66,10 +70,72 @@ public function __construct
$this->service = $service;
}

/**
* @param $summit_id
* @return \Illuminate\Http\JsonResponse|mixed
*/
#[OA\Get(
path: "/api/v1/summits/{id}/submitters",
summary: "Get all submitters for a summit",
operationId: "getSubmittersBySummit",
tags: ["Summit Submitters"],
security: [['summit_submitters_oauth2' => [
SummitScopes::ReadSummitData,
SummitScopes::ReadAllSummitData,
]]],
parameters: [
new OA\Parameter(
name: "id",
in: "path",
required: true,
description: "Summit ID or slug",
schema: new OA\Schema(type: "string")
),
new OA\Parameter(
name: "page",
in: "query",
required: false,
description: "Page number",
schema: new OA\Schema(type: "integer", default: 1)
),
new OA\Parameter(
name: "per_page",
in: "query",
required: false,
description: "Items per page",
schema: new OA\Schema(type: "integer", default: 10)
),
new OA\Parameter(
name: "filter",
in: "query",
required: false,
description: "Filter query (supports multiple operators)",
schema: new OA\Schema(type: "string", example: "first_name=@John")
),
new OA\Parameter(
name: "order",
in: "query",
required: false,
description: "Order by field (prefix with - for descending)",
schema: new OA\Schema(type: "string", example: "first_name,-created")
),
new OA\Parameter(
name: "expand",
in: "query",
required: false,
description: "Expand relations (presentations, member)",
schema: new OA\Schema(type: "string", example: "presentations,member")
),
],
responses: [
new OA\Response(
response: Response::HTTP_OK,
description: "Successful response with paginated submitters",
content: new OA\JsonContent(ref: '#/components/schemas/PaginatedSubmittersResponse')
),
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: "Summit not found"),
new OA\Response(response: Response::HTTP_INTERNAL_SERVER_ERROR, description: "Server Error"),
]
)]
public function getAllBySummit($summit_id)
{
$summit = SummitFinderStrategyFactory::build($this->summit_repository, $this->getResourceServerContext())->find(intval($summit_id));
Expand Down Expand Up @@ -158,10 +224,62 @@ function ($page, $per_page, $filter, $order, $applyExtraFilters) use ($summit) {
);
}

/**
* @param $summit_id
* @return \Illuminate\Http\JsonResponse|mixed
*/
#[OA\Get(
path: "/api/v1/summits/{id}/submitters/csv",
description: "required-groups " . IGroup::SummitAdministrators . ", " . IGroup::SuperAdmins . ", " . IGroup::Administrators,
summary: "Get all submitters for a summit in CSV format",
operationId: "getSubmittersCSV",
tags: ["Summit Submitters"],
security: [['summit_submitters_oauth2' => [
SummitScopes::ReadSummitData,
SummitScopes::ReadAllSummitData,
]]],
x: [
'required-groups' => [
IGroup::SummitAdministrators,
IGroup::SuperAdmins,
IGroup::Administrators,
]
],
parameters: [
new OA\Parameter(
name: "id",
in: "path",
required: true,
description: "Summit ID or slug",
schema: new OA\Schema(type: "string")
),
new OA\Parameter(
name: "filter",
in: "query",
required: false,
description: "Filter query to select specific submitters",
schema: new OA\Schema(type: "string", example: "first_name=@John")
),
new OA\Parameter(
name: "order",
in: "query",
required: false,
description: "Order by field (prefix with - for descending)",
schema: new OA\Schema(type: "string", example: "first_name,-created")
),
],
responses: [
new OA\Response(
response: Response::HTTP_OK,
description: "CSV file with submitter data",
content: new OA\MediaType(
mediaType: "text/csv",
schema: new OA\Schema(type: "string", format: "binary")
)
),
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: "Summit not found"),
new OA\Response(response: Response::HTTP_INTERNAL_SERVER_ERROR, description: "Server Error"),
]
)]
public function getAllBySummitCSV($summit_id)
{
$summit = SummitFinderStrategyFactory::build($this->summit_repository, $this->getResourceServerContext())->find(intval($summit_id));
Expand Down Expand Up @@ -255,10 +373,57 @@ function ($page, $per_page, $filter, $order, $applyExtraFilters) use ($summit) {
);
}

/**
* @param $summit_id
* @return \Illuminate\Http\JsonResponse|mixed
*/
#[OA\Put(
path: "/api/v1/summits/{id}/submitters/all/send",
description: "required-groups " . IGroup::SummitAdministrators . ", " . IGroup::SuperAdmins . ", " . IGroup::Administrators . ", " . IGroup::SummitRegistrationAdmins,
summary: "Send bulk emails to submitters",
operationId: "sendSubmittersBulkEmails",
tags: ["Summit Submitters"],
security: [['summit_submitters_oauth2' => [
SummitScopes::WriteSummitData,
SummitScopes::WriteSpeakersData,
]]],
x: [
'required-groups' => [
IGroup::SummitAdministrators,
IGroup::SuperAdmins,
IGroup::Administrators,
IGroup::SummitRegistrationAdmins,
]
],
parameters: [
new OA\Parameter(
name: "id",
in: "path",
required: true,
description: "Summit ID or slug",
schema: new OA\Schema(type: "string")
),
new OA\Parameter(
name: "filter",
in: "query",
required: false,
description: "Filter query to select specific submitters",
schema: new OA\Schema(type: "string", example: "has_accepted_presentations==true")
),
],
requestBody: new OA\RequestBody(
required: true,
content: new OA\JsonContent(ref: "#/components/schemas/SendSubmittersEmailsRequest")
),
responses: [
new OA\Response(
response: Response::HTTP_OK,
description: "Emails sent successfully"
),
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: "Summit 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 send($summit_id)
{
return $this->processRequest(function () use ($summit_id) {
Expand Down Expand Up @@ -330,4 +495,4 @@ public function send($summit_id)
return $this->ok();
});
}
}
}
90 changes: 90 additions & 0 deletions app/Swagger/SubmitterSchemas.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
<?php

namespace App\Swagger\schemas;

use OpenApi\Attributes as OA;

#[OA\Schema(
schema: 'Submitter',
type: 'object',
description: 'Submitter extends Member with presentation data',
allOf: [
new OA\Schema(ref: '#/components/schemas/Member'),
new OA\Schema(
type: 'object',
properties: [
new OA\Property(
property: 'accepted_presentations',
type: 'array',
items: new OA\Items(type: 'integer'),
description: 'Array of accepted presentation IDs. Use expand=accepted_presentations to get full objects'
),
new OA\Property(
property: 'alternate_presentations',
type: 'array',
items: new OA\Items(type: 'integer'),
description: 'Array of alternate presentation IDs. Use expand=alternate_presentations to get full objects'
),
new OA\Property(
property: 'rejected_presentations',
type: 'array',
items: new OA\Items(type: 'integer'),
description: 'Array of rejected presentation IDs. Use expand=rejected_presentations to get full objects'
),
]
)
]
)]
class SubmitterSchemas {}

/**
* Paginated Submitters Response
*/
#[OA\Schema(
schema: 'PaginatedSubmittersResponse',
allOf: [
new OA\Schema(ref: '#/components/schemas/PaginateDataSchemaResponse'),
new OA\Schema(
type: 'object',
properties: [
new OA\Property(
property: 'data',
type: 'array',
description: 'List of submitters',
items: new OA\Items(ref: '#/components/schemas/Submitter')
)
]
)
]
)]
class PaginatedSubmittersResponseSchema {}

/**
* Send Emails to Submitters Request
*/
#[OA\Schema(
schema: 'SendSubmittersEmailsRequest',
type: 'object',
required: ['subject', 'body'],
properties: [
new OA\Property(
property: 'subject',
type: 'string',
example: 'Important Update for Submitters',
description: 'Email subject'
),
new OA\Property(
property: 'body',
type: 'string',
example: 'Dear Submitter, here is an important update...',
description: 'Email body content'
),
new OA\Property(
property: 'filter',
type: 'string',
example: 'has_accepted_presentations==true',
description: 'Optional filter to select specific submitters'
),
]
)]
class SendSubmittersEmailsRequestSchema {}
30 changes: 30 additions & 0 deletions app/Swagger/security/SummitSubmittersOAuthSchema.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<?php

namespace App\Swagger\schemas;

use App\Security\SummitScopes;
use OpenApi\Attributes as OA;



#[
OA\SecurityScheme(
type: 'oauth2',
securityScheme: 'summit_submitters_oauth2',
flows: [
new OA\Flow(
authorizationUrl: L5_SWAGGER_CONST_AUTH_URL,
tokenUrl: L5_SWAGGER_CONST_TOKEN_URL,
flow: 'authorizationCode',
scopes: [
SummitScopes::ReadSummitData => 'Read summit data',
SummitScopes::ReadAllSummitData => 'Read all summit data',
SummitScopes::WriteSummitData => 'Write summit data',
SummitScopes::WriteSpeakersData => 'Write speakers data',
],
),
],
)
]
class SummitSubmittersOAuthSchema {}