Feature | Extend Swagger Coverage for controller OAuth2SummitAttendeeNotesApiController

[andrestejerina97]

ref: https://app.clickup.com/t/86b6wkh99

[caseylocker]

Wrong namespace as per project standards:
App\Swagger\security should be App\Swagger\schemas

As per project standards tag "AttendeeNotes" should be "Attendee Notes" - Title Case.

The anyOf is incorrectly used for expandable properties.

//  Current (invalid)
anyOf: [
    new OA\Property(property: 'author_id', type: 'integer', ...),
    new OA\Property(property: 'author', type: 'AdminMember', ...),
    ...
]

// Fix - Document in properties
properties: [
    new OA\Property(property: 'id', type: 'integer'),
    new OA\Property(property: 'created', type: 'integer', description: 'Unix timestamp'),
    new OA\Property(property: 'last_edited', type: 'integer', description: 'Unix timestamp'),
    new OA\Property(property: 'content', type: 'string', description: 'Note content'),
    new OA\Property(property: 'author_id', type: 'integer', description: 'Author member ID. Replaced by author object when using ?expand=author'),
    new OA\Property(property: 'owner_id', type: 'integer', description: 'Owner attendee ID. Replaced by owner object when using ?expand=owner'),
    new OA\Property(property: 'ticket_id', type: 'integer', nullable: true, description: 'Ticket ID. Replaced by ticket object when using ?expand=ticket'),
]

[matiasperrone-exo]

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

[caseylocker]

Let's make it easy. Here's the new block of code for app/Swagger/SummitAttendeeNoteSchemas.php.

#[OA\Schema(
    schema: 'SummitAttendeeNote',
    type: 'object',
    description: 'Note attached to an attendee (admin view with email)',
    required: ['id', 'created', 'last_edited', 'content'],
    properties: [
        new OA\Property(property: 'id', type: 'integer'),
        new OA\Property(property: 'created', type: 'integer', description: 'Unix timestamp'),
        new OA\Property(property: 'last_edited', type: 'integer', description: 'Unix timestamp'),
        new OA\Property(property: 'content', type: 'string', description: 'Note content'),
        new OA\Property(property: 'author_id', type: 'integer', example: 123, description: 'Author member ID. Replaced by author object when using ?expand=author'),
        new OA\Property(property: 'owner_id', type: 'integer', example: 456, description: 'Owner attendee ID. Replaced by owner object when using ?expand=owner'),
        new OA\Property(property: 'ticket_id', type: 'integer', example: 789, nullable: true, description: 'Ticket ID. Replaced by ticket object when using ?expand=ticket'),
    ]
)]
class SummitAttendeeNoteSchema {}

[matiasperrone-exo]

Sorry @caseylocker this one shouldn't been moved as it was not ready yet.
I added the requested code, and moved such schema into its own file to follow the new structure.

Please review it again. thanks.

[caseylocker]

@matiasperrone-exo approved. @smarcet if you agree please merge.

[smarcet]

LGTM