Skip to content

Commit d5aad68

Browse files
matiasperronematiasperrone
committed
chore: Add PR's requested changes
1 parent f3fca5d commit d5aad68

File tree

5 files changed

+146
-73
lines changed

5 files changed

+146
-73
lines changed

‎app/Http/Controllers/Apis/Protected/Summit/OAuth2SummitTrackChairsApiController.php‎

Lines changed: 94 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -75,13 +75,18 @@ public function __construct
7575

7676
#[OA\Get(
7777
path: "/api/v1/summits/{id}/track-chairs",
78+
operationId: "getAllTrackChairs",
7879
summary: "Get all track chairs for a summit",
7980
description: "Returns different data based on user role: Public view for regular users, Admin view for admins/track chairs",
80-
security: [['summit_track_chairs_oauth2' => [
81-
SummitScopes::ReadSummitData,
82-
SummitScopes::ReadAllSummitData,
83-
]]],
84-
tags: ["TrackChairs"],
81+
tags: ["Track Chairs"],
82+
security: [
83+
[
84+
'summit_track_chairs_oauth2' => [
85+
SummitScopes::ReadSummitData,
86+
SummitScopes::ReadAllSummitData,
87+
]
88+
]
89+
],
8590
x: [
8691
'required-groups' => [
8792
IGroup::SuperAdmins,
@@ -92,7 +97,7 @@ public function __construct
9297
]
9398
],
9499
parameters: [
95-
new OA\Parameter(name: "id", description: "Summit ID or slug", in: "path", required: true, schema: new OA\Schema(type: "string")),
100+
new OA\Parameter(name: "id", description: "Summit ID", in: "path", required: true, schema: new OA\Schema(type: "string")),
96101
new OA\Parameter(name: "page", description: "Page number", in: "query", required: false, schema: new OA\Schema(type: "integer", default: 1)),
97102
new OA\Parameter(name: "per_page", description: "Items per page", in: "query", required: false, schema: new OA\Schema(type: "integer", default: 10)),
98103
new OA\Parameter(name: "filter", description: "Filter query (member_first_name=@value, member_last_name=@value, member_email=@value, member_id==value, track_id==value)", in: "query", required: false, schema: new OA\Schema(type: "string")),
@@ -109,7 +114,7 @@ public function __construct
109114
new OA\Response(response: Response::HTTP_BAD_REQUEST, description: "Bad Request"),
110115
new OA\Response(response: Response::HTTP_UNAUTHORIZED, description: "Unauthorized"),
111116
new OA\Response(response: Response::HTTP_FORBIDDEN, description: "Forbidden"),
112-
new OA\Response(response: Response::HTTP_NOT_FOUND, description: "not found"),
117+
new OA\Response(response: Response::HTTP_NOT_FOUND, description: "Not Found"),
113118
new OA\Response(response: Response::HTTP_INTERNAL_SERVER_ERROR, description: "Server Error"),
114119
]
115120
)]
@@ -175,12 +180,17 @@ function () {
175180

176181
#[OA\Get(
177182
path: "/api/v1/summits/{id}/track-chairs/csv",
183+
operationId: "getAllTrackChairsCSV",
178184
summary: "Get all track chairs for a summit in CSV format",
179-
security: [['summit_track_chairs_oauth2' => [
180-
SummitScopes::ReadSummitData,
181-
SummitScopes::ReadAllSummitData,
182-
]]],
183-
tags: ["TrackChairs"],
185+
tags: ["Track Chairs"],
186+
security: [
187+
[
188+
'summit_track_chairs_oauth2' => [
189+
SummitScopes::ReadSummitData,
190+
SummitScopes::ReadAllSummitData,
191+
]
192+
]
193+
],
184194
x: [
185195
'required-groups' => [
186196
IGroup::SuperAdmins,
@@ -190,7 +200,7 @@ function () {
190200
]
191201
],
192202
parameters: [
193-
new OA\Parameter(name: "id", description: "Summit ID or slug", in: "path", required: true, schema: new OA\Schema(type: "string")),
203+
new OA\Parameter(name: "id", description: "Summit ID", in: "path", required: true, schema: new OA\Schema(type: "string")),
194204
new OA\Parameter(name: "filter", description: "Filter query", in: "query", required: false, schema: new OA\Schema(type: "string")),
195205
new OA\Parameter(name: "order", description: "Order by", in: "query", required: false, schema: new OA\Schema(type: "string")),
196206
new OA\Parameter(
@@ -214,7 +224,7 @@ function () {
214224
new OA\Response(response: Response::HTTP_BAD_REQUEST, description: "Bad Request"),
215225
new OA\Response(response: Response::HTTP_UNAUTHORIZED, description: "Unauthorized"),
216226
new OA\Response(response: Response::HTTP_FORBIDDEN, description: "Forbidden"),
217-
new OA\Response(response: Response::HTTP_NOT_FOUND, description: "not found"),
227+
new OA\Response(response: Response::HTTP_NOT_FOUND, description: "Not Found"),
218228
new OA\Response(response: Response::HTTP_INTERNAL_SERVER_ERROR, description: "Server Error"),
219229
]
220230
)]
@@ -377,11 +387,16 @@ protected function getChildFromSummit(Summit $summit, $child_id):?IEntity{
377387

378388
#[OA\Post(
379389
path: "/api/v1/summits/{id}/track-chairs",
390+
operationId: "addTrackChair",
380391
summary: "Add a track chair to a summit",
381-
security: [['summit_track_chairs_oauth2' => [
382-
SummitScopes::WriteSummitData,
383-
]]],
384-
tags: ["TrackChairs"],
392+
tags: ["Track Chairs"],
393+
security: [
394+
[
395+
'summit_track_chairs_oauth2' => [
396+
SummitScopes::WriteSummitData,
397+
]
398+
]
399+
],
385400
x: [
386401
'required-groups' => [
387402
IGroup::SuperAdmins,
@@ -391,7 +406,7 @@ protected function getChildFromSummit(Summit $summit, $child_id):?IEntity{
391406
]
392407
],
393408
parameters: [
394-
new OA\Parameter(name: "id", description: "Summit ID or slug", in: "path", required: true, schema: new OA\Schema(type: "string")),
409+
new OA\Parameter(name: "id", description: "Summit ID", in: "path", required: true, schema: new OA\Schema(type: "string")),
395410
],
396411
requestBody: new OA\RequestBody(
397412
required: true,
@@ -406,7 +421,7 @@ protected function getChildFromSummit(Summit $summit, $child_id):?IEntity{
406421
new OA\Response(response: Response::HTTP_BAD_REQUEST, description: "Bad Request"),
407422
new OA\Response(response: Response::HTTP_UNAUTHORIZED, description: "Unauthorized"),
408423
new OA\Response(response: Response::HTTP_FORBIDDEN, description: "Forbidden"),
409-
new OA\Response(response: Response::HTTP_NOT_FOUND, description: "not found"),
424+
new OA\Response(response: Response::HTTP_NOT_FOUND, description: "Not Found"),
410425
new OA\Response(response: Response::HTTP_PRECONDITION_FAILED, description: "Validation Error"),
411426
new OA\Response(response: Response::HTTP_INTERNAL_SERVER_ERROR, description: "Server Error"),
412427
]
@@ -421,22 +436,28 @@ public function add($summit_id){
421436

422437
#[OA\Get(
423438
path: "/api/v1/summits/{id}/track-chairs/{track_chair_id}",
439+
operationId: "getTrackChair",
424440
summary: "Get a track chair by id",
425-
security: [['summit_track_chairs_oauth2' => [
426-
SummitScopes::ReadSummitData,
427-
SummitScopes::ReadAllSummitData,
428-
]]],
429-
tags: ["TrackChairs"],
441+
tags: ["Track Chairs"],
442+
security: [
443+
[
444+
'summit_track_chairs_oauth2' => [
445+
SummitScopes::ReadSummitData,
446+
SummitScopes::ReadAllSummitData,
447+
]
448+
]
449+
],
430450
x: [
431451
'required-groups' => [
432452
IGroup::SuperAdmins,
433453
IGroup::Administrators,
434454
IGroup::SummitAdministrators,
435-
IGroup::TrackChairsAdmins
455+
IGroup::TrackChairsAdmins,
456+
IGroup::TrackChairs
436457
]
437458
],
438459
parameters: [
439-
new OA\Parameter(name: "id", description: "Summit ID or slug", in: "path", required: true, schema: new OA\Schema(type: "string")),
460+
new OA\Parameter(name: "id", description: "Summit ID", in: "path", required: true, schema: new OA\Schema(type: "string")),
440461
new OA\Parameter(name: "track_chair_id", description: "Track chair ID", in: "path", required: true, schema: new OA\Schema(type: "integer")),
441462
new OA\Parameter(name: "expand", description: "Expand relations (categories, member, summit)", in: "query", required: false, schema: new OA\Schema(type: "string")),
442463
],
@@ -454,7 +475,7 @@ public function add($summit_id){
454475
new OA\Response(response: Response::HTTP_BAD_REQUEST, description: "Bad Request"),
455476
new OA\Response(response: Response::HTTP_UNAUTHORIZED, description: "Unauthorized"),
456477
new OA\Response(response: Response::HTTP_FORBIDDEN, description: "Forbidden"),
457-
new OA\Response(response: Response::HTTP_NOT_FOUND, description: "not found"),
478+
new OA\Response(response: Response::HTTP_NOT_FOUND, description: "Not Found"),
458479
new OA\Response(response: Response::HTTP_INTERNAL_SERVER_ERROR, description: "Server Error"),
459480
]
460481
)]
@@ -468,11 +489,16 @@ public function get($summit_id, $track_chair_id){
468489

469490
#[OA\Put(
470491
path: "/api/v1/summits/{id}/track-chairs/{track_chair_id}",
492+
operationId: "updateTrackChair",
471493
summary: "Update a track chair's categories",
472-
security: [['summit_track_chairs_oauth2' => [
473-
SummitScopes::WriteSummitData,
474-
]]],
475-
tags: ["TrackChairs"],
494+
tags: ["Track Chairs"],
495+
security: [
496+
[
497+
'summit_track_chairs_oauth2' => [
498+
SummitScopes::WriteSummitData,
499+
]
500+
]
501+
],
476502
x: [
477503
'required-groups' => [
478504
IGroup::SuperAdmins,
@@ -482,7 +508,7 @@ public function get($summit_id, $track_chair_id){
482508
]
483509
],
484510
parameters: [
485-
new OA\Parameter(name: "id", description: "Summit ID or slug", in: "path", required: true, schema: new OA\Schema(type: "string")),
511+
new OA\Parameter(name: "id", description: "Summit ID", in: "path", required: true, schema: new OA\Schema(type: "string")),
486512
new OA\Parameter(name: "track_chair_id", description: "Track chair ID", in: "path", required: true, schema: new OA\Schema(type: "integer")),
487513
],
488514
requestBody: new OA\RequestBody(
@@ -498,7 +524,7 @@ public function get($summit_id, $track_chair_id){
498524
new OA\Response(response: Response::HTTP_BAD_REQUEST, description: "Bad Request"),
499525
new OA\Response(response: Response::HTTP_UNAUTHORIZED, description: "Unauthorized"),
500526
new OA\Response(response: Response::HTTP_FORBIDDEN, description: "Forbidden"),
501-
new OA\Response(response: Response::HTTP_NOT_FOUND, description: "not found"),
527+
new OA\Response(response: Response::HTTP_NOT_FOUND, description: "Not Found"),
502528
new OA\Response(response: Response::HTTP_PRECONDITION_FAILED, description: "Validation Error"),
503529
new OA\Response(response: Response::HTTP_INTERNAL_SERVER_ERROR, description: "Server Error"),
504530
]
@@ -513,11 +539,16 @@ public function update($summit_id, $track_chair_id){
513539

514540
#[OA\Delete(
515541
path: "/api/v1/summits/{id}/track-chairs/{track_chair_id}",
542+
operationId: "deleteTrackChair",
516543
summary: "Delete a track chair",
517-
security: [['summit_track_chairs_oauth2' => [
518-
SummitScopes::WriteSummitData,
519-
]]],
520-
tags: ["TrackChairs"],
544+
tags: ["Track Chairs"],
545+
security: [
546+
[
547+
'summit_track_chairs_oauth2' => [
548+
SummitScopes::WriteSummitData,
549+
]
550+
]
551+
],
521552
x: [
522553
'required-groups' => [
523554
IGroup::SuperAdmins,
@@ -527,15 +558,15 @@ public function update($summit_id, $track_chair_id){
527558
]
528559
],
529560
parameters: [
530-
new OA\Parameter(name: "id", description: "Summit ID or slug", in: "path", required: true, schema: new OA\Schema(type: "string")),
561+
new OA\Parameter(name: "id", description: "Summit ID", in: "path", required: true, schema: new OA\Schema(type: "string")),
531562
new OA\Parameter(name: "track_chair_id", description: "Track chair ID", in: "path", required: true, schema: new OA\Schema(type: "integer")),
532563
],
533564
responses: [
534565
new OA\Response(response: Response::HTTP_NO_CONTENT, description: "No Content"),
535566
new OA\Response(response: Response::HTTP_BAD_REQUEST, description: "Bad Request"),
536567
new OA\Response(response: Response::HTTP_UNAUTHORIZED, description: "Unauthorized"),
537568
new OA\Response(response: Response::HTTP_FORBIDDEN, description: "Forbidden"),
538-
new OA\Response(response: Response::HTTP_NOT_FOUND, description: "not found"),
569+
new OA\Response(response: Response::HTTP_NOT_FOUND, description: "Not Found"),
539570
new OA\Response(response: Response::HTTP_INTERNAL_SERVER_ERROR, description: "Server Error"),
540571
]
541572
)]
@@ -549,11 +580,16 @@ public function delete($summit_id, $track_chair_id){
549580

550581
#[OA\Post(
551582
path: "/api/v1/summits/{id}/track-chairs/{track_chair_id}/categories/{track_id}",
583+
operationId: "addCategoryToTrackChair",
552584
summary: "Add a track/category to a track chair",
553-
security: [['summit_track_chairs_oauth2' => [
554-
SummitScopes::WriteSummitData,
555-
]]],
556-
tags: ["TrackChairs"],
585+
tags: ["Track Chairs"],
586+
security: [
587+
[
588+
'summit_track_chairs_oauth2' => [
589+
SummitScopes::WriteSummitData,
590+
]
591+
]
592+
],
557593
x: [
558594
'required-groups' => [
559595
IGroup::SuperAdmins,
@@ -563,7 +599,7 @@ public function delete($summit_id, $track_chair_id){
563599
]
564600
],
565601
parameters: [
566-
new OA\Parameter(name: "id", description: "Summit ID or slug", in: "path", required: true, schema: new OA\Schema(type: "string")),
602+
new OA\Parameter(name: "id", description: "Summit ID", in: "path", required: true, schema: new OA\Schema(type: "string")),
567603
new OA\Parameter(name: "track_chair_id", description: "Track chair ID", in: "path", required: true, schema: new OA\Schema(type: "integer")),
568604
new OA\Parameter(name: "track_id", description: "Track/Category ID", in: "path", required: true, schema: new OA\Schema(type: "integer")),
569605
],
@@ -576,7 +612,7 @@ public function delete($summit_id, $track_chair_id){
576612
new OA\Response(response: Response::HTTP_BAD_REQUEST, description: "Bad Request"),
577613
new OA\Response(response: Response::HTTP_UNAUTHORIZED, description: "Unauthorized"),
578614
new OA\Response(response: Response::HTTP_FORBIDDEN, description: "Forbidden"),
579-
new OA\Response(response: Response::HTTP_NOT_FOUND, description: "not found"),
615+
new OA\Response(response: Response::HTTP_NOT_FOUND, description: "Not Found"),
580616
new OA\Response(response: Response::HTTP_PRECONDITION_FAILED, description: "Validation Error"),
581617
new OA\Response(response: Response::HTTP_INTERNAL_SERVER_ERROR, description: "Server Error"),
582618
]
@@ -612,11 +648,16 @@ public function addTrack2TrackChair($summit_id, $track_chair_id, $track_id){
612648

613649
#[OA\Delete(
614650
path: "/api/v1/summits/{id}/track-chairs/{track_chair_id}/categories/{track_id}",
651+
operationId: "removeCategoryFromTrackChair",
615652
summary: "Remove a track/category from a track chair",
616-
security: [['summit_track_chairs_oauth2' => [
617-
SummitScopes::WriteSummitData,
618-
]]],
619-
tags: ["TrackChairs"],
653+
tags: ["Track Chairs"],
654+
security: [
655+
[
656+
'summit_track_chairs_oauth2' => [
657+
SummitScopes::WriteSummitData,
658+
]
659+
]
660+
],
620661
x: [
621662
'required-groups' => [
622663
IGroup::SuperAdmins,
@@ -626,7 +667,7 @@ public function addTrack2TrackChair($summit_id, $track_chair_id, $track_id){
626667
]
627668
],
628669
parameters: [
629-
new OA\Parameter(name: "id", description: "Summit ID or slug", in: "path", required: true, schema: new OA\Schema(type: "string")),
670+
new OA\Parameter(name: "id", description: "Summit ID", in: "path", required: true, schema: new OA\Schema(type: "string")),
630671
new OA\Parameter(name: "track_chair_id", description: "Track chair ID", in: "path", required: true, schema: new OA\Schema(type: "integer")),
631672
new OA\Parameter(name: "track_id", description: "Track/Category ID", in: "path", required: true, schema: new OA\Schema(type: "integer")),
632673
],
@@ -639,7 +680,7 @@ public function addTrack2TrackChair($summit_id, $track_chair_id, $track_id){
639680
new OA\Response(response: Response::HTTP_BAD_REQUEST, description: "Bad Request"),
640681
new OA\Response(response: Response::HTTP_UNAUTHORIZED, description: "Unauthorized"),
641682
new OA\Response(response: Response::HTTP_FORBIDDEN, description: "Forbidden"),
642-
new OA\Response(response: Response::HTTP_NOT_FOUND, description: "not found"),
683+
new OA\Response(response: Response::HTTP_NOT_FOUND, description: "Not Found"),
643684
new OA\Response(response: Response::HTTP_PRECONDITION_FAILED, description: "Validation Error"),
644685
new OA\Response(response: Response::HTTP_INTERNAL_SERVER_ERROR, description: "Server Error"),
645686
]
@@ -673,4 +714,4 @@ public function removeFromTrackChair($summit_id, $track_chair_id, $track_id){
673714
}
674715
}
675716

676-
}
717+
}

‎app/Swagger/Models/SummitAbstractLocationSchema.php‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<?php
2+
3+
namespace App\Swagger\schemas;
4+
5+
use OpenApi\Attributes as OA;
6+
7+
8+
#[OA\Schema(
9+
schema: 'SummitAbstractLocation',
10+
type: 'object',
11+
properties: [
12+
new OA\Property(property: 'id', type: 'integer', example: 1),
13+
new OA\Property(property: 'created', type: 'integer', example: 1),
14+
new OA\Property(property: 'last_edited', type: 'integer', example: 1),
15+
new OA\Property(property: 'name', type: 'string'),
16+
new OA\Property(property: 'short_name', type: 'string'),
17+
new OA\Property(property: 'description', type: 'string'),
18+
new OA\Property(property: 'location_type', type: 'string'),
19+
new OA\Property(property: 'order', type: 'integer'),
20+
new OA\Property(property: 'opening_hour', type: 'integer'),
21+
new OA\Property(property: 'closing_hour', type: 'integer'),
22+
new OA\Property(property: 'class_name', type: 'string'),
23+
new OA\Property(property: 'published_events', type: 'array', items: new OA\Items(type: 'integer'), description: 'Array of published event IDs'),
24+
]
25+
)]
26+
class SummitAbstractLocationSchema
27+
{
28+
}

app/Swagger/Security/SummitTrackChairSchemas.php renamed to app/Swagger/Security/TrackChairsAuthSchema.php

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
1-
<?php
2-
namespace App\Swagger\schemas;
1+
<?php
32

3+
namespace App\Swagger\schemas;
44

55
use App\Security\SummitScopes;
66
use OpenApi\Attributes as OA;
77

8-
#[
9-
OA\SecurityScheme(
8+
#[OA\SecurityScheme(
109
type: 'oauth2',
1110
securityScheme: 'summit_track_chairs_oauth2',
1211
flows: [
@@ -23,4 +22,4 @@
2322
],
2423
)
2524
]
26-
class TrackChairsAuthSchema{}
25+
class TrackChairsAuthSchema{}

0 commit comments

Comments
 (0)