From 5bd2af53823b2bc6b594c5f8c52cd1031efdf25a Mon Sep 17 00:00:00 2001
From: Claude <longneck@scratchbook.ch>
Date: Thu, 19 Apr 2012 11:02:07 +0200
Subject: [PATCH] api docs

---
 htdocs/application/views/api_help.php        | 36 ++++++++++++++++++--
 htdocs/application/views/defaults/header.php |  1 +
 2 files changed, 35 insertions(+), 2 deletions(-)

diff --git a/htdocs/application/views/api_help.php b/htdocs/application/views/api_help.php
index 1198d56..78fe038 100755
--- a/htdocs/application/views/api_help.php
+++ b/htdocs/application/views/api_help.php
@@ -1,8 +1,40 @@
 <?php $this->load->view("defaults/header");?>
 
-<div class="about">
+<div class="api">
 	<h1>API</h1>
-	Todo.
+    <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>POST parameters</h2>
+
+	<code>text=[your paste text]</code>
+    <p class="explain">The paste content. Required.</p>
+
+	<code>name=[name]</code>
+    <p class="explain">The author's name.</p>
+
+	<code>private=1</code>
+    <p class="explain">Make paste private.</p>
+
+	<h2>Return values</h2>
+    <p class="explain">
+        On success, the API returns the paste URL in JSON format: <code>{"url":"<?php echo site_url('view/68582786'); ?>"}</code><br />
+        On error, the API returns the error message in JSON format: <code>{"error":"missing paste text"}</code>
+    </p>
+
+	<h2>Examples</h2>
+    <p>&nbsp;</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>
+
+	<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>
+
 </div>
 
 <?php $this->load->view("defaults/footer");?>
diff --git a/htdocs/application/views/defaults/header.php b/htdocs/application/views/defaults/header.php
index 38ffb3e..015d5bd 100755
--- a/htdocs/application/views/defaults/header.php
+++ b/htdocs/application/views/defaults/header.php
@@ -35,6 +35,7 @@ $this->carabiner->display('css');
 						<?php $l = $this->uri->segment(1)?>
 						<li><a <?php if($l == ""){ echo 'class="active"'; }?> href="<?php echo base_url()?>" title="Create A New Paste">Create</a></li>
 						<li><a <?php if($l == "lists" || $l == "view" and $this->uri->segment(2) != "options"){ echo 'class="active"'; }?> href="<?php echo site_url('lists'); ?>" title="Recent Pastes">Recent</a></li>
+						<li><a  <?php if($l == "api"){ echo 'class="active"'; }?> href="<?php echo site_url('api'); ?>" title="API">API</a></li>
 						<li><a  <?php if($l == "about"){ echo 'class="active"'; }?> href="<?php echo site_url('about'); ?>" title="About">About</a></li>
 					</ul>
 				</div>