Skip to content

Commit 5e30e60

Browse files
committed
chore: add operationId and fix schema name
1 parent 81b418c commit 5e30e60

1 file changed

Lines changed: 23 additions & 12 deletions

File tree

app/Http/Controllers/Apis/Protected/Main/OAuth2CompaniesApiController.php

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -70,11 +70,12 @@ public function __construct
7070

7171
#[OA\Get(
7272
path: "/api/v1/companies/{id}",
73+
operationId: "getCompany",
7374
summary: "Get a specific company",
7475
description: "Returns detailed information about a specific company",
7576
security: [
7677
[
77-
"OAuth2CompaniesApiControllerAuthSchema" => [
78+
"companies_oauth2" => [
7879
CompanyScopes::Read,
7980
]
8081
]
@@ -118,9 +119,10 @@ public function __construct
118119
*/
119120
#[OA\Get(
120121
path: "/api/public/v1/companies/{id}",
122+
operationId: "getCompanyPublic",
121123
summary: "Get a specific company (Public)",
122124
description: "Returns detailed information about a specific company",
123-
tags: ["Companies"],
125+
tags: ["Companies (Public)"],
124126
parameters: [
125127
new OA\Parameter(
126128
name: "id",
@@ -155,11 +157,12 @@ public function __construct
155157
)]
156158
#[OA\Post(
157159
path: "/api/v1/companies",
160+
operationId: "createCompany",
158161
summary: "Create a new company",
159162
description: "Creates a new company",
160163
security: [
161164
[
162-
"OAuth2CompaniesApiControllerAuthSchema" => [
165+
"companies_oauth2" => [
163166
CompanyScopes::Write,
164167
]
165168
]
@@ -189,11 +192,12 @@ public function __construct
189192
)]
190193
#[OA\Put(
191194
path: "/api/v1/companies/{id}",
195+
operationId: "updateCompany",
192196
summary: "Update a company",
193197
description: "Updates an existing company",
194198
security: [
195199
[
196-
"OAuth2CompaniesApiControllerAuthSchema" => [
200+
"companies_oauth2" => [
197201
CompanyScopes::Write,
198202
]
199203
]
@@ -233,11 +237,12 @@ public function __construct
233237
)]
234238
#[OA\Delete(
235239
path: "/api/v1/companies/{id}",
240+
operationId: "deleteCompany",
236241
summary: "Delete a company",
237242
description: "Deletes a company",
238243
security: [
239244
[
240-
"OAuth2CompaniesApiControllerAuthSchema" => [
245+
"companies_oauth2" => [
241246
CompanyScopes::Write,
242247
]
243248
]
@@ -267,11 +272,12 @@ public function __construct
267272
)]
268273
#[OA\Get(
269274
path: "/api/v1/companies",
275+
operationId: "getAllCompanies",
270276
summary: "Get all companies",
271277
description: "Returns a paginated list of companies. Allows ordering, filtering and pagination.",
272278
security: [
273279
[
274-
"OAuth2CompaniesApiControllerAuthSchema" => [
280+
"companies_oauth2" => [
275281
CompanyScopes::Read,
276282
SummitScopes::ReadSummitData,
277283
SummitScopes::ReadAllSummitData,
@@ -336,9 +342,10 @@ public function __construct
336342

337343
#[OA\Get(
338344
path: "/api/public/v1/companies",
345+
operationId: "getAllCompaniesPublic",
339346
summary: "Get all companies (Public)",
340347
description: "Returns a paginated list of companies. Allows ordering, filtering and pagination.",
341-
tags: ["Companies"],
348+
tags: ["Companies (Public)"],
342349
parameters: [
343350
new OA\Parameter(
344351
name: 'page',
@@ -501,11 +508,12 @@ protected function updateEntity($id, array $payload): IEntity
501508

502509
#[OA\Post(
503510
path: "/api/v1/companies/{id}/logo",
511+
operationId: "addCompanyLogo",
504512
summary: "Add company logo",
505513
description: "Uploads a logo image for the company",
506514
security: [
507515
[
508-
"OAuth2CompaniesApiControllerAuthSchema" => [
516+
"companies_oauth2" => [
509517
CompanyScopes::Write,
510518
]
511519
]
@@ -573,11 +581,12 @@ public function addCompanyLogo(LaravelRequest $request, $company_id)
573581

574582
#[OA\Delete(
575583
path: "/api/v1/companies/{id}/logo",
584+
operationId: "deleteCompanyLogo",
576585
summary: "Delete company logo",
577586
description: "Removes the logo image from the company",
578587
security: [
579588
[
580-
"OAuth2CompaniesApiControllerAuthSchema" => [
589+
"companies_oauth2" => [
581590
CompanyScopes::Write,
582591
]
583592
]
@@ -618,11 +627,12 @@ public function deleteCompanyLogo($company_id)
618627

619628
#[OA\Post(
620629
path: "/api/v1/companies/{id}/logo/big",
630+
operationId: "addCompanyBigLogo",
621631
summary: "Add company big logo",
622632
description: "Uploads a big logo image for the company",
623633
security: [
624634
[
625-
"OAuth2CompaniesApiControllerAuthSchema" => [
635+
"companies_oauth2" => [
626636
CompanyScopes::Write,
627637
]
628638
]
@@ -689,11 +699,12 @@ public function addCompanyBigLogo(LaravelRequest $request, $company_id)
689699

690700
#[OA\Delete(
691701
path: "/api/v1/companies/{id}/logo/big",
702+
operationId: "deleteCompanyBigLogo",
692703
summary: "Delete company big logo",
693704
description: "Removes the big logo image from the company",
694705
security: [
695706
[
696-
"OAuth2CompaniesApiControllerAuthSchema" => [
707+
"companies_oauth2" => [
697708
CompanyScopes::Write,
698709
]
699710
]
@@ -728,4 +739,4 @@ public function deleteCompanyBigLogo($company_id)
728739
return $this->deleted();
729740
});
730741
}
731-
}
742+
}

0 commit comments

Comments
 (0)