Feature | Extend Swagger Coverage for controller OAuth2SummitMediaUploadTypeApiController

[matiasperrone-exo]

Task:

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

[caseylocker]

@matiasperrone-exo Parameter mismatch on all 8 endpoints.
// Path uses {id}
path: "/api/v1/summits/{id}/media-upload-types"

// But parameter says 'summit_id' in 'query' - WRONG!
new OA\Parameter(
name: 'summit_id', // Should be 'id'
in: 'query', // Should be 'path'
required: false, // Should be true
...
),

// Correct definition:
new OA\Parameter(
name: 'id',
in: 'path',
required: true,
description: 'Summit ID',
schema: new OA\Schema(type: 'integer')
),

Add operanIds to all the endpoint definitions

Endpoint	Suggested operationId
GET /media-upload-types	getAllMediaUploadTypes
GET /media-upload-types/{id}	getMediaUploadType
POST /media-upload-types	createMediaUploadType
PUT /media-upload-types/{id}	updateMediaUploadType
DELETE /media-upload-types/{id}	deleteMediaUploadType
PUT .../presentation-types/{id}	addMediaUploadTypeToPresentationType
DELETE .../presentation-types/{id}	removeMediaUploadTypeFromPresentationType
POST .../all/clone/{to_summit_id}	cloneMediaUploadTypes

[caseylocker]

I may not have been clear enough regarding the 'id' in 'query' being wrong and that it's actually in the 'path' for all 8 endpoints.

Example:

new OA\Parameter(
    name: 'id',
    in: 'query',      //  WRONG - should be 'path'
    required: false,  //  WRONG - path params must be required: true
    schema: new OA\Schema(type: 'integer'),
    description: 'The summit ID'
), 

Should be:

new OA\Parameter(
    name: 'id',
    in: 'path',       //  Correct
    required: true,   //  Path parameters MUST be required
    schema: new OA\Schema(type: 'integer'),
    description: 'The summit ID'
),

Affected lines:
Lines 94-100 (getAllMediaUploadTypes)
Lines 187-193 (getMediaUploadType)
Lines 253-259 (createMediaUploadType)
Lines 304-310 (updateMediaUploadType)
Lines 362-368 (deleteMediaUploadType)
Lines 531-537 (addMediaUploadTypeToPresentationType)
Lines 610-616 (removeMediaUploadTypeFromPresentationType)
Lines 688-694 (cloneMediaUploadTypes)

[matiasperrone-exo]

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

[caseylocker]

Approved

[smarcet]

@matiasperrone please rebase against main and fix conflicts many thanks

[smarcet]

@matiasperrone-exo please review comments

[romanetar]

LGTM