Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Geod24 committed Mar 25, 2015
1 parent 0118a2d commit 1773fbc
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 17 deletions.
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ docs.json
/docs/prettify
/docs/scripts
/docs/styles
__dummy.html

.dub
dub.selections.json
Expand All @@ -22,8 +23,7 @@ dub.selections.json
# Unittest binaries
vibe-d
tests/*/tests
__test__libevent__
__test__libev__
__test__*__

# Examples
examples/app_skeleton/__test__library__
Expand Down
30 changes: 15 additions & 15 deletions source/vibe/web/rest.d
Original file line number Diff line number Diff line change
Expand Up @@ -32,22 +32,22 @@ import std.typetuple : anySatisfy, Filter;
The following table lists the mappings from prefix verb to HTTP verb:
<table>
<tr><th>Prefix</th><th>HTTP verb</th></tr>
<tr><td>get</td><td>GET</td></tr>
<tr><td>query</td><td>GET</td></tr>
<tr><td>set</td><td>PUT</td></tr>
<tr><td>put</td><td>PUT</td></tr>
<tr><td>update</td><td>PATCH</td></tr>
<tr><td>patch</td><td>PATCH</td></tr>
<tr><td>add</td><td>POST</td></tr>
<tr><td>create</td><td>POST</td></tr>
<tr><td>post</td><td>POST</td></tr>
</table>
$(TABLE
$(TR $(TH Prefix) $(TH HTTP verb))
$(TR $(TD get) $(TD GET))
$(TR $(TD query) $(TD GET))
$(TR $(TD set) $(TD PUT))
$(TR $(TD put) $(TD PUT))
$(TR $(TD update) $(TD PATCH))
$(TR $(TD patch) $(TD PATCH))
$(TR $(TD add) $(TD POST))
$(TR $(TD create) $(TD POST))
$(TR $(TD post) $(TD POST))
)
If a method has its first parameter named 'id', it will be mapped to ':id/method' and
'id' is expected to be part of the URL instead of a JSON request. Parameters with default
values will be optional in the corresponding JSON request.
'id' is expected to be part of the URL instead of a JSON request. Parameters with default
values will be optional in the corresponding JSON request.
Any interface that you return from a getter will be made available with the
base url and its name appended.
Expand All @@ -58,7 +58,7 @@ import std.typetuple : anySatisfy, Filter;
must either be an interface type, or a class which derives from a
single interface
settings = Additional settings, such as the $(D MethodStyle), or the prefix.
See $(D RestInterfaceSettings) for more details.
See $(D RestInterfaceSettings) for more details.
See_Also:
$(D RestInterfaceClient) class for a seamless way to access such a generated API
Expand Down

0 comments on commit 1773fbc

Please sign in to comment.