===========
Disable RPC
===========
..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:3f16adf8833c58d64fd85ebe695de4757240613295bd553286ecfc6420f75efe
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |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/18.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-18-0/server-tools-18-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=18.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:%2018.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>
Trobz
- Tuan Nguyen <tuanna@trobz.com>
Other credits
-------------
The migration of this module from 16.0 to 18.0 was financially supported
by Camptocamp.
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/18.0/rpc_helper>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
Raw data
{
"_id": null,
"home_page": "https://github.com/OCA/server-tools",
"name": "odoo-addon-rpc-helper",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Camptocamp, Odoo Community Association (OCA)",
"author_email": "support@odoo-community.org",
"download_url": null,
"platform": null,
"description": "===========\nDisable RPC\n===========\n\n.. \n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n !! This file is generated by oca-gen-addon-readme !!\n !! changes will be overwritten. !!\n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n !! source digest: sha256:3f16adf8833c58d64fd85ebe695de4757240613295bd553286ecfc6420f75efe\n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n\n.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png\n :target: https://odoo-community.org/page/development-status\n :alt: Beta\n.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png\n :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html\n :alt: License: LGPL-3\n.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github\n :target: https://github.com/OCA/server-tools/tree/18.0/rpc_helper\n :alt: OCA/server-tools\n.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png\n :target: https://translation.odoo-community.org/projects/server-tools-18-0/server-tools-18-0-rpc_helper\n :alt: Translate me on Weblate\n.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png\n :target: https://runboat.odoo-community.org/builds?repo=OCA/server-tools&target_branch=18.0\n :alt: Try me on Runboat\n\n|badge1| |badge2| |badge3| |badge4| |badge5|\n\nProvide helpers to authorize RPC calls.\n\n**Table of contents**\n\n.. contents::\n :local:\n\nConfiguration\n=============\n\nEnable debug mode and go to \"Technical -> Database Structure -> Models\".\n\nOpen the model that you like to configure and go to the tab \"RPC\nconfig\".\n\nThere you see a text field which supports JSON configuration.\n\nThe configuration is the same you can pass via decorator. The only\ndifference is that you have to wrap values in a dictionary like\n{\"disable\": [...values...]}.\n\nTo disable all calls:\n\n::\n\n {\n \"disable\": [\"all\"]\n }\n\nTo disable only some methods:\n\n::\n\n {\n \"disable\": [\"create\", \"write\", \"another_method\"]\n }\n\nNOTE: on the resulting JSON will be automatically formatted on save for\nbetter readability.\n\nUsage\n=====\n\nVia code\n--------\n\nDecorate an Odoo model class like this:\n\n::\n\n from odoo.addons.rpc_helper.decorator import disable_rpc\n\n @disable_rpc()\n class AverageModel(models.Model):\n _inherit = \"avg.model\"\n\nThis will disable ALL calls.\n\nTo selectively disable only some methods:\n\n::\n\n @disable_rpc(\"create\", \"write\", \"any_method\")\n class AverageModel(models.Model):\n _inherit = \"avg.model\"\n\nVia ir.model configuration\n--------------------------\n\nSee \"Configuration\" section.\n\nBug Tracker\n===========\n\nBugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.\nIn case of trouble, please check there if your issue has already been reported.\nIf you spotted it first, help us to smash it by providing a detailed and welcomed\n`feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20rpc_helper%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.\n\nDo not contact contributors directly about support or help with technical issues.\n\nCredits\n=======\n\nAuthors\n-------\n\n* Camptocamp\n\nContributors\n------------\n\n- Simone Orsi <simone.orsi@camptocamp.com>\n\nTrobz\n\n- Tuan Nguyen <tuanna@trobz.com>\n\nOther credits\n-------------\n\nThe migration of this module from 16.0 to 18.0 was financially supported\nby Camptocamp.\n\nMaintainers\n-----------\n\nThis module is maintained by the OCA.\n\n.. image:: https://odoo-community.org/logo.png\n :alt: Odoo Community Association\n :target: https://odoo-community.org\n\nOCA, or the Odoo Community Association, is a nonprofit organization whose\nmission is to support the collaborative development of Odoo features and\npromote its widespread use.\n\n.. |maintainer-simahawk| image:: https://github.com/simahawk.png?size=40px\n :target: https://github.com/simahawk\n :alt: simahawk\n\nCurrent `maintainer <https://odoo-community.org/page/maintainer-role>`__:\n\n|maintainer-simahawk| \n\nThis module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/18.0/rpc_helper>`_ project on GitHub.\n\nYou are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.\n",
"bugtrack_url": null,
"license": "LGPL-3",
"summary": "Helpers for disabling RPC calls",
"version": "18.0.1.0.0.3",
"project_urls": {
"Homepage": "https://github.com/OCA/server-tools"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dd107464730207196aa3345c203782ea231f908a73acc6a544e9ad8700ec85e6",
"md5": "d71c6b6c6228d624f40546fac3f564bc",
"sha256": "cae576d2f5b63d27e84917921d8715aaad98164388861f5fb166f76567a65a22"
},
"downloads": -1,
"filename": "odoo_addon_rpc_helper-18.0.1.0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d71c6b6c6228d624f40546fac3f564bc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 32035,
"upload_time": "2024-12-04T03:33:52",
"upload_time_iso_8601": "2024-12-04T03:33:52.541303Z",
"url": "https://files.pythonhosted.org/packages/dd/10/7464730207196aa3345c203782ea231f908a73acc6a544e9ad8700ec85e6/odoo_addon_rpc_helper-18.0.1.0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-04 03:33:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OCA",
"github_project": "server-tools",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "acme",
"specs": []
},
{
"name": "astor",
"specs": []
},
{
"name": "cryptography",
"specs": []
},
{
"name": "dataclasses",
"specs": []
},
{
"name": "dnspython",
"specs": []
},
{
"name": "josepy",
"specs": []
},
{
"name": "mako",
"specs": []
},
{
"name": "odoo_test_helper",
"specs": []
},
{
"name": "odoorpc",
"specs": []
},
{
"name": "openpyxl",
"specs": []
},
{
"name": "openupgradelib",
"specs": []
},
{
"name": "pygount",
"specs": []
},
{
"name": "pysftp",
"specs": []
},
{
"name": "sentry_sdk",
"specs": [
[
"<=",
"1.9.0"
]
]
},
{
"name": "unidecode",
"specs": []
}
],
"lcname": "odoo-addon-rpc-helper"
}
JSON
