chore: remove z param from the API #2591
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ioslife
commented
Aug 4, 2024
wescopeland
approved these changes
Aug 6, 2024
Jamiras
reviewed
Aug 15, 2024
app/Exceptions/Handler.php
Outdated
| @@ -72,7 +72,6 @@ protected function buildExceptionContext(Throwable $e): array | |||
| unset($params['p']); | |||
| } | |||
| } elseif (str_contains($context['url'], '/API/')) { | |||
| unset($params['z']); | |||
There was a problem hiding this comment.
We should probably still exclude this from the exception log, as consumers will likely continue to pass it for quite some time.
There was a problem hiding this comment.
Yeah, that's a good point. Will revert.
Jamiras
approved these changes
Aug 17, 2024
|
There was a merge conflict here in a file I didn't touch, but seems to be resolved now |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
After recognizing that the username (z) param in the API calls doesn't affect anything, I started investigating why we weren't ensuring that the provided API key (y param) matches
User->APIKey. I thought this to be a bug, but it appears that Laravel doesn't need the username.It looks like the way that the auth guards are designed (by Laravel, not RA), providing an API token is all you need. https://laravel.com/docs/5.8/api-authentication
From what I am reading online, there doesn't seem to be any reason to include username and API token. From what I can tell, we aren't even ingesting the z= value anywhere in our API for auth purposes.
AuthServiceProvider.php seems like it used to with an override, but even that isn't set up right (it is also commented out).
TL;DR – the z param on API requests seems to be unnecessary. The API token should be the sole authentication method.