wsme/doc/api.rst
2013-04-09 13:10:57 +02:00

46 lines
831 B
ReStructuredText
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

API
===
Public API
----------
:mod:`wsme` -- Essentials
~~~~~~~~~~~~~~~~~~~~~~~~~
.. module:: wsme
.. autoclass:: signature([return_type, [arg0_type, [arg1_type, ... ] ] ], body=None, status=None)
.. autoclass:: wsme.types.Base
.. autoclass:: wsattr
.. autoclass:: wsproperty
.. data:: Unset
Default value of the complex type attributes.
.. autoclass:: WSRoot
:members:
Internals
---------
:mod:`wsme.types` -- Types
~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: wsme.types
:members: register_type
:mod:`wsme.api` -- API related api
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: wsme.api
:members: FunctionArgument, FunctionDefinition
:mod:`wsme.rest.args` -- REST protocol argument handling
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: wsme.rest.args
:members: