[IMP] fastapi_captcha: Handle custom altcha url

Author: paradoxxxzero

fastapi_captcha/README.rst

@@ -31,7 +31,7 @@ Fastapi Captcha
 This module provides a simple way to protect several fastapi endpoints
 routes with a captcha.
 
-It curreently supports the following captcha providers:
+It currently supports the following captcha providers:
 
 - `Google reCAPTCHA <https://www.google.com/recaptcha>`__
 - `hCaptcha <https://www.hcaptcha.com/>`__
@@ -49,6 +49,9 @@ Check the ``Use Captcha`` checkbox in your FastAPI endpoint to enable
 captcha validation, then enter your captcha provider, secret key and an
 array of route url regex.
 
+Every matching route will now require a valid captcha token in the
+X-Captcha-Token header.
+
 Bug Tracker
 ===========
 

fastapi_captcha/readme/DESCRIPTION.md

@@ -1,7 +1,7 @@
 This module provides a simple way to protect several fastapi endpoints routes with a
 captcha.
 
-It curreently supports the following captcha providers:
+It currently supports the following captcha providers:
 
 - [Google reCAPTCHA](https://www.google.com/recaptcha)
 - [hCaptcha](https://www.hcaptcha.com/)

fastapi_captcha/readme/USAGE.md

@@ -1,2 +1,5 @@
 Check the `Use Captcha` checkbox in your FastAPI endpoint to enable captcha validation,
 then enter your captcha provider, secret key and an array of route url regex.
+
+Every matching route will now require a valid captcha token in the X-Captcha-Token
+header.

fastapi_captcha/static/description/index.html

@@ -372,7 +372,7 @@ <h1 class="title">Fastapi Captcha</h1>
 <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/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/rest-framework/tree/16.0/fastapi_captcha"><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-fastapi_captcha"><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 module provides a simple way to protect several fastapi endpoints
 routes with a captcha.</p>
-<p>It curreently supports the following captcha providers:</p>
+<p>It currently supports the following captcha providers:</p>
 <ul class="simple">
 <li><a class="reference external" href="https://www.google.com/recaptcha">Google reCAPTCHA</a></li>
 <li><a class="reference external" href="https://www.hcaptcha.com/">hCaptcha</a></li>
@@ -396,6 +396,8 @@ <h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
 <p>Check the <tt class="docutils literal">Use Captcha</tt> checkbox in your FastAPI endpoint to enable
 captcha validation, then enter your captcha provider, secret key and an
 array of route url regex.</p>
+<p>Every matching route will now require a valid captcha token in the
+X-Captcha-Token header.</p>
 </div>
 <div class="section" id="bug-tracker">
 <h1><a class="toc-backref" href="#toc-entry-2">Bug Tracker</a></h1>