From c1bf0a2792673f5f43b3b72a168397d5a2c87507 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Mon, 11 Feb 2013 09:26:13 +0100 Subject: Add a few directions in the REST chapter in the guide This is obviously not proper documentation. We will properly document it when the API stabilizes. --- guide/rest_handlers.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) (limited to 'guide') diff --git a/guide/rest_handlers.md b/guide/rest_handlers.md index df5f841..62f0ba1 100644 --- a/guide/rest_handlers.md +++ b/guide/rest_handlers.md @@ -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. -- cgit v1.2.3