Skip to content

feat: Extend Swagger Coverage for controller OAuth2SummitTrackChairRatingTypesApiController #405

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+340 −30
Open

feat: Extend Swagger Coverage for controller OAuth2SummitTrackChairRatingTypesApiController #405

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
294 changes: 264 additions & 30 deletions ...Http/Controllers/Apis/Protected/Summit/OAuth2SummitTrackChairRatingTypesApiController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,12 @@
use App\Models\Foundation\Summit\Repositories\ISelectionPlanRepository;
use App\ModelSerializers\SerializerUtils;
use App\Services\Model\ITrackChairRankingService;
use Illuminate\Http\Response;
use models\oauth2\IResourceServerContext;
use models\summit\ISummitRepository;
use models\utils\IBaseRepository;
use models\utils\IEntity;
use ModelSerializers\SerializerRegistry;
use OpenApi\Attributes as OA;
use utils\Filter;
use utils\FilterElement;

Expand Down Expand Up @@ -89,11 +90,84 @@ protected function getRepository(): IBaseRepository
return $this->repository;
}

/**
* @param $summit_id
* @param $selection_plan_id
* @return \Illuminate\Http\JsonResponse|mixed
*/
#[OA\Get(
path: "/api/v1/summits/{id}/selection-plans/{selection_plan_id}/track-chair-rating-types",
description: "Get all track chair rating types for a selection plan",
summary: "Get all track chair rating types",
operationId: "getAllTrackChairRatingTypes",
tags: ['Track Chair Rating Types'],
security: [['summit_oauth2' => []]],
parameters: [
new OA\Parameter(
name: 'id',
in: 'path',
required: true,
schema: new OA\Schema(type: 'integer'),
description: 'The summit id'
),
new OA\Parameter(
name: 'selection_plan_id',
in: 'path',
required: true,
schema: new OA\Schema(type: 'integer'),
description: 'The selection plan id'
),
new OA\Parameter(
name: 'page',
in: 'query',
required: false,
schema: new OA\Schema(type: 'integer', default: 1),
description: 'Page number'
),
new OA\Parameter(
name: 'per_page',
in: 'query',
required: false,
schema: new OA\Schema(type: 'integer', default: 10),
description: 'Items per page'
),
new OA\Parameter(
name: 'filter',
in: 'query',
required: false,
schema: new OA\Schema(type: 'string'),
description: 'Filter expression (e.g., name=@Technical)'
),
new OA\Parameter(
name: 'order',
in: 'query',
required: false,
schema: new OA\Schema(type: 'string'),
description: 'Order by field (e.g., +order, -name)'
),
new OA\Parameter(
name: 'expand',
in: 'query',
required: false,
schema: new OA\Schema(type: 'string'),
description: 'Expand relationships (score_types,selection_plan)'
),
new OA\Parameter(
name: 'relations',
in: 'query',
required: false,
schema: new OA\Schema(type: 'string'),
description: 'Relations to include (score_types)'
)
],
responses: [
new OA\Response(
response: 200,
description: 'Success',
content: new OA\JsonContent(ref: '#/components/schemas/PaginatedPresentationTrackChairRatingTypesResponse')
),
new OA\Response(response: Response::HTTP_UNAUTHORIZED, description: "Unauthorized"),
new OA\Response(response: Response::HTTP_FORBIDDEN, description: "Forbidden"),
new OA\Response(response: Response::HTTP_NOT_FOUND, description: "not found"),
new OA\Response(response: Response::HTTP_PRECONDITION_FAILED, description: "Validation Error"),
new OA\Response(response: Response::HTTP_INTERNAL_SERVER_ERROR, description: "Server Error")
]
)]
public function getTrackChairRatingTypes($summit_id, $selection_plan_id) {

$summit = SummitFinderStrategyFactory::build($this->summit_repository, $this->resource_server_context)->find(intval($summit_id));
Expand Down Expand Up @@ -134,12 +208,62 @@ function () {
);
}

/**
* @param $summit_id
* @param $selection_plan_id
* @param $type_id
* @return \Illuminate\Http\JsonResponse|mixed
*/
#[OA\Get(
path: "/api/v1/summits/{id}/selection-plans/{selection_plan_id}/track-chair-rating-types/{type_id}",
description: "Get a specific track chair rating type by id",
summary: "Get track chair rating type",
operationId: "getTrackChairRatingType",
tags: ['Track Chair Rating Types'],
security: [['summit_oauth2' => []]],
parameters: [
new OA\Parameter(
name: 'id',
in: 'path',
required: true,
schema: new OA\Schema(type: 'integer'),
description: 'The summit id'
),
new OA\Parameter(
name: 'selection_plan_id',
in: 'path',
required: true,
schema: new OA\Schema(type: 'integer'),
description: 'The selection plan id'
),
new OA\Parameter(
name: 'type_id',
in: 'path',
required: true,
schema: new OA\Schema(type: 'integer'),
description: 'The rating type id'
),
new OA\Parameter(
name: 'expand',
in: 'query',
required: false,
schema: new OA\Schema(type: 'string'),
description: 'Expand relationships (score_types,selection_plan)'
),
new OA\Parameter(
name: 'relations',
in: 'query',
required: false,
schema: new OA\Schema(type: 'string'),
description: 'Relations to include (score_types)'
)
],
responses: [
new OA\Response(
response: 200,
description: 'Success',
content: new OA\JsonContent(ref: '#/components/schemas/PresentationTrackChairRatingType')
),
new OA\Response(response: Response::HTTP_UNAUTHORIZED, description: "Unauthorized"),
new OA\Response(response: Response::HTTP_FORBIDDEN, description: "Forbidden"),
new OA\Response(response: Response::HTTP_NOT_FOUND, description: "not found"),
new OA\Response(response: Response::HTTP_INTERNAL_SERVER_ERROR, description: "Server Error")
]
)]
public function getTrackChairRatingType($summit_id, $selection_plan_id, $type_id) {

return $this->processRequest(function () use ($summit_id, $selection_plan_id, $type_id) {
Expand All @@ -162,11 +286,47 @@ public function getTrackChairRatingType($summit_id, $selection_plan_id, $type_id
});
}

/**
* @param $summit_id
* @param $selection_plan_id
* @return IEntity
*/
#[OA\Post(
path: "/api/v1/summits/{id}/selection-plans/{selection_plan_id}/track-chair-rating-types",
description: "Create a new track chair rating type",
summary: "Create track chair rating type",
operationId: "createTrackChairRatingType",
tags: ['Track Chair Rating Types'],
security: [['summit_oauth2' => []]],
parameters: [
new OA\Parameter(
name: 'id',
in: 'path',
required: true,
schema: new OA\Schema(type: 'integer'),
description: 'The summit id'
),
new OA\Parameter(
name: 'selection_plan_id',
in: 'path',
required: true,
schema: new OA\Schema(type: 'integer'),
description: 'The selection plan id'
)
],
requestBody: new OA\RequestBody(
required: true,
content: new OA\JsonContent(ref: '#/components/schemas/PresentationTrackChairRatingTypeCreateRequest')
),
responses: [
new OA\Response(
response: 201,
description: 'Created',
content: new OA\JsonContent(ref: '#/components/schemas/PresentationTrackChairRatingType')
),
new OA\Response(response: Response::HTTP_BAD_REQUEST, description: "Bad Request"),
new OA\Response(response: Response::HTTP_UNAUTHORIZED, description: "Unauthorized"),
new OA\Response(response: Response::HTTP_FORBIDDEN, description: "Forbidden"),
new OA\Response(response: Response::HTTP_NOT_FOUND, description: "not found"),
new OA\Response(response: Response::HTTP_PRECONDITION_FAILED, description: "Validation Error"),
new OA\Response(response: Response::HTTP_INTERNAL_SERVER_ERROR, description: "Server Error")
]
)]
public function addTrackChairRatingType($summit_id, $selection_plan_id) {

return $this->processRequest(function () use ($summit_id, $selection_plan_id) {
Expand All @@ -190,12 +350,54 @@ public function addTrackChairRatingType($summit_id, $selection_plan_id) {
});
}

/**
* @param $summit_id
* @param $selection_plan_id
* @param $type_id
* @return \Illuminate\Http\JsonResponse|mixed
*/
#[OA\Put(
path: "/api/v1/summits/{id}/selection-plans/{selection_plan_id}/track-chair-rating-types/{type_id}",
description: "Update an existing track chair rating type",
summary: "Update track chair rating type",
operationId: "updateTrackChairRatingType",
tags: ['Track Chair Rating Types'],
security: [['summit_oauth2' => []]],
parameters: [
new OA\Parameter(
name: 'id',
in: 'path',
required: true,
schema: new OA\Schema(type: 'integer'),
description: 'The summit id'
),
new OA\Parameter(
name: 'selection_plan_id',
in: 'path',
required: true,
schema: new OA\Schema(type: 'integer'),
description: 'The selection plan id'
),
new OA\Parameter(
name: 'type_id',
in: 'path',
required: true,
schema: new OA\Schema(type: 'integer'),
description: 'The rating type id'
)
],
requestBody: new OA\RequestBody(
required: true,
content: new OA\JsonContent(ref: '#/components/schemas/PresentationTrackChairRatingTypeUpdateRequest')
),
responses: [
new OA\Response(
response: 200,
description: 'Success',
content: new OA\JsonContent(ref: '#/components/schemas/PresentationTrackChairRatingType')
),
new OA\Response(response: Response::HTTP_BAD_REQUEST, description: "Bad Request"),
new OA\Response(response: Response::HTTP_UNAUTHORIZED, description: "Unauthorized"),
new OA\Response(response: Response::HTTP_FORBIDDEN, description: "Forbidden"),
new OA\Response(response: Response::HTTP_NOT_FOUND, description: "not found"),
new OA\Response(response: Response::HTTP_PRECONDITION_FAILED, description: "Validation Error"),
new OA\Response(response: Response::HTTP_INTERNAL_SERVER_ERROR, description: "Server Error")
]
)]
public function updateTrackChairRatingType($summit_id, $selection_plan_id, $type_id) {

return $this->processRequest(function () use ($summit_id, $selection_plan_id, $type_id) {
Expand All @@ -219,12 +421,44 @@ public function updateTrackChairRatingType($summit_id, $selection_plan_id, $type
});
}

/**
* @param $summit_id
* @param $selection_plan_id
* @param $type_id
* @return \Illuminate\Http\JsonResponse|mixed
*/
#[OA\Delete(
path: "/api/v1/summits/{id}/selection-plans/{selection_plan_id}/track-chair-rating-types/{type_id}",
description: "Delete a track chair rating type",
summary: "Delete track chair rating type",
operationId: "deleteTrackChairRatingType",
tags: ['Track Chair Rating Types'],
security: [['summit_oauth2' => []]],
parameters: [
new OA\Parameter(
name: 'id',
in: 'path',
required: true,
schema: new OA\Schema(type: 'integer'),
description: 'The summit id'
),
new OA\Parameter(
name: 'selection_plan_id',
in: 'path',
required: true,
schema: new OA\Schema(type: 'integer'),
description: 'The selection plan id'
),
new OA\Parameter(
name: 'type_id',
in: 'path',
required: true,
schema: new OA\Schema(type: 'integer'),
description: 'The rating type id'
)
],
responses: [
new OA\Response(response: 204, description: 'No Content'),
new OA\Response(response: Response::HTTP_UNAUTHORIZED, description: "Unauthorized"),
new OA\Response(response: Response::HTTP_FORBIDDEN, description: "Forbidden"),
new OA\Response(response: Response::HTTP_NOT_FOUND, description: "not found"),
new OA\Response(response: Response::HTTP_INTERNAL_SERVER_ERROR, description: "Server Error")
]
)]
public function deleteTrackChairRatingType($summit_id, $selection_plan_id, $type_id) {

return $this->processRequest(function () use ($summit_id, $selection_plan_id, $type_id) {
Expand All @@ -239,4 +473,4 @@ public function deleteTrackChairRatingType($summit_id, $selection_plan_id, $type
return $this->deleted();
});
}
}
}
Loading