Skip to content
Browse files

Add initial Markdown version of API docs

  • Loading branch information...
1 parent 1dd4861 commit e6f64699f06efac524212956d21868f78fc75f7d @birtles birtles committed Mar 19, 2013
Showing with 24 additions and 0 deletions.
  1. +24 −0 docs/api.md
View
24 docs/api.md
@@ -0,0 +1,24 @@
+Wall API
+========
+
+JSON API
+--------
+
+<dl>
+<dt>/api/walls[POST]</dt>
+<dd>Create new wall [session required].
+Parameters:
+* <code>name</code> (Name of wall) [Required]
+* <code>design</code> (ID of design to use) [Required]
+Returns:
+The created wall (same parameters as when getting wall)
+Errors:
+* TBD
+</dd>
+<dt>/api/walls/<wall-id>[GET]</dt>
+<dd>
+Returns the specified wall.
+Errors:
+* <code>not-found</code> - Wall ID wasn't located
+* TBD
+</dd>

0 comments on commit e6f6469

Please sign in to comment.
Something went wrong with that request. Please try again.