Feature | Extend Swagger Coverage for controller RemoteCloudsApiController

[matiasperrone-exo]

Task:

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

[smarcet]

@matiasperrone-exo review comments

[matiasperrone-exo]

@smarcet please review, all the requested changes were incorporated.

[matiasperrone-exo]

Hello @smarcet

The changes were introduced from main, and as requested the schemas were move to its schema file. Please review the PR again

[caseylocker]

@matiasperrone-exo
In "RemoteCloudsResponse" these are invalid property types - 'Company', 'MarketPlaceType', 'MarketPlaceReview' - and render with "Unknown Type:" in the Swagger documentation. Should use ref.
'company' => new OA\Property(property: 'company', type: 'Company'),
'type' => new OA\Property(property: 'type', type: 'MarketPlaceType'),
'reviews' => new OA\Property(property: 'reviews', type: 'array', items: new OA\Items(type: 'MarketPlaceReview')),

Example:
'company' => new OA\Property(
property: 'company',
ref: '#/components/schemas/Company',
description: 'Company object (when expanded)',
nullable: true
),
'type' => new OA\Property(
property: 'type',
ref: '#/components/schemas/MarketPlaceType',
description: 'Marketplace type object (when expanded)',
nullable: true
),
'reviews' => new OA\Property(
property: 'reviews',
type: 'array',
items: new OA\Items(ref: '#/components/schemas/MarketPlaceReview'),
description: 'Customer reviews (when expanded)',
nullable: true
),

Expanded parameters should list "reviews" as it's in the schema and but not currently in the list.

Be more descriptive - in keeping with other PRs - with the filter expressions:
description: 'Filter expressions in the format fieldvalue. Available fields: name, company. Operators: == (equals), =@ (starts with), @@ (contains).',

Is it's missing the 'page' and 'per_page' parameters.

[caseylocker]

Globally:
response: 200, // Should be Response::HTTP_OK

app/Swagger/MarketplaceSchemas.php:
Invalid types used: 'company' and 'MarketPlaceType', 'MarketPlaceReview'
For 'company' and 'MarketPlaceType' either reference an existing/new schema or just use the id integers and document the other on expansion.
For 'reviews', since the schema exists:

'reviews' => new OA\Property(
    property: 'reviews', 
    type: 'array', 
    items: new OA\Items(ref: '#/components/schemas/MarketPlaceReview'),
    description: 'Approved reviews. Only available with ?relations=reviews&expand=reviews'
),

[caseylocker]

Approved

[smarcet]

@matiasperrone this branch need a rebase against main and fixing the conflicts

[matiasperrone-exo]

@smarcet now it is rebased!