Documented the ExtDirect protocol

This commit is contained in:
Christophe de Vienne
2011-10-28 12:43:54 +02:00
parent 2d70d5656f
commit 190faf8e82

View File

@@ -1,23 +1,59 @@
Protocols
=========
:mod:`wsme.protocols.restjson` -- REST+Json
-------------------------------------------
REST+Json
---------
.. automodule:: wsme.protocols.restjson
:members:
:name: ``'restjson'``
REST+XML
--------
:mod:`wsme.protocols.restxml` -- REST+XML
-----------------------------------------
:name: ``'restxml'``
.. automodule:: wsme.protocols.restxml
:members:
SOAP
----
:name: ``'soap'``
:package: WSME-Soap
:mod:`wsme.protocols.soap` -- SOAP
----------------------------------
Options
~~~~~~~
.. automodule:: wsme.protocols.soap
:members:
:tns: Type namespace
ExtDirect
---------
:name: ``extdirect``
:package: WSME-ExtDirect
Implements the `Ext Direct`_ protocol.
The provider definition is made available at the ``/extdirect/api.js`` subpath.
The router url is ``/extdirect/router[/subnamespace]``.
Options
~~~~~~~
:namespace: Base namespace of the api. Used for the provider definition.
:params_notation: Default notation for function call parameters. Can be
overriden for individual functions by adding the
``extdirect_params_notation`` extra option to @expose.
The possible notations are :
- ``'named'`` -- The function will take only one object parameter
in which each property will be one of the parameters.
- ``'positional'`` -- The function will take as many parameters as
the function has, and their position will determine which parameter
they are.
expose extra options
~~~~~~~~~~~~~~~~~~~~
:extdirect_params_notation: Override the params_notation for a particular
function.
.. _Ext Direct: http://www.sencha.com/products/extjs/extdirect