Skip to content

Commit 3f2c638

Browse files
chore: Add unique operationId attribute to OpenAPI documentation
Signed-off-by: matiasperrone-exo <matias.perrone@exomindset.co>
1 parent d46008f commit 3f2c638

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

app/Http/Controllers/Api/OAuth2/OAuth2UserApiController.php

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ final class OAuth2UserApiController extends OAuth2ProtectedController
5555
#[OA\Get(
5656
path: '/api/v1/users',
5757
summary: 'Get all users',
58+
operationId: 'getUsers',
5859
tags: ['Users'],
5960
security: [
6061
['user_oauth2' => [
@@ -211,6 +212,7 @@ public function __construct
211212
#[OA\Get(
212213
path: '/api/v1/users/me',
213214
summary: 'Get current user basic info',
215+
operationId: 'getCurrentUser',
214216
tags: ['Users'],
215217
security: [
216218
['user_oauth2' => [
@@ -328,6 +330,7 @@ private function _update($id){
328330
#[OA\Post(
329331
path: '/api/v1/users',
330332
summary: 'Create a new user',
333+
operationId: 'createUser',
331334
tags: ['Users'],
332335
security: [
333336
['user_oauth2' => [
@@ -365,6 +368,7 @@ public function create(){
365368
#[OA\Put(
366369
path: '/api/v1/users/me',
367370
summary: 'Update current user',
371+
operationId: 'updateCurrentUser',
368372
tags: ['Users'],
369373
security: [
370374
['user_oauth2' => [
@@ -402,6 +406,7 @@ public function updateMe(){
402406
#[OA\Put(
403407
path: '/api/v1/users/{id}',
404408
summary: 'Update a user by ID',
409+
operationId: 'updateUser',
405410
tags: ['Users'],
406411
security: [
407412
['user_oauth2' => [
@@ -448,6 +453,7 @@ public function update($id){
448453
#[OA\Put(
449454
path: '/api/v1/users/me/pic',
450455
summary: 'Update current user profile picture',
456+
operationId: 'updateCurrentUserProfilePicture',
451457
tags: ['Users'],
452458
security: [
453459
['user_oauth2' => [
@@ -511,6 +517,7 @@ public function updateMyPic(LaravelRequest $request){
511517
#[OA\Get(
512518
path: '/api/v1/users/info',
513519
summary: 'Get current user info (OpenID Connect UserInfo)',
520+
operationId: 'getUserInfo',
514521
tags: ['Users'],
515522
security: [
516523
['user_oauth2' => [
@@ -533,6 +540,7 @@ public function updateMyPic(LaravelRequest $request){
533540
#[OA\Post(
534541
path: '/api/v1/users/info',
535542
summary: 'Get current user info (OpenID Connect UserInfo)',
543+
operationId: 'getUserInfoPost',
536544
tags: ['Users'],
537545
security: [
538546
['user_oauth2' => [
@@ -591,6 +599,7 @@ public function userInfo()
591599
#[OA\Get(
592600
path: '/api/v1/users/{id}',
593601
summary: 'Get a user by ID',
602+
operationId: 'getUserById',
594603
tags: ['Users'],
595604
security: [
596605
['user_oauth2' => [
@@ -672,6 +681,7 @@ public function getV2($id)
672681
#[OA\Put(
673682
path: '/api/v1/users/{id}/groups',
674683
summary: 'Update user group assignments',
684+
operationId: 'updateUserGroups',
675685
tags: ['Users'],
676686
security: [
677687
['user_oauth2' => [

0 commit comments

Comments
 (0)