Feature | Extend Swagger Coverage for controller OAuth2SummitRegistrationInvitationApiController

[matiasperrone-exo]

Task:

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

[caseylocker]

Wrong Namespace in Security Schema
File: app/Swagger/Security/SummitRegistrationInvitationAuthSchema.php
namespace App\Swagger\Security; // WRONG
Should be:
namespace App\Swagger\schemas; // CORRECT

Protected endpoints use 'authz_groups' instead of the standard 'required-groups':
x: [
'authz_groups' => [ // Wrong key name
IGroup::SuperAdmins,
...
]
],
Should be:
x: [
'required-groups' => [ // Correct key name
IGroup::SuperAdmins,
...
]
],

[matiasperrone-exo]

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

[caseylocker]

@matiasperrone this is looking good and is very close.
Since this is using OpenAPI 3.0 the "tags" property in SummitRegistrationSchemas.php is invalid.

// Invalid - only valid for OpenAPI 3.1
new OA\Property(property: "tags", type: "array", items: new OA\Items(type: ["integer", "string"]), ...)

Either simplify for integers only:

new OA\Property(
    property: "tags",
    type: "array",
    items: new OA\Items(type: "integer"),
    description: "Array of Tag IDs. Full Tag objects when ?expand=tags",
    nullable: true
)

Or use oneOf

new OA\Property(
    property: "tags",
    type: "array",
    items: new OA\Items(
        oneOf: [
            new OA\Schema(type: "integer"),
            new OA\Schema(type: "string")
        ]
    ),
    description: "Array of Tag IDs or names when expanded",
    nullable: true
)

[matiasperrone-exo]

Moved to OpenAPI 3.1. please approve PR.

[caseylocker]

Please be consistent with http response codes. I haven't been calling all of these out but I'm going to be doing that again.

ALL responses should use the response constants rather than the raw numbers.
"response: 200" should be "Response::HTTP_OK"
"response: 204" should be "Response::HTTP_NO_CONTENT"
"response: 201" should be "Response::HTTP_CREATED"

There are about 13 occurrences here that need to be updated.

[caseylocker]

Approved too soon. @matiasperrone-exo This is failing on documentation generation.

[smarcet]

LGTM

[smarcet]

LGTM