diff --git a/actions/apitimelinepublic.php b/actions/apitimelinepublic.php index 9034614253..30f9f4cda6 100644 --- a/actions/apitimelinepublic.php +++ b/actions/apitimelinepublic.php @@ -55,6 +55,95 @@ require_once INSTALLDIR . '/lib/apiprivateauth.php'; * @link http://status.net/ */ +/* External API usage documentation. Please update when you change how this method works. */ + +/*! @page publictimeline statuses/public_timeline + + @section Description + Returns the 20 most recent notices from users throughout the system who have + uploaded their own avatars. Depending on configuration, it may or may not + not include notices from automatic posting services. + + @par URL patterns + @li /api/statuses/public_timeline.:format + + @par Formats (:format) + xml, json, rss, atom + + @par HTTP Method(s) + GET + + @par Requires Authentication + No + + @param since_id (Optional) Returns only statuses with an ID greater + than (that is, more recent than) the specified ID. + @param max_id (Optional) Returns only statuses with an ID less than + (that is, older than) or equal to the specified ID. + @param count (Optional) Specifies the number of statuses to retrieve. + @param page (Optional) Specifies the page of results to retrieve. + + @sa @ref apiroot + + @subsection usagenotes Usage notes + @li The URL pattern is relative to the @ref apiroot. + @li The XML response uses GeoRSS + to encode the latitude and longitude (see example response below ). + + @subsection exampleusage Example usage + + @verbatim + curl http://identi.ca/api/statuses/friends_timeline/evan.xml?count=1&page=2 + @endverbatim + + @subsection exampleresponse Example response + + @verbatim + + + + @skwashd oh, commbank reenabled me super quick both times. but disconcerting when you don't expect it though + false + Sat Apr 17 00:49:12 +0000 2010 + 28838393 + xmpp + 28838456 + 39303 + skwashd + + false + + 44517 + joshua may + notjosh + + + http://avatar.identi.ca/44517-48-20090321004106.jpeg + + false + 17 + + + + + + 20 + Sat Mar 21 00:40:25 +0000 2009 + 0 + 0 + UTC + + false + 100 + false + false + + + [....] + +@endverbatim +*/ + class ApiTimelinePublicAction extends ApiPrivateAuthAction { diff --git a/lib/apiaction.php b/lib/apiaction.php index f206f1d5c4..a3c34a91bf 100644 --- a/lib/apiaction.php +++ b/lib/apiaction.php @@ -44,6 +44,7 @@ @subsection timelinesmethods_sec Timeline Methods + @li @ref publictimeline @li @ref friendstimeline @subsection statusmethods_sec Status Methods