[BOT] post-merge updates

README.md

@@ -28,8 +28,8 @@ addon | version | maintainers | summary
 [base_rest_pydantic](base_rest_pydantic/) | 16.0.2.0.1 |  | Pydantic binding for base_rest
 [datamodel](datamodel/) | 16.0.1.0.0 | [![lmignon](https://github.com/lmignon.png?size=30px)](https://github.com/lmignon) | This addon allows you to define simple data models supporting serialization/deserialization
 [extendable](extendable/) | 16.0.1.0.1 | [![lmignon](https://github.com/lmignon.png?size=30px)](https://github.com/lmignon) | Extendable classes registry loader for Odoo
-[extendable_fastapi](extendable_fastapi/) | 16.0.2.0.2 | [![lmignon](https://github.com/lmignon.png?size=30px)](https://github.com/lmignon) | Allows the use of extendable into fastapi apps
-[fastapi](fastapi/) | 16.0.1.1.2 | [![lmignon](https://github.com/lmignon.png?size=30px)](https://github.com/lmignon) | Odoo FastAPI endpoint
+[extendable_fastapi](extendable_fastapi/) | 16.0.2.1.0 | [![lmignon](https://github.com/lmignon.png?size=30px)](https://github.com/lmignon) | Allows the use of extendable into fastapi apps
+[fastapi](fastapi/) | 16.0.1.2.0 | [![lmignon](https://github.com/lmignon.png?size=30px)](https://github.com/lmignon) | Odoo FastAPI endpoint
 [fastapi_auth_jwt](fastapi_auth_jwt/) | 16.0.1.0.1 | [![sbidoul](https://github.com/sbidoul.png?size=30px)](https://github.com/sbidoul) | JWT bearer token authentication for FastAPI.
 [fastapi_auth_jwt_demo](fastapi_auth_jwt_demo/) | 16.0.2.0.0 | [![sbidoul](https://github.com/sbidoul.png?size=30px)](https://github.com/sbidoul) | Test/demo module for fastapi_auth_jwt.
 [graphql_base](graphql_base/) | 16.0.1.0.1 | [![sbidoul](https://github.com/sbidoul.png?size=30px)](https://github.com/sbidoul) | Base GraphQL/GraphiQL controller

extendable_fastapi/README.rst

@@ -7,7 +7,7 @@ Extendable Fastapi
    !! This file is generated by oca-gen-addon-readme !!
    !! changes will be overwritten.                   !!
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-   !! source digest: sha256:c7b10b63e31f4c8afde11bbc7a51c20c62fbe212b77decaa194dbe6bfd413c55
+   !! source digest: sha256:959cc91eecf414d64d236339357d4322403e81584fb614d58d650f238d69fb93
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 
 .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
@@ -39,6 +39,22 @@ models when defining your endpoint handlers request and response models.
 .. contents::
    :local:
 
+Changelog
+=========
+
+16.0.2.1.0 (2023-10-13)
+~~~~~~~~~~~~~~~~~~~~~~~
+
+**Features**
+
+- * New base schemas: *PagedCollection*. This schema is used to define the
+    the structure of a paged collection of resources. This schema is similar
+    to the ones defined in the Odoo's **fastapi** addon but works as/with
+    extendable models.
+
+  * The *StrictExtendableBaseModel* has been moved to the *extendable_pydantic*
+    python lib. You should consider to import it from there. (`#380 <https://github.com/OCA/rest-framework/issues/380>`_)
+
 Bug Tracker
 ===========
 

extendable_fastapi/__manifest__.py

@@ -5,7 +5,7 @@
     "name": "Extendable Fastapi",
     "summary": """
         Allows the use of extendable into fastapi apps""",
-    "version": "16.0.2.0.2",
+    "version": "16.0.2.1.0",
     "license": "LGPL-3",
     "author": "ACSONE SA/NV,Odoo Community Association (OCA)",
     "maintainers": ["lmignon"],

extendable_fastapi/readme/HISTORY.rst

@@ -0,0 +1,12 @@
+16.0.2.1.0 (2023-10-13)
+~~~~~~~~~~~~~~~~~~~~~~~
+
+**Features**
+
+- * New base schemas: *PagedCollection*. This schema is used to define the
+    the structure of a paged collection of resources. This schema is similar
+    to the ones defined in the Odoo's **fastapi** addon but works as/with
+    extendable models.
+
+  * The *StrictExtendableBaseModel* has been moved to the *extendable_pydantic*
+    python lib. You should consider to import it from there. (`#380 <https://github.com/OCA/rest-framework/issues/380>`_)

extendable_fastapi/static/description/index.html

@@ -367,7 +367,7 @@ <h1 class="title">Extendable Fastapi</h1>
 !! This file is generated by oca-gen-addon-readme !!
 !! changes will be overwritten.                   !!
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-!! source digest: sha256:c7b10b63e31f4c8afde11bbc7a51c20c62fbe212b77decaa194dbe6bfd413c55
+!! source digest: sha256:959cc91eecf414d64d236339357d4322403e81584fb614d58d650f238d69fb93
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
 <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/extendable_fastapi"><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-extendable_fastapi"><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&amp;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 is a technical addon used to allows the use of
@@ -378,40 +378,62 @@ <h1 class="title">Extendable Fastapi</h1>
 <p><strong>Table of contents</strong></p>
 <div class="contents local topic" id="contents">
 <ul class="simple">
-<li><a class="reference internal" href="#bug-tracker" id="toc-entry-1">Bug Tracker</a></li>
-<li><a class="reference internal" href="#credits" id="toc-entry-2">Credits</a><ul>
-<li><a class="reference internal" href="#authors" id="toc-entry-3">Authors</a></li>
-<li><a class="reference internal" href="#contributors" id="toc-entry-4">Contributors</a></li>
-<li><a class="reference internal" href="#maintainers" id="toc-entry-5">Maintainers</a></li>
+<li><a class="reference internal" href="#changelog" id="toc-entry-1">Changelog</a><ul>
+<li><a class="reference internal" href="#section-1" id="toc-entry-2">16.0.2.1.0 (2023-10-13)</a></li>
 </ul>
 </li>
+<li><a class="reference internal" href="#bug-tracker" id="toc-entry-3">Bug Tracker</a></li>
+<li><a class="reference internal" href="#credits" id="toc-entry-4">Credits</a><ul>
+<li><a class="reference internal" href="#authors" id="toc-entry-5">Authors</a></li>
+<li><a class="reference internal" href="#contributors" id="toc-entry-6">Contributors</a></li>
+<li><a class="reference internal" href="#maintainers" id="toc-entry-7">Maintainers</a></li>
 </ul>
+</li>
+</ul>
+</div>
+<div class="section" id="changelog">
+<h1><a class="toc-backref" href="#toc-entry-1">Changelog</a></h1>
+<div class="section" id="section-1">
+<h2><a class="toc-backref" href="#toc-entry-2">16.0.2.1.0 (2023-10-13)</a></h2>
+<p><strong>Features</strong></p>
+<ul class="simple">
+<li><ul class="first">
+<li>New base schemas: <em>PagedCollection</em>. This schema is used to define the
+the structure of a paged collection of resources. This schema is similar
+to the ones defined in the Odoo’s <strong>fastapi</strong> addon but works as/with
+extendable models.</li>
+<li>The <em>StrictExtendableBaseModel</em> has been moved to the <em>extendable_pydantic</em>
+python lib. You should consider to import it from there. (<a class="reference external" href="https://github.com/OCA/rest-framework/issues/380">#380</a>)</li>
+</ul>
+</li>
+</ul>
+</div>
 </div>
 <div class="section" id="bug-tracker">
-<h1><a class="toc-backref" href="#toc-entry-1">Bug Tracker</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-3">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:%20extendable_fastapi%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-2">Credits</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-4">Credits</a></h1>
 <div class="section" id="authors">
-<h2><a class="toc-backref" href="#toc-entry-3">Authors</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-5">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-4">Contributors</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-6">Contributors</a></h2>
 <ul class="simple">
 <li>Laurent Mignon &lt;<a class="reference external" href="mailto:laurent.mignon&#64;acsone.eu">laurent.mignon&#64;acsone.eu</a>&gt; (<a class="reference external" href="https://acsone.eu">https://acsone.eu</a>)</li>
 <li>Marie Lejeune &lt;<a class="reference external" href="mailto:marie.lejeune&#64;acsone.eu">marie.lejeune&#64;acsone.eu</a>&gt; (<a class="reference external" href="https://acsone.eu">https://acsone.eu</a>)</li>
 </ul>
 </div>
 <div class="section" id="maintainers">
-<h2><a class="toc-backref" href="#toc-entry-5">Maintainers</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-7">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

fastapi/README.rst

@@ -7,7 +7,7 @@ Odoo FastAPI
    !! This file is generated by oca-gen-addon-readme !!
    !! changes will be overwritten.                   !!
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-   !! source digest: sha256:a4887b42c6065cb1ae8928373e674ecc54ef62902bedcfd96d610a51bca363b4
+   !! source digest: sha256:74b10695320a638d007194fffad82fd960d70315de5055461bf3ebe5c09283be
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 
 .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
@@ -1193,8 +1193,9 @@ the app is robust and easy to maintain. Here are some of them:
 
 * As a corollary of the previous point, a search handler must always use the
   pagination mechanism with a reasonable default page size. The result list
-  must be enclosed in a json document that contains the total number of records
-  and the list of records.
+  must be enclosed in a json document that contains the count of records into
+  the system matching your search criteria and the list of records for the given
+  page and size.
 
 * Use plural for the name of a service. For example, if you provide a service
   that allows you to manage the sale orders, you must use the name 'sale_orders'
@@ -1226,7 +1227,7 @@ you be consistent when writing a route handler for a search route.
 1. A dependency method to use to specify the pagination parameters in the same
    way for all the search route handlers: **'odoo.addons.fastapi.paging'**.
 2. A PagedCollection pydantic model to use to return the result of a search route
-   handler enclosed in a json document that contains the total number of records.
+   handler enclosed in a json document that contains the count of records.
 
 .. code-block:: python
 
@@ -1256,7 +1257,7 @@ you be consistent when writing a route handler for a search route.
         count = env["sale.order"].search_count([])
         orders = env["sale.order"].search([], limit=paging.limit, offset=paging.offset)
         return PagedCollection[SaleOrder](
-            total=count,
+            count=count,
             items=[SaleOrder.model_validate(order) for order in orders],
         )
 
@@ -1464,6 +1465,22 @@ that convert the WSGI request consumed by odoo to a ASGI request. The question
 is to know if it is also possible to develop the same kind of bridge for the
 WebSockets and to stream large responses.
 
+Changelog
+=========
+
+16.0.1.2.0 (2023-10-13)
+~~~~~~~~~~~~~~~~~~~~~~~
+
+**Features**
+
+- The field *total* in the *PagedCollection* schema is replaced by the field *count*.
+  The field *total* is now deprecated and will be removed in the next major version.
+  This change is backward compatible. The json document returned will now
+  contain both fields *total* and *count* with the same value. In your python
+  code the field *total*, if used, will fill the field *count* with the same
+  value. You are encouraged to use the field *count* instead of *total* and adapt
+  your code accordingly. (`#380 <https://github.com/OCA/rest-framework/issues/380>`_)
+
 Bug Tracker
 ===========
 

fastapi/__manifest__.py

@@ -5,7 +5,7 @@
     "name": "Odoo FastAPI",
     "summary": """
         Odoo FastAPI endpoint""",
-    "version": "16.0.1.1.2",
+    "version": "16.0.1.2.0",
     "license": "LGPL-3",
     "author": "ACSONE SA/NV,Odoo Community Association (OCA)",
     "maintainers": ["lmignon"],

fastapi/readme/HISTORY.rst

@@ -0,0 +1,12 @@
+16.0.1.2.0 (2023-10-13)
+~~~~~~~~~~~~~~~~~~~~~~~
+
+**Features**
+
+- The field *total* in the *PagedCollection* schema is replaced by the field *count*.
+  The field *total* is now deprecated and will be removed in the next major version.
+  This change is backward compatible. The json document returned will now
+  contain both fields *total* and *count* with the same value. In your python
+  code the field *total*, if used, will fill the field *count* with the same
+  value. You are encouraged to use the field *count* instead of *total* and adapt
+  your code accordingly. (`#380 <https://github.com/OCA/rest-framework/issues/380>`_)