Improve comments for remaining legacy API endpoints.

(imported from commit 923b30b4c2a8e724ce8262e9eaeb69887572fd4b)
This commit is contained in:
Tim Abbott
2013-12-11 14:50:49 -05:00
parent 0a7c6ac261
commit 08ac439d0f
2 changed files with 8 additions and 5 deletions

View File

@@ -160,9 +160,10 @@ def zulip_internal(view_func):
return view_func(request, *args, **kwargs)
return _wrapped_view_func
# authenticated_api_view will add the authenticated user's user_profile to
# the view function's arguments list, since we have to look it up
# anyway.
# authenticated_api_view will add the authenticated user's
# user_profile to the view function's arguments list, since we have to
# look it up anyway. It is deprecated in favor on the REST API
# versions.
def authenticated_api_view(view_func):
@csrf_exempt
@require_post

View File

@@ -139,10 +139,12 @@ urlpatterns += patterns('zerver.views',
url(r'^json/set_muted_topics$', 'json_set_muted_topics'),
url(r'^json/set_avatar$', 'json_set_avatar'),
# These are json format views used by the API. They require an API key.
# This json format view is used by the LEGACY pre-REST API. It
# requires an API key.
url(r'^api/v1/send_message$', 'api_send_message'),
# This json format view used by the API accepts a username password/pair and returns an API key.
# This json format view used by the mobila apps accepts a username
# password/pair and returns an API key.
url(r'^api/v1/fetch_api_key$', 'api_fetch_api_key'),
# These are integration-specific web hook callbacks