From: Craig Andrews Date: Wed, 13 Oct 2010 03:36:33 +0000 (-0400) Subject: Add a doc page that links to the StatusNet wiki API page X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=f79dbaf9a76c10969dbc45fd43a0bb26f5f64ed4;p=quix0rs-gnu-social.git Add a doc page that links to the StatusNet wiki API page Add a redirect action that merely redirects to another action Redirect /api to /doc/api so users don't get the "lame" "No such user" error message --- diff --git a/actions/redirect.php b/actions/redirect.php new file mode 100644 index 0000000000..9cb03708db --- /dev/null +++ b/actions/redirect.php @@ -0,0 +1,71 @@ +. + * + * @category Action + * @package StatusNet + * @author Craig Andrews + * @copyright 2010 StatusNet, Inc. + * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0 + * @link http://status.net/ + */ + +if (!defined('STATUSNET')) { + exit(1); +} + +/** + * Administer site access settings + * + * @category Action + * @package StatusNet + * @author Craig Andrews + * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0 + * @link http://status.net/ + */ + +class RedirectAction extends Action +{ + /** + * These pages are read-only. + * + * @param array $args unused. + * + * @return boolean read-only flag (false) + */ + + function isReadOnly($args) + { + return true; + } + + /** + * Handle a request + * + * @param array $args array of arguments + * + * @return nothing + */ + function handle($args) + { + common_redirect(common_local_url($this->arg('nextAction'), $this->arg('args'))); + } +} + diff --git a/doc-src/api b/doc-src/api new file mode 100644 index 0000000000..5c8815bddd --- /dev/null +++ b/doc-src/api @@ -0,0 +1,6 @@ + + + + +%%site.name%% provides an API that applications can use to interact with it. +More information about this API can be found on the [StatusNet Wiki](http://status.net/wiki/API). diff --git a/doc-src/help b/doc-src/help index 024d473780..6d12b4cd76 100644 --- a/doc-src/help +++ b/doc-src/help @@ -35,3 +35,4 @@ Here are some documents that you might find helpful in understanding * [Source](%%doc.source%%) - How to get the StatusNet source code * [Badge](%%doc.badge%%) - How to put a StatusNet badge on your blog or homepage * [Bookmarklet](%%doc.bookmarklet%%) - Bookmarklet for posting Web pages +* [API](%%doc.api%%) - API for use by external clients diff --git a/lib/router.php b/lib/router.php index eebe2beea6..54d3d0f68b 100644 --- a/lib/router.php +++ b/lib/router.php @@ -322,6 +322,11 @@ class Router // statuses API + $m->connect('api', + array('action' => 'Redirect', + 'nextAction' => 'doc', + 'args' => array('title' => 'api'))); + $m->connect('api/statuses/public_timeline.:format', array('action' => 'ApiTimelinePublic', 'format' => '(xml|json|rss|atom)'));