140 lines
4.1 KiB
ReStructuredText
140 lines
4.1 KiB
ReStructuredText
===========
|
|
Disable RPC
|
|
===========
|
|
|
|
..
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
!! This file is generated by oca-gen-addon-readme !!
|
|
!! changes will be overwritten. !!
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
!! source digest: sha256:3e95cc80fbae1cb569a46d799e19ecc6edf4f605f8d131a25bed6daf5057b512
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
|
|
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
|
|
:target: https://odoo-community.org/page/development-status
|
|
:alt: Beta
|
|
.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png
|
|
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
|
|
:alt: License: LGPL-3
|
|
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github
|
|
:target: https://github.com/OCA/server-tools/tree/16.0/rpc_helper
|
|
:alt: OCA/server-tools
|
|
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
|
|
:target: https://translation.odoo-community.org/projects/server-tools-16-0/server-tools-16-0-rpc_helper
|
|
:alt: Translate me on Weblate
|
|
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
|
|
:target: https://runboat.odoo-community.org/builds?repo=OCA/server-tools&target_branch=16.0
|
|
:alt: Try me on Runboat
|
|
|
|
|badge1| |badge2| |badge3| |badge4| |badge5|
|
|
|
|
Provide helpers to authorize RPC calls.
|
|
|
|
**Table of contents**
|
|
|
|
.. contents::
|
|
:local:
|
|
|
|
Configuration
|
|
=============
|
|
|
|
Enable debug mode and go to "Technical -> Database Structure -> Models".
|
|
|
|
Open the model that you like to configure and go to the tab "RPC config".
|
|
|
|
There you see a text field which supports JSON configuration.
|
|
|
|
The configuration is the same you can pass via decorator.
|
|
The only difference is that you have to wrap values in a dictionary
|
|
like `{"disable": [...values...]}`.
|
|
|
|
To disable all calls::
|
|
|
|
{
|
|
"disable": ["all"],
|
|
}
|
|
|
|
To disable only some methods::
|
|
|
|
{
|
|
"disable": ["create", "write", "another_method"],
|
|
}
|
|
|
|
NOTE: on the resulting JSON will be automatically formatted on save for better readability.
|
|
|
|
Usage
|
|
=====
|
|
|
|
Via code
|
|
~~~~~~~~
|
|
|
|
Decorate an Odoo model class like this::
|
|
|
|
from odoo.addons.rpc_helper.decorator import disable_rpc
|
|
|
|
@disable_rpc()
|
|
class AverageModel(models.Model):
|
|
_inherit = "avg.model"
|
|
|
|
This will disable ALL calls.
|
|
|
|
To selectively disable only some methods::
|
|
|
|
@disable_rpc("create", "write", "any_method")
|
|
class AverageModel(models.Model):
|
|
_inherit = "avg.model"
|
|
|
|
|
|
Via `ir.model` configuration
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
See "Configuration" section.
|
|
|
|
Bug Tracker
|
|
===========
|
|
|
|
Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.
|
|
In case of trouble, please check there if your issue has already been reported.
|
|
If you spotted it first, help us to smash it by providing a detailed and welcomed
|
|
`feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20rpc_helper%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
|
|
|
|
Do not contact contributors directly about support or help with technical issues.
|
|
|
|
Credits
|
|
=======
|
|
|
|
Authors
|
|
~~~~~~~
|
|
|
|
* Camptocamp
|
|
|
|
Contributors
|
|
~~~~~~~~~~~~
|
|
|
|
* Simone Orsi <simone.orsi@camptocamp.com>
|
|
|
|
Maintainers
|
|
~~~~~~~~~~~
|
|
|
|
This module is maintained by the OCA.
|
|
|
|
.. image:: https://odoo-community.org/logo.png
|
|
:alt: Odoo Community Association
|
|
:target: https://odoo-community.org
|
|
|
|
OCA, or the Odoo Community Association, is a nonprofit organization whose
|
|
mission is to support the collaborative development of Odoo features and
|
|
promote its widespread use.
|
|
|
|
.. |maintainer-simahawk| image:: https://github.com/simahawk.png?size=40px
|
|
:target: https://github.com/simahawk
|
|
:alt: simahawk
|
|
|
|
Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
|
|
|
|
|maintainer-simahawk|
|
|
|
|
This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/16.0/rpc_helper>`_ project on GitHub.
|
|
|
|
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
|