Skip to content

Comments

Feat | Add OpenAPI documentation for OAuth2RocketChatSSOApiController v1#112

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

Feat | Add OpenAPI documentation for OAuth2RocketChatSSOApiController v1#112
matiasperrone-exo wants to merge 1 commit intomainfrom
feat/openapi----api-v1---oauth2rocketchatssoapicontroller

Conversation

@matiasperrone-exo
Copy link
Contributor

@matiasperrone-exo matiasperrone-exo added the documentation Improvements or additions to documentation label Feb 12, 2026
@matiasperrone-exo matiasperrone-exo self-assigned this Feb 12, 2026
@matiasperrone-exo matiasperrone-exo added the documentation Improvements or additions to documentation label Feb 12, 2026
@matiasperrone-exo matiasperrone-exo marked this pull request as ready for review February 12, 2026 21:13
@matiasperrone-exo matiasperrone-exo force-pushed the feat/openapi----api-v1---oauth2rocketchatssoapicontroller branch from 1292905 to 5ce71f5 Compare February 17, 2026 21:32
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

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.

The RocketChatUserProfileSchema is created but never referenced from the endpoint's HTTP_OK response — the response uses a bare new OA\JsonContent() instead. An orphaned empty schema adds noise to the generated spec without providing value to API consumers.

Either wire it up by adding ref: '#/components/schemas/RocketChatUserProfile' to the JsonContent and marking the schema with additionalProperties: true (since the response proxies Rocket Chat's dynamic payload), or delete RocketChatUserProfileSchema.php entirely and keep the descriptive comment on the empty JsonContent.

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