Add the new /api/links endpoint
#4524
Conversation
| user_url = request.route_url('stream.user_query', user='_user_') | ||
| user_url = user_url.replace('_user_', ':user') | ||
|
|
||
| return { |
There was a problem hiding this comment.
I think it would be nice if this endpoint was self-documenting in a similar way to the /api endpoint. We could do this by keeping the key as the route name but changing the value to a { url, desc } object, consistent with the /api endpoint. Thoughts?
There was a problem hiding this comment.
We actually discussed this on Slack way back (one of the Slack convo's that the product-backlog issue for this links to, I think) because I wanted each link to be an object with url and method, but the method would always be GET, and these links aren't API endpoints like the /api ones are they're just links to be rendered as hrefs and the browser directed to, so we decided on a simple list of name -> URL. It's the same as what the github API uses.
What would be the benefit of adding descs to these, beyond the already-existing descriptiveness of the name and the URL itself?
account.settings: {
url: "http://localhost:5000/account/settings",
desc: "The account settings page"
}I'm not sure it adds much.
I suppose we could add, in the desc or in an additional key, that groups.leave is deprecated. But I'm not sure anyone would notice it. A developer programs their client to use the links API once, later on deprecated is added to the desc of one of the links, but unless the developer is manually looking at the /api/links output again after having already finished programming their client to use it, they aren't likely to notice are they? (Of course developers writing new clients might see it...)
There was a problem hiding this comment.
@seanh - OK, if we've already had the discussion I don't have a strong enough opinion to justify rehashing it. Let's go with this as-is.
| return { | ||
| 'account.settings': request.route_url('account'), | ||
| 'forgot-password': request.route_url('forgot_password'), | ||
| 'groups.leave': group_leave_url, |
There was a problem hiding this comment.
If we follow the suggestion above to add a description to each link, I would then explicitly call out the fact that groups.leave is deprecated.
Codecov Report
@@ Coverage Diff @@
## master #4524 +/- ##
==========================================
+ Coverage 94.89% 94.89% +<.01%
==========================================
Files 352 352
Lines 18965 18988 +23
Branches 1102 1102
==========================================
+ Hits 17996 18019 +23
+ Misses 868 865 -3
- Partials 101 104 +3
Continue to review full report at Codecov.
|
|
I've added the new feature flag to this but note that there's an issue over in the client PR with the client being able to actually use this feature flag |
Add the new
/api/linksendpoint and add a link to this endpoint to the existing/apiendpoint. This new endpoint will be used by the client to get the URL templates for generating URLs to HTML pages of the web service. This is part of hypothesis/product-backlog#215