Skip to content

Feature | Extend Swagger Coverage for controller OAuth2SummitSponsorApiController#473

Open
andrestejerina97 wants to merge 13 commits intomainfrom
feature/openapi-documentation--oauth2summitsponsorsapicontrolller
Open

Feature | Extend Swagger Coverage for controller OAuth2SummitSponsorApiController#473
andrestejerina97 wants to merge 13 commits intomainfrom
feature/openapi-documentation--oauth2summitsponsorsapicontrolller

Conversation

@andrestejerina97
Copy link
Contributor

@matiasperrone-exo matiasperrone-exo force-pushed the feature/openapi-documentation--oauth2summitsponsorsapicontrolller branch from a0cf7f5 to 9b2f2af Compare December 31, 2025 18:31
@matiasperrone-exo matiasperrone-exo self-assigned this Dec 31, 2025
@matiasperrone-exo matiasperrone-exo force-pushed the feature/openapi-documentation--oauth2summitsponsorsapicontrolller branch 3 times, most recently from e791fd9 to 9711775 Compare December 31, 2025 20:40
@matiasperrone-exo matiasperrone-exo marked this pull request as ready for review December 31, 2025 20:41
@matiasperrone-exo matiasperrone-exo changed the title feat: Extend Swagger Coverage for controller OAuth2SummitSponsorApiController Feature | Extend Swagger Coverage for controller OAuth2SummitSponsorApiController Jan 8, 2026
@matiasperrone-exo matiasperrone-exo added the documentation Improvements or additions to documentation label Jan 20, 2026
@matiasperrone-exo matiasperrone-exo changed the title Feature | Extend Swagger Coverage for controller OAuth2SummitSponsorApiController Feature | Extend Swagger Coverage for controller OAuth2SummitSponsorApiController Jan 29, 2026
@matiasperrone-exo matiasperrone-exo force-pushed the feature/openapi-documentation--oauth2summitsponsorsapicontrolller branch 4 times, most recently from e82b4f4 to d7e1864 Compare January 29, 2026 20:03
Copy link

@caseylocker caseylocker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

app/Http/Controllers/Apis/Protected/Summit/OAuth2SummitSponsorApiController.php
in 'getSponsorsV2BySummitPublic',
lines 330-336
There is no 'sponsor_id' in the path
Was this a copy paste error that should have gone further down for operationId: 'getSponsorsV2BySummit' which is missing a 'sponsor_id' parameter?
This is documented as a public endpoint - it's mentioned twice.
If that's accurate then remove the Security scopes, Required groups otherwise change the documentation.

In 'getSponsorMaterials'
Line 2070 - IGroup::SponsorExternalUsers,
This isn't included in the seeder. Are we still using the seeder as the source of truth?
This appears again on 2525 in 'getSponsorSocialNetworks'

app/Swagger/Models/SubQuestionRuleSchema.php
line 17
new OA\Property(property: 'answer_values', type: 'string_array'),
'string_array' isn't a valid OpenAPI type.
Should probably be:
new OA\Property(property: 'answer_values', type: 'array', items: new OA\Items(type: 'string')),

The endpoint getSponsorsV2BySummitPublic at /api/public/v1/summits/all/{id}/sponsors is documented as a public endpoint - it's mentioned twice.
If that's accurate then remove the Security scopes, Required groups

andrestejerina97 and others added 9 commits February 2, 2026 18:43
Signed-off-by: Matias Perrone <github@matiasperrone.com>
Signed-off-by: Matias Perrone <github@matiasperrone.com>
Signed-off-by: Matias Perrone <github@matiasperrone.com>
Signed-off-by: Matias Perrone <github@matiasperrone.com>
Signed-off-by: Matias Perrone <github@matiasperrone.com>
Signed-off-by: Matias Perrone <github@matiasperrone.com>
Signed-off-by: Matias Perrone <github@matiasperrone.com>
@matiasperrone-exo matiasperrone-exo force-pushed the feature/openapi-documentation--oauth2summitsponsorsapicontrolller branch from 5b47633 to 58eda1e Compare February 2, 2026 18:44
Signed-off-by: Matias Perrone <github@matiasperrone.com>
…dReportSettings" and "addLeadReportSettings" operationIds

Signed-off-by: Matias Perrone <github@matiasperrone.com>
@andrestejerina97
Copy link
Contributor Author

The changes were implemented

Copy link

@caseylocker caseylocker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Collaborator

@smarcet smarcet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@andrestejerina97 u are missing all v1 methods defined by the traits please review the routes file

Route::post('', ['middleware' => 'auth.user', 'uses' => 'OAuth2SummitSponsorApiController@add']);

Signed-off-by: matiasperrone-exo <matias.perrone@exomindset.co>
@matiasperrone-exo
Copy link
Contributor

@andrestejerina97 u are missing all v1 methods defined by the traits please review the routes file

Route::post('', ['middleware' => 'auth.user', 'uses' => 'OAuth2SummitSponsorApiController@add']);

Thanks @smarcet for the comments it was a very good catch.
The missing v1 endpoints were incorporated.

Please review again as all the requested changes were incorporated.

Signed-off-by: matiasperrone-exo <matias.perrone@exomindset.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants