Skip to content

Commit 9f70bcb

Browse files
committed
chore: Add PR's requested changes
1 parent 0820fc2 commit 9f70bcb

File tree

2 files changed

+19
-18
lines changed

2 files changed

+19
-18
lines changed

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

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -154,12 +154,12 @@ protected function updateChild(Summit $summit,int $child_id, array $payload):IEn
154154
path: "/api/v1/summits/{id}/sponsors/{sponsor_id}/user-info-grants/me",
155155
summary: "Add user info grant for current user",
156156
operationId: "addUserInfoWithSponsor",
157-
tags: ["SponsorUserInfoGrants"],
157+
tags: ["Badge Scans", "Sponsor User Info Grants"],
158158
security: [['summit_badge_scan_oauth2' => [
159159
SummitScopes::WriteMyBadgeScan,
160160
]]],
161161
parameters: [
162-
new OA\Parameter(name: "id", description: "Summit ID or slug", in: "path", required: true, schema: new OA\Schema(type: "string")),
162+
new OA\Parameter(name: "id", description: "Summit ID", in: "path", required: true, schema: new OA\Schema(type: "string")),
163163
new OA\Parameter(name: "sponsor_id", description: "Sponsor ID", in: "path", required: true, schema: new OA\Schema(type: "integer")),
164164
],
165165
responses: [
@@ -211,12 +211,12 @@ protected function getSummitRepository(): ISummitRepository
211211
path: "/api/v1/summits/{id}/badge-scans/me",
212212
summary: "Get all my badge scans for a summit",
213213
operationId: "getMyBadgeScans",
214-
tags: ['BadgeScans'],
214+
tags: ['Badge Scans'],
215215
security: [['summit_badge_scan_oauth2' => [
216216
SummitScopes::ReadMyBadgeScan,
217217
]]],
218218
parameters: [
219-
new OA\Parameter(name: "id", description: "Summit ID or slug", in: "path", required: true, schema: new OA\Schema(type: "string")),
219+
new OA\Parameter(name: "id", description: "Summit ID", in: "path", required: true, schema: new OA\Schema(type: "string")),
220220
new OA\Parameter(name: "page", description: "Page number", in: "query", required: false, schema: new OA\Schema(type: "integer", default: 1)),
221221
new OA\Parameter(name: "per_page", description: "Items per page", in: "query", required: false, schema: new OA\Schema(type: "integer", default: 10)),
222222
new OA\Parameter(name: "filter", description: "Filter query", in: "query", required: false, schema: new OA\Schema(type: "string")),
@@ -290,7 +290,7 @@ function(){
290290
path: "/api/v1/summits/{id}/badge-scans",
291291
summary: "Get all badge scans for a summit",
292292
operationId: "getAllBadgeScans",
293-
tags: ['BadgeScans'],
293+
tags: ['Badge Scans'],
294294
x: [
295295
'required-groups' => [
296296
IGroup::SummitAdministrators,
@@ -305,7 +305,7 @@ function(){
305305
SummitScopes::ReadBadgeScan,
306306
]]],
307307
parameters: [
308-
new OA\Parameter(name: "id", description: "Summit ID or slug", in: "path", required: true, schema: new OA\Schema(type: "string")),
308+
new OA\Parameter(name: "id", description: "Summit ID", in: "path", required: true, schema: new OA\Schema(type: "string")),
309309
new OA\Parameter(name: "page", description: "Page number", in: "query", required: false, schema: new OA\Schema(type: "integer", default: 1)),
310310
new OA\Parameter(name: "per_page", description: "Items per page", in: "query", required: false, schema: new OA\Schema(type: "integer", default: 10)),
311311
new OA\Parameter(name: "filter", description: "Filter query", in: "query", required: false, schema: new OA\Schema(type: "string")),
@@ -408,7 +408,7 @@ function(){
408408
path: "/api/v1/summits/{id}/badge-scans/csv",
409409
summary: "Get all badge scans for a summit in CSV format",
410410
operationId: "getAllBadgeScansCSV",
411-
tags: ['BadgeScans'],
411+
tags: ['Badge Scans'],
412412
x: [
413413
'required-groups' => [
414414
IGroup::SummitAdministrators,
@@ -423,7 +423,7 @@ function(){
423423
SummitScopes::ReadBadgeScan,
424424
]]],
425425
parameters: [
426-
new OA\Parameter(name: "id", description: "Summit ID or slug", in: "path", required: true, schema: new OA\Schema(type: "string")),
426+
new OA\Parameter(name: "id", description: "Summit ID", in: "path", required: true, schema: new OA\Schema(type: "string")),
427427
new OA\Parameter(name: "filter", description: "Filter query", in: "query", required: false, schema: new OA\Schema(type: "string")),
428428
new OA\Parameter(name: "order", description: "Order by", in: "query", required: false, schema: new OA\Schema(type: "string")),
429429
new OA\Parameter(name: "columns", description: "Columns to export (comma separated)", in: "query", required: false, schema: new OA\Schema(type: "string")),
@@ -579,7 +579,7 @@ function() use($summit) {
579579
path: "/api/v1/summits/{id}/badge-scans",
580580
summary: "Add a badge scan",
581581
operationId: "addBadgeScan",
582-
tags: ['BadgeScans'],
582+
tags: ['Badge Scans'],
583583
x: [
584584
'required-groups' => [
585585
IGroup::SummitAdministrators,
@@ -593,7 +593,7 @@ function() use($summit) {
593593
SummitScopes::WriteBadgeScan,
594594
]]],
595595
parameters: [
596-
new OA\Parameter(name: "id", description: "Summit ID or slug", in: "path", required: true, schema: new OA\Schema(type: "string")),
596+
new OA\Parameter(name: "id", description: "Summit ID", in: "path", required: true, schema: new OA\Schema(type: "string")),
597597
],
598598
requestBody: new OA\RequestBody(
599599
required: true,
@@ -625,13 +625,13 @@ public function add($summit_id){
625625
path: "/api/v1/summits/{id}/badge-scans/checkin",
626626
summary: "Check in an attendee using QR code",
627627
operationId: "checkInBadgeScan",
628-
tags: ['BadgeScans'],
628+
tags: ['Badge Scans'],
629629
security: [['summit_badge_scan_oauth2' => [
630630
SummitScopes::WriteBadgeScan,
631631
SummitScopes::WriteSummitData,
632632
]]],
633633
parameters: [
634-
new OA\Parameter(name: "id", description: "Summit ID or slug", in: "path", required: true, schema: new OA\Schema(type: "string")),
634+
new OA\Parameter(name: "id", description: "Summit ID", in: "path", required: true, schema: new OA\Schema(type: "string")),
635635
],
636636
requestBody: new OA\RequestBody(
637637
required: true,
@@ -679,7 +679,7 @@ protected function getChildFromSummit(Summit $summit, $child_id): ?IEntity
679679
path: "/api/v1/summits/{id}/badge-scans/{scan_id}",
680680
summary: "Get a badge scan by id",
681681
operationId: "getBadgeScan",
682-
tags: ['BadgeScans'],
682+
tags: ['Badge Scans'],
683683
x: [
684684
'required-groups' => [
685685
IGroup::SummitAdministrators,
@@ -695,7 +695,7 @@ protected function getChildFromSummit(Summit $summit, $child_id): ?IEntity
695695
SummitScopes::ReadMyBadgeScan,
696696
]]],
697697
parameters: [
698-
new OA\Parameter(name: "id", description: "Summit ID or slug", in: "path", required: true, schema: new OA\Schema(type: "string")),
698+
new OA\Parameter(name: "id", description: "Summit ID", in: "path", required: true, schema: new OA\Schema(type: "string")),
699699
new OA\Parameter(name: "scan_id", description: "Badge scan ID", in: "path", required: true, schema: new OA\Schema(type: "integer")),
700700
],
701701
responses: [
@@ -723,7 +723,7 @@ public function get($summit_id, $scan_id){
723723
path: "/api/v1/summits/{id}/badge-scans/{scan_id}",
724724
summary: "Update a badge scan",
725725
operationId: "updateBadgeScan",
726-
tags: ['BadgeScans'],
726+
tags: ['Badge Scans'],
727727
x: [
728728
'required-groups' => [
729729
IGroup::SummitAdministrators,
@@ -738,7 +738,7 @@ public function get($summit_id, $scan_id){
738738
SummitScopes::WriteBadgeScan,
739739
]]],
740740
parameters: [
741-
new OA\Parameter(name: "id", description: "Summit ID or slug", in: "path", required: true, schema: new OA\Schema(type: "string")),
741+
new OA\Parameter(name: "id", description: "Summit ID", in: "path", required: true, schema: new OA\Schema(type: "string")),
742742
new OA\Parameter(name: "scan_id", description: "Badge scan ID", in: "path", required: true, schema: new OA\Schema(type: "integer")),
743743
],
744744
requestBody: new OA\RequestBody(

app/Swagger/security/SponsorBadgeScanAuthScheme.php

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?php
22

3-
namespace App\Swagger\security;
3+
namespace App\Swagger\schemas;
44

55
use App\Security\SummitScopes;
66
use OpenApi\Attributes as OA;
@@ -18,10 +18,11 @@
1818
scopes: [
1919
SummitScopes::ReadBadgeScan => 'Read Badge Scan Data',
2020
SummitScopes::ReadMyBadgeScan => 'Read My Badge Scan Data',
21-
SummitScopes::WriteBadgeScan => 'Write Badge Scan Data',
2221
SummitScopes::ReadBadgeScanValidate => 'Validate Badge Scan',
2322
SummitScopes::ReadAllSummitData => 'Read All Summit Data',
2423
SummitScopes::WriteSummitData => 'Write Summit Data',
24+
SummitScopes::WriteBadgeScan => 'Write Badge Scan Data',
25+
SummitScopes::WriteMyBadgeScan => 'Write My Badge Scan Data',
2526
],
2627
),
2728
],

0 commit comments

Comments
 (0)