umgeher/cowboy
0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-15 04:30:25 +00:00
Code Issues Wiki Activity

Add a few directions in the REST chapter in the guide

Browse source 
This is obviously not proper documentation. We will properly document
it when the API stabilizes.
This commit is contained in:
Loïc Hoguin 2013-02-11 09:26:13 +01:00
parent 40b8d0befc
commit c1bf0a2792
1 changed files with 8 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

11
guide/rest_handlers.md
View file

@ -12,17 +12,22 @@ REST is implemented in Cowboy as a protocol upgrade. Once upgraded,
the request is handled as a state machine with many optional callbacks
describing the resource and modifying the machine's behavior.
As the REST handler is still subject to change, the documentation is
still thin. This state of affair will be improved in the coming weeks.
Flow diagram
------------
@todo Add the beautiful flow diagram here.
Not done yet. Feel free to use the one that is currently being worked on.
* https://github.com/extend/cowboy/pull/364
Callbacks
---------
@todo Describe the callbacks.
Please see the Webmachine documentation at this time.
Usage
-----
@todo Explain how to use them.
Please see the examples at this time.