feat(api): add public endpoint for querying wikis #635
Conversation
m90
force-pushed
the
fr/public-wiki-endpoint
branch
15 times, most recently
from
ff49ecf
to
2c75c93
Compare
| */ | ||
| public function show($id) | ||
| { | ||
| return new PublicWikiResource(Wiki::findOrFail($id)); |
There was a problem hiding this comment.
This allows clients to look up wikis by their integer id. Instead, we could also look them up by domain and hide the id from the public, not sure if I have a preference.
m90
force-pushed
the
fr/public-wiki-endpoint
branch
from
406659e
to
a984c35
Compare
routes/api.php
Outdated
| @@ -22,6 +22,8 @@ | |||
| $router->post('user/resetPassword', ['uses' => 'Auth\ResetPasswordController@reset']); | |||
| $router->post('contact/sendMessage', ['uses' => 'ContactController@sendMessage']); | |||
|
|
|||
| $router->apiResource('wiki', 'PublicWikiController'); | |||
There was a problem hiding this comment.
Not sure if this needs stricter throttling than the default one? Current settings allows for 45 request to be made in one minute per IP. I am not sure however if we actually see the forwarded IP or if this is effectively a global setting, throttling the "ingress client".
m90
force-pushed
the
fr/public-wiki-endpoint
branch
10 times, most recently
from
fa3d97a
to
1d752fa
Compare
m90
force-pushed
the
fr/public-wiki-endpoint
branch
4 times, most recently
from
26661e7
to
9717f24
Compare
| 'is_featured' => 'boolean', | ||
| 'is_active' => 'boolean', | ||
| 'per_page' => 'numeric', | ||
| 'page' => 'numeric' |
There was a problem hiding this comment.
The page parameter is somehow magically picked up by Laravel itself, we never pass it on or look at it. Not sure if we need to validate it, but I thought it might be good to put it here so all possible query params are documented here.
| } | ||
|
|
||
| if (array_key_exists('is_active', $params) && $params['is_active']) { | ||
| $query = $query->whereRelation('wikiSiteStats', 'pages', '>', 0); |
There was a problem hiding this comment.
The ticket currently say > 1, I need to double check if this is correct or needs to be changed.
There was a problem hiding this comment.
The ticket is correct. I fixed this to be > 1
m90
force-pushed
the
fr/public-wiki-endpoint
branch
2 times, most recently
from
3d044a5
to
ee5c4bd
Compare
m90
force-pushed
the
fr/public-wiki-endpoint
branch
from
ee5c4bd
to
e692b26
Compare
Ticket https://phabricator.wikimedia.org/T344581
Pagination behavior is documented here: https://laravel.com/docs/8.x/eloquent-resources#pagination, i.e. the UI can pass
per_pageandpage, and reads cursor info in themetaproperty.Available
sortoptions arepagesandsitename(default) withdirectionvalues ofasc(default) anddesc.