Skip to content

Commit

Permalink
added documentation to repo
Browse files Browse the repository at this point in the history
  • Loading branch information
garethr committed Dec 28, 2008
1 parent fa9c953 commit 6099af1
Show file tree
Hide file tree
Showing 4 changed files with 83 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/source/admin/index.txt
@@ -0,0 +1,21 @@
====================
About the Admin Site
====================

The backend provides a simple web based interface to the webservice.

/
-

:GET: display list of admin options

/add/
-----

:GET: display html form
:POST: display html success message

/delete/{id}/
-------------

:POST: display html successfully deleted message
7 changes: 7 additions & 0 deletions docs/source/static/index.txt
@@ -0,0 +1,7 @@
======================
About the Asset Server
======================

.. warning::

Not started yet.
21 changes: 21 additions & 0 deletions docs/source/web/index.txt
@@ -0,0 +1,21 @@
==================
About the Web Site
==================

The front end of the site provides a simple list of books, available in
different flavours. All links will contain an Amazon affiliate code.

/
-

:GET: display html list of books

/books.json
-----------

:GET: display json list of books

/books.rss
----------

:GET: display rss list of books
34 changes: 34 additions & 0 deletions docs/source/webservice/index.txt
@@ -0,0 +1,34 @@
===========================
About the Web Service
===========================

.. note::

Work in progress.

The webservice acts as the datastore. It keeps hold of the current list of
books and provides a JSON based interface for managing things.

.. module:: webservice
:synopsis: simple datastore management web service.
.. moduleauthor:: Gareth Rushgrove <gareth@morethanseven.net>

.. literalinclude:: ../../../ws/models.py
:linenos:

.. literalinclude:: ../../../ws/main.py
:linenos:


/books/
-------

:GET: return json list of books
:POST: post json of book to add new book

/books/{id}/
------------

:GET: get json of book details
:DELETE: delete book
:PUT: update book record

0 comments on commit 6099af1

Please sign in to comment.