Metadata-Version: 2.4
Name: odoo-addon-fastapi_auth_api_key_sc
Version: 16.0.1.0.0.1
Summary: FastApi module based on the OCA fastapi_auth_api_key from version 17
Home-page: https://git.coopdevs.org/coopdevs/som-connexio/odoo/odoo-somconnexio
Author: Som Connexió SCCL, Odoo Community Association (OCA)
Author-email: support@odoo-community.org
License: AGPL-3
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: Framework :: Odoo :: 16.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Requires-Python: >=3.10
Requires-Dist: fastapi==0.111.1
Requires-Dist: odoo-addon-auth_api_key_group<16.1dev,>=16.0dev
Requires-Dist: odoo-addon-fastapi<16.1dev,>=16.0dev
Requires-Dist: odoo<16.1dev,>=16.0a
Requires-Dist: pydantic==2.8.2
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: license
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

#######################################
 FASTAPI Auth API-KEY for Som Connexio
#######################################

This module uses OCAs FAST API module for creating endpoints with
API-KEY authentication. It is based on the module `fastapi_auth_api_key`
from the OCA, which was not available before the 17 version. This module
provides a demo API-key and endpoint to test the authentication, and an
API user related to the API-key.

.. note::

   This module is made by and for developers.

**Table of contents**

.. contents::
   :local:

***************
 Configuration
***************

No configuration needed for this module.

*******
 Usage
*******

To use this module it just needs to be installed. It provides
FastAPI-based endpoints by extending `fastapi.endpoint`.

The module registers an example model API at the following roots:

-  POST: `/demo/example/`
-  GET: `/demo/example/{id}`
-  GET: `/demo/example/search?code={code}`

The authenticated API uses `API-KEY`

Also, the class `APICommonBaseFastAPICase` from
`tests/common_service.py` can be inherited in API tests classes from
dependent modules in order to reuse the test helpers.

************************
 Known issues / Roadmap
************************

There are no known issues for this module.

*************
 Bug Tracker
*************

Bugs are tracked on `GitLab Issues
<https://gitlab.com/somitcoop/erp-research/odoo-helpdesk/-/issues>`_. 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 feedback.

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

TODO: Module to be substituted by `the OCA module`_ once this ODOO is
migrated to the 17th version or further.

.. _the oca module: https://github.com/OCA/rest-framework/tree/17.0/fastapi_auth_api_key/

*********
 Credits
*********

Authors
=======

-  Som Connexio SCCL

Contributors
============

-  `Som Connexio SCCL <https://somconnexio.coop>`_:

      -  Gerard Funosas <gerard.funosas@somconnexio.coop>

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.

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