diff options
| author | Brion Vibber <brion@pobox.com> | 2010-11-03 14:58:33 -0700 |
|---|---|---|
| committer | Brion Vibber <brion@pobox.com> | 2010-11-03 14:58:33 -0700 |
| commit | 51a756c2117ec6804b38bea29f56dcc585781f47 (patch) | |
| tree | 3c383086cc949e6b99f590d6c680144fe62950eb /actions | |
| parent | a3928e5583aa0e2f4a429a6322bfc094ca907fd2 (diff) | |
Fix ticket #2860: clarify API doc comments for 'source' parameter's interaction with OAuth on api/statuses/update
Diffstat (limited to 'actions')
| -rw-r--r-- | actions/apistatusesupdate.php | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/actions/apistatusesupdate.php b/actions/apistatusesupdate.php index 666ed9fa3..1a3b54900 100644 --- a/actions/apistatusesupdate.php +++ b/actions/apistatusesupdate.php @@ -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. |