Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

FIxed error in API documentation #532

Closed
wants to merge 1 commit into from

3 participants

@tick-tock-clock

If one uses the API to get information user, one must visit /user/{username}/overview.json, etc., but the documentation had said one should visit /{username}/overview.json, etc. Updated to show the actual link.

@adebray adebray Fixed an issue in the API documentation. To view information about
a user, one must visit /user/{username}/overview.json, etc., but
the documentation had said one should visit
/{username}/overview.json, etc.
b75d060
@chromakode

Looks good, thanks for catching this! Will merge up soon.

@chromakode

Merged in 87a6a29. Thanks! What's your reddit username?

@chromakode chromakode closed this
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Sep 17, 2012
  1. @adebray

    Fixed an issue in the API documentation. To view information about

    adebray authored
    a user, one must visit /user/{username}/overview.json, etc., but
    the documentation had said one should visit
    /{username}/overview.json, etc.
This page is out of date. Refresh to see the latest.
Showing with 3 additions and 3 deletions.
  1. +3 −3 r2/r2/controllers/listingcontroller.py
View
6 r2/r2/controllers/listingcontroller.py
@@ -628,8 +628,8 @@ def query(self):
@validate(vuser = VExistingUname('username'),
sort = VMenu('sort', ProfileSortMenu, remember = False),
time = VMenu('t', TimeMenu, remember = False))
- @listing_api_doc(section=api_section.users, uri='/{username}/{where}',
- uri_variants=['/{username}/' + where for where in [
+ @listing_api_doc(section=api_section.users, uri='/user/{username}/{where}',
+ uri_variants=['/user/{username}/' + where for where in [
'overview', 'submitted', 'commented',
'liked', 'disliked', 'hidden', 'saved']])
def GET_listing(self, where, vuser, sort, time, **env):
@@ -671,7 +671,7 @@ def GET_listing(self, where, vuser, sort, time, **env):
return ListingController.GET_listing(self, **env)
@validate(vuser = VExistingUname('username'))
- @api_doc(section=api_section.users, uri='/{username}/about', extensions=['json'])
+ @api_doc(section=api_section.users, uri='/user/{username}/about', extensions=['json'])
def GET_about(self, vuser):
"""Return information about the user, including karma and gold status."""
if not is_api() or not vuser:
Something went wrong with that request. Please try again.