mirror of
https://github.com/bringout/oca-technical.git
synced 2026-04-18 03:12:04 +02:00
Initial commit: OCA Technical packages (595 packages)
This commit is contained in:
Ernad Husremovic
commit
2cc02aac6e
24950 changed files with 2318079 additions and 0 deletions
|
|
@ -0,0 +1,47 @@
|
|||
# Base Rest Datamodel
|
||||
|
||||
Odoo addon: base_rest_datamodel
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
pip install odoo-bringout-oca-rest-framework-base_rest_datamodel
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
This addon depends on:
|
||||
- base_rest
|
||||
- datamodel
|
||||
|
||||
## Manifest Information
|
||||
|
||||
- **Name**: Base Rest Datamodel
|
||||
- **Version**: 16.0.1.0.0
|
||||
- **Category**: N/A
|
||||
- **License**: LGPL-3
|
||||
- **Installable**: True
|
||||
|
||||
## Source
|
||||
|
||||
Based on [OCA/rest-framework](https://github.com/OCA/rest-framework) branch 16.0, addon `base_rest_datamodel`.
|
||||
|
||||
## License
|
||||
|
||||
This package maintains the original LGPL-3 license from the upstream Odoo project.
|
||||
|
||||
## Documentation
|
||||
|
||||
- Overview: doc/OVERVIEW.md
|
||||
- Architecture: doc/ARCHITECTURE.md
|
||||
- Models: doc/MODELS.md
|
||||
- Controllers: doc/CONTROLLERS.md
|
||||
- Wizards: doc/WIZARDS.md
|
||||
- Reports: doc/REPORTS.md
|
||||
- Security: doc/SECURITY.md
|
||||
- Install: doc/INSTALL.md
|
||||
- Usage: doc/USAGE.md
|
||||
- Configuration: doc/CONFIGURATION.md
|
||||
- Dependencies: doc/DEPENDENCIES.md
|
||||
- Troubleshooting: doc/TROUBLESHOOTING.md
|
||||
- FAQ: doc/FAQ.md
|
||||
|
|
@ -0,0 +1,118 @@
|
|||
===================
|
||||
Base Rest Datamodel
|
||||
===================
|
||||
|
||||
..
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! This file is generated by oca-gen-addon-readme !!
|
||||
!! changes will be overwritten. !!
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! source digest: sha256:632b35243641f36c3ca35bc933ba7583ff963556c68379ee46f58fda26873ba3
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
|
||||
.. |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%2Frest--framework-lightgray.png?logo=github
|
||||
:target: https://github.com/OCA/rest-framework/tree/16.0/base_rest_datamodel
|
||||
:alt: OCA/rest-framework
|
||||
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
|
||||
:target: https://translation.odoo-community.org/projects/rest-framework-16-0/rest-framework-16-0-base_rest_datamodel
|
||||
: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/rest-framework&target_branch=16.0
|
||||
:alt: Try me on Runboat
|
||||
|
||||
|badge1| |badge2| |badge3| |badge4| |badge5|
|
||||
|
||||
This addon allows you to use DataModel objects as params and/or response with your
|
||||
REST API methods.
|
||||
|
||||
**Table of contents**
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
|
||||
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;
|
||||
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
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 <https://github.com/OCA/rest-framework/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/rest-framework/issues/new?body=module:%20base_rest_datamodel%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
|
||||
~~~~~~~
|
||||
|
||||
* ACSONE SA/NV
|
||||
|
||||
Contributors
|
||||
~~~~~~~~~~~~
|
||||
|
||||
* Laurent Mignon <laurent.mignon@acsone.eu>
|
||||
|
||||
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.
|
||||
|
||||
This module is part of the `OCA/rest-framework <https://github.com/OCA/rest-framework/tree/16.0/base_rest_datamodel>`_ project on GitHub.
|
||||
|
||||
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
|
||||
|
|
@ -0,0 +1 @@
|
|||
from . import restapi
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
# Copyright 2020 ACSONE SA/NV
|
||||
# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html)
|
||||
|
||||
{
|
||||
"name": "Base Rest Datamodel",
|
||||
"summary": """
|
||||
Datamodel binding for base_rest""",
|
||||
"version": "16.0.1.0.0",
|
||||
"license": "LGPL-3",
|
||||
"author": "ACSONE SA/NV,Odoo Community Association (OCA)",
|
||||
"website": "https://github.com/OCA/rest-framework",
|
||||
"depends": ["base_rest", "datamodel"],
|
||||
"external_dependencies": {"python": ["apispec>=4.0.0", "marshmallow"]},
|
||||
"installable": True,
|
||||
}
|
||||
|
|
@ -0,0 +1,28 @@
|
|||
# Translation of Odoo Server.
|
||||
# This file contains the translation of the following modules:
|
||||
# * base_rest_datamodel
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: Odoo Server 16.0\n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"Last-Translator: \n"
|
||||
"Language-Team: \n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: \n"
|
||||
"Plural-Forms: \n"
|
||||
|
||||
#. module: base_rest_datamodel
|
||||
#. odoo-python
|
||||
#: code:addons/base_rest_datamodel/restapi.py:0
|
||||
#, python-format
|
||||
msgid "BadRequest %s"
|
||||
msgstr ""
|
||||
|
||||
#. module: base_rest_datamodel
|
||||
#. odoo-python
|
||||
#: code:addons/base_rest_datamodel/restapi.py:0
|
||||
#, python-format
|
||||
msgid "Invalid Response %s"
|
||||
msgstr ""
|
||||
|
|
@ -0,0 +1,28 @@
|
|||
# Translation of Odoo Server.
|
||||
# This file contains the translation of the following modules:
|
||||
# * base_rest_datamodel
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: Odoo Server 16.0\n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"Last-Translator: \n"
|
||||
"Language-Team: \n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: \n"
|
||||
"Plural-Forms: \n"
|
||||
|
||||
#. module: base_rest_datamodel
|
||||
#. odoo-python
|
||||
#: code:addons/base_rest_datamodel/restapi.py:0
|
||||
#, python-format
|
||||
msgid "BadRequest %s"
|
||||
msgstr "Neispravni zahtjev %s"
|
||||
|
||||
#. module: base_rest_datamodel
|
||||
#. odoo-python
|
||||
#: code:addons/base_rest_datamodel/restapi.py:0
|
||||
#, python-format
|
||||
msgid "Invalid Response %s"
|
||||
msgstr "Neispravni odgovor %s"
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
# Translation of Odoo Server.
|
||||
# This file contains the translation of the following modules:
|
||||
# * base_rest_datamodel
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: Odoo Server 16.0\n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"PO-Revision-Date: 2024-01-15 11:35+0000\n"
|
||||
"Last-Translator: mymage <stefano.consolaro@mymage.it>\n"
|
||||
"Language-Team: none\n"
|
||||
"Language: it\n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: \n"
|
||||
"Plural-Forms: nplurals=2; plural=n != 1;\n"
|
||||
"X-Generator: Weblate 4.17\n"
|
||||
|
||||
#. module: base_rest_datamodel
|
||||
#. odoo-python
|
||||
#: code:addons/base_rest_datamodel/restapi.py:0
|
||||
#, python-format
|
||||
msgid "BadRequest %s"
|
||||
msgstr "Richiesta errata %s"
|
||||
|
||||
#. module: base_rest_datamodel
|
||||
#. odoo-python
|
||||
#: code:addons/base_rest_datamodel/restapi.py:0
|
||||
#, python-format
|
||||
msgid "Invalid Response %s"
|
||||
msgstr "Risposta non valida %s"
|
||||
|
|
@ -0,0 +1 @@
|
|||
* Laurent Mignon <laurent.mignon@acsone.eu>
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
This addon allows you to use DataModel objects as params and/or response with your
|
||||
REST API methods.
|
||||
|
|
@ -0,0 +1,37 @@
|
|||
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;
|
||||
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
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)
|
||||
|
|
@ -0,0 +1,100 @@
|
|||
# Copyright 2020 ACSONE SA/NV
|
||||
# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
|
||||
|
||||
import marshmallow
|
||||
from apispec.ext.marshmallow.openapi import OpenAPIConverter
|
||||
from marshmallow.exceptions import ValidationError
|
||||
|
||||
from odoo import _
|
||||
from odoo.exceptions import UserError
|
||||
|
||||
from odoo.addons.base_rest import restapi
|
||||
|
||||
|
||||
class Datamodel(restapi.RestMethodParam):
|
||||
def __init__(self, name, is_list=False, partial=None):
|
||||
"""
|
||||
|
||||
:param name: The datamodel name
|
||||
:param is_list: Should be set to True if params is a collection so that
|
||||
the object will be de/serialized from/to a list
|
||||
:param partial: Whether to ignore missing fields and not require
|
||||
any fields declared. Propagates down to ``Nested`` fields as well. If
|
||||
its value is an iterable, only missing fields listed in that iterable
|
||||
will be ignored. Use dot delimiters to specify nested fields.
|
||||
"""
|
||||
self._name = name
|
||||
self._is_list = is_list
|
||||
self._partial = partial
|
||||
|
||||
def from_params(self, service, params):
|
||||
ModelClass = service.env.datamodels[self._name]
|
||||
try:
|
||||
return ModelClass.load(
|
||||
params,
|
||||
many=self._is_list,
|
||||
unknown=marshmallow.EXCLUDE,
|
||||
partial=self._partial,
|
||||
)
|
||||
except ValidationError as ve:
|
||||
raise UserError(_("BadRequest %s") % ve.messages) from ve
|
||||
|
||||
def to_response(self, service, result):
|
||||
ModelClass = service.env.datamodels[self._name]
|
||||
if self._is_list:
|
||||
json = [i.dump() for i in result]
|
||||
else:
|
||||
json = result.dump()
|
||||
errors = ModelClass.validate(
|
||||
json, many=self._is_list, unknown=marshmallow.EXCLUDE
|
||||
)
|
||||
if errors:
|
||||
raise SystemError(_("Invalid Response %s") % errors)
|
||||
return json
|
||||
|
||||
def to_openapi_query_parameters(self, service, spec):
|
||||
converter = self._get_converter()
|
||||
schema = self._get_schema(service)
|
||||
return converter.schema2parameters(schema, location="query")
|
||||
|
||||
# TODO, we should probably get the spec as parameters. That should
|
||||
# allows to add the definition of a schema only once into the specs
|
||||
# and use a reference to the schema into the parameters
|
||||
def to_openapi_requestbody(self, service, spec):
|
||||
return {
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": self.to_json_schema(service, spec, "input")
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
def to_openapi_responses(self, service, spec):
|
||||
return {
|
||||
"200": {
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": self.to_json_schema(service, spec, "output")
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
def to_json_schema(self, service, spec, direction):
|
||||
converter = self._get_converter()
|
||||
schema = self._get_schema(service)
|
||||
return converter.resolve_nested_schema(schema)
|
||||
|
||||
def _get_schema(self, service):
|
||||
return service.env.datamodels[self._name].get_schema(many=self._is_list)
|
||||
|
||||
def _get_converter(self):
|
||||
return OpenAPIConverter("3.0", self._schema_name_resolver, None)
|
||||
|
||||
def _schema_name_resolver(self, schema):
|
||||
# name resolver used by the OpenapiConverter. always return None
|
||||
# to force nested schema definition
|
||||
return None
|
||||
|
||||
|
||||
restapi.Datamodel = Datamodel
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 9.2 KiB |
|
|
@ -0,0 +1,462 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="Docutils: https://docutils.sourceforge.io/" />
|
||||
<title>Base Rest Datamodel</title>
|
||||
<style type="text/css">
|
||||
|
||||
/*
|
||||
:Author: David Goodger (goodger@python.org)
|
||||
:Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z milde $
|
||||
:Copyright: This stylesheet has been placed in the public domain.
|
||||
|
||||
Default cascading style sheet for the HTML output of Docutils.
|
||||
|
||||
See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
|
||||
customize this style sheet.
|
||||
*/
|
||||
|
||||
/* used to remove borders from tables and images */
|
||||
.borderless, table.borderless td, table.borderless th {
|
||||
border: 0 }
|
||||
|
||||
table.borderless td, table.borderless th {
|
||||
/* Override padding for "table.docutils td" with "! important".
|
||||
The right padding separates the table cells. */
|
||||
padding: 0 0.5em 0 0 ! important }
|
||||
|
||||
.first {
|
||||
/* Override more specific margin styles with "! important". */
|
||||
margin-top: 0 ! important }
|
||||
|
||||
.last, .with-subtitle {
|
||||
margin-bottom: 0 ! important }
|
||||
|
||||
.hidden {
|
||||
display: none }
|
||||
|
||||
.subscript {
|
||||
vertical-align: sub;
|
||||
font-size: smaller }
|
||||
|
||||
.superscript {
|
||||
vertical-align: super;
|
||||
font-size: smaller }
|
||||
|
||||
a.toc-backref {
|
||||
text-decoration: none ;
|
||||
color: black }
|
||||
|
||||
blockquote.epigraph {
|
||||
margin: 2em 5em ; }
|
||||
|
||||
dl.docutils dd {
|
||||
margin-bottom: 0.5em }
|
||||
|
||||
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
/* Uncomment (and remove this text!) to get bold-faced definition list terms
|
||||
dl.docutils dt {
|
||||
font-weight: bold }
|
||||
*/
|
||||
|
||||
div.abstract {
|
||||
margin: 2em 5em }
|
||||
|
||||
div.abstract p.topic-title {
|
||||
font-weight: bold ;
|
||||
text-align: center }
|
||||
|
||||
div.admonition, div.attention, div.caution, div.danger, div.error,
|
||||
div.hint, div.important, div.note, div.tip, div.warning {
|
||||
margin: 2em ;
|
||||
border: medium outset ;
|
||||
padding: 1em }
|
||||
|
||||
div.admonition p.admonition-title, div.hint p.admonition-title,
|
||||
div.important p.admonition-title, div.note p.admonition-title,
|
||||
div.tip p.admonition-title {
|
||||
font-weight: bold ;
|
||||
font-family: sans-serif }
|
||||
|
||||
div.attention p.admonition-title, div.caution p.admonition-title,
|
||||
div.danger p.admonition-title, div.error p.admonition-title,
|
||||
div.warning p.admonition-title, .code .error {
|
||||
color: red ;
|
||||
font-weight: bold ;
|
||||
font-family: sans-serif }
|
||||
|
||||
/* Uncomment (and remove this text!) to get reduced vertical space in
|
||||
compound paragraphs.
|
||||
div.compound .compound-first, div.compound .compound-middle {
|
||||
margin-bottom: 0.5em }
|
||||
|
||||
div.compound .compound-last, div.compound .compound-middle {
|
||||
margin-top: 0.5em }
|
||||
*/
|
||||
|
||||
div.dedication {
|
||||
margin: 2em 5em ;
|
||||
text-align: center ;
|
||||
font-style: italic }
|
||||
|
||||
div.dedication p.topic-title {
|
||||
font-weight: bold ;
|
||||
font-style: normal }
|
||||
|
||||
div.figure {
|
||||
margin-left: 2em ;
|
||||
margin-right: 2em }
|
||||
|
||||
div.footer, div.header {
|
||||
clear: both;
|
||||
font-size: smaller }
|
||||
|
||||
div.line-block {
|
||||
display: block ;
|
||||
margin-top: 1em ;
|
||||
margin-bottom: 1em }
|
||||
|
||||
div.line-block div.line-block {
|
||||
margin-top: 0 ;
|
||||
margin-bottom: 0 ;
|
||||
margin-left: 1.5em }
|
||||
|
||||
div.sidebar {
|
||||
margin: 0 0 0.5em 1em ;
|
||||
border: medium outset ;
|
||||
padding: 1em ;
|
||||
background-color: #ffffee ;
|
||||
width: 40% ;
|
||||
float: right ;
|
||||
clear: right }
|
||||
|
||||
div.sidebar p.rubric {
|
||||
font-family: sans-serif ;
|
||||
font-size: medium }
|
||||
|
||||
div.system-messages {
|
||||
margin: 5em }
|
||||
|
||||
div.system-messages h1 {
|
||||
color: red }
|
||||
|
||||
div.system-message {
|
||||
border: medium outset ;
|
||||
padding: 1em }
|
||||
|
||||
div.system-message p.system-message-title {
|
||||
color: red ;
|
||||
font-weight: bold }
|
||||
|
||||
div.topic {
|
||||
margin: 2em }
|
||||
|
||||
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
|
||||
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
|
||||
margin-top: 0.4em }
|
||||
|
||||
h1.title {
|
||||
text-align: center }
|
||||
|
||||
h2.subtitle {
|
||||
text-align: center }
|
||||
|
||||
hr.docutils {
|
||||
width: 75% }
|
||||
|
||||
img.align-left, .figure.align-left, object.align-left, table.align-left {
|
||||
clear: left ;
|
||||
float: left ;
|
||||
margin-right: 1em }
|
||||
|
||||
img.align-right, .figure.align-right, object.align-right, table.align-right {
|
||||
clear: right ;
|
||||
float: right ;
|
||||
margin-left: 1em }
|
||||
|
||||
img.align-center, .figure.align-center, object.align-center {
|
||||
display: block;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
table.align-center {
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
.align-left {
|
||||
text-align: left }
|
||||
|
||||
.align-center {
|
||||
clear: both ;
|
||||
text-align: center }
|
||||
|
||||
.align-right {
|
||||
text-align: right }
|
||||
|
||||
/* reset inner alignment in figures */
|
||||
div.align-right {
|
||||
text-align: inherit }
|
||||
|
||||
/* div.align-center * { */
|
||||
/* text-align: left } */
|
||||
|
||||
.align-top {
|
||||
vertical-align: top }
|
||||
|
||||
.align-middle {
|
||||
vertical-align: middle }
|
||||
|
||||
.align-bottom {
|
||||
vertical-align: bottom }
|
||||
|
||||
ol.simple, ul.simple {
|
||||
margin-bottom: 1em }
|
||||
|
||||
ol.arabic {
|
||||
list-style: decimal }
|
||||
|
||||
ol.loweralpha {
|
||||
list-style: lower-alpha }
|
||||
|
||||
ol.upperalpha {
|
||||
list-style: upper-alpha }
|
||||
|
||||
ol.lowerroman {
|
||||
list-style: lower-roman }
|
||||
|
||||
ol.upperroman {
|
||||
list-style: upper-roman }
|
||||
|
||||
p.attribution {
|
||||
text-align: right ;
|
||||
margin-left: 50% }
|
||||
|
||||
p.caption {
|
||||
font-style: italic }
|
||||
|
||||
p.credits {
|
||||
font-style: italic ;
|
||||
font-size: smaller }
|
||||
|
||||
p.label {
|
||||
white-space: nowrap }
|
||||
|
||||
p.rubric {
|
||||
font-weight: bold ;
|
||||
font-size: larger ;
|
||||
color: maroon ;
|
||||
text-align: center }
|
||||
|
||||
p.sidebar-title {
|
||||
font-family: sans-serif ;
|
||||
font-weight: bold ;
|
||||
font-size: larger }
|
||||
|
||||
p.sidebar-subtitle {
|
||||
font-family: sans-serif ;
|
||||
font-weight: bold }
|
||||
|
||||
p.topic-title {
|
||||
font-weight: bold }
|
||||
|
||||
pre.address {
|
||||
margin-bottom: 0 ;
|
||||
margin-top: 0 ;
|
||||
font: inherit }
|
||||
|
||||
pre.literal-block, pre.doctest-block, pre.math, pre.code {
|
||||
margin-left: 2em ;
|
||||
margin-right: 2em }
|
||||
|
||||
pre.code .ln { color: grey; } /* line numbers */
|
||||
pre.code, code { background-color: #eeeeee }
|
||||
pre.code .comment, code .comment { color: #5C6576 }
|
||||
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
|
||||
pre.code .literal.string, code .literal.string { color: #0C5404 }
|
||||
pre.code .name.builtin, code .name.builtin { color: #352B84 }
|
||||
pre.code .deleted, code .deleted { background-color: #DEB0A1}
|
||||
pre.code .inserted, code .inserted { background-color: #A3D289}
|
||||
|
||||
span.classifier {
|
||||
font-family: sans-serif ;
|
||||
font-style: oblique }
|
||||
|
||||
span.classifier-delimiter {
|
||||
font-family: sans-serif ;
|
||||
font-weight: bold }
|
||||
|
||||
span.interpreted {
|
||||
font-family: sans-serif }
|
||||
|
||||
span.option {
|
||||
white-space: nowrap }
|
||||
|
||||
span.pre {
|
||||
white-space: pre }
|
||||
|
||||
span.problematic {
|
||||
color: red }
|
||||
|
||||
span.section-subtitle {
|
||||
/* font-size relative to parent (h1..h6 element) */
|
||||
font-size: 80% }
|
||||
|
||||
table.citation {
|
||||
border-left: solid 1px gray;
|
||||
margin-left: 1px }
|
||||
|
||||
table.docinfo {
|
||||
margin: 2em 4em }
|
||||
|
||||
table.docutils {
|
||||
margin-top: 0.5em ;
|
||||
margin-bottom: 0.5em }
|
||||
|
||||
table.footnote {
|
||||
border-left: solid 1px black;
|
||||
margin-left: 1px }
|
||||
|
||||
table.docutils td, table.docutils th,
|
||||
table.docinfo td, table.docinfo th {
|
||||
padding-left: 0.5em ;
|
||||
padding-right: 0.5em ;
|
||||
vertical-align: top }
|
||||
|
||||
table.docutils th.field-name, table.docinfo th.docinfo-name {
|
||||
font-weight: bold ;
|
||||
text-align: left ;
|
||||
white-space: nowrap ;
|
||||
padding-left: 0 }
|
||||
|
||||
/* "booktabs" style (no vertical lines) */
|
||||
table.docutils.booktabs {
|
||||
border: 0px;
|
||||
border-top: 2px solid;
|
||||
border-bottom: 2px solid;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
table.docutils.booktabs * {
|
||||
border: 0px;
|
||||
}
|
||||
table.docutils.booktabs th {
|
||||
border-bottom: thin solid;
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
|
||||
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
|
||||
font-size: 100% }
|
||||
|
||||
ul.auto-toc {
|
||||
list-style-type: none }
|
||||
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class="document" id="base-rest-datamodel">
|
||||
<h1 class="title">Base Rest Datamodel</h1>
|
||||
|
||||
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! This file is generated by oca-gen-addon-readme !!
|
||||
!! changes will be overwritten. !!
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! source digest: sha256:632b35243641f36c3ca35bc933ba7583ff963556c68379ee46f58fda26873ba3
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
|
||||
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/licence-LGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/rest-framework/tree/16.0/base_rest_datamodel"><img alt="OCA/rest-framework" src="https://img.shields.io/badge/github-OCA%2Frest--framework-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/rest-framework-16-0/rest-framework-16-0-base_rest_datamodel"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/rest-framework&target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
|
||||
<p>This addon allows you to use DataModel objects as params and/or response with your
|
||||
REST API methods.</p>
|
||||
<p><strong>Table of contents</strong></p>
|
||||
<div class="contents local topic" id="contents">
|
||||
<ul class="simple">
|
||||
<li><a class="reference internal" href="#usage" id="toc-entry-1">Usage</a></li>
|
||||
<li><a class="reference internal" href="#bug-tracker" id="toc-entry-2">Bug Tracker</a></li>
|
||||
<li><a class="reference internal" href="#credits" id="toc-entry-3">Credits</a><ul>
|
||||
<li><a class="reference internal" href="#authors" id="toc-entry-4">Authors</a></li>
|
||||
<li><a class="reference internal" href="#contributors" id="toc-entry-5">Contributors</a></li>
|
||||
<li><a class="reference internal" href="#maintainers" id="toc-entry-6">Maintainers</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="usage">
|
||||
<h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
|
||||
<p>To use DataModel instances as request and/or response of a REST service endpoint
|
||||
you must:</p>
|
||||
<ul class="simple">
|
||||
<li>Define your DataModel objects;</li>
|
||||
<li>Provides the information required to the <tt class="docutils literal">odoo.addons.base_rest.restapi.method</tt> decorator;</li>
|
||||
</ul>
|
||||
<pre class="code python literal-block">
|
||||
<span class="kn">from</span> <span class="nn">marshmallow</span> <span class="kn">import</span> <span class="n">fields</span><span class="w">
|
||||
|
||||
</span><span class="kn">from</span> <span class="nn">odoo.addons.base_rest</span> <span class="kn">import</span> <span class="n">restapi</span><span class="w">
|
||||
</span><span class="kn">from</span> <span class="nn">odoo.addons.component.core</span> <span class="kn">import</span> <span class="n">Component</span><span class="w">
|
||||
</span><span class="kn">from</span> <span class="nn">odoo.addons.datamodel.core</span> <span class="kn">import</span> <span class="n">Datamodel</span><span class="w">
|
||||
|
||||
</span><span class="k">class</span> <span class="nc">PingMessage</span><span class="p">(</span><span class="n">Datamodel</span><span class="p">):</span><span class="w">
|
||||
</span> <span class="n">_name</span> <span class="o">=</span> <span class="s2">"ping.message"</span><span class="w">
|
||||
|
||||
</span> <span class="n">message</span> <span class="o">=</span> <span class="n">fields</span><span class="o">.</span><span class="n">String</span><span class="p">(</span><span class="n">required</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">allow_none</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span><span class="w">
|
||||
|
||||
|
||||
</span><span class="k">class</span> <span class="nc">PingService</span><span class="p">(</span><span class="n">Component</span><span class="p">):</span><span class="w">
|
||||
</span> <span class="n">_inherit</span> <span class="o">=</span> <span class="s1">'base.rest.service'</span><span class="w">
|
||||
</span> <span class="n">_name</span> <span class="o">=</span> <span class="s1">'ping.service'</span><span class="w">
|
||||
</span> <span class="n">_usage</span> <span class="o">=</span> <span class="s1">'ping'</span><span class="w">
|
||||
</span> <span class="n">_collection</span> <span class="o">=</span> <span class="s1">'my_module.services'</span><span class="w">
|
||||
|
||||
|
||||
</span> <span class="nd">@restapi</span><span class="o">.</span><span class="n">method</span><span class="p">(</span><span class="w">
|
||||
</span> <span class="p">[([</span><span class="s2">"/pong"</span><span class="p">],</span> <span class="s2">"GET"</span><span class="p">)],</span><span class="w">
|
||||
</span> <span class="n">input_param</span><span class="o">=</span><span class="n">restapi</span><span class="o">.</span><span class="n">Datamodel</span><span class="p">(</span><span class="s2">"ping.message"</span><span class="p">),</span><span class="w">
|
||||
</span> <span class="n">output_param</span><span class="o">=</span><span class="n">restapi</span><span class="o">.</span><span class="n">Datamodel</span><span class="p">(</span><span class="s2">"ping.message"</span><span class="p">),</span><span class="w">
|
||||
</span> <span class="n">auth</span><span class="o">=</span><span class="s2">"public"</span><span class="p">,</span><span class="w">
|
||||
</span> <span class="p">)</span><span class="w">
|
||||
</span> <span class="k">def</span> <span class="nf">pong</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ping_message</span><span class="p">):</span><span class="w">
|
||||
</span> <span class="n">PingMessage</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="o">.</span><span class="n">datamodels</span><span class="p">[</span><span class="s2">"ping.message"</span><span class="p">]</span><span class="w">
|
||||
</span> <span class="k">return</span> <span class="n">PingMessage</span><span class="p">(</span><span class="n">message</span> <span class="o">=</span> <span class="s2">"Received: "</span> <span class="o">+</span> <span class="n">ping_message</span><span class="o">.</span><span class="n">message</span><span class="p">)</span>
|
||||
</pre>
|
||||
</div>
|
||||
<div class="section" id="bug-tracker">
|
||||
<h1><a class="toc-backref" href="#toc-entry-2">Bug Tracker</a></h1>
|
||||
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/rest-framework/issues">GitHub Issues</a>.
|
||||
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
|
||||
<a class="reference external" href="https://github.com/OCA/rest-framework/issues/new?body=module:%20base_rest_datamodel%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
|
||||
<p>Do not contact contributors directly about support or help with technical issues.</p>
|
||||
</div>
|
||||
<div class="section" id="credits">
|
||||
<h1><a class="toc-backref" href="#toc-entry-3">Credits</a></h1>
|
||||
<div class="section" id="authors">
|
||||
<h2><a class="toc-backref" href="#toc-entry-4">Authors</a></h2>
|
||||
<ul class="simple">
|
||||
<li>ACSONE SA/NV</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="contributors">
|
||||
<h2><a class="toc-backref" href="#toc-entry-5">Contributors</a></h2>
|
||||
<ul class="simple">
|
||||
<li>Laurent Mignon <<a class="reference external" href="mailto:laurent.mignon@acsone.eu">laurent.mignon@acsone.eu</a>></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="maintainers">
|
||||
<h2><a class="toc-backref" href="#toc-entry-6">Maintainers</a></h2>
|
||||
<p>This module is maintained by the OCA.</p>
|
||||
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
|
||||
<p>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.</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/rest-framework/tree/16.0/base_rest_datamodel">OCA/rest-framework</a> project on GitHub.</p>
|
||||
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
from . import test_response
|
||||
from . import test_from_params
|
||||
|
|
@ -0,0 +1,53 @@
|
|||
# Copyright 2021 Wakari SRL
|
||||
# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
|
||||
from unittest import mock
|
||||
|
||||
from odoo.exceptions import UserError
|
||||
|
||||
from odoo.addons.datamodel import fields
|
||||
from odoo.addons.datamodel.core import Datamodel
|
||||
from odoo.addons.datamodel.tests import common
|
||||
|
||||
from .. import restapi
|
||||
|
||||
|
||||
class TestDataModel(common.DatamodelRegistryCase):
|
||||
def setUp(self):
|
||||
super(TestDataModel, self).setUp()
|
||||
|
||||
class Datamodel1(Datamodel):
|
||||
_name = "datamodel1"
|
||||
|
||||
name = fields.String(required=True, allow_none=False)
|
||||
description = fields.String(required=False)
|
||||
|
||||
Datamodel1._build_datamodel(self.datamodel_registry)
|
||||
|
||||
def _from_params(self, datamodel_name, params, **kwargs):
|
||||
restapi_datamodel = restapi.Datamodel(datamodel_name, **kwargs)
|
||||
mock_service = mock.Mock()
|
||||
mock_service.env = self.env
|
||||
return restapi_datamodel.from_params(mock_service, params)
|
||||
|
||||
def test_from_params(self):
|
||||
params = {"name": "Instance Name", "description": "Instance Description"}
|
||||
instance = self._from_params("datamodel1", params)
|
||||
self.assertEqual(instance.name, params["name"])
|
||||
self.assertEqual(instance.description, params["description"])
|
||||
|
||||
def test_from_params_missing_optional_field(self):
|
||||
params = {"name": "Instance Name"}
|
||||
instance = self._from_params("datamodel1", params)
|
||||
self.assertEqual(instance.name, params["name"])
|
||||
self.assertIsNone(instance.description)
|
||||
|
||||
def test_from_params_missing_required_field(self):
|
||||
msg = r"BadRequest {'name': \['Missing data for required field.'\]}"
|
||||
with self.assertRaisesRegex(UserError, msg):
|
||||
self._from_params("datamodel1", {"description": "Instance Description"})
|
||||
|
||||
def test_from_partial_params_missing_required_field(self):
|
||||
params = {"description": "Instance Description"}
|
||||
instance = self._from_params("datamodel1", params, partial=True)
|
||||
self.assertEqual(instance.description, params["description"])
|
||||
self.assertIsNone(instance.name)
|
||||
|
|
@ -0,0 +1,77 @@
|
|||
# Copyright 2021 Wakari SRL
|
||||
# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
|
||||
from unittest import mock
|
||||
|
||||
import marshmallow
|
||||
|
||||
from odoo.addons.base_rest_datamodel import restapi
|
||||
from odoo.addons.datamodel import fields
|
||||
from odoo.addons.datamodel.core import Datamodel
|
||||
from odoo.addons.datamodel.tests import common
|
||||
|
||||
|
||||
class TestDataModel(common.DatamodelRegistryCase):
|
||||
def _to_response(self, instance):
|
||||
restapi_datamodel = restapi.Datamodel(instance._name)
|
||||
mock_service = mock.Mock()
|
||||
mock_service.env = self.env
|
||||
return restapi_datamodel.to_response(mock_service, instance)
|
||||
|
||||
def test_to_response(self):
|
||||
class Datamodel1(Datamodel):
|
||||
_name = "datamodel1"
|
||||
|
||||
name = fields.String(required=True, allow_none=False)
|
||||
|
||||
Datamodel1._build_datamodel(self.datamodel_registry)
|
||||
instance = self.env.datamodels["datamodel1"](name="Instance 1")
|
||||
res = self._to_response(instance)
|
||||
self.assertEqual(res["name"], instance.name)
|
||||
|
||||
def test_to_response_dump_only(self):
|
||||
class Datamodel2(Datamodel):
|
||||
_name = "datamodel2"
|
||||
|
||||
name = fields.String(required=True, allow_none=False, dump_only=True)
|
||||
|
||||
Datamodel2._build_datamodel(self.datamodel_registry)
|
||||
schema = self.env.datamodels["datamodel2"].get_schema()
|
||||
self.assertEqual(schema.unknown, "raise")
|
||||
msg = r"{'name': \['Unknown field.'\]}"
|
||||
with self.assertRaisesRegex(marshmallow.exceptions.ValidationError, msg):
|
||||
# confirmation that "name" cannot be loaded
|
||||
self.env.datamodels["datamodel2"].load({"name": "Failure"})
|
||||
instance = self.env.datamodels["datamodel2"](name="Instance 2")
|
||||
res = self._to_response(instance)
|
||||
self.assertEqual(res["name"], instance.name)
|
||||
# schema 'unknown' is back to "raise"
|
||||
self.assertEqual(schema.unknown, "raise")
|
||||
|
||||
def test_to_response_dump_only_nested(self):
|
||||
class Datamodel3(Datamodel):
|
||||
_name = "datamodel3"
|
||||
|
||||
child = fields.NestedModel("nested_datamodel")
|
||||
|
||||
class NestedDatamodel(Datamodel):
|
||||
_name = "nested_datamodel"
|
||||
|
||||
name = fields.String(required=True, allow_none=False, dump_only=True)
|
||||
|
||||
NestedDatamodel._build_datamodel(self.datamodel_registry)
|
||||
Datamodel3._build_datamodel(self.datamodel_registry)
|
||||
for datamodel_name in ("datamodel3", "nested_datamodel"):
|
||||
schema = self.env.datamodels[datamodel_name].get_schema()
|
||||
self.assertEqual(schema.unknown, "raise")
|
||||
msg = r"{'name': \['Unknown field.'\]}"
|
||||
with self.assertRaisesRegex(marshmallow.exceptions.ValidationError, msg):
|
||||
# confirmation that child "name" cannot be loaded
|
||||
self.env.datamodels["datamodel3"].load({"child": {"name": "Failure"}})
|
||||
child_instance = NestedDatamodel(name="Child Instance")
|
||||
instance = self.env.datamodels["datamodel3"](child=child_instance)
|
||||
res = self._to_response(instance)
|
||||
self.assertEqual(res["child"]["name"], child_instance.name)
|
||||
for datamodel_name in ("datamodel3", "nested_datamodel"):
|
||||
schema = self.env.datamodels[datamodel_name].get_schema()
|
||||
# schema 'unknown' is back to "raise"
|
||||
self.assertEqual(schema.unknown, "raise")
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
# Architecture
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
U[Users] -->|HTTP| V[Views and QWeb Templates]
|
||||
V --> C[Controllers]
|
||||
V --> W[Wizards – Transient Models]
|
||||
C --> M[Models and ORM]
|
||||
W --> M
|
||||
M --> R[Reports]
|
||||
DX[Data XML] --> M
|
||||
S[Security – ACLs and Groups] -. enforces .-> M
|
||||
|
||||
subgraph Base_rest_datamodel Module - base_rest_datamodel
|
||||
direction LR
|
||||
M:::layer
|
||||
W:::layer
|
||||
C:::layer
|
||||
V:::layer
|
||||
R:::layer
|
||||
S:::layer
|
||||
DX:::layer
|
||||
end
|
||||
|
||||
classDef layer fill:#eef8ff,stroke:#6ea8fe,stroke-width:1px
|
||||
```
|
||||
|
||||
Notes
|
||||
- Views include tree/form/kanban templates and report templates.
|
||||
- Controllers provide website/portal routes when present.
|
||||
- Wizards are UI flows implemented with `models.TransientModel`.
|
||||
- Data XML loads data/demo records; Security defines groups and access.
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# Configuration
|
||||
|
||||
Refer to Odoo settings for base_rest_datamodel. Configure related models, access rights, and options as needed.
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# Controllers
|
||||
|
||||
This module does not define custom HTTP controllers.
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
# Dependencies
|
||||
|
||||
This addon depends on:
|
||||
|
||||
- [base_rest](../../odoo-bringout-oca-rest-framework-base_rest)
|
||||
- [datamodel](../../odoo-bringout-oca-rest-framework-datamodel)
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
# FAQ
|
||||
|
||||
- Q: Which Odoo version? A: 16.0 (OCA/OCB packaged).
|
||||
- Q: How to enable? A: Start server with --addon base_rest_datamodel or install in UI.
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
# Install
|
||||
|
||||
```bash
|
||||
pip install odoo-bringout-oca-rest-framework-base_rest_datamodel"
|
||||
# or
|
||||
uv pip install odoo-bringout-oca-rest-framework-base_rest_datamodel"
|
||||
```
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
# Models
|
||||
|
||||
Detected core models and extensions in base_rest_datamodel.
|
||||
|
||||
```mermaid
|
||||
classDiagram
|
||||
```
|
||||
|
||||
Notes
|
||||
- Classes show model technical names; fields omitted for brevity.
|
||||
- Items listed under _inherit are extensions of existing models.
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
# Overview
|
||||
|
||||
Packaged Odoo addon: base_rest_datamodel. Provides features documented in upstream Odoo 16 under this addon.
|
||||
|
||||
- Source: OCA/OCB 16.0, addon base_rest_datamodel
|
||||
- License: LGPL-3
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# Reports
|
||||
|
||||
This module does not define custom reports.
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
# Security
|
||||
|
||||
This module does not define custom security rules or access controls beyond Odoo defaults.
|
||||
|
||||
Default Odoo security applies:
|
||||
- Base user access through standard groups
|
||||
- Model access inherited from dependencies
|
||||
- No custom row-level security rules
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
# Troubleshooting
|
||||
|
||||
- Ensure Python and Odoo environment matches repo guidance.
|
||||
- Check database connectivity and logs if startup fails.
|
||||
- Validate that dependent addons listed in DEPENDENCIES.md are installed.
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
# Usage
|
||||
|
||||
Start Odoo including this addon (from repo root):
|
||||
|
||||
```bash
|
||||
python3 scripts/nix_odoo_web_server.py --db-name mydb --addon base_rest_datamodel
|
||||
```
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# Wizards
|
||||
|
||||
This module does not include UI wizards.
|
||||
|
|
@ -0,0 +1,44 @@
|
|||
[project]
|
||||
name = "odoo-bringout-oca-rest-framework-base_rest_datamodel"
|
||||
version = "16.0.0"
|
||||
description = "Base Rest Datamodel -
|
||||
Datamodel binding for base_rest"
|
||||
authors = [
|
||||
{ name = "Ernad Husremovic", email = "hernad@bring.out.ba" }
|
||||
]
|
||||
dependencies = [
|
||||
"odoo-bringout-oca-rest-framework-base_rest>=16.0.0",
|
||||
"odoo-bringout-oca-rest-framework-datamodel>=16.0.0",
|
||||
"requests>=2.25.1"
|
||||
]
|
||||
readme = "README.md"
|
||||
requires-python = ">= 3.11"
|
||||
classifiers = [
|
||||
"Development Status :: 5 - Production/Stable",
|
||||
"Intended Audience :: Developers",
|
||||
"License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)",
|
||||
"Programming Language :: Python :: 3",
|
||||
"Programming Language :: Python :: 3.11",
|
||||
"Programming Language :: Python :: 3.12",
|
||||
"Topic :: Office/Business",
|
||||
]
|
||||
|
||||
[project.urls]
|
||||
homepage = "https://github.com/bringout/0"
|
||||
repository = "https://github.com/bringout/0"
|
||||
|
||||
[build-system]
|
||||
requires = ["hatchling"]
|
||||
build-backend = "hatchling.build"
|
||||
|
||||
[tool.hatch.metadata]
|
||||
allow-direct-references = true
|
||||
|
||||
[tool.hatch.build.targets.wheel]
|
||||
packages = ["base_rest_datamodel"]
|
||||
|
||||
[tool.rye]
|
||||
managed = true
|
||||
dev-dependencies = [
|
||||
"pytest>=8.4.1",
|
||||
]
|
||||
Loading…
Add table
Add a link
Reference in a new issue