Skip to content

Comments

Feat | Add OpenAPI documentation for OAuth2GroupApiController#109

Open
matiasperrone-exo wants to merge 1 commit intomainfrom
feat/openapi----api-v1---oauth2groupapicontroller
Open

Feat | Add OpenAPI documentation for OAuth2GroupApiController#109
matiasperrone-exo wants to merge 1 commit intomainfrom
feat/openapi----api-v1---oauth2groupapicontroller

Conversation

@matiasperrone-exo
Copy link
Contributor

@matiasperrone-exo matiasperrone-exo commented Feb 11, 2026

Task:

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

Endpoints:

Method Endpoint Method Name
GET,HEAD api/v1/groups getAll

@matiasperrone-exo matiasperrone-exo added the documentation Improvements or additions to documentation label Feb 11, 2026
@matiasperrone-exo matiasperrone-exo self-assigned this Feb 11, 2026
@matiasperrone-exo matiasperrone-exo force-pushed the feat/openapi----api-v1---oauth2groupapicontroller branch 2 times, most recently from 25a4f67 to 853feef Compare February 12, 2026 19:19
@smarcet smarcet force-pushed the main branch 2 times, most recently from ae79f5e to 4b5b726 Compare February 12, 2026 20:00
@matiasperrone-exo matiasperrone-exo force-pushed the feat/openapi----api-v1---oauth2groupapicontroller branch 4 times, most recently from 28dad35 to 04d4dab Compare February 18, 2026 21:08
Copy link

@martinquiroga-exo martinquiroga-exo left a comment

Choose a reason for hiding this comment

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

LGTM

@matiasperrone-exo please add the clickup card link to this PR.

@matiasperrone-exo matiasperrone-exo force-pushed the feat/openapi----api-v1---oauth2groupapicontroller branch from 04d4dab to d4856c2 Compare February 19, 2026 20:34
@matiasperrone-exo matiasperrone-exo force-pushed the feat/openapi----api-v1---oauth2groupapicontroller branch from d4856c2 to 16a5eb6 Compare February 19, 2026 21:01
Copy link
Contributor

@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.

  1. Move #[OA\Get] from the class to getAllSerializerType() — Follow the pattern in OAuth2UserApiController where the annotation sits on getAllSerializerType(), not on the class declaration.
  2. 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.
  3. 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.").

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.

3 participants