From 7c0ba5ce2e87e749a2288d6b83c55ec8c8aca9f9 Mon Sep 17 00:00:00 2001
From: Claude <longneck@scratchbook.ch>
Date: Sun, 10 Nov 2013 13:24:54 +0100
Subject: [PATCH] #102: api docs

---
 htdocs/themes/bootstrap/views/api_help.php |  33 ++++---
 htdocs/themes/default/views/api_help.php   |  33 ++++---
 htdocs/themes/geocities/views/api_help.php | 104 +++++++++++----------
 3 files changed, 99 insertions(+), 71 deletions(-)

diff --git a/htdocs/themes/bootstrap/views/api_help.php b/htdocs/themes/bootstrap/views/api_help.php
index 3cd2ea0..28e0cc1 100644
--- a/htdocs/themes/bootstrap/views/api_help.php
+++ b/htdocs/themes/bootstrap/views/api_help.php
@@ -9,18 +9,25 @@
 	<div class="span12">
 	    <p class="explain border">Create pastes from the commandline</p>
 
-		<h2>API URL</h2>
-	    <p class="explain"><code><?php echo site_url('api/create'); ?></code></p>
+        <h2>API URL</h2>
+        <p class="explain"><code><?php echo site_url('api'); ?></code></p>
 
-		<h2>Return values</h2>
-	    <p class="explain">
-		On success, the API returns the paste URL: <code><?php echo site_url('view/[pasteid]'); ?></code><br />
-		On error, the API returns the error message: <code>Error: Missing paste text</code>
-	    </p>
+        <h2>Get paste</h2>
+        <p class="explain"><code><?php echo site_url('api/paste/[pasteid]'); ?></code></p>
 
-		<h2>POST parameters</h2>
-	    <p>&nbsp;</p>
+        <h2>Get random paste</h2>
+        <p class="explain"><code><?php echo site_url('api/random'); ?></code></p>
 
+        <h2>Get recent pastes</h2>
+        <p class="explain"><code><?php echo site_url('api/recent'); ?></code></p>
+
+        <h2>Get trending pastes</h2>
+        <p class="explain"><code><?php echo site_url('api/trending'); ?></code></p>
+
+        <h2>Create a paste</h2>
+        <p class="explain"><code><?php echo site_url('api/create'); ?></code></p>
+
+		<h3>POST parameters</h3>
 		<code>text=[your paste text]</code>
 	    <p class="explain">The paste content. Required.</p>
 
@@ -45,9 +52,13 @@
 		<code>reply=[pasteid]</code>
 	    <p class="explain">Reply to existing paste.</p>
 
-		<h2>Examples</h2>
-	    <p>&nbsp;</p>
+		<h3>Return values</h3>
+	    <p class="explain">
+		On success, the API returns the paste URL: <code><?php echo site_url('view/[pasteid]'); ?></code><br />
+		On error, the API returns the error message: <code>Error: Missing paste text</code>
+	    </p>
 
+		<h2>Examples</h2>
 		<h3>Create paste</h3>
 		<code>curl -d text='this is my text' <?php echo site_url('api/create'); ?></code>
 	    <p class="explain">Create a paste with the text 'this is my text'.</p>
diff --git a/htdocs/themes/default/views/api_help.php b/htdocs/themes/default/views/api_help.php
index 43982c8..5caa976 100644
--- a/htdocs/themes/default/views/api_help.php
+++ b/htdocs/themes/default/views/api_help.php
@@ -5,17 +5,24 @@
     <p class="explain border">Create pastes from the commandline</p>
 
 	<h2>API URL</h2>
+    <p class="explain"><code><?php echo site_url('api'); ?></code></p>
+
+	<h2>Get paste</h2>
+    <p class="explain"><code><?php echo site_url('api/paste/[pasteid]'); ?></code></p>
+
+	<h2>Get random paste</h2>
+    <p class="explain"><code><?php echo site_url('api/random'); ?></code></p>
+
+	<h2>Get recent pastes</h2>
+    <p class="explain"><code><?php echo site_url('api/recent'); ?></code></p>
+
+	<h2>Get trending pastes</h2>
+    <p class="explain"><code><?php echo site_url('api/trending'); ?></code></p>
+
+	<h2>Create a paste</h2>
     <p class="explain"><code><?php echo site_url('api/create'); ?></code></p>
 
-	<h2>Return values</h2>
-    <p class="explain">
-        On success, the API returns the paste URL: <code><?php echo site_url('view/[pasteid]'); ?></code><br />
-        On error, the API returns the error message: <code>Error: Missing paste text</code>
-    </p>
-
-	<h2>POST parameters</h2>
-    <p>&nbsp;</p>
-
+	<h3>POST parameters</h3>
 	<code>text=[your paste text]</code>
     <p class="explain">The paste content. Required.</p>
 
@@ -40,9 +47,13 @@
 	<code>reply=[pasteid]</code>
     <p class="explain">Reply to existing paste.</p>
 
-	<h2>Examples</h2>
-    <p>&nbsp;</p>
+	<h3>Return values</h3>
+    <p class="explain">
+        On success, the API returns the paste URL: <code><?php echo site_url('view/[pasteid]'); ?></code><br />
+        On error, the API returns the error message: <code>Error: Missing paste text</code>
+    </p>
 
+	<h2>Examples</h2>
 	<h3>Create paste</h3>
 	<code>curl -d text='this is my text' <?php echo site_url('api/create'); ?></code>
     <p class="explain">Create a paste with the text 'this is my text'.</p>
diff --git a/htdocs/themes/geocities/views/api_help.php b/htdocs/themes/geocities/views/api_help.php
index 3cd2ea0..5caa976 100644
--- a/htdocs/themes/geocities/views/api_help.php
+++ b/htdocs/themes/geocities/views/api_help.php
@@ -1,69 +1,75 @@
 <?php $this->load->view("defaults/header");?>
 
-<div class="row">
-	<div class="span12">
-		<div class="page-header">
-			<h1>API</h1>
-		</div>
-	</div>
-	<div class="span12">
-	    <p class="explain border">Create pastes from the commandline</p>
+<div class="api">
+	<h1>API</h1>
+    <p class="explain border">Create pastes from the commandline</p>
 
-		<h2>API URL</h2>
-	    <p class="explain"><code><?php echo site_url('api/create'); ?></code></p>
+	<h2>API URL</h2>
+    <p class="explain"><code><?php echo site_url('api'); ?></code></p>
 
-		<h2>Return values</h2>
-	    <p class="explain">
-		On success, the API returns the paste URL: <code><?php echo site_url('view/[pasteid]'); ?></code><br />
-		On error, the API returns the error message: <code>Error: Missing paste text</code>
-	    </p>
+	<h2>Get paste</h2>
+    <p class="explain"><code><?php echo site_url('api/paste/[pasteid]'); ?></code></p>
 
-		<h2>POST parameters</h2>
-	    <p>&nbsp;</p>
+	<h2>Get random paste</h2>
+    <p class="explain"><code><?php echo site_url('api/random'); ?></code></p>
 
-		<code>text=[your paste text]</code>
-	    <p class="explain">The paste content. Required.</p>
+	<h2>Get recent pastes</h2>
+    <p class="explain"><code><?php echo site_url('api/recent'); ?></code></p>
 
-		<code>title=[title]</code>
-	    <p class="explain">Title for the paste.</p>
+	<h2>Get trending pastes</h2>
+    <p class="explain"><code><?php echo site_url('api/trending'); ?></code></p>
 
-		<code>name=[name]</code>
-	    <p class="explain">The author's name.</p>
+	<h2>Create a paste</h2>
+    <p class="explain"><code><?php echo site_url('api/create'); ?></code></p>
 
-		<code>private=1</code>
-	    <p class="explain">Make paste private.</p>
+	<h3>POST parameters</h3>
+	<code>text=[your paste text]</code>
+    <p class="explain">The paste content. Required.</p>
 
-		<code>lang=[language]</code>
-	    <p class="explain">
-		Use alternative syntax highlighting.<br />
-		Possible values: <?php echo $languages; ?>
-	    </p>
+	<code>title=[title]</code>
+    <p class="explain">Title for the paste.</p>
 
-		<code>expire=[minutes]</code>
-	    <p class="explain">Set paste expiration.</p>
+	<code>name=[name]</code>
+    <p class="explain">The author's name.</p>
 
-		<code>reply=[pasteid]</code>
-	    <p class="explain">Reply to existing paste.</p>
+	<code>private=1</code>
+    <p class="explain">Make paste private.</p>
 
-		<h2>Examples</h2>
-	    <p>&nbsp;</p>
+	<code>lang=[language]</code>
+    <p class="explain">
+        Use alternative syntax highlighting.<br />
+        Possible values: <?php echo $languages; ?>
+    </p>
 
-		<h3>Create paste</h3>
-		<code>curl -d text='this is my text' <?php echo site_url('api/create'); ?></code>
-	    <p class="explain">Create a paste with the text 'this is my text'.</p>
+	<code>expire=[minutes]</code>
+    <p class="explain">Set paste expiration.</p>
 
-		<h3>Create paste from a file</h3>
-		<code>curl -d private=1 -d name=Herbert --data-urlencode text@/etc/passwd <?php echo site_url('api/create'); ?></code>
-	    <p class="explain">Create a private paste with the author 'Herbert' and the contents of '/etc/passwd'.</p>
+	<code>reply=[pasteid]</code>
+    <p class="explain">Reply to existing paste.</p>
 
-		<h3>Create paste from a php file</h3>
-		<code>curl -d lang=php --data-urlencode text@main.php <?php echo site_url('api/create'); ?></code>
-	    <p class="explain">Create a paste with PHP syntax highlighting.</p>
+	<h3>Return values</h3>
+    <p class="explain">
+        On success, the API returns the paste URL: <code><?php echo site_url('view/[pasteid]'); ?></code><br />
+        On error, the API returns the error message: <code>Error: Missing paste text</code>
+    </p>
+
+	<h2>Examples</h2>
+	<h3>Create paste</h3>
+	<code>curl -d text='this is my text' <?php echo site_url('api/create'); ?></code>
+    <p class="explain">Create a paste with the text 'this is my text'.</p>
+
+	<h3>Create paste from a file</h3>
+	<code>curl -d private=1 -d name=Herbert --data-urlencode text@/etc/passwd <?php echo site_url('api/create'); ?></code>
+    <p class="explain">Create a private paste with the author 'Herbert' and the contents of '/etc/passwd'.</p>
+
+	<h3>Create paste from a php file</h3>
+	<code>curl -d lang=php --data-urlencode text@main.php <?php echo site_url('api/create'); ?></code>
+    <p class="explain">Create a paste with PHP syntax highlighting.</p>
+
+	<h3>Get paste ;-)</h3>
+	<code>curl <?php echo site_url('view/raw/[pasteid]'); ?></code>
+    <p class="explain">Display paste.</p>
 
-		<h3>Get paste ;-)</h3>
-		<code>curl <?php echo site_url('view/raw/[pasteid]'); ?></code>
-	    <p class="explain">Display paste.</p>
-	</div>
 </div>
 
 <?php $this->load->view("defaults/footer");?>