Skip to content

Commit 0d1777a

Browse files
matiasperronematiasperrone
committed
chore: Add missing doc on public endpoint
1 parent 5a0f6f9 commit 0d1777a

File tree

2 files changed

+53
-23
lines changed

2 files changed

+53
-23
lines changed

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

Lines changed: 47 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ public function __construct
9696
in: "path",
9797
required: true,
9898
schema: new OA\Schema(type: "string"),
99-
description: "Summit ID or slug"
99+
description: "Summit ID"
100100
),
101101
new OA\Parameter(
102102
name: "page",
@@ -230,7 +230,7 @@ function ($page, $per_page, $filter, $order, $applyExtraFilters) use ($summit) {
230230
in: "path",
231231
required: true,
232232
schema: new OA\Schema(type: "string"),
233-
description: "Summit ID or slug"
233+
description: "Summit ID"
234234
),
235235
new OA\Parameter(
236236
name: "page",
@@ -403,14 +403,52 @@ public function getAllBySummitCSV($summit_id)
403403
path: "/api/v1/summits/{id}/event-types/{event_type_id}",
404404
operationId: "getEventTypeBySummit",
405405
description: "Get a specific event type by ID",
406+
tags: ["Event Types"],
407+
parameters: [
408+
new OA\Parameter(
409+
name: "id",
410+
in: "path",
411+
required: true,
412+
schema: new OA\Schema(type: "string"),
413+
description: "Summit ID"
414+
),
415+
new OA\Parameter(
416+
name: "event_type_id",
417+
in: "path",
418+
required: true,
419+
schema: new OA\Schema(type: "integer", format: "int64"),
420+
description: "Event type ID"
421+
),
422+
new OA\Parameter(
423+
name: "expand",
424+
in: "query",
425+
required: false,
426+
schema: new OA\Schema(type: "string"),
427+
description: "Expand relationships"
428+
),
429+
],
430+
responses: [
431+
new OA\Response(
432+
response: Response::HTTP_OK,
433+
description: "Event type retrieved successfully",
434+
content: new OA\JsonContent(ref: "#/components/schemas/EventType")
435+
),
436+
new OA\Response(response: Response::HTTP_NOT_FOUND, description: "Event type or summit not found"),
437+
new OA\Response(response: Response::HTTP_INTERNAL_SERVER_ERROR, description: "Server Error"),
438+
]
439+
)]
440+
#[OA\Get(
441+
path: "/api/public/v1/summits/{id}/event-types/{event_type_id}",
442+
operationId: "getEventTypeBySummitPublic",
443+
description: "Get a specific event type by ID",
406444
tags: ["Event Types (Public)"],
407445
parameters: [
408446
new OA\Parameter(
409447
name: "id",
410448
in: "path",
411449
required: true,
412450
schema: new OA\Schema(type: "string"),
413-
description: "Summit ID or slug"
451+
description: "Summit ID"
414452
),
415453
new OA\Parameter(
416454
name: "event_type_id",
@@ -484,7 +522,7 @@ public function getEventTypeBySummit($summit_id, $event_type_id)
484522
in: "path",
485523
required: true,
486524
schema: new OA\Schema(type: "string"),
487-
description: "Summit ID or slug"
525+
description: "Summit ID"
488526
),
489527
],
490528
requestBody: new OA\RequestBody(
@@ -549,7 +587,7 @@ public function addEventTypeBySummit($summit_id)
549587
in: "path",
550588
required: true,
551589
schema: new OA\Schema(type: "string"),
552-
description: "Summit ID or slug"
590+
description: "Summit ID"
553591
),
554592
new OA\Parameter(
555593
name: "event_type_id",
@@ -621,7 +659,7 @@ public function updateEventTypeBySummit($summit_id, $event_type_id)
621659
in: "path",
622660
required: true,
623661
schema: new OA\Schema(type: "string"),
624-
description: "Summit ID or slug"
662+
description: "Summit ID"
625663
),
626664
new OA\Parameter(
627665
name: "event_type_id",
@@ -680,7 +718,7 @@ public function deleteEventTypeBySummit($summit_id, $event_type_id)
680718
in: "path",
681719
required: true,
682720
schema: new OA\Schema(type: "string"),
683-
description: "Summit ID or slug"
721+
description: "Summit ID"
684722
),
685723
],
686724
responses: [
@@ -744,7 +782,7 @@ public function seedDefaultEventTypesBySummit($summit_id)
744782
in: "path",
745783
required: true,
746784
schema: new OA\Schema(type: "string"),
747-
description: "Summit ID or slug"
785+
description: "Summit ID"
748786
),
749787
new OA\Parameter(
750788
name: "event_type_id",
@@ -829,7 +867,7 @@ public function addSummitDocument($summit_id, $event_type_id, $document_id)
829867
in: "path",
830868
required: true,
831869
schema: new OA\Schema(type: "string"),
832-
description: "Summit ID or slug"
870+
description: "Summit ID"
833871
),
834872
new OA\Parameter(
835873
name: "event_type_id",

‎app/Swagger/Models/EventTypeSchema.php‎

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<?php
1+
<?php
22
namespace App\Swagger\schemas;
33

44
use OpenApi\Attributes as OA;
@@ -29,15 +29,13 @@
2929
new OA\Property(
3030
property: "color",
3131
type: "string",
32-
nullable: true,
3332
description: "Display color (hex)",
3433
example: "#FF5733"
3534
),
3635
new OA\Property(
3736
property: "black_out_times",
3837
type: "string",
3938
enum: ["UNLIMITED", "ONLY_MAIN_EVENTS", "BLACKOUT_TIMES"],
40-
nullable: true,
4139
description: "Blackout times setting",
4240
example: "UNLIMITED"
4341
),
@@ -107,33 +105,27 @@ enum: ["UNLIMITED", "ONLY_MAIN_EVENTS", "BLACKOUT_TIMES"],
107105
type: "array",
108106
description: "Summit document IDs (use expand=summit_documents to get full objects)",
109107
items: new OA\Items(
110-
anyOf: [
108+
oneOf: [
111109
new OA\Schema(type: "integer"),
112110
new OA\Schema(ref: "#/components/schemas/SummitDocument")
113111
]
114-
),
115-
nullable: true
112+
)
116113
),
117114
new OA\Property(
118115
property: "allowed_ticket_types",
119116
type: "array",
120117
description: "Allowed ticket type IDs (use expand=allowed_ticket_types to get full objects)",
121118
items: new OA\Items(
122-
anyOf: [
119+
oneOf: [
123120
new OA\Schema(type: "integer"),
124121
new OA\Schema(ref: "#/components/schemas/SummitTicketType")
125122
]
126-
),
127-
nullable: true
123+
)
128124
),
129125
new OA\Property(
130126
property: "summit",
131127
description: "Summit ID or expanded object (use expand=summit to get full object)",
132-
anyOf: [
133-
new OA\Schema(type: "integer"),
134-
new OA\Schema(ref: "#/components/schemas/Summit")
135-
],
136-
nullable: true
128+
schema: "#/components/schemas/Summit",
137129
),
138130
new OA\Property(
139131
property: "created",

0 commit comments

Comments
 (0)