Feature | Extend Swagger Coverage for controller OAuth2SummitTicketApiController

[matiasperrone-exo]

Task:

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

Dependencies:

#436 #450

[caseylocker]

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]

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

[caseylocker]

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

[matiasperrone-exo]

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

[caseylocker]

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]

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

[romanetar]

@matiasperrone-exo two checks are failing, please review

[caseylocker]

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]

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

[caseylocker]

'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

[matiasperrone-exo]

@caseylocker all the requested changes were introduced, you may review it again.

• type: 'float' was changed to type: 'number', format: 'float'

[caseylocker]

LGTM

[romanetar]

@matiasperrone-exo please review

[romanetar]

@matiasperrone-exo summary and description must reflect an export, not a list

[JpMaxMan]

good catch @romanetar

[andrestejerina97]

@romanetar thank you. The description was changed and it was ready along with a new rebase