33< head >
44< meta http-equiv ="Content-Type " content ="text/html; charset=utf-8 " />
55< meta name ="generator " content ="Docutils: https://docutils.sourceforge.io/ " />
6- < title > Base Rest </ title >
6+ < title > README.rst </ title >
77< style type ="text/css ">
88
99/*
360360</ style >
361361</ head >
362362< body >
363- < div class ="document " id ="base-rest ">
364- < h1 class ="title "> Base Rest</ h1 >
363+ < div class ="document ">
365364
365+
366+ < a class ="reference external image-reference " href ="https://odoo-community.org/get-involved?utm_source=readme ">
367+ < img alt ="Odoo Community Association " src ="https://odoo-community.org/readme-banner-image " />
368+ </ a >
369+ < div class ="section " id ="base-rest ">
370+ < h1 > Base Rest</ h1 >
366371<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
367372!! This file is generated by oca-gen-addon-readme !!
368373!! changes will be overwritten. !!
369374!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
370- !! source digest: sha256:4bac77b10863d37a6d94d450ac1584accce5be4a436a7a839f8035d8cab1729d
375+ !! source digest: sha256:25cd8c40026a737b1bedc8d9b51867a5be4866256a570f3363f939584faece0d
371376!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
372- < 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/18.0/base_rest "> < 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-18-0/rest-framework-18-0-base_rest "> < 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=18.0 "> < img alt ="Try me on Runboat " src ="https://img.shields.io/badge/runboat-Try%20me-875A7B.png " /> </ a > </ p >
377+ < 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/license-LGPL--3-blue.png " /> </ a > < a class ="reference external image-reference " href ="https://github.com/OCA/rest-framework/tree/18.0/base_rest "> < 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-18-0/rest-framework-18-0-base_rest "> < 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=18.0 "> < img alt ="Try me on Runboat " src ="https://img.shields.io/badge/runboat-Try%20me-875A7B.png " /> </ a > </ p >
373378< p > This addon is deprecated and not fully supported anymore from Odoo 16.
374379Please migrate to the FastAPI migration module. See
375380< a class ="reference external " href ="https://github.com/OCA/rest-framework/pull/291 "> https://github.com/OCA/rest-framework/pull/291</ a > .</ p >
@@ -409,7 +414,7 @@ <h1 class="title">Base Rest</h1>
409414</ ul >
410415</ div >
411416< div class ="section " id ="configuration ">
412- < h1 > < a class ="toc-backref " href ="#toc-entry-1 "> Configuration</ a > </ h1 >
417+ < h2 > < a class ="toc-backref " href ="#toc-entry-1 "> Configuration</ a > </ h2 >
413418< p > If an error occurs when calling a method of a service (ie missing
414419parameter, ..) the system returns only a general description of the
415420problem without details. This is done on purpose to ensure maximum
@@ -431,7 +436,7 @@ <h1><a class="toc-backref" href="#toc-entry-1">Configuration</a></h1>
431436mode in production</ strong > .</ p >
432437</ div >
433438< div class ="section " id ="usage ">
434- < h1 > < a class ="toc-backref " href ="#toc-entry-2 "> Usage</ a > </ h1 >
439+ < h2 > < a class ="toc-backref " href ="#toc-entry-2 "> Usage</ a > </ h2 >
435440< p > To add your own REST service you must provides at least 2 classes.</ p >
436441< ul class ="simple ">
437442< li > A Component providing the business logic of your service,</ li >
@@ -678,17 +683,17 @@ <h1><a class="toc-backref" href="#toc-entry-2">Usage</a></h1>
678683evaluation context.</ p >
679684</ div >
680685< div class ="section " id ="known-issues-roadmap ">
681- < h1 > < a class ="toc-backref " href ="#toc-entry-3 "> Known issues / Roadmap</ a > </ h1 >
686+ < h2 > < a class ="toc-backref " href ="#toc-entry-3 "> Known issues / Roadmap</ a > </ h2 >
682687< p > The
683688< a class ="reference external " href ="https://github.com/OCA/rest-framework/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement+label%3Abase_rest "> roadmap</ a >
684689and < a class ="reference external " href ="https://github.com/OCA/rest-framework/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Abase_rest "> known
685690issues</ a >
686691can be found on GitHub.</ p >
687692</ div >
688693< div class ="section " id ="changelog ">
689- < h1 > < a class ="toc-backref " href ="#toc-entry-4 "> Changelog</ a > </ h1 >
694+ < h2 > < a class ="toc-backref " href ="#toc-entry-4 "> Changelog</ a > </ h2 >
690695< div class ="section " id ="section-1 ">
691- < h2 > < a class ="toc-backref " href ="#toc-entry-5 "> 16.0.1.0.2 (2023-10-07)</ a > </ h2 >
696+ < h3 > < a class ="toc-backref " href ="#toc-entry-5 "> 16.0.1.0.2 (2023-10-07)</ a > </ h3 >
692697< p > < strong > Features</ strong > </ p >
693698< ul class ="simple ">
694699< li > Add support for oauth2 security scheme in the Swagger UI. If your
@@ -702,59 +707,59 @@ <h2><a class="toc-backref" href="#toc-entry-5">16.0.1.0.2 (2023-10-07)</a></h2>
702707</ ul >
703708</ div >
704709< div class ="section " id ="section-2 ">
705- < h2 > < a class ="toc-backref " href ="#toc-entry-6 "> 12.0.2.0.1</ a > </ h2 >
710+ < h3 > < a class ="toc-backref " href ="#toc-entry-6 "> 12.0.2.0.1</ a > </ h3 >
706711< ul class ="simple ">
707712< li > validator_…() methods can now return a cerberus < tt class ="docutils literal "> Validator</ tt >
708713object instead of a schema dictionnary, for additional flexibility
709714(e.g. allowing validator options such as < tt class ="docutils literal "> allow_unknown</ tt > ).</ li >
710715</ ul >
711716</ div >
712717< div class ="section " id ="section-3 ">
713- < h2 > < a class ="toc-backref " href ="#toc-entry-7 "> 12.0.2.0.0</ a > </ h2 >
718+ < h3 > < a class ="toc-backref " href ="#toc-entry-7 "> 12.0.2.0.0</ a > </ h3 >
714719< ul class ="simple ">
715720< li > Licence changed from AGPL-3 to LGPL-3</ li >
716721</ ul >
717722</ div >
718723< div class ="section " id ="section-4 ">
719- < h2 > < a class ="toc-backref " href ="#toc-entry-8 "> 12.0.1.0.1</ a > </ h2 >
724+ < h3 > < a class ="toc-backref " href ="#toc-entry-8 "> 12.0.1.0.1</ a > </ h3 >
720725< ul class ="simple ">
721726< li > Fix issue when rendering the jsonapi documentation if no documentation
722727is provided on a method part of the REST api.</ li >
723728</ ul >
724729</ div >
725730< div class ="section " id ="section-5 ">
726- < h2 > < a class ="toc-backref " href ="#toc-entry-9 "> 12.0.1.0.0</ a > </ h2 >
731+ < h3 > < a class ="toc-backref " href ="#toc-entry-9 "> 12.0.1.0.0</ a > </ h3 >
727732< p > First official version. The addon has been incubated into the
728733< a class ="reference external " href ="https://github.com/akretion/odoo-shopinvader "> Shopinvader
729734repository</ a > from
730735Akretion. For more information you need to look at the git log.</ p >
731736</ div >
732737</ div >
733738< div class ="section " id ="bug-tracker ">
734- < h1 > < a class ="toc-backref " href ="#toc-entry-10 "> Bug Tracker</ a > </ h1 >
739+ < h2 > < a class ="toc-backref " href ="#toc-entry-10 "> Bug Tracker</ a > </ h2 >
735740< p > Bugs are tracked on < a class ="reference external " href ="https://github.com/OCA/rest-framework/issues "> GitHub Issues</ a > .
736741In case of trouble, please check there if your issue has already been reported.
737742If you spotted it first, help us to smash it by providing a detailed and welcomed
738743< a class ="reference external " href ="https://github.com/OCA/rest-framework/issues/new?body=module:%20base_rest%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior** "> feedback</ a > .</ p >
739744< p > Do not contact contributors directly about support or help with technical issues.</ p >
740745</ div >
741746< div class ="section " id ="credits ">
742- < h1 > < a class ="toc-backref " href ="#toc-entry-11 "> Credits</ a > </ h1 >
747+ < h2 > < a class ="toc-backref " href ="#toc-entry-11 "> Credits</ a > </ h2 >
743748< div class ="section " id ="authors ">
744- < h2 > < a class ="toc-backref " href ="#toc-entry-12 "> Authors</ a > </ h2 >
749+ < h3 > < a class ="toc-backref " href ="#toc-entry-12 "> Authors</ a > </ h3 >
745750< ul class ="simple ">
746751< li > ACSONE SA/NV</ li >
747752</ ul >
748753</ div >
749754< div class ="section " id ="contributors ">
750- < h2 > < a class ="toc-backref " href ="#toc-entry-13 "> Contributors</ a > </ h2 >
755+ < h3 > < a class ="toc-backref " href ="#toc-entry-13 "> Contributors</ a > </ h3 >
751756< ul class ="simple ">
752757< li > Laurent Mignon << a class ="reference external " href ="mailto:laurent.mignon@acsone.eu "> laurent.mignon@acsone.eu</ a > ></ li >
753758< li > Sébastien Beau << a class ="reference external " href ="mailto:sebastien.beau@akretion.com "> sebastien.beau@akretion.com</ a > ></ li >
754759</ ul >
755760</ div >
756761< div class ="section " id ="maintainers ">
757- < h2 > < a class ="toc-backref " href ="#toc-entry-14 "> Maintainers</ a > </ h2 >
762+ < h3 > < a class ="toc-backref " href ="#toc-entry-14 "> Maintainers</ a > </ h3 >
758763< p > This module is maintained by the OCA.</ p >
759764< a class ="reference external image-reference " href ="https://odoo-community.org ">
760765< img alt ="Odoo Community Association " src ="https://odoo-community.org/logo.png " />
@@ -767,5 +772,6 @@ <h2><a class="toc-backref" href="#toc-entry-14">Maintainers</a></h2>
767772</ div >
768773</ div >
769774</ div >
775+ </ div >
770776</ body >
771777</ html >
0 commit comments