PsychoticNinja/Stikked
1
0
Fork 0
mirror of https://github.com/claudehohl/Stikked.git synced 2025-04-25 12:31:06 -05:00
Code Issues Projects Releases Wiki Activity

#102: api docs

Browse Source
This commit is contained in:
Claude 2013-11-10 13:24:54 +01:00
parent 9804cb15ee
commit 7c0ba5ce2e
3 changed files with 99 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
htdocs/themes/bootstrap/views/api_help.php
View File

@ -10,17 +10,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>
@ -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>

33
htdocs/themes/default/views/api_help.php
View File

@ -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>

42
htdocs/themes/geocities/views/api_help.php
View File

@ -1,26 +1,28 @@
<?php $this->load->view("defaults/header");?>
<div class="row">
<div class="span12">
<div class="page-header">
<div class="api">
<h1>API</h1>
</div>
</div>
<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'); ?></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>
@ -45,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>
@ -63,7 +69,7 @@
<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");?>