Feature | Extend Swagger Coverage for controller PublicCloudsApiController

[matiasperrone-exo]

Task:

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

[caseylocker]

This is generating a schema reference error and breaking doc generation.
The schema: parameter in OpenAPI attributes should NOT include the "Schema" suffix, but the class name should keep it.

In MarketplaceSchemas.php, change:

• schema: 'PublicOrPrivateCloudsResponseSchema' → schema: 'PublicOrPrivateCloudsResponse'
• schema: 'PaginatedPublicOrPrivateCloudsResponseSchema' → schema: 'PaginatedPublicOrPrivateCloudsResponse'

Keep class names as: class PublicOrPrivateCloudsResponseSchema (correct as-is)

See /app/Swagger/schemas.php for examples: schema: 'RSVPInvitation' with class RSVPInvitationSchema

Minor - PHPDoc typo
Line 24: "PrivateCloudsApiController" → "PublicCloudsApiController"

After these fixes, please run php artisan l5-swagger:generate to verify.

[matiasperrone-exo]

This is generating a schema reference error and breaking doc generation. The schema: parameter in OpenAPI attributes should NOT include the "Schema" suffix, but the class name should keep it.

In MarketplaceSchemas.php, change:

• schema: 'PublicOrPrivateCloudsResponseSchema' → schema: 'PublicOrPrivateCloudsResponse'
• schema: 'PaginatedPublicOrPrivateCloudsResponseSchema' → schema: 'PaginatedPublicOrPrivateCloudsResponse'

Keep class names as: class PublicOrPrivateCloudsResponseSchema (correct as-is)

See /app/Swagger/schemas.php for examples: schema: 'RSVPInvitation' with class RSVPInvitationSchema

Minor - PHPDoc typo Line 24: "PrivateCloudsApiController" → "PublicCloudsApiController"

After these fixes, please run php artisan l5-swagger:generate to verify.

Done, thanks!

[caseylocker]

This is approved for merge @matiasperrone-exo @smarcet

[caseylocker]

@matiasperrone-exo On second look this one and #363 both have a few issues that I didn't catch.

• Expand on the 'order' parameter description.

description: 'Order by field(s). Available fields: id, name. Use "-" prefix for descending order.',

• Missing pagination parameters (page, per_page). Add 'page' and 'per_page' parameters to the controller

Example:

new OA\Parameter(
    name: 'page',
    in: 'query',
    required: false,
    description: 'Page number for pagination',
    schema: new OA\Schema(type: 'integer', example: 1)
),
new OA\Parameter(
    name: 'per_page',
    in: 'query',
    required: false,
    description: 'Items per page',
    schema: new OA\Schema(type: 'integer', example: 10, maximum: 100)
),

• Enhance filter operator descriptions (=@ means "starts with", etc.)

format field<op>value. Available fields: name, company. Operators: == (equals), =@ (starts with), @@ (contains).',

• Clarify expand parameter behavior (what gets replaces on expansion)

[caseylocker]

This looks good. @smarcet if you agree please merge.

[smarcet]

LGTM