Files
deb-python-wsme/doc/api.rst

42 lines
650 B
ReStructuredText

API
===
Public API
----------
:mod:`wsme` -- Essentials
~~~~~~~~~~~~~~~~~~~~~~~~~
.. module:: wsme
.. autoclass:: WSRoot
.. autoclass:: expose
.. autoclass:: validate
.. autoclass:: wsproperty
.. autoclass:: wsattr
Internals
---------
:mod:`wsme.types` -- Types
~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: wsme.types
:members: register_type
:mod:`wsme.controller` -- Controller
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: wsme.controller
:members: scan_api, FunctionArgument, FunctionDefinition
:mod:`wsme.rest` -- REST protocol commons
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: wsme.rest
:members: