Skip to content

feat: Extend Swagger Coverage for controller OAuth2SummitTicketApiController #440

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

Jump to bottom
Open
matiasperrone-exo wants to merge 13 commits into
base: main
Choose a base branch
from
Open

feat: Extend Swagger Coverage for controller OAuth2SummitTicketApiController #440

matiasperrone-exo wants to merge 13 commits into from
+867 −168

Conversation

@matiasperrone-exo
Copy link
Contributor

@matiasperrone-exo matiasperrone-exo commented Oct 24, 2025 •
edited
Loading

Task:

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

Dependencies:

#436 #450

@matiasperrone-exo matiasperrone-exo added the documentation Improvements or additions to documentation label Oct 24, 2025
@matiasperrone-exo matiasperrone-exo self-assigned this Oct 24, 2025
@matiasperrone-exo matiasperrone-exo added the review Need reviewing from the developer label Nov 10, 2025
@matiasperrone-exo matiasperrone-exo removed the review Need reviewing from the developer label Nov 24, 2025
@matiasperrone-exo matiasperrone-exo force-pushed the feature/openapi-documentation--oauth2summitticketapicontroller branch from 08fb819 to acaa457 Compare December 5, 2025 19:27
caseylocker
caseylocker requested changes Dec 8, 2025
View reviewed changes
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.

In app/Swagger/SummitRegistrationSchemas.php
items: new OA\Items(type: 'SummitAttendeeTicket')
Is an invalid type.

In app/Http/Controllers/Apis/Protected/Summit/OAuth2SummitTicketApiController.php
tags: ['tickets'],
Should be title cased
tags: ['Tickets'],

@matiasperrone-exo
Copy link
Contributor Author

matiasperrone-exo commented Dec 8, 2025

Thanks @caseylocker for the comments. Now is ready to review again

caseylocker
caseylocker requested changes Dec 8, 2025
View reviewed changes
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.

This was not addressed:
"In app/Swagger/SummitRegistrationSchemas.php
items: new OA\Items(type: 'SummitAttendeeTicket')
Is an invalid type."

@smarcet smarcet force-pushed the main branch 4 times, most recently from c6ecdd0 to 728ae67 Compare December 17, 2025 00:43
@matiasperrone-exo matiasperrone-exo force-pushed the feature/openapi-documentation--oauth2summitticketapicontroller branch from f41ca9b to 01db7d5 Compare December 18, 2025 20:32
@matiasperrone-exo
Copy link
Contributor Author

matiasperrone-exo commented Dec 18, 2025

Thanks @caseylocker for the comments. Now is ready to review again

caseylocker
caseylocker requested changes Dec 19, 2025
View reviewed changes
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.

SummitRegistrationSchemas.php line 70 Schema reference error:

items: new OA\Items(type: 'SummitAttendeeTicket') // WRONG

Should be:

items: new OA\Items(ref: '#/components/schemas/SummitAttendeeTicket') // CORRECT

OAuth2SummitTicketApiController.php line 1125 Invalid schema syntax

// Current (incorrect):
content: new OA\JsonContent(schema: 'SummitAttendeeBadge')

// Should be:
content: new OA\JsonContent(ref: '#/components/schemas/SummitAttendeeBadge')

OA\JsonContent doesn't have a schema parameter for referencing other schemas. Use ref instead.

@matiasperrone-exo matiasperrone-exo force-pushed the feature/openapi-documentation--oauth2summitticketapicontroller branch from 01db7d5 to 1c786ab Compare December 29, 2025 21:15
@matiasperrone-exo
Copy link
Contributor Author

matiasperrone-exo commented Dec 29, 2025

Thanks @caseylocker for the comments. Now is ready to review again.

@matiasperrone-exo matiasperrone-exo mentioned this pull request Dec 29, 2025
Merged
@matiasperrone-exo matiasperrone-exo force-pushed the feature/openapi-documentation--oauth2summitticketapicontroller branch from 132d5fd to 54b98ac Compare January 27, 2026 17:34
@romanetar romanetar self-requested a review January 28, 2026 10:58
romanetar
romanetar requested changes Jan 28, 2026
View reviewed changes
Copy link
Collaborator

@romanetar romanetar left a comment

Choose a reason for hiding this comment

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

@matiasperrone-exo two checks are failing, please review

@matiasperrone-exo matiasperrone-exo force-pushed the feature/openapi-documentation--oauth2summitticketapicontroller branch 2 times, most recently from 74b0a50 to 7a734db Compare January 28, 2026 15:34
@matiasperrone-exo
Copy link
Contributor Author

matiasperrone-exo commented Jan 28, 2026

@romanetar you may merge now-

caseylocker
caseylocker requested changes Jan 28, 2026
View reviewed changes
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.

I'm seeing usage of 'numeric' for type in several places. 'numeric' is a Laravel validation rule, not a valid OpenAPI type. Please use a valid OpenAPI type like 'integer' or 'number' for floating point values like 'final_amount'.

@matiasperrone-exo
Copy link
Contributor Author

matiasperrone-exo commented Jan 28, 2026

Thanks @caseylocker for the comments. Now is ready to review again

matiasperrone-exo and others added 13 commits January 28, 2026 21:00
@matiasperrone-exo @matiasperrone
feat: Extend Swagger Coverage for controller `OAuth2SummitTicketApiCo…
ff1bb89 
…ntroller`
@matiasperrone
fix: Add security schema, also security and x.required-groups fields
052bd61
@matiasperrone
chore: Add operationId
c3726d5
@matiasperrone
fix: Update path parameters in OAuth2SummitTicketApiController for co…
24a1fa1 
…nsistency
@matiasperrone
chore: change tag to title case
cabcfc8
@matiasperrone
chore: Add PR's requested changes
2a5b67d 
Signed-off-by: Matias Perrone <github@matiasperrone.com>
@matiasperrone
chore: fix incorrect HTTP codes responses
0417adf 
Signed-off-by: Matias Perrone <github@matiasperrone.com>
@matiasperrone
fix: linting back to main
9887e33 
Signed-off-by: Matias Perrone <github@matiasperrone.com>
@matiasperrone
chore: add "Schema" to schema classes names
3a931b5 
Signed-off-by: Matias Perrone <github@matiasperrone.com>
@matiasperrone
chore: Add missing schemas and route
23486c9 
Signed-off-by: Matias Perrone <github@matiasperrone.com>
@matiasperrone
chore: Move SummitAttendeeTicket to its own file
abf436e 
Signed-off-by: Matias Perrone <github@matiasperrone.com>
@matiasperrone
chore: fix rebase issues
3502631 
Signed-off-by: Matias Perrone <github@matiasperrone.com>
@matiasperrone
chore: change floating numbers to "number" type
8208cd5 
Signed-off-by: Matias Perrone <github@matiasperrone.com>
@matiasperrone-exo matiasperrone-exo force-pushed the feature/openapi-documentation--oauth2summitticketapicontroller branch from 9c7424f to 8208cd5 Compare January 28, 2026 21:00
caseylocker
caseylocker requested changes Jan 29, 2026
View reviewed changes
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.

'float' isn't a type, it's a format. If this is a floating point number then the syntax should be:

new OA\Property(property: 'raw_cost', type: 'number', format: 'float'),

Please address the other instances of 'float' as well.
Properties to fix (lines 25, 26, 28, 30, 31, 33, 35, 39):
- raw_cost
- net_selling_cost
- final_amount
- discount
- discount_rate
- refunded_amount
- total_refunded_amount
- taxes_amount

app/Swagger/Models/SummitAttendeeTicketSchema.php
new OA\Property(property: 'order_id', type: 'integer'),
new OA\Property(property: 'badge_id', type: 'integer'),
new OA\Property(property: 'promo_code_id', type: 'integer'),
new OA\Property(property: 'raw_cost', type: 'float'),
Copy link

@caseylocker caseylocker Jan 29, 2026

Choose a reason for hiding this comment

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

'float' isn't a type, it's a format. If this is a floating point number then the syntax should be:

new OA\Property(property: 'raw_cost', type: 'number', format: 'float'),

Please address the other instances of 'float' as well.
Properties to fix (lines 25, 26, 28, 30, 31, 33, 35, 39):
- raw_cost
- net_selling_cost
- final_amount
- discount
- discount_rate
- refunded_amount
- total_refunded_amount
- taxes_amount

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@caseylocker caseylocker caseylocker requested changes

@smarcet smarcet Awaiting requested review from smarcet

@romanetar romanetar Awaiting requested review from romanetar

Requested changes must be addressed to merge this pull request.

Assignees

@matiasperrone-exo matiasperrone-exo

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@matiasperrone-exo @caseylocker @romanetar @andrestejerina97 @matiasperrone