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 > README.rst </ title >
6+ < title > Base Rest </ title >
77< style type ="text/css ">
88
99/*
360360</ style >
361361</ head >
362362< body >
363- < div class ="document ">
363+ < div class ="document " id ="base-rest ">
364+ < h1 class ="title "> Base Rest</ h1 >
364365
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 >
371366<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
372367!! This file is generated by oca-gen-addon-readme !!
373368!! changes will be overwritten. !!
374369!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
375370!! source digest: sha256:4bac77b10863d37a6d94d450ac1584accce5be4a436a7a839f8035d8cab1729d
376371!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
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 >
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 >
378373< p > This addon is deprecated and not fully supported anymore from Odoo 16.
379374Please migrate to the FastAPI migration module. See
380375< a class ="reference external " href ="https://github.com/OCA/rest-framework/pull/291 "> https://github.com/OCA/rest-framework/pull/291</ a > .</ p >
@@ -414,7 +409,7 @@ <h1>Base Rest</h1>
414409</ ul >
415410</ div >
416411< div class ="section " id ="configuration ">
417- < h2 > < a class ="toc-backref " href ="#toc-entry-1 "> Configuration</ a > </ h2 >
412+ < h1 > < a class ="toc-backref " href ="#toc-entry-1 "> Configuration</ a > </ h1 >
418413< p > If an error occurs when calling a method of a service (ie missing
419414parameter, ..) the system returns only a general description of the
420415problem without details. This is done on purpose to ensure maximum
@@ -436,7 +431,7 @@ <h2><a class="toc-backref" href="#toc-entry-1">Configuration</a></h2>
436431mode in production</ strong > .</ p >
437432</ div >
438433< div class ="section " id ="usage ">
439- < h2 > < a class ="toc-backref " href ="#toc-entry-2 "> Usage</ a > </ h2 >
434+ < h1 > < a class ="toc-backref " href ="#toc-entry-2 "> Usage</ a > </ h1 >
440435< p > To add your own REST service you must provides at least 2 classes.</ p >
441436< ul class ="simple ">
442437< li > A Component providing the business logic of your service,</ li >
@@ -683,17 +678,17 @@ <h2><a class="toc-backref" href="#toc-entry-2">Usage</a></h2>
683678evaluation context.</ p >
684679</ div >
685680< div class ="section " id ="known-issues-roadmap ">
686- < h2 > < a class ="toc-backref " href ="#toc-entry-3 "> Known issues / Roadmap</ a > </ h2 >
681+ < h1 > < a class ="toc-backref " href ="#toc-entry-3 "> Known issues / Roadmap</ a > </ h1 >
687682< p > The
688683< a class ="reference external " href ="https://github.com/OCA/rest-framework/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement+label%3Abase_rest "> roadmap</ a >
689684and < a class ="reference external " href ="https://github.com/OCA/rest-framework/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Abase_rest "> known
690685issues</ a >
691686can be found on GitHub.</ p >
692687</ div >
693688< div class ="section " id ="changelog ">
694- < h2 > < a class ="toc-backref " href ="#toc-entry-4 "> Changelog</ a > </ h2 >
689+ < h1 > < a class ="toc-backref " href ="#toc-entry-4 "> Changelog</ a > </ h1 >
695690< div class ="section " id ="section-1 ">
696- < h3 > < a class ="toc-backref " href ="#toc-entry-5 "> 16.0.1.0.2 (2023-10-07)</ a > </ h3 >
691+ < h2 > < a class ="toc-backref " href ="#toc-entry-5 "> 16.0.1.0.2 (2023-10-07)</ a > </ h2 >
697692< p > < strong > Features</ strong > </ p >
698693< ul class ="simple ">
699694< li > Add support for oauth2 security scheme in the Swagger UI. If your
@@ -707,59 +702,59 @@ <h3><a class="toc-backref" href="#toc-entry-5">16.0.1.0.2 (2023-10-07)</a></h3>
707702</ ul >
708703</ div >
709704< div class ="section " id ="section-2 ">
710- < h3 > < a class ="toc-backref " href ="#toc-entry-6 "> 12.0.2.0.1</ a > </ h3 >
705+ < h2 > < a class ="toc-backref " href ="#toc-entry-6 "> 12.0.2.0.1</ a > </ h2 >
711706< ul class ="simple ">
712707< li > validator_…() methods can now return a cerberus < tt class ="docutils literal "> Validator</ tt >
713708object instead of a schema dictionnary, for additional flexibility
714709(e.g. allowing validator options such as < tt class ="docutils literal "> allow_unknown</ tt > ).</ li >
715710</ ul >
716711</ div >
717712< div class ="section " id ="section-3 ">
718- < h3 > < a class ="toc-backref " href ="#toc-entry-7 "> 12.0.2.0.0</ a > </ h3 >
713+ < h2 > < a class ="toc-backref " href ="#toc-entry-7 "> 12.0.2.0.0</ a > </ h2 >
719714< ul class ="simple ">
720715< li > Licence changed from AGPL-3 to LGPL-3</ li >
721716</ ul >
722717</ div >
723718< div class ="section " id ="section-4 ">
724- < h3 > < a class ="toc-backref " href ="#toc-entry-8 "> 12.0.1.0.1</ a > </ h3 >
719+ < h2 > < a class ="toc-backref " href ="#toc-entry-8 "> 12.0.1.0.1</ a > </ h2 >
725720< ul class ="simple ">
726721< li > Fix issue when rendering the jsonapi documentation if no documentation
727722is provided on a method part of the REST api.</ li >
728723</ ul >
729724</ div >
730725< div class ="section " id ="section-5 ">
731- < h3 > < a class ="toc-backref " href ="#toc-entry-9 "> 12.0.1.0.0</ a > </ h3 >
726+ < h2 > < a class ="toc-backref " href ="#toc-entry-9 "> 12.0.1.0.0</ a > </ h2 >
732727< p > First official version. The addon has been incubated into the
733728< a class ="reference external " href ="https://github.com/akretion/odoo-shopinvader "> Shopinvader
734729repository</ a > from
735730Akretion. For more information you need to look at the git log.</ p >
736731</ div >
737732</ div >
738733< div class ="section " id ="bug-tracker ">
739- < h2 > < a class ="toc-backref " href ="#toc-entry-10 "> Bug Tracker</ a > </ h2 >
734+ < h1 > < a class ="toc-backref " href ="#toc-entry-10 "> Bug Tracker</ a > </ h1 >
740735< p > Bugs are tracked on < a class ="reference external " href ="https://github.com/OCA/rest-framework/issues "> GitHub Issues</ a > .
741736In case of trouble, please check there if your issue has already been reported.
742737If you spotted it first, help us to smash it by providing a detailed and welcomed
743738< 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 >
744739< p > Do not contact contributors directly about support or help with technical issues.</ p >
745740</ div >
746741< div class ="section " id ="credits ">
747- < h2 > < a class ="toc-backref " href ="#toc-entry-11 "> Credits</ a > </ h2 >
742+ < h1 > < a class ="toc-backref " href ="#toc-entry-11 "> Credits</ a > </ h1 >
748743< div class ="section " id ="authors ">
749- < h3 > < a class ="toc-backref " href ="#toc-entry-12 "> Authors</ a > </ h3 >
744+ < h2 > < a class ="toc-backref " href ="#toc-entry-12 "> Authors</ a > </ h2 >
750745< ul class ="simple ">
751746< li > ACSONE SA/NV</ li >
752747</ ul >
753748</ div >
754749< div class ="section " id ="contributors ">
755- < h3 > < a class ="toc-backref " href ="#toc-entry-13 "> Contributors</ a > </ h3 >
750+ < h2 > < a class ="toc-backref " href ="#toc-entry-13 "> Contributors</ a > </ h2 >
756751< ul class ="simple ">
757752< li > Laurent Mignon << a class ="reference external " href ="mailto:laurent.mignon@acsone.eu "> laurent.mignon@acsone.eu</ a > ></ li >
758753< li > Sébastien Beau << a class ="reference external " href ="mailto:sebastien.beau@akretion.com "> sebastien.beau@akretion.com</ a > ></ li >
759754</ ul >
760755</ div >
761756< div class ="section " id ="maintainers ">
762- < h3 > < a class ="toc-backref " href ="#toc-entry-14 "> Maintainers</ a > </ h3 >
757+ < h2 > < a class ="toc-backref " href ="#toc-entry-14 "> Maintainers</ a > </ h2 >
763758< p > This module is maintained by the OCA.</ p >
764759< a class ="reference external image-reference " href ="https://odoo-community.org ">
765760< img alt ="Odoo Community Association " src ="https://odoo-community.org/logo.png " />
@@ -772,6 +767,5 @@ <h3><a class="toc-backref" href="#toc-entry-14">Maintainers</a></h3>
772767</ div >
773768</ div >
774769</ div >
775- </ div >
776770</ body >
777771</ html >
0 commit comments