Feat | Add OpenAPI documentation for OAuth2GroupApiController#109
Feat | Add OpenAPI documentation for OAuth2GroupApiController#109matiasperrone-exo wants to merge 2 commits intomainfrom
Conversation
25a4f67 to
853feef
Compare
ae79f5e to
4b5b726
Compare
28dad35 to
04d4dab
Compare
martinquiroga-exo
left a comment
There was a problem hiding this comment.
LGTM
@matiasperrone-exo please add the clickup card link to this PR.
04d4dab to
d4856c2
Compare
d4856c2 to
16a5eb6
Compare
caseylocker
left a comment
There was a problem hiding this comment.
- Move #[OA\Get] from the class to getAllSerializerType() — Follow the pattern in OAuth2UserApiController where the annotation sits on getAllSerializerType(), not on the class declaration.
- Use the existing user_oauth2 security scheme instead of creating OAuth2GroupsSecurity — user_oauth2 already covers Groups. Add IGroupScopes::ReadAll and IGroupScopes::Write to the scopes in
app/Swagger/Security/UsersOAuth2Schema.php and reference user_oauth2 in the endpoint annotation. Remove OAuth2GroupApiControllerSecuritySchema.php. - Document the lack of route middleware — GET /api/v1/groups has no middleware in routes/api.php. The description field should note this (e.g., "No route-level middleware enforcement; requires valid OAuth2 bearer
token only.").
|
Bullets 1 and 3 were incorporated:
I have some questions regarding your comment (2nd bullet):
This PR does not have UsersOAuth2Schema present, if I disregard that issue, are you sure you want to use the scopes from Users into Groups? Taking into account that one comes from App\libs\OAuth2\IUserScopes and the this one (OAuth2GroupsSecurity) from App\libs\OAuth2\IGroupScopes. If you are sure I will make the change. |
Task:
Ref: https://app.clickup.com/t/86b8e6jrj
Endpoints: