Skip to content

Commit 7dd2970

Browse files
committed
[ADD] webservice_base
Refactoring of `webservice` module to remove dependency on `component`.
1 parent 04908b5 commit 7dd2970

22 files changed

+2468
-0
lines changed

webservice_base/README.rst

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
===============
2+
WebService Base
3+
===============
4+
5+
..
6+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
7+
!! This file is generated by oca-gen-addon-readme !!
8+
!! changes will be overwritten. !!
9+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
10+
!! source digest: sha256:ad7f19cee6c43ff3b4e9901cd1fd7be8b4ec5b0c5a73c7fad30497bdb0f27037
11+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
12+
13+
.. |badge1| image:: https://img.shields.io/badge/maturity-Production%2FStable-green.png
14+
:target: https://odoo-community.org/page/development-status
15+
:alt: Production/Stable
16+
.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png
17+
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
18+
:alt: License: LGPL-3
19+
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb--api-lightgray.png?logo=github
20+
:target: https://github.com/OCA/web-api/tree/18.0/webservice_base
21+
:alt: OCA/web-api
22+
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
23+
:target: https://translation.odoo-community.org/projects/web-api-18-0/web-api-18-0-webservice_base
24+
:alt: Translate me on Weblate
25+
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
26+
:target: https://runboat.odoo-community.org/builds?repo=OCA/web-api&target_branch=18.0
27+
:alt: Try me on Runboat
28+
29+
|badge1| |badge2| |badge3| |badge4| |badge5|
30+
31+
This module creates WebService frameworks to be used globally.
32+
33+
It introduces support for HTTP Request protocol. The webservice HTTP
34+
call returns by default the content of the response. A context
35+
'content_only' can be passed to get the full response object.
36+
37+
It comes with no additional dependencies. For the original
38+
implementation relying on ``components`` objects, see the ``webservice``
39+
addon module.
40+
41+
This work is derived from that module, removing the ``components`` and
42+
``server_env`` dependencies to make it lighter. As a design decision,
43+
using ``components`` seems to an an additional abstraction layer (and
44+
dependency) that brings little benefit, and removing it brings the
45+
implementation closer to Odoo's framework design patterns.
46+
47+
**Table of contents**
48+
49+
.. contents::
50+
:local:
51+
52+
Bug Tracker
53+
===========
54+
55+
Bugs are tracked on `GitHub Issues <https://github.com/OCA/web-api/issues>`_.
56+
In case of trouble, please check there if your issue has already been reported.
57+
If you spotted it first, help us to smash it by providing a detailed and welcomed
58+
`feedback <https://github.com/OCA/web-api/issues/new?body=module:%20webservice_base%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
59+
60+
Do not contact contributors directly about support or help with technical issues.
61+
62+
Credits
63+
=======
64+
65+
Authors
66+
-------
67+
68+
* Creu Blanca
69+
* Camptocamp
70+
71+
Contributors
72+
------------
73+
74+
- Enric Tobella <[email protected]>
75+
- Alexandre Fayolle <[email protected]>
76+
- Daniel Reis <[email protected]>
77+
78+
Maintainers
79+
-----------
80+
81+
This module is maintained by the OCA.
82+
83+
.. image:: https://odoo-community.org/logo.png
84+
:alt: Odoo Community Association
85+
:target: https://odoo-community.org
86+
87+
OCA, or the Odoo Community Association, is a nonprofit organization whose
88+
mission is to support the collaborative development of Odoo features and
89+
promote its widespread use.
90+
91+
.. |maintainer-etobella| image:: https://github.com/etobella.png?size=40px
92+
:target: https://github.com/etobella
93+
:alt: etobella
94+
95+
Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
96+
97+
|maintainer-etobella|
98+
99+
This module is part of the `OCA/web-api <https://github.com/OCA/web-api/tree/18.0/webservice_base>`_ project on GitHub.
100+
101+
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

webservice_base/__init__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
from . import models

webservice_base/__manifest__.py

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Copyright 2020 Creu Blanca
2+
# Copyright 2022 Camptocamp SA
3+
# @author Simone Orsi <[email protected]>
4+
# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
5+
6+
{
7+
"name": "WebService Base",
8+
"summary": """Defines webservice abstract definition to be used generally""",
9+
"version": "18.0.1.1.0",
10+
"license": "LGPL-3",
11+
"development_status": "Production/Stable",
12+
"maintainers": ["etobella"],
13+
"author": "Creu Blanca, Camptocamp, Odoo Community Association (OCA)",
14+
"website": "https://github.com/OCA/web-api",
15+
"depends": ["base"],
16+
"external_dependencies": {"python": ["requests-oauthlib", "oauthlib", "responses"]},
17+
"data": [
18+
"security/ir.model.access.csv",
19+
"security/ir_rule.xml",
20+
"views/webservice_backend.xml",
21+
],
22+
"demo": [],
23+
}

0 commit comments

Comments
 (0)