Skip to content

Conversation

@andrestejerina97
Copy link
Contributor

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

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

6 participants