Skip to content
This repository has been archived by the owner on Aug 10, 2018. It is now read-only.

Commit

Permalink
doc(reference): updated reference docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Thierry Templier committed Jun 19, 2015
1 parent cf6fe82 commit 4718e59
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 10 deletions.
2 changes: 1 addition & 1 deletion docs/references/doc-client-0.4.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ __Version 0.4.0__

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*


- [Core elements](#core-elements)
- [Client resource](#client-resource)
Expand Down
21 changes: 12 additions & 9 deletions docs/references/doc-server-0.4.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ __Version 0.4.0__

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*


- [Core elements](#core-elements)
- [Component](#component)
Expand Down Expand Up @@ -231,7 +231,7 @@ __`restlet.createApplication`__

Create a new application.

An application gather a set of elements like routers, filters
An application gather a set of elements like routers, filters
and server resources to handle requests for a particular paths.
In addition, applications provide services to manage media types,
content negotiation.
Expand Down Expand Up @@ -364,11 +364,13 @@ in the following snippet:

var virtualHost = restlet.createVirtualHost();

var myRestlet1 = restlet.createRestlet(function(request, response, next) {
var myRestlet1 = restlet.createRestlet(function(
request, response, next) {
(...)
});

var myRestlet2 = restlet.createRestlet(function(request, response, next) {
var myRestlet2 = restlet.createRestlet(function(
request, response, next) {
(...)
// Call the next restlet in the chain
next();
Expand Down Expand Up @@ -413,7 +415,8 @@ set, it's implicitely called.

The following snippet describes this mechanism:

var myRestlet2 = restlet.createRestlet(function(request, response, next) {
var myRestlet2 = restlet.createRestlet(function(
request, response, next) {
(...)
// Call the next restlet in the chain
next();
Expand Down Expand Up @@ -518,10 +521,10 @@ can be used at this level:
object if the conversion if enabled
* `clientInfo`: the client info
* `reference`: the reference
* `pathVariables`: the map containing the path variables
* `pathVariables["varName"]`: the path variable with name `varName`
* `queryParameters`: the map containing the query parameters
* `queryParameters["paramName"]`: the query parameter with name `varName`
* `pathVariables`: the map containing the path variables
* `pathVariables["varName"]`: the path variable with name `varName`
* `queryParameters`: the map containing the query parameters
* `queryParameters["paramName"]`: the query parameter with name `varName`

By default, the parameter `entity` provides the representation itself.
If you expect to have a JavaScript object that maps the received data,
Expand Down

0 comments on commit 4718e59

Please sign in to comment.