-
Notifications
You must be signed in to change notification settings - Fork 2
Feature | Extend Swagger Coverage for controller OAuth2ElectionsApiController… #419
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
60e41ee to
e8e90dc
Compare
e8e90dc to
09fc7e3
Compare
fa093a1 to
561cbd8
Compare
caseylocker
left a comment
There was a problem hiding this 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
left a comment
There was a problem hiding this 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
812ef91 to
903c6c6
Compare
caseylocker
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approved
|
@andrestejerina97 please review conflicts |
c6ecdd0 to
728ae67
Compare
ref: https://app.clickup.com/t/86b6wkh9k