Skip to content

Commit b0c7a06

Browse files
OCA-git-botarantxa-s73
authored andcommitted
[BOT] post-merge updates
1 parent e7143b6 commit b0c7a06

3 files changed

Lines changed: 39 additions & 29 deletions

File tree

auth_api_key/README.rst

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
.. image:: https://odoo-community.org/readme-banner-image
2+
:target: https://odoo-community.org/get-involved?utm_source=readme
3+
:alt: Odoo Community Association
4+
15
============
26
Auth Api Key
37
============
@@ -7,13 +11,13 @@ Auth Api Key
711
!! This file is generated by oca-gen-addon-readme !!
812
!! changes will be overwritten. !!
913
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
10-
!! source digest: sha256:bfed24ce8c3a57ea6a6270a37d412ab6fe00b5d2004270943ad5f9039a572fcc
14+
!! source digest: sha256:78e3946b0dbb81bb6fbf6c434aaf5214faec00449a765c2f41e321b65024ba05
1115
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
1216
1317
.. |badge1| image:: https://img.shields.io/badge/maturity-Production%2FStable-green.png
1418
:target: https://odoo-community.org/page/development-status
1519
:alt: Production/Stable
16-
.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png
20+
.. |badge2| image:: https://img.shields.io/badge/license-LGPL--3-blue.png
1721
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
1822
:alt: License: LGPL-3
1923
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--auth-lightgray.png?logo=github
@@ -45,11 +49,11 @@ Odoo allows users to authenticate ``XMLRPC/JSONRPC`` calls using their
4549
API key instead of a password by native API keys (``res.users.apikey``).
4650
However, ``auth_api_key`` has some special features of its own such as:
4751

48-
- API keys remain usable even when the user is inactive, if enabled via
49-
settings (e.g., for system users in a shopinvader case).
50-
- Supports dual authentication via Basic Auth and API_KEY in separate
51-
HTTP headers.
52-
- Admins can manage API keys for all users
52+
- API keys remain usable even when the user is inactive, if enabled via
53+
settings (e.g., for system users in a shopinvader case).
54+
- Supports dual authentication via Basic Auth and API_KEY in separate
55+
HTTP headers.
56+
- Admins can manage API keys for all users
5357

5458
Given these advantages, particularly in use case like system user
5559
authentication, we have decided to keep the ``auth_api_key`` module
@@ -105,12 +109,12 @@ Authors
105109
Contributors
106110
------------
107111

108-
- Denis Robinet <denis.robinet@acsone.eu>
109-
- Laurent Mignon <laurent.mignon@acsone.eu>
110-
- Quentin Groulard <quentin.groulard@acsone.eu>
111-
- Sébastien Beau <sebastien.beau@akretion.com>
112-
- Chafique Delli <chafique.delli@akretion.com>
113-
- Thien Vo Hong <thienvh@trobz.com>
112+
- Denis Robinet <denis.robinet@acsone.eu>
113+
- Laurent Mignon <laurent.mignon@acsone.eu>
114+
- Quentin Groulard <quentin.groulard@acsone.eu>
115+
- Sébastien Beau <sebastien.beau@akretion.com>
116+
- Chafique Delli <chafique.delli@akretion.com>
117+
- Thien Vo Hong <thienvh@trobz.com>
114118

115119
Other credits
116120
-------------

auth_api_key/__manifest__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"name": "Auth Api Key",
66
"summary": """
77
Authenticate http requests from an API key""",
8-
"version": "18.0.1.0.0",
8+
"version": "18.0.1.0.1",
99
"license": "LGPL-3",
1010
"author": "ACSONE SA/NV,Odoo Community Association (OCA)",
1111
"website": "https://github.com/OCA/server-auth",

auth_api_key/static/description/index.html

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
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>Auth Api Key</title>
6+
<title>README.rst</title>
77
<style type="text/css">
88

99
/*
@@ -360,16 +360,21 @@
360360
</style>
361361
</head>
362362
<body>
363-
<div class="document" id="auth-api-key">
364-
<h1 class="title">Auth Api Key</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="auth-api-key">
370+
<h1>Auth Api Key</h1>
366371
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
367372
!! This file is generated by oca-gen-addon-readme !!
368373
!! changes will be overwritten. !!
369374
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
370-
!! source digest: sha256:bfed24ce8c3a57ea6a6270a37d412ab6fe00b5d2004270943ad5f9039a572fcc
375+
!! source digest: sha256:78e3946b0dbb81bb6fbf6c434aaf5214faec00449a765c2f41e321b65024ba05
371376
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
372-
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Production/Stable" src="https://img.shields.io/badge/maturity-Production%2FStable-green.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/server-auth/tree/18.0/auth_api_key"><img alt="OCA/server-auth" src="https://img.shields.io/badge/github-OCA%2Fserver--auth-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/server-auth-18-0/server-auth-18-0-auth_api_key"><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/server-auth&amp;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="Production/Stable" src="https://img.shields.io/badge/maturity-Production%2FStable-green.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/server-auth/tree/18.0/auth_api_key"><img alt="OCA/server-auth" src="https://img.shields.io/badge/github-OCA%2Fserver--auth-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/server-auth-18-0/server-auth-18-0-auth_api_key"><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/server-auth&amp;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>Authenticate http requests from an API key.</p>
374379
<p>API keys are codes passed in (in the http header API-KEY) by programs
375380
calling an API in order to identify -in this case- the calling program’s
@@ -407,44 +412,44 @@ <h1 class="title">Auth Api Key</h1>
407412
</ul>
408413
</div>
409414
<div class="section" id="configuration">
410-
<h1><a class="toc-backref" href="#toc-entry-1">Configuration</a></h1>
415+
<h2><a class="toc-backref" href="#toc-entry-1">Configuration</a></h2>
411416
<p>The api key menu is available into Settings &gt; Technical in debug mode.
412417
By default, when you create an API key, the key is saved into the
413418
database.</p>
414419
<p>If you want to manage them via serve environment settings use
415420
auth_api_key_server_env.</p>
416421
</div>
417422
<div class="section" id="usage">
418-
<h1><a class="toc-backref" href="#toc-entry-2">Usage</a></h1>
423+
<h2><a class="toc-backref" href="#toc-entry-2">Usage</a></h2>
419424
<p>To apply this authentication system to your http request you must set
420425
‘api_key’ as value for the ‘auth’ parameter of your route definition
421426
into your controller.</p>
422427
<pre class="code python literal-block">
423-
<span class="k">class</span> <span class="nc">MyController</span><span class="p">(</span><span class="n">Controller</span><span class="p">):</span><span class="w">
428+
<span class="k">class</span><span class="w"> </span><span class="nc">MyController</span><span class="p">(</span><span class="n">Controller</span><span class="p">):</span><span class="w">
424429

425430
</span> <span class="nd">&#64;route</span><span class="p">(</span><span class="s1">'/my_service'</span><span class="p">,</span> <span class="n">auth</span><span class="o">=</span><span class="s1">'api_key'</span><span class="p">,</span> <span class="o">...</span><span class="p">)</span><span class="w">
426-
</span> <span class="k">def</span> <span class="nf">my_service</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span><span class="w">
431+
</span> <span class="k">def</span><span class="w"> </span><span class="nf">my_service</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span><span class="w">
427432
</span> <span class="k">pass</span>
428433
</pre>
429434
</div>
430435
<div class="section" id="bug-tracker">
431-
<h1><a class="toc-backref" href="#toc-entry-3">Bug Tracker</a></h1>
436+
<h2><a class="toc-backref" href="#toc-entry-3">Bug Tracker</a></h2>
432437
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-auth/issues">GitHub Issues</a>.
433438
In case of trouble, please check there if your issue has already been reported.
434439
If you spotted it first, help us to smash it by providing a detailed and welcomed
435440
<a class="reference external" href="https://github.com/OCA/server-auth/issues/new?body=module:%20auth_api_key%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
436441
<p>Do not contact contributors directly about support or help with technical issues.</p>
437442
</div>
438443
<div class="section" id="credits">
439-
<h1><a class="toc-backref" href="#toc-entry-4">Credits</a></h1>
444+
<h2><a class="toc-backref" href="#toc-entry-4">Credits</a></h2>
440445
<div class="section" id="authors">
441-
<h2><a class="toc-backref" href="#toc-entry-5">Authors</a></h2>
446+
<h3><a class="toc-backref" href="#toc-entry-5">Authors</a></h3>
442447
<ul class="simple">
443448
<li>ACSONE SA/NV</li>
444449
</ul>
445450
</div>
446451
<div class="section" id="contributors">
447-
<h2><a class="toc-backref" href="#toc-entry-6">Contributors</a></h2>
452+
<h3><a class="toc-backref" href="#toc-entry-6">Contributors</a></h3>
448453
<ul class="simple">
449454
<li>Denis Robinet &lt;<a class="reference external" href="mailto:denis.robinet&#64;acsone.eu">denis.robinet&#64;acsone.eu</a>&gt;</li>
450455
<li>Laurent Mignon &lt;<a class="reference external" href="mailto:laurent.mignon&#64;acsone.eu">laurent.mignon&#64;acsone.eu</a>&gt;</li>
@@ -455,12 +460,12 @@ <h2><a class="toc-backref" href="#toc-entry-6">Contributors</a></h2>
455460
</ul>
456461
</div>
457462
<div class="section" id="other-credits">
458-
<h2><a class="toc-backref" href="#toc-entry-7">Other credits</a></h2>
463+
<h3><a class="toc-backref" href="#toc-entry-7">Other credits</a></h3>
459464
<p>The migration of this module from 17.0 to 18.0 was financially supported
460465
by Camptocamp.</p>
461466
</div>
462467
<div class="section" id="maintainers">
463-
<h2><a class="toc-backref" href="#toc-entry-8">Maintainers</a></h2>
468+
<h3><a class="toc-backref" href="#toc-entry-8">Maintainers</a></h3>
464469
<p>This module is maintained by the OCA.</p>
465470
<a class="reference external image-reference" href="https://odoo-community.org">
466471
<img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" />
@@ -473,5 +478,6 @@ <h2><a class="toc-backref" href="#toc-entry-8">Maintainers</a></h2>
473478
</div>
474479
</div>
475480
</div>
481+
</div>
476482
</body>
477483
</html>

0 commit comments

Comments
 (0)