Skip to content

Commit 270bcec

Browse files
committed
feat: Add changes requested in PR
1 parent 770d7d2 commit 270bcec

4 files changed

Lines changed: 116 additions & 61 deletions

File tree

.env.example

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -265,3 +265,17 @@ PAYMENTS_SERVICE_BASE_URL=
265265
PAYMENTS_SERVICE_OAUTH2_CLIENT_ID=
266266
PAYMENTS_SERVICE_OAUTH2_CLIENT_SECRET=
267267
PAYMENTS_SERVICE_OAUTH2_SCOPES=payment-profile/read
268+
269+
270+
# L5_FORMAT_TO_USE_FOR_DOCS=yaml
271+
# L5_SWAGGER_GENERATE_ALWAYS=true # Dev setting
272+
# L5_SWAGGER_GENERATE_YAML_COPY=true
273+
# L5_SWAGGER_UI_DARK_MODE=true
274+
275+
# Apply a sort to the operation list of each API. It can be 'alpha' (sort by paths alphanumerically), 'method' (sort by HTTP method). Default is the order returned by the server unchanged.
276+
# L5_SWAGGER_OPERATIONS_SORT=
277+
# Controls the default expansion setting for the operations and tags. It can be: 'list' (expands only the tags), 'full' (expands the tags and operations), 'none' (expands nothing -default-).
278+
# L5_SWAGGER_UI_DOC_EXPANSION=none
279+
# L5_SWAGGER_UI_FILTERS=false # Show/Hide filters. default true
280+
# L5_SWAGGER_UI_PERSIST_AUTHORIZATION=false # If set to true, it persists authorization data, and it would not be lost on browser close/refresh
281+
L5_SWAGGER_OPEN_API_SPEC_VERSION=3.1.0

app/Http/Controllers/Apis/Protected/Summit/OAuth2SummitSubmissionInvitationApiController.php

Lines changed: 72 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -109,10 +109,14 @@ public function __construct
109109
IGroup::SummitRegistrationAdmins
110110
]
111111
],
112-
security: [['summit_submission_invitations_oauth2' => [
113-
SummitScopes::WriteSummitData,
114-
SummitScopes::WriteSubmissionInvitations,
115-
]]],
112+
security: [
113+
[
114+
'summit_submission_invitations_oauth2' => [
115+
SummitScopes::WriteSummitData,
116+
SummitScopes::WriteSubmissionInvitations,
117+
]
118+
]
119+
],
116120
parameters: [
117121
new OA\Parameter(
118122
name: 'id',
@@ -198,10 +202,14 @@ protected function getChildFromSummit(Summit $summit, $child_id): ?IEntity
198202
IGroup::SummitRegistrationAdmins
199203
]
200204
],
201-
security: [['summit_submission_invitations_oauth2' => [
202-
SummitScopes::ReadAllSummitData,
203-
SummitScopes::ReadSubmissionInvitations,
204-
]]],
205+
security: [
206+
[
207+
'summit_submission_invitations_oauth2' => [
208+
SummitScopes::ReadAllSummitData,
209+
SummitScopes::ReadSubmissionInvitations,
210+
]
211+
]
212+
],
205213
parameters: [
206214
new OA\Parameter(
207215
name: 'id',
@@ -330,10 +338,14 @@ function () {
330338
IGroup::SummitRegistrationAdmins
331339
]
332340
],
333-
security: [['summit_submission_invitations_oauth2' => [
334-
SummitScopes::ReadAllSummitData,
335-
SummitScopes::ReadSubmissionInvitations,
336-
]]],
341+
security: [
342+
[
343+
'summit_submission_invitations_oauth2' => [
344+
SummitScopes::ReadAllSummitData,
345+
SummitScopes::ReadSubmissionInvitations,
346+
]
347+
]
348+
],
337349
parameters: [
338350
new OA\Parameter(
339351
name: 'id',
@@ -516,10 +528,14 @@ protected function updateChild(Summit $summit, int $child_id, array $payload): I
516528
IGroup::SummitRegistrationAdmins
517529
]
518530
],
519-
security: [['summit_submission_invitations_oauth2' => [
520-
SummitScopes::ReadAllSummitData,
521-
SummitScopes::ReadSubmissionInvitations,
522-
]]],
531+
security: [
532+
[
533+
'summit_submission_invitations_oauth2' => [
534+
SummitScopes::ReadAllSummitData,
535+
SummitScopes::ReadSubmissionInvitations,
536+
]
537+
]
538+
],
523539
parameters: [
524540
new OA\Parameter(
525541
name: 'id',
@@ -581,10 +597,14 @@ public function get($summit_id, $invitation_id)
581597
IGroup::SummitRegistrationAdmins
582598
]
583599
],
584-
security: [['summit_submission_invitations_oauth2' => [
585-
SummitScopes::WriteSummitData,
586-
SummitScopes::WriteSubmissionInvitations,
587-
]]],
600+
security: [
601+
[
602+
'summit_submission_invitations_oauth2' => [
603+
SummitScopes::WriteSummitData,
604+
SummitScopes::WriteSubmissionInvitations,
605+
]
606+
]
607+
],
588608
parameters: [
589609
new OA\Parameter(
590610
name: 'id',
@@ -631,10 +651,14 @@ public function add($summit_id)
631651
IGroup::SummitRegistrationAdmins
632652
]
633653
],
634-
security: [['summit_submission_invitations_oauth2' => [
635-
SummitScopes::WriteSummitData,
636-
SummitScopes::WriteSubmissionInvitations,
637-
]]],
654+
security: [
655+
[
656+
'summit_submission_invitations_oauth2' => [
657+
SummitScopes::WriteSummitData,
658+
SummitScopes::WriteSubmissionInvitations,
659+
]
660+
]
661+
],
638662
parameters: [
639663
new OA\Parameter(
640664
name: 'id',
@@ -688,10 +712,14 @@ public function update($summit_id, $invitation_id)
688712
IGroup::SummitRegistrationAdmins
689713
]
690714
],
691-
security: [['summit_submission_invitations_oauth2' => [
692-
SummitScopes::WriteSummitData,
693-
SummitScopes::WriteSubmissionInvitations,
694-
]]],
715+
security: [
716+
[
717+
'summit_submission_invitations_oauth2' => [
718+
SummitScopes::WriteSummitData,
719+
SummitScopes::WriteSubmissionInvitations,
720+
]
721+
]
722+
],
695723
parameters: [
696724
new OA\Parameter(
697725
name: 'id',
@@ -735,10 +763,14 @@ public function delete($summit_id, $invitation_id)
735763
IGroup::SummitRegistrationAdmins
736764
]
737765
],
738-
security: [['summit_submission_invitations_oauth2' => [
739-
SummitScopes::WriteSummitData,
740-
SummitScopes::WriteSubmissionInvitations,
741-
]]],
766+
security: [
767+
[
768+
'summit_submission_invitations_oauth2' => [
769+
SummitScopes::WriteSummitData,
770+
SummitScopes::WriteSubmissionInvitations,
771+
]
772+
]
773+
],
742774
parameters: [
743775
new OA\Parameter(
744776
name: 'id',
@@ -785,10 +817,14 @@ public function deleteAll($summit_id)
785817
IGroup::SummitRegistrationAdmins
786818
]
787819
],
788-
security: [['summit_submission_invitations_oauth2' => [
789-
SummitScopes::WriteSummitData,
790-
SummitScopes::WriteSubmissionInvitations,
791-
]]],
820+
security: [
821+
[
822+
'summit_submission_invitations_oauth2' => [
823+
SummitScopes::WriteSummitData,
824+
SummitScopes::WriteSubmissionInvitations,
825+
]
826+
]
827+
],
792828
parameters: [
793829
new OA\Parameter(
794830
name: 'id',
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<?php
2+
3+
namespace App\Swagger\schemas;
4+
5+
use OpenApi\Attributes as OA;
6+
7+
#[OA\Schema(
8+
schema: 'SummitSubmissionInvitation',
9+
type: 'object',
10+
properties: [
11+
new OA\Property(property: 'id', type: 'integer', example: 1),
12+
new OA\Property(property: 'created', type: 'integer', description: 'Unix timestamp', example: 1640995200),
13+
new OA\Property(property: 'last_edited', type: 'integer', description: 'Unix timestamp', example: 1640995200),
14+
new OA\Property(property: 'email', type: 'string', format: 'email', example: 'speaker@example.com'),
15+
new OA\Property(property: 'first_name', type: 'string', example: 'John'),
16+
new OA\Property(property: 'last_name', type: 'string', example: 'Doe'),
17+
new OA\Property(property: 'summit_id', type: 'integer', example: 1, description: 'Summit ID'),
18+
new OA\Property(property: 'is_sent', type: 'boolean', example: false),
19+
new OA\Property(property: 'sent_date', type: 'integer', description: 'Unix timestamp', example: 1640995200, nullable: true),
20+
new OA\Property(
21+
property: 'tags',
22+
type: 'array',
23+
items: new OA\Items(type: ['integer', 'string']),
24+
example: [1, 2, 3],
25+
description: 'Array of Tag IDs or names (when expanded) associated with the invitation',
26+
)
27+
]
28+
)]
29+
class SummitSubmissionInvitationSchema {}

app/Swagger/SummitSpeakersSchemas.php

Lines changed: 1 addition & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -6,30 +6,6 @@
66
use App\Jobs\Emails\PresentationSubmissions\Invitations\ReInviteSubmissionEmail;
77
use OpenApi\Attributes as OA;
88

9-
#[OA\Schema(
10-
schema: 'SummitSubmissionInvitation',
11-
type: 'object',
12-
properties: [
13-
new OA\Property(property: 'id', type: 'integer', example: 1),
14-
new OA\Property(property: 'created', type: 'integer', description: 'Unix timestamp', example: 1640995200),
15-
new OA\Property(property: 'last_edited', type: 'integer', description: 'Unix timestamp', example: 1640995200),
16-
new OA\Property(property: 'email', type: 'string', format: 'email', example: 'speaker@example.com'),
17-
new OA\Property(property: 'first_name', type: 'string', example: 'John'),
18-
new OA\Property(property: 'last_name', type: 'string', example: 'Doe'),
19-
new OA\Property(property: 'summit_id', type: 'integer', example: 1, description: 'Summit ID'),
20-
new OA\Property(property: 'is_sent', type: 'boolean', example: false),
21-
new OA\Property(property: 'sent_date', type: 'integer', description: 'Unix timestamp', example: 1640995200, nullable: true),
22-
new OA\Property(
23-
property: 'tags',
24-
type: 'array',
25-
items: new OA\Items(type: ['integer', 'string']),
26-
example: [1, 2, 3],
27-
description: 'Array of Tag IDs or names (when expanded) associated with the invitation',
28-
)
29-
]
30-
)]
31-
class SummitSubmissionInvitationSchema {}
32-
339
#[OA\Schema(
3410
schema: 'PaginatedSummitSubmissionInvitationsResponse',
3511
allOf: [
@@ -200,4 +176,4 @@ class SpeakerOrganizationalRoleSchema
200176
)]
201177
class SpeakerOrganizationalRolesResponseSchema
202178
{
203-
}
179+
}

0 commit comments

Comments
 (0)