-
Notifications
You must be signed in to change notification settings - Fork 2
Feature | Extend Swagger Coverage for controller PrivateCloudsApiController
#363
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Feature | Extend Swagger Coverage for controller PrivateCloudsApiController
#363
Conversation
4f4b976 to
9ed27c0
Compare
d46a3d6 to
ba24e02
Compare
c94fc68 to
9a8387b
Compare
ba24e02 to
91e997c
Compare
PrivateCloudsApiController
f907c52 to
d5ecc7a
Compare
d5ecc7a to
923fa2c
Compare
caseylocker
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
caseylocker
left a comment
There was a problem hiding this 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.)
|
All the requested changes were introduced. I don't understand what is missing. |
6ce1385 to
894ef11
Compare
894ef11 to
7ba5958
Compare
caseylocker
left a comment
There was a problem hiding this 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.
7ba5958 to
7fc30ad
Compare
caseylocker
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approved
smarcet
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Task:
Ref: https://app.clickup.com/t/86b6wkg8t
Depends on PR #362