2022-06-04 08:41:53 +00:00
|
|
|
API Documentation
|
|
|
|
|
=================
|
|
|
|
|
|
|
|
|
|
.. module:: bthlabs_jsonrpc_django
|
|
|
|
|
|
2024-01-15 20:20:10 +00:00
|
|
|
This section provides the API documentation for BTHLabs JSONRPC - Django.
|
2022-06-04 08:41:53 +00:00
|
|
|
|
|
|
|
|
Auth checks
|
|
|
|
|
-----------
|
|
|
|
|
|
|
|
|
|
.. autofunction:: has_perms
|
|
|
|
|
|
|
|
|
|
.. autofunction:: is_authenticated
|
|
|
|
|
|
|
|
|
|
.. autofunction:: is_staff
|
|
|
|
|
|
2024-01-15 20:20:10 +00:00
|
|
|
Codecs
|
|
|
|
|
------
|
|
|
|
|
|
|
|
|
|
.. autoclass:: DjangoJSONCodec
|
|
|
|
|
:members:
|
|
|
|
|
|
|
|
|
|
Executors
|
|
|
|
|
---------
|
|
|
|
|
|
|
|
|
|
.. autoclass:: DjangoExecutor
|
|
|
|
|
:members:
|
|
|
|
|
|
|
|
|
|
Serializers
|
|
|
|
|
-----------
|
|
|
|
|
|
|
|
|
|
.. autoclass:: DjangoJSONRPCSerializer
|
|
|
|
|
:members:
|
|
|
|
|
|
2022-06-04 08:41:53 +00:00
|
|
|
Views
|
|
|
|
|
-----
|
|
|
|
|
|
|
|
|
|
.. autoclass:: JSONRPCView
|
2024-01-15 20:20:10 +00:00
|
|
|
:members:
|
