aboutsummaryrefslogtreecommitdiffstats
path: root/guide/rest_flowcharts.md
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2014-06-21 18:50:50 +0200
committerLoïc Hoguin <[email protected]>2014-06-21 18:50:50 +0200
commit05503affa8a85bd71f67cbe5580545d18d356f93 (patch)
tree2888dac2efca53fc03ddcb096e9d7cd4750924e4 /guide/rest_flowcharts.md
parent7b18373943853e08f00341ece92dbf3dd5e2a9b2 (diff)
downloadcowboy-05503affa8a85bd71f67cbe5580545d18d356f93.tar.gz
cowboy-05503affa8a85bd71f67cbe5580545d18d356f93.tar.bz2
cowboy-05503affa8a85bd71f67cbe5580545d18d356f93.zip
Add a stub chapter with all the REST flowcharts
The detailed explanations will be written at a later time.
Diffstat (limited to 'guide/rest_flowcharts.md')
-rw-r--r--guide/rest_flowcharts.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/guide/rest_flowcharts.md b/guide/rest_flowcharts.md
new file mode 100644
index 0000000..1aa4f55
--- /dev/null
+++ b/guide/rest_flowcharts.md
@@ -0,0 +1,42 @@
+REST flowcharts
+===============
+
+This chapter will explain the REST handler state machine through
+a number of different diagrams.
+
+This chapter is still under construction.
+
+Start
+-----
+
+![REST starting flowchart](rest_start.png)
+
+OPTIONS method
+--------------
+
+![REST OPTIONS method flowchart](rest_options.png)
+
+Content negotiation
+-------------------
+
+![REST content negotiation flowchart](rest_conneg.png)
+
+GET and HEAD methods
+--------------------
+
+![REST GET/HEAD methods flowchart](rest_get_head.png)
+
+PUT, POST and PATCH methods
+---------------------------
+
+![REST PUT/POST/PATCH methods flowchart](rest_put_post_patch.png)
+
+DELETE method
+-------------
+
+![REST DELETE method flowchart](rest_delete.png)
+
+Conditional requests
+--------------------
+
+![REST conditional requests flowchart](rest_cond.png)