diff --git a/README.md b/README.md index 4761ce32..1e9e769a 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,7 @@ addon | version | maintainers | summary --- | --- | --- | --- [endpoint](endpoint/) | 14.0.2.2.0 | [![simahawk](https://github.com/simahawk.png?size=30px)](https://github.com/simahawk) | Provide custom endpoint machinery. [endpoint_auth_api_key](endpoint_auth_api_key/) | 14.0.1.1.2 | [![simahawk](https://github.com/simahawk.png?size=30px)](https://github.com/simahawk) | Provide API key auth for endpoints. +[endpoint_cache](endpoint_cache/) | 14.0.1.0.0 | [![simahawk](https://github.com/simahawk.png?size=30px)](https://github.com/simahawk) | Provide basic caching utils for endpoints [endpoint_jsonifier](endpoint_jsonifier/) | 14.0.1.0.0 | [![SilvioC2C](https://github.com/SilvioC2C.png?size=30px)](https://github.com/SilvioC2C) [![simahawk](https://github.com/simahawk.png?size=30px)](https://github.com/simahawk) | Allow to configure jsonifier parsers on endpoints [endpoint_route_handler](endpoint_route_handler/) | 14.0.2.1.0 | [![simahawk](https://github.com/simahawk.png?size=30px)](https://github.com/simahawk) | Provide mixin and tool to generate custom endpoints on the fly. [webservice](webservice/) | 14.0.1.5.0 | [![etobella](https://github.com/etobella.png?size=30px)](https://github.com/etobella) [![simahawk](https://github.com/simahawk.png?size=30px)](https://github.com/simahawk) | Provide unified way to handle external webservices configuration and calls. diff --git a/endpoint_cache/README.rst b/endpoint_cache/README.rst new file mode 100644 index 00000000..b1d9acd1 --- /dev/null +++ b/endpoint_cache/README.rst @@ -0,0 +1,113 @@ +============== +Endpoint cache +============== + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:e0e0315de34eb69c4cd523a4ca131352f2b11a94af0f83b534ee414d29cf70d6 + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Alpha-red.png + :target: https://odoo-community.org/page/development-status + :alt: Alpha +.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png + :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html + :alt: License: LGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb--api-lightgray.png?logo=github + :target: https://github.com/OCA/web-api/tree/14.0/endpoint_cache + :alt: OCA/web-api +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/web-api-14-0/web-api-14-0-endpoint_cache + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png + :target: https://runboat.odoo-community.org/builds?repo=OCA/web-api&target_branch=14.0 + :alt: Try me on Runboat + +|badge1| |badge2| |badge3| |badge4| |badge5| + +Technical module provide basic caching configuration and utils for endpoints. + +.. IMPORTANT:: + This is an alpha version, the data model and design can change at any time without warning. + Only for development or testing purpose, do not use in production. + `More details on development status `_ + +**Table of contents** + +.. contents:: + :local: + +Usage +===== + +Example of usage in an endpoint:: + + # get the name of the cache + cache_name = endpoint._endpoint_cache_make_name("json") + # check if the cache exists + cached = endpoint._endpoint_cache_get(cache_name) + if cached: + result = cached + else: + result = json.dumps(env["my.model"]._get_a_very_expensive_computed_result()) + # cache does not exist, create it + endpoint._endpoint_cache_store(cache_name, result) + + resp = Response(result, content_type="application/json", status=200) + result = dict(response=resp) + +Known issues / Roadmap +====================== + +* Add cache pre-heating + +Bug Tracker +=========== + +Bugs are tracked on `GitHub Issues `_. +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 +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* Camptocamp + +Contributors +~~~~~~~~~~~~ + +* Simone Orsi + +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +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. + +.. |maintainer-simahawk| image:: https://github.com/simahawk.png?size=40px + :target: https://github.com/simahawk + :alt: simahawk + +Current `maintainer `__: + +|maintainer-simahawk| + +This module is part of the `OCA/web-api `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/endpoint_cache/static/description/icon.png b/endpoint_cache/static/description/icon.png new file mode 100644 index 00000000..3a0328b5 Binary files /dev/null and b/endpoint_cache/static/description/icon.png differ diff --git a/endpoint_cache/static/description/index.html b/endpoint_cache/static/description/index.html new file mode 100644 index 00000000..a540ab06 --- /dev/null +++ b/endpoint_cache/static/description/index.html @@ -0,0 +1,458 @@ + + + + + +Endpoint cache + + + +
+

Endpoint cache

+ + +

Alpha License: LGPL-3 OCA/web-api Translate me on Weblate Try me on Runboat

+

Technical module provide basic caching configuration and utils for endpoints.

+
+

Important

+

This is an alpha version, the data model and design can change at any time without warning. +Only for development or testing purpose, do not use in production. +More details on development status

+
+

Table of contents

+ +
+

Usage

+

Example of usage in an endpoint:

+
+# get the name of the cache
+cache_name = endpoint._endpoint_cache_make_name("json")
+# check if the cache exists
+cached = endpoint._endpoint_cache_get(cache_name)
+if cached:
+    result = cached
+else:
+    result = json.dumps(env["my.model"]._get_a_very_expensive_computed_result())
+    # cache does not exist, create it
+    endpoint._endpoint_cache_store(cache_name, result)
+
+resp = Response(result, content_type="application/json", status=200)
+result = dict(response=resp)
+
+
+
+

Known issues / Roadmap

+
    +
  • Add cache pre-heating
    • +
+
+
+

Bug Tracker

+

Bugs are tracked on GitHub Issues. +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 +feedback.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • Camptocamp
    • +
+
+ +
+

Maintainers

+

This module is maintained by the OCA.

+ +Odoo Community Association + +

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.

+

Current maintainer:

+

simahawk

+

This module is part of the OCA/web-api project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ + diff --git a/setup/_metapackage/VERSION.txt b/setup/_metapackage/VERSION.txt index 6f5058c5..1063dce5 100644 --- a/setup/_metapackage/VERSION.txt +++ b/setup/_metapackage/VERSION.txt @@ -1 +1 @@ -14.0.20240704.0 \ No newline at end of file +14.0.20240711.0 \ No newline at end of file diff --git a/setup/_metapackage/setup.py b/setup/_metapackage/setup.py index cdb8551a..ea3b841a 100644 --- a/setup/_metapackage/setup.py +++ b/setup/_metapackage/setup.py @@ -10,6 +10,7 @@ install_requires=[ 'odoo14-addon-endpoint', 'odoo14-addon-endpoint_auth_api_key', + 'odoo14-addon-endpoint_cache', 'odoo14-addon-endpoint_jsonifier', 'odoo14-addon-endpoint_route_handler', 'odoo14-addon-webservice',