Feature | Extend Swagger Coverage for controller OAuth2SummitProposedScheduleApiController

[matiasperrone-exo]

Task:

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

[caseylocker]

@matiasperrone-exo

As per our decision to limit sub schemas to keep this as simple as possible, and since the use of anyOf is incorrect here...
Remove the anyOf blocks and keep only the _id properties with descriptions noting expansion behavior.

[matiasperrone-exo]

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

[caseylocker]

Invalid OpenAPI types in SummitProposedScheduleSchemas.php
The idea here was not to keep the invalid types, like 'type: "SummitAbstractLocation"' or change them to refs but simplify it to describe the expansion.
Like this:

#[OA\Schema(
    schema: "SummitProposedScheduleAllowedLocation",
    properties: [
        new OA\Property(property: "id", type: "integer", example: 1),
        new OA\Property(property: "created", type: "integer", description: "Unix timestamp", example: 1640995200),
        new OA\Property(property: "last_edited", type: "integer", description: "Unix timestamp", example: 1640995200),
        new OA\Property(property: "allowed_timeframes", type: "array", items: new OA\Items(type: "integer"), description: "Array of SummitProposedScheduleAllowedDay IDs. Full objects when ?expand=allowed_timeframes"),
        new OA\Property(property: "location_id", type: "integer", example: 10, description: "SummitAbstractLocation ID. Full object in 'location' property when ?expand=location"),
        new OA\Property(property: "track_id", type: "integer", example: 5, description: "PresentationCategory ID. Full object in 'track' property when ?expand=track"),
    ]
)]
class SummitProposedScheduleAllowedLocation {}

[caseylocker]

The getProposedScheduleEvents endpoint only requires OAuth2 authentication (via the api middleware from RouteServiceProvider), not admin group membership.

Remove the x: ['required-groups' => [...]] block since the route does not have auth.user middleware. The endpoint only requires OAuth2 authentication, not group-based authorization.

[matiasperrone-exo]

The getProposedScheduleEvents endpoint only requires OAuth2 authentication (via the api middleware from RouteServiceProvider), not admin group membership.

Remove the x: ['required-groups' => [...]] block since the route does not have auth.user middleware. The endpoint only requires OAuth2 authentication, not group-based authorization.

Hello @caseylocker, thanks for your comments, according with the seeder (which is our main source of information) that is not correct:

Do you want that I dig deeper?
Or just remove such groups even when the seeder says otherwise?

[caseylocker]

The getProposedScheduleEvents endpoint only requires OAuth2 authentication (via the api middleware from RouteServiceProvider), not admin group membership.
Remove the x: ['required-groups' => [...]] block since the route does not have auth.user middleware. The endpoint only requires OAuth2 authentication, not group-based authorization.

Hello @caseylocker, thanks for your comments, according with the seeder (which is our main source of information) that is not correct:

Do you want that I dig deeper? Or just remove such groups even when the seeder says otherwise?

Looks like you're correct. Good catch @matiasperrone-exo. Please ignore that request.
I would like to see the raw response codes use the constants instead though.
So please update any instance of the following at the 7 instances:
"response: 200" should be "Response::HTTP_OK"
"response: 201" should be "Response::HTTP_CREATED"
"response: 204" should be "Response::HTTP_NO_CONTENT"

[caseylocker]

This is approved.

[smarcet]

LGTM