Feature | Extend Swagger Coverage for controller `OAuth2GroupsApiController` #365

matiasperrone-exo · 2025-09-30T20:39:49Z

Task:

Ref: https://app.clickup.com/t/86b6wkgk3

caseylocker

One line change needed: File: OAuth2GroupsApiController.php
Line: 32

- OAuth2MembersApiController constructor.

- OAuth2GroupsApiController constructor.

matiasperrone-exo · 2025-10-31T14:04:48Z

One line change needed: File: OAuth2GroupsApiController.php Line: 32

OAuth2MembersApiController constructor.

OAuth2GroupsApiController constructor.

Done @caseylocker , thanks!

caseylocker

The '%s/groups/read' => 'Read Groups Data', in the controller looks like a placeholder or template string, is that correct? Check the seeder for actual scope constant.

Security schemas should be in schemas.php.

'members' is called out as an expand option but the Group schema doesn't include it.

matiasperrone-exo · 2025-11-13T18:43:36Z

The '%s/groups/read' => 'Read Groups Data', in the controller looks like a placeholder or template string, is that correct? Check the seeder for actual scope constant.

Security schemas should be in schemas.php.

'members' is called out as an expand option but the Group schema doesn't include it.

The value members is included in the serializer:

Also getMembers() is a valid method:

On the other hand ReadGroupsData was added to SummitScopes and the security schema for the controller was moved to its own file in app/Swagger/Security/GroupsOAuthSchema.php as discussed with @smarcet by our TL.

@caseylocker this PR is ready to be approved

caseylocker

Close, please fix the following 2 issues and then this should be good:

Improve the Expand Parameter documentation to be -
"description: 'Comma-separated list of related resources to include. Available relations: members (expands member IDs to full member objects)'," and use this format, or a generalized version, in the future for all expand parameters.
Change line 2 of app/Swagger/Security/GroupsOAuthSchema.php from namespace App\OpenApi\schemas to namespace App\Swagger\schemas;

caseylocker

@matiasperrone-exo The namespace App\OpenApi\schemas; in GroupsOAuthSchema.php needs to be changed to namespace App\Swagger\schemas;

After that this should be good to go.

matiasperrone-exo · 2025-12-02T21:21:18Z

@caseylocker thanks. done.

caseylocker

Approved.

smarcet · 2025-12-16T15:35:34Z

@matiasperrone please rebase against main and fix the conflicts many thanks

fix: improve ticket repository performance remove not needed extra joins fix: set fetchJoinCollection to false for ticket repo fix: get always owner to avoid N+1 on ticket repository fix: improve get tickets generic pagination

chore: fix .gitmessage.txt chore: increase header size to 150

- Add controller's response to OpenAPI schema

…ma was moved to its own file

matiasperrone-exo · 2025-12-18T21:57:00Z

@smarcet you may now merge it, as all the conflicts were addressed

smarcet · 2025-12-22T13:18:02Z

app/Security/SummitScopes.php

    const ReadAttendeeNotesData = '%s/attendee/notes/read';
-}
+
+    const ReadGroupsData = '%s/groups/read';


@matiasperrone-exo
please remove this ( rollback this file)
due this scope does not belongs to this file
and rebase against main and use this c9726df

smarcet · 2025-12-22T13:18:37Z

app/Swagger/Security/GroupsOAuthSchema.php

+            scopes: [
+                SummitScopes::ReadAllSummitData => 'Read All Summit Data',
+                SummitScopes::ReadSummitData => 'Read Summit Data',
+                SummitScopes::ReadGroupsData => 'Read Groups Data',


@matiasperrone-exo please review c9726df

smarcet · 2025-12-22T13:19:00Z

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

+                'groups_oauth2' => [
+                    SummitScopes::ReadAllSummitData,
+                    SummitScopes::ReadSummitData,
+                    SummitScopes::ReadGroupsData,


@matiasperrone please review c9726df

smarcet

@matiasperrone-exo please review comments

matiasperrone-exo self-assigned this Sep 30, 2025

matiasperrone-exo requested a review from smarcet September 30, 2025 20:40

matiasperrone-exo force-pushed the feature/add-openapi-documentation-to-controller---apis---protected---main---oauth2groupsapicontroller branch from 2c68dd1 to da8fd46 Compare September 30, 2025 20:51

smarcet force-pushed the main branch 9 times, most recently from c94fc68 to 9a8387b Compare October 2, 2025 17:58

matiasperrone-exo added the documentation Improvements or additions to documentation label Oct 7, 2025

matiasperrone-exo force-pushed the feature/add-openapi-documentation-to-controller---apis---protected---main---oauth2groupsapicontroller branch from da8fd46 to 519673e Compare October 7, 2025 21:42

matiasperrone-exo changed the title ~~Feature | Extend Swagger Coverage for controller Apis/Protected/Main/OAuth2GroupsApiController.php~~ Feature | Extend Swagger Coverage for controller OAuth2GroupsApiController Oct 9, 2025

smarcet force-pushed the main branch from c5a5158 to 81bd847 Compare October 11, 2025 20:56

matiasperrone-exo force-pushed the feature/add-openapi-documentation-to-controller---apis---protected---main---oauth2groupsapicontroller branch 2 times, most recently from e01245b to 3f0b170 Compare October 14, 2025 16:08

caseylocker requested changes Oct 30, 2025

View reviewed changes

matiasperrone-exo force-pushed the feature/add-openapi-documentation-to-controller---apis---protected---main---oauth2groupsapicontroller branch from 3f0b170 to d619644 Compare October 31, 2025 14:03

matiasperrone-exo requested a review from caseylocker October 31, 2025 14:04

matiasperrone-exo added the review Need reviewing from the developer label Nov 10, 2025

caseylocker requested changes Nov 12, 2025

View reviewed changes

matiasperrone-exo requested a review from caseylocker November 13, 2025 18:50

caseylocker requested changes Nov 18, 2025

View reviewed changes

matiasperrone-exo removed the review Need reviewing from the developer label Nov 18, 2025

matiasperrone-exo force-pushed the feature/add-openapi-documentation-to-controller---apis---protected---main---oauth2groupsapicontroller branch 2 times, most recently from 323b3bc to dadf122 Compare November 20, 2025 22:37

matiasperrone-exo requested a review from caseylocker November 20, 2025 22:37

matiasperrone-exo force-pushed the feature/add-openapi-documentation-to-controller---apis---protected---main---oauth2groupsapicontroller branch from dadf122 to ad0f318 Compare November 21, 2025 13:35

caseylocker requested changes Nov 28, 2025

View reviewed changes

matiasperrone-exo force-pushed the feature/add-openapi-documentation-to-controller---apis---protected---main---oauth2groupsapicontroller branch from 8f4a3df to d704939 Compare December 2, 2025 21:20

matiasperrone-exo requested a review from caseylocker December 2, 2025 21:21

matiasperrone-exo force-pushed the feature/add-openapi-documentation-to-controller---apis---protected---main---oauth2groupsapicontroller branch from d704939 to ee298ed Compare December 4, 2025 21:06

caseylocker approved these changes Dec 10, 2025

View reviewed changes

smarcet force-pushed the main branch 4 times, most recently from c6ecdd0 to 728ae67 Compare December 17, 2025 00:43

smarcet and others added 10 commits December 18, 2025 21:40

fix: improve ticket csv serializer performance

5bcce22

fix: improve ticket repository performance remove not needed extra joins fix: set fetchJoinCollection to false for ticket repo fix: get always owner to avoid N+1 on ticket repository fix: improve get tickets generic pagination

chore: refactor DoctrineSummitEventRepository to suppport 2 phase paging

90450e3

chore: fix .gitmessage.txt chore: increase header size to 150

feat: Add OpenAPI documentation to "getAll" method

b5f7394

- Add controller's response to OpenAPI schema

chore: Revert to main version due to conflicts with rebase

dedf3c7

fix: comment

4f8b596

fix: Add security schema

c0c97b2

fix: security schema class name

196ebea

chore: ReadGroupsData was added to SummitScopes and the security sche…

c6c76d4

…ma was moved to its own file

chore: add requested changes in PR

8a7cd80

chore: change namespace

5dff35c

matiasperrone-exo force-pushed the feature/add-openapi-documentation-to-controller---apis---protected---main---oauth2groupsapicontroller branch from ee298ed to 5dff35c Compare December 18, 2025 21:48

caseylocker assigned smarcet Dec 18, 2025

smarcet reviewed Dec 22, 2025

View reviewed changes

smarcet requested changes Dec 22, 2025

View reviewed changes

Feature | Extend Swagger Coverage for controller OAuth2GroupsApiController #365

Are you sure you want to change the base?

Feature | Extend Swagger Coverage for controller OAuth2GroupsApiController #365

Conversation

matiasperrone-exo commented Sep 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Task:

Uh oh!

caseylocker left a comment

Choose a reason for hiding this comment

Uh oh!

matiasperrone-exo commented Oct 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

caseylocker left a comment

Choose a reason for hiding this comment

Uh oh!

matiasperrone-exo commented Nov 13, 2025

Uh oh!

caseylocker left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

caseylocker left a comment

Choose a reason for hiding this comment

Uh oh!

matiasperrone-exo commented Dec 2, 2025

Uh oh!

caseylocker left a comment

Choose a reason for hiding this comment

Uh oh!

smarcet commented Dec 16, 2025

Uh oh!

matiasperrone-exo commented Dec 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

smarcet Dec 22, 2025

Choose a reason for hiding this comment

Uh oh!

smarcet Dec 22, 2025

Choose a reason for hiding this comment

Uh oh!

smarcet Dec 22, 2025

Choose a reason for hiding this comment

Uh oh!

smarcet left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Feature | Extend Swagger Coverage for controller `OAuth2GroupsApiController` #365

Feature | Extend Swagger Coverage for controller `OAuth2GroupsApiController` #365

matiasperrone-exo commented Sep 30, 2025 •

edited

Loading

matiasperrone-exo commented Oct 31, 2025 •

edited

Loading

caseylocker left a comment •

edited

Loading

matiasperrone-exo commented Dec 18, 2025 •

edited

Loading