Datamodel binding for base_rest
Project description
This addon allows you to use DataModel objects as params and/or response with your REST API methods.
Table of contents
Usage
To use DataModel instances as request and/or response of a REST service endpoint you must:
Define your DataModel objects;
Provides the information required to the odoo.addons.base_rest.restapi.method decorator;
from marshmallow import fields
from odoo.addons.base_rest import restapi
from odoo.addons.component.core import Component
from odoo.addons.datamodel.core import Datamodel
class PingMessage(Datamodel):
_name = "ping.message"
message = fields.String(required=True, allow_none=False)
class PingService(Component):
_inherit = 'base.rest.service'
_name = 'ping.service'
_usage = 'ping'
_collection = 'my_module.services'
@restapi.method(
[(["/pong"], "GET")],
input_param=restapi.Datamodel("ping.message"),
output_param=restapi.Datamodel("ping.message"),
auth="public",
)
def pong(self, ping_message):
PingMessage = self.env.datamodels["ping.message"]
return PingMessage(message = "Received: " + ping_message.message)
Bug Tracker
Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us smashing it by providing a detailed and welcomed feedback.
Do not contact contributors directly about support or help with technical issues.
Credits
Contributors
Laurent Mignon <laurent.mignon@acsone.eu>
Maintainers
This module is maintained by the OCA.
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.
This module is part of the OCA/rest-framework project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
File details
Details for the file odoo14_addon_base_rest_datamodel-14.0.4.3.0-py3-none-any.whl
.
File metadata
- Download URL: odoo14_addon_base_rest_datamodel-14.0.4.3.0-py3-none-any.whl
- Upload date:
- Size: 25.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.8.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ec0c517df7b3c4176f9f2830cb10b3c6b65336c58e638a2c5afbfc0a7dfc30a5 |
|
MD5 | 2aa0fa444f6cc94771410204aaa2e306 |
|
BLAKE2b-256 | cd25286ac9b32e22ea78fc95b1f7c1a48860dbe8b165ecb58eb73f59a0a929a2 |