Skip to content

Feature | Extend Swagger Coverage for controller OAuth2ElectionsApiController#419

Merged
romanetar merged 5 commits intomainfrom
feature/add-openapi-documentation-to-controller-oauthelectionsapicontroller
Jan 27, 2026
Merged

Feature | Extend Swagger Coverage for controller OAuth2ElectionsApiController#419
romanetar merged 5 commits intomainfrom
feature/add-openapi-documentation-to-controller-oauthelectionsapicontroller

Conversation

@andrestejerina97
Copy link
Contributor

@andrestejerina97 andrestejerina97 commented Oct 17, 2025

@andrestejerina97 andrestejerina97 self-assigned this Oct 31, 2025
@andrestejerina97 andrestejerina97 force-pushed the feature/add-openapi-documentation-to-controller-oauthelectionsapicontroller branch from 60e41ee to e8e90dc Compare November 18, 2025 22:25
@andrestejerina97 andrestejerina97 force-pushed the feature/add-openapi-documentation-to-controller-oauthelectionsapicontroller branch from e8e90dc to 09fc7e3 Compare November 18, 2025 22:28
@andrestejerina97 andrestejerina97 force-pushed the feature/add-openapi-documentation-to-controller-oauthelectionsapicontroller branch 3 times, most recently from fa093a1 to 561cbd8 Compare November 18, 2025 22:35
caseylocker
caseylocker requested changes Dec 2, 2025
View reviewed changes
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.

Incorrect namespace as per project standards for Swagger
App\Swagger\security should be App\Swagger\schemas

Public endpoints have the wrong path.
Wrong:
/api/v1/elections/current
Right:
/api/public/v1/elections/current

Wrong
/api/v1/elections/current/candidates
Right
/api/public/v1/elections/current/candidates

Wrong
/api/v1/elections/current/candidates/gold
Right
/api/public/v1/elections/current/candidates/gold

caseylocker
caseylocker requested changes Dec 6, 2025
View reviewed changes
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.

The 3 public endpoints are defined in routes/public_api.php which has prefix api/public/v1 (see RouteServiceProvider.php:110).
Documented (incorrect):
/api/v1/elections/current
/api/v1/elections/current/candidates
/api/v1/elections/current/candidates/gold

Actual (correct):
/api/public/v1/elections/current
/api/public/v1/elections/current/candidates
/api/public/v1/elections/current/candidates/gold

@matiasperrone-exo matiasperrone-exo force-pushed the feature/add-openapi-documentation-to-controller-oauthelectionsapicontroller branch from 812ef91 to 903c6c6 Compare December 8, 2025 16:21
caseylocker
caseylocker approved these changes Dec 8, 2025
View reviewed changes
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

@smarcet
Copy link
Collaborator

smarcet commented Dec 8, 2025

@andrestejerina97 please review conflicts

@matiasperrone-exo matiasperrone-exo added the documentation Improvements or additions to documentation label Dec 9, 2025
@matiasperrone-exo matiasperrone-exo changed the title Extend Swagger Coverage for controller OAuth2ElectionsApiController… Feat | Extend Swagger Coverage for controller OAuth2ElectionsApiController… Dec 9, 2025
@matiasperrone-exo matiasperrone-exo changed the title Feat | Extend Swagger Coverage for controller OAuth2ElectionsApiController… Feature | Extend Swagger Coverage for controller OAuth2ElectionsApiController… Dec 9, 2025
@smarcet smarcet force-pushed the main branch 4 times, most recently from c6ecdd0 to 728ae67 Compare December 17, 2025 00:43
@matiasperrone-exo matiasperrone-exo force-pushed the feature/add-openapi-documentation-to-controller-oauthelectionsapicontroller branch from 903c6c6 to 2a5b0cf Compare December 29, 2025 20:11
@matiasperrone-exo matiasperrone-exo changed the title Feature | Extend Swagger Coverage for controller OAuth2ElectionsApiController… Feature | Extend Swagger Coverage for controller OAuth2ElectionsApiController Jan 23, 2026
@matiasperrone-exo matiasperrone-exo force-pushed the feature/add-openapi-documentation-to-controller-oauthelectionsapicontroller branch from 2a5b0cf to 4f18a22 Compare January 23, 2026 20:37
@matiasperrone
chore: Add summary field and fix security schema namespace
b336441 
Signed-off-by: Matias Perrone <github@matiasperrone.com>
@romanetar romanetar merged commit 25622a6 into main Jan 27, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@caseylocker caseylocker caseylocker approved these changes

Assignees

@matiasperrone-exo matiasperrone-exo

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@andrestejerina97 @smarcet @caseylocker @romanetar @matiasperrone-exo @matiasperrone