Added OpenAPI docs using nelmioAPIDocBundle.
CI / Docker Lint (push) Successful in 21s

This commit is contained in:
2024-09-20 21:29:23 +02:00
parent 0cf6f231a3
commit bfcd04c701
18 changed files with 610 additions and 20 deletions
+28
View File
@@ -0,0 +1,28 @@
<?php
namespace App\Request;
use App\Entity\BookingCustomer;
use OpenApi\Attributes as OA;
class BookingCreateRequest
{
#[OA\Property(description: 'Booking Arrival date')]
public \DateTime $arrivalDate;
#[OA\Property(description: 'Booking departure date')]
public \DateTime $departureDate;
#[OA\Property(
description: 'Booking customer details',
)]
public BookingCustomer $customerDetails;
/**
* @var array<BookingCreateRoomItem>
*/
#[OA\Property(
description: 'Rooms to book',
)]
public array $rooms;
}
+17
View File
@@ -0,0 +1,17 @@
<?php
namespace App\Request;
use OpenApi\Attributes as OA;
class BookingCreateRoomItem
{
#[OA\Property(description: 'Room category ID')]
public string $roomCategory;
#[OA\Property(description: 'Guest number for the room')]
public int $guestNumber;
#[OA\Property(description: 'Room amount')]
public int $amount;
}
+14
View File
@@ -0,0 +1,14 @@
<?php
namespace App\Request;
use OpenApi\Attributes as OA;
class BookingDetailsRequest
{
#[OA\Property(description: 'Booking reference number')]
public string $refNumber;
#[OA\Property(maxLength: 255, description: 'Email associated to the booking')]
public string $email;
}
@@ -0,0 +1,14 @@
<?php
namespace App\Request;
use OpenApi\Attributes as OA;
class SearchAvailabilityPeriodRequest
{
#[OA\Property(description: 'Period start date')]
public \DateTime $startDate;
#[OA\Property(description: 'Period end date')]
public \DateTime $endDate;
}
+17
View File
@@ -0,0 +1,17 @@
<?php
namespace App\Request;
use OpenApi\Attributes as OA;
class SearchFareCategoryRequest
{
#[OA\Property(description: 'Room category ID')]
public int $roomCategory;
#[OA\Property(description: 'Period start date')]
public \DateTime $startDate;
#[OA\Property(description: 'Period end date')]
public \DateTime $endDate;
}