Author: |
ACSONE SA/NV, Odoo Community Association (OCA) |
License: |
LGPL-3 |
Branch: |
10.0-backport-context-provider-lmi |
Repository: |
acsone/rest-framework |
Dependencies: |
base_rest,
and
component |
Languages: |
HTML (365, 14.1%),
JSON (1660, 64.0%),
Python (503, 19.4%),
and
reStructuredText (67, 2.6%) |
Other branches: |
10.0,
10.0-abi_master,
10.0-backport-from-14.0,
10.0-backport-rest-log,
10.0-base_rest_inherit,
10.0-data_model-lmi,
10.0-fix_base_rest_registry,
10.0-fixrestlog-len,
10.0-improve-doc,
10.0-osi_master,
11.0-backport-from-12-13,
11.0-fix_base_rest_registry,
11.0-improve-doc,
12.0,
12.0-asw_master,
12.0-backport-improve-exception-wrap,
12.0-base_rest-cors-options,
12.0-datamodel-experiment,
12.0-fix_base_rest_registry,
12.0-new-api-wip,
13.0,
13.0-48-port,
13.0-backport-base-rest-pydantic,
13.0-backport-extendable,
13.0-base_rest-cors-options,
13.0-fixcrashdesc,
14.0,
14.0-abi_master,
14.0-add-pydantic,
14.0-base-rest-pydantic-lmi,
14.0-base_res_service_add_properties-qgr,
14.0-deprecated-implicit-rest-method,
14.0-fdl_master,
14.0-fix-path-parameter-name,
14.0-fix-response-processing,
14.0-fixcrashdesc,
14.0-moz_master,
15.0,
15.0-initial,
16.0,
16.0-fastapi,
16.0-mfr_fix_base_rest_missing_argument,
16.0-upgrade-pre-commit,
9.0,
and
oca-port-pr--from-14.0-to-13.0 |
Other repositories: |
Ahmad-Datasmith/rest-framework,
Change2improve/rest-framework,
Digital5-Odoo/rest-framework,
Gabinete-Digital/rest-framework,
LeartS/rest-framework,
LevelPrime/rest-framework,
NeatNerdPrime/rest-framework,
OCA-MUK/rest-framework,
OCA/rest-framework,
SetRac/rest-framework,
SeuMarco/rest-framework,
TDu/rest-framework,
Tomaskarpovic/rest-framework,
ajinvn2019/rest-framework,
akretion/rest-framework,
alecvinent/rest-framework,
altanmur/rest-framework,
andres-mejia/rest-framework,
baotnp/rest-framework,
bigmoney-team/rest-framework,
boky1993/rest-framework,
cedvict/rest-framework,
coopiteasy/rest-framework,
darshan-odoo/rest-framework,
dndoanh/rest-framework,
elmosolutions/rest-framework,
gaanto/rest-framework,
gastonfeng/rest-framework,
glm-conseil/rest-framework,
guewen/rest-framework,
gurneyalex/rest-framework,
guwenfeng/rest-framework,
hinfo506/rest-framework,
hminle/rest-framework,
huntergps/rest-framework,
id42sistemas/rest-framework,
jacky82669513/rest-framework,
jamesvibar/rest-framework,
janverb/rest-framework,
jobiols/oca-rest-framework,
jorgeblanc9/rest-framework,
josuf567/rest-framework,
lebanggit/rest-framework,
led-startup-studio/rest-framework,
lideritjnma/rest-framework,
marvin981973/rest-framework,
maxindo/rest-framework,
mohamed-helmy/rest-framework,
ngnamuit/rest-framework,
novawish/rest-framework,
odoogap/rest-framework,
oliverzgy/rest-framework,
one2pret/rest-framework,
osvalr/rest-framework,
pscloud/rest-framework,
royalline1/rest-framework,
sanube/rest-framework,
simahawk/rest-framework,
skander-cherif/rest-framework,
themreza/rest-framework,
ursais/rest-framework,
wahello/rest-framework,
warp10/rest-framework,
x0rzkov/odoo-rest-framework,
xaoxaodigital/rest-framework,
xoe-labs/rest-framework,
xubiuit/rest-framework,
xwh123807/rest-framework,
and
yasmanycastillo/rest-framework |
<h1 class="title">Base Rest Demo</h1>
<p><a class="reference external" 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" 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" href="https://github.com/OCA/rest-framework/tree/10.0/base_rest_demo"><img alt="OCA/rest-framework" src="https://img.shields.io/badge/github-OCA%2Frest--framework-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/rest-framework-10-0/rest-framework-10-0-base_rest_demo"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/271/10.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p>Demo addon to illustrate how to develop self documented REST services thanks
to the <strong>base_rest</strong> addon.</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="id3">Usage</a></li>
<li><a class="reference internal" href="#known-issues-roadmap" id="id4">Known issues / Roadmap</a></li>
<li><a class="reference internal" href="#changelog" id="id5">Changelog</a><ul>
<li><a class="reference internal" href="#id1" id="id6">10.0.2.0.0</a></li>
<li><a class="reference internal" href="#id2" id="id7">10.0.1.0.0</a></li>
</ul>
</li>
<li><a class="reference internal" href="#bug-tracker" id="id8">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id9">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id10">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id11">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id12">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<a name="usage"></a>
<h2><a class="toc-backref" href="#id3">Usage</a></h2>
<p>This module provides sample REST services based on base_rest. The documentation
of provided services is available at the '/api_docs' URL. This frontend based
on <a class="reference external" href="https://swagger.io/">Swagger</a> is generated from the implemented
webservices.</p>
<a name="known-issues-roadmap"></a>
<h2><a class="toc-backref" href="#id4">Known issues / Roadmap</a></h2>
<p>The <a class="reference external" href="https://github.com/OCA/rest-framework/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement">roadmap</a>
and <a class="reference external" href="https://github.com/OCA/rest-framework/issues?q=is%3Aopen+is%3Aissue+label%3Abug">known issues</a> can
be found on GitHub.</p>
<a name="changelog"></a>
<h2><a class="toc-backref" href="#id5">Changelog</a></h2>
<a name="id1"></a>
<h3><a class="toc-backref" href="#id6">10.0.2.0.0</a></h3>
<ul class="simple">
<li>Licence changed from AGPL-3 to LGPL-3</li>
</ul>
<a name="id2"></a>
<h3><a class="toc-backref" href="#id7">10.0.1.0.0</a></h3>
<p>First official version.</p>
<a name="bug-tracker"></a>
<h2><a class="toc-backref" href="#id8">Bug Tracker</a></h2>
<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 smashing it by providing a detailed and welcomed
<a class="reference external" href="https://github.com/OCA/rest-framework/issues/new?body=module:%20base_rest_demo%0Aversion:%2010.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>
<a name="credits"></a>
<h2><a class="toc-backref" href="#id9">Credits</a></h2>
<a name="authors"></a>
<h3><a class="toc-backref" href="#id10">Authors</a></h3>
<ul class="simple">
<li>ACSONE SA/NV</li>
</ul>
<a name="contributors"></a>
<h3><a class="toc-backref" href="#id11">Contributors</a></h3>
<ul class="simple">
<li>Laurent Mignon <<a class="reference external" href="mailto:laurent.mignon@acsone.eu">laurent.mignon@acsone.eu</a>></li>
</ul>
<a name="maintainers"></a>
<h3><a class="toc-backref" href="#id12">Maintainers</a></h3>
<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>Current <a class="reference external" href="https://odoo-community.org/page/maintainer-role">maintainer</a>:</p>
<p><a class="reference external" href="https://github.com/lmignon"><img alt="lmignon" src="https://github.com/lmignon.png?size=40px" /></a></p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/rest-framework/tree/10.0/base_rest_demo">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>