Feature | Extend Swagger Coverage for controller OAuth2PaymentGatewayProfileApiController

[matiasperrone-exo]

Task:

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

[caseylocker]

@matiasperrone-exo Looking at this I don't see "oauth2_security_scope" defined anywhere.

[matiasperrone-exo]

@matiasperrone-exo Looking at this I don't see "oauth2_security_scope" defined anywhere.

@caseylocker thanks! I added a new security schema and replaced with the correct scopes

[smarcet]

@matiasperrone-exo please review comments

[matiasperrone-exo]

@caseylocker Please review again. All the conflicts were resolved, the security schema created and also the related security roles were included.
The serializer was review to avoid missing fields.

[caseylocker]

@matiasperrone-exo The format of the security definitions is incorrect. Missing inner array brackets around the scopes:

// Current (INVALID)
security: [['summit_payment_gateway_oauth2' =>
    SummitScopes::ReadAllSummitData,
    SummitScopes::ReadPaymentProfiles
]],

// Required (CORRECT)
security: [['summit_payment_gateway_oauth2' => [
    SummitScopes::ReadAllSummitData,
    SummitScopes::ReadPaymentProfiles
]]],

We're also missing the operationId on all endpoints. Endpoints and suggestions...

GET /api/v1/summits/{id}/payment-gateway-profiles	getAllPaymentGatewayProfiles
GET /api/v1/summits/{id}/payment-gateway-profiles/{payment_profile_id}	getPaymentGatewayProfile
POST /api/v1/summits/{id}/payment-gateway-profiles	createPaymentGatewayProfile
PUT /api/v1/summits/{id}/payment-gateway-profiles/{payment_profile_id}	updatePaymentGatewayProfile
DELETE /api/v1/summits/{id}/payment-gateway-profiles/{payment_profile_id}	deletePaymentGatewayProfile

[caseylocker]

Please double check your security scopes syntax. 4 are missing array brackets.

// WRONG
'summit_payment_gateway_oauth2' =>
    SummitScopes::ReadAllSummitData,
SummitScopes::ReadPaymentProfiles

// Correct
security: [
    [
        'summit_payment_gateway_oauth2' => [
            SummitScopes::ReadAllSummitData,
            SummitScopes::ReadPaymentProfiles
        ]
    ]
],

[matiasperrone-exo]

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

I fixed the missing brackets and the rebase conflicts

[caseylocker]

Approved

[smarcet]

LGTM