Skip to content

Fix | Issue on doc generation OAuth2CompaniesApiController #472

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
matiasperrone-exo wants to merge 6 commits into
base: main
Choose a base branch
from
+130 −135
Open

Fix | Issue on doc generation OAuth2CompaniesApiController #472

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a02cb8c
feat: Extend Swagger Coverage for controller `OAuth2CompaniesApiContr…
matiasperrone-exo Oct 13, 2025
61a1e1c
fix: Change "namespace" word positioning
matiasperrone-exo Oct 14, 2025
981652c
fix: Add security schema
matiasperrone Nov 10, 2025
2e0d3ba
chore: Move the security schema for the controller to its own file
matiasperrone Nov 13, 2025
9d605a9
chore: add operationId and fix schema name
matiasperrone Dec 3, 2025
62ffc89
fix: main rebase conflict
matiasperrone Dec 5, 2025
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
265 changes: 130 additions & 135 deletions app/Http/Controllers/Apis/Protected/Main/OAuth2CompaniesApiController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,135 @@ public function __construct
$this->service = $service;
}

#[OA\Get(
path: "/api/v1/companies",
operationId: "getAllCompanies",
summary: "Get all companies",
description: "Returns a paginated list of companies. Allows ordering, filtering and pagination.",
security: [
[
"companies_oauth2" => [
CompanyScopes::Read,
SummitScopes::ReadSummitData,
SummitScopes::ReadAllSummitData,
]
]
],
tags: ["Companies"],
parameters: [
new OA\Parameter(
name: 'page',
in: 'query',
required: false,
schema: new OA\Schema(type: 'integer'),
description: 'The page number'
),
new OA\Parameter(
name: 'per_page',
in: 'query',
required: false,
schema: new OA\Schema(type: 'integer'),
description: 'The number of items per page',
),
new OA\Parameter(
name: "filter[]",
in: "query",
required: false,
description: "Filter companies. Available filters: name (=@, ==, @@), member_level (=@, ==, @@), display_on_site (==)",
schema: new OA\Schema(type: "array", items: new OA\Items(type: "string")),
explode: true
),
new OA\Parameter(
name: "order",
in: "query",
required: false,
description: "Order by field. Valid fields: id, name, member_level",
schema: new OA\Schema(type: "string")
),
new OA\Parameter(
name: "expand",
in: "query",
required: false,
description: "Expand related entities. Available expansions: sponsorships, project_sponsorships",
schema: new OA\Schema(type: "string")
),
new OA\Parameter(
name: "relations",
in: "query",
required: false,
description: "Load relations. Available: sponsorships, project_sponsorships",
schema: new OA\Schema(type: "string")
),
],
responses: [
new OA\Response(
response: Response::HTTP_OK,
description: "Success",
content: new OA\JsonContent(ref: "#/components/schemas/PaginatedCompaniesResponse")
),
new OA\Response(response: Response::HTTP_BAD_REQUEST, description: "Bad Request"),
]
)]
#[OA\Get(
path: "/api/public/v1/companies",
operationId: "getAllCompaniesPublic",
summary: "Get all companies (Public)",
description: "Returns a paginated list of companies. Allows ordering, filtering and pagination.",
tags: ["Companies (Public)"],
parameters: [
new OA\Parameter(
name: 'page',
in: 'query',
required: false,
schema: new OA\Schema(type: 'integer'),
description: 'The page number'
),
new OA\Parameter(
name: 'per_page',
in: 'query',
required: false,
schema: new OA\Schema(type: 'integer'),
description: 'The number of items per page',
),
new OA\Parameter(
name: "filter[]",
in: "query",
required: false,
description: "Filter companies. Available filters: name (=@, ==, @@), member_level (=@, ==, @@), display_on_site (==)",
schema: new OA\Schema(type: "array", items: new OA\Items(type: "string")),
explode: true
),
new OA\Parameter(
name: "order",
in: "query",
required: false,
description: "Order by field. Valid fields: id, name, member_level",
schema: new OA\Schema(type: "string")
),
new OA\Parameter(
name: "expand",
in: "query",
required: false,
description: "Expand related entities. Available expansions: sponsorships, project_sponsorships",
schema: new OA\Schema(type: "string")
),
new OA\Parameter(
name: "relations",
in: "query",
required: false,
description: "Load relations. Available: sponsorships, project_sponsorships",
schema: new OA\Schema(type: "string")
),
],
responses: [
new OA\Response(
response: Response::HTTP_OK,
description: "Success",
content: new OA\JsonContent(ref: "#/components/schemas/PaginatedCompaniesResponse")
),
new OA\Response(response: Response::HTTP_BAD_REQUEST, description: "Bad Request"),
]
)]
#[OA\Get(
path: "/api/v1/companies/{id}",
operationId: "getCompany",
Expand Down Expand Up @@ -113,10 +242,6 @@ public function __construct
new OA\Response(response: Response::HTTP_NOT_FOUND, description: "Company not found"),
]
)]
/**
* Class OAuth2CompaniesApiController
* @package App\Http\Controllers
*/
#[OA\Get(
path: "/api/public/v1/companies/{id}",
operationId: "getCompanyPublic",
Expand Down Expand Up @@ -270,136 +395,6 @@ public function __construct
new OA\Response(response: Response::HTTP_NOT_FOUND, description: "Company not found"),
]
)]
#[OA\Get(
path: "/api/v1/companies",
operationId: "getAllCompanies",
summary: "Get all companies",
description: "Returns a paginated list of companies. Allows ordering, filtering and pagination.",
security: [
[
"companies_oauth2" => [
CompanyScopes::Read,
SummitScopes::ReadSummitData,
SummitScopes::ReadAllSummitData,
]
]
],
tags: ["Companies"],
parameters: [
new OA\Parameter(
name: 'page',
in: 'query',
required: false,
schema: new OA\Schema(type: 'integer'),
description: 'The page number'
),
new OA\Parameter(
name: 'per_page',
in: 'query',
required: false,
schema: new OA\Schema(type: 'integer'),
description: 'The number of pages in each page',
),
new OA\Parameter(
name: "filter[]",
in: "query",
required: false,
description: "Filter companies. Available filters: name (=@, ==, @@), member_level (=@, ==, @@), display_on_site (==)",
schema: new OA\Schema(type: "array", items: new OA\Items(type: "string")),
explode: true
),
new OA\Parameter(
name: "order",
in: "query",
required: false,
description: "Order by field. Valid fields: id, name, member_level",
schema: new OA\Schema(type: "string")
),
new OA\Parameter(
name: "expand",
in: "query",
required: false,
description: "Expand related entities. Available expansions: sponsorships, project_sponsorships",
schema: new OA\Schema(type: "string")
),
new OA\Parameter(
name: "relations",
in: "query",
required: false,
description: "Load relations. Available: sponsorships, project_sponsorships",
schema: new OA\Schema(type: "string")
),
],
responses: [
new OA\Response(
response: Response::HTTP_OK,
description: "Success",
content: new OA\JsonContent(ref: "#/components/schemas/PaginatedCompaniesResponse")
),
new OA\Response(response: Response::HTTP_BAD_REQUEST, description: "Bad Request"),
]
)]

#[OA\Get(
path: "/api/public/v1/companies",
operationId: "getAllCompaniesPublic",
summary: "Get all companies (Public)",
description: "Returns a paginated list of companies. Allows ordering, filtering and pagination.",
tags: ["Companies (Public)"],
parameters: [
new OA\Parameter(
name: 'page',
in: 'query',
required: false,
schema: new OA\Schema(type: 'integer'),
description: 'The page number'
),
new OA\Parameter(
name: 'per_page',
in: 'query',
required: false,
schema: new OA\Schema(type: 'integer'),
description: 'The number of pages in each page',
),
new OA\Parameter(
name: "filter[]",
in: "query",
required: false,
description: "Filter companies. Available filters: name (=@, ==, @@), member_level (=@, ==, @@), display_on_site (==)",
schema: new OA\Schema(type: "array", items: new OA\Items(type: "string")),
explode: true
),
new OA\Parameter(
name: "order",
in: "query",
required: false,
description: "Order by field. Valid fields: id, name, member_level",
schema: new OA\Schema(type: "string")
),
new OA\Parameter(
name: "expand",
in: "query",
required: false,
description: "Expand related entities. Available expansions: sponsorships, project_sponsorships",
schema: new OA\Schema(type: "string")
),
new OA\Parameter(
name: "relations",
in: "query",
required: false,
description: "Load relations. Available: sponsorships, project_sponsorships",
schema: new OA\Schema(type: "string")
),
],
responses: [
new OA\Response(
response: Response::HTTP_OK,
description: "Success",
content: new OA\JsonContent(ref: "#/components/schemas/PaginatedCompaniesResponse")
),
new OA\Response(response: Response::HTTP_BAD_REQUEST, description: "Bad Request"),
]
)]
public function getAllCompanies()
{

Expand Down Expand Up @@ -739,4 +734,4 @@ public function deleteCompanyBigLogo($company_id)
return $this->deleted();
});
}
}
}