Skip to content

Conversation

@matiasperrone-exo
Copy link
Contributor

@matiasperrone-exo matiasperrone-exo commented Sep 30, 2025

Task:

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

Depends on PR #362

@matiasperrone-exo matiasperrone-exo self-assigned this Sep 30, 2025
@smarcet smarcet force-pushed the main branch 2 times, most recently from 4f4b976 to 9ed27c0 Compare September 30, 2025 17:46
@matiasperrone-exo matiasperrone-exo force-pushed the feature/add-openapi-documentation-to-controller-marketplace---privatecloudsapicontroller branch from d46a3d6 to ba24e02 Compare September 30, 2025 19:13
@matiasperrone-exo matiasperrone-exo changed the title Feature | Extend Swagger Coverage for controller /Apis/Marketplace/PrivateCloudsApiController.php Feature | Extend Swagger Coverage for controller Apis/Marketplace/PrivateCloudsApiController.php Sep 30, 2025
@smarcet smarcet force-pushed the main branch 9 times, most recently from c94fc68 to 9a8387b Compare October 2, 2025 17:58
@matiasperrone-exo matiasperrone-exo added the documentation Improvements or additions to documentation label Oct 7, 2025
@matiasperrone-exo matiasperrone-exo force-pushed the feature/add-openapi-documentation-to-controller-marketplace---privatecloudsapicontroller branch from ba24e02 to 91e997c Compare October 7, 2025 21:22
@matiasperrone-exo matiasperrone-exo changed the title Feature | Extend Swagger Coverage for controller Apis/Marketplace/PrivateCloudsApiController.php Feature | Extend Swagger Coverage for controller PrivateCloudsApiController Oct 7, 2025
@matiasperrone-exo matiasperrone-exo marked this pull request as ready for review October 7, 2025 21:22
@matiasperrone-exo matiasperrone-exo force-pushed the feature/add-openapi-documentation-to-controller-marketplace---privatecloudsapicontroller branch from f907c52 to d5ecc7a Compare October 7, 2025 21:27
@matiasperrone-exo matiasperrone-exo force-pushed the feature/add-openapi-documentation-to-controller-marketplace---privatecloudsapicontroller branch from d5ecc7a to 923fa2c Compare October 14, 2025 15:58
@matiasperrone-exo matiasperrone-exo added review Need reviewing from the developer and removed review Need reviewing from the developer labels Nov 10, 2025
Copy link

@caseylocker caseylocker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@smarcet This has been tested along with #362 and passed. Please merge.

Copy link

@caseylocker caseylocker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still needs work.

  • 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.)

...Operators: == (equals), =@ (starts with), @@ (contains).',

  • Clarify expand parameter behavior (what gets replaced on expansion.)

@matiasperrone-exo
Copy link
Contributor Author

All the requested changes were introduced. I don't understand what is missing.

@matiasperrone-exo matiasperrone-exo force-pushed the feature/add-openapi-documentation-to-controller-marketplace---privatecloudsapicontroller branch from 6ce1385 to 894ef11 Compare December 2, 2025 21:09
@matiasperrone-exo matiasperrone-exo force-pushed the feature/add-openapi-documentation-to-controller-marketplace---privatecloudsapicontroller branch from 894ef11 to 7ba5958 Compare December 4, 2025 21:03
Copy link

@caseylocker caseylocker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace response: 200 with response: Response::HTTP_OK then it should be good to go.

@matiasperrone-exo matiasperrone-exo force-pushed the feature/add-openapi-documentation-to-controller-marketplace---privatecloudsapicontroller branch from 7ba5958 to 7fc30ad Compare December 11, 2025 19:25
Copy link

@caseylocker caseylocker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved

Copy link
Collaborator

@smarcet smarcet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@smarcet smarcet merged commit 46e1f13 into main Dec 16, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants