GNUsocial
/
gnu-social
4
0
Fork 1
Code Issues Releases Wiki Activity

Fix ticket #2860: clarify API doc comments for 'source' parameter's interaction with OAuth on api/statuses/update

This commit is contained in:
Brion Vibber 2010-11-03 14:58:33 -07:00
parent a3928e5583
commit 51a756c211
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
actions/apistatusesupdate.php
View File

@ -55,7 +55,7 @@
Yes
@param status (Required) The URL-encoded text of the status update.
@param source (Optional) The source of the status.
@param source (Optional) The source application name, if using HTTP authentication or an anonymous OAuth consumer.
@param in_reply_to_status_id (Optional) The ID of an existing status that the update is in reply to.
@param lat (Optional) The latitude the status refers to.
@param long (Optional) The longitude the status refers to.
@ -67,7 +67,7 @@
@subsection usagenotes Usage notes
@li The URL pattern is relative to the @ref apiroot.
@li If the @e source parameter is not supplied the source of the status will default to 'api'.
@li If the @e source parameter is not supplied the source of the status will default to 'api'. When authenticated via a registered OAuth application, the application's registered name and URL will always override the source parameter.
@li The XML response uses <a href="http://georss.org/Main_Page">GeoRSS</a>
to encode the latitude and longitude (see example response below <georss:point>).
@li Data uploaded via the @e media parameter should be multipart/form-data encoded.