LCORE-4606: document the period format of the SQLite quota backend

The description of a limiter period points to the PostgreSQL interval
syntax only. The SQLite storage takes the period as a modifier of the
SQLite function datetime(), which accepts less: "7 days" works and
"1 week" does not.

The QuotaLimiterConfiguration docstring now says so in one sentence.
The checked-in documents that carry the docstring get the same
sentence. docs/devel_doc/openapi.json and
docs/models/successful_responses.{json,md} are rebuilt by their
make targets. docs/devel_doc/openapi.md, the three docs/user_doc/config
files and the schema example in test_models_dumper.py are edited by
hand, as no make target writes them.

Checked: the description in the three JSON documents equals the one in
the model schema, the Markdown documents contain it verbatim and the
HTML matches its pandoc rendering.

Author: max-svistunov

docs/devel_doc/openapi.json

@@ -19416,7 +19416,7 @@
                     "period"
                 ],
                 "title": "QuotaLimiterConfiguration",
-                "description": "Configuration for one quota limiter.\n\nThere are three configuration options for each limiter:\n\n1. ``period`` is specified in a human-readable form, see\n   https://www.postgresql.org/docs/current/datatype-datetime.html#DATATYPE-INTERVAL-INPUT\n   for all possible options. When the end of the period is reached, the\n   quota is reset or increased.\n2. ``initial_quota`` is the value set at the beginning of the period.\n3. ``quota_increase`` is the value (if specified) used to increase the\n   quota when the period is reached.\n\nThere are two basic use cases:\n\n1. When the quota needs to be reset to a specific value periodically (for\n   example on a weekly or monthly basis), set ``initial_quota`` to the\n   required value.\n2. When the quota needs to be increased by a specific value periodically\n   (for example on a daily basis), set ``quota_increase``."
+                "description": "Configuration for one quota limiter.\n\nThere are three configuration options for each limiter:\n\n1. ``period`` is specified in a human-readable form, see\n   https://www.postgresql.org/docs/current/datatype-datetime.html#DATATYPE-INTERVAL-INPUT\n   for all possible options. When the end of the period is reached, the\n   quota is reset or increased. With the SQLite storage the period must be\n   a modifier of the SQLite function ``datetime()`` that moves the time\n   forward, for example ``7 days``; ``1 week`` is rejected.\n2. ``initial_quota`` is the value set at the beginning of the period.\n3. ``quota_increase`` is the value (if specified) used to increase the\n   quota when the period is reached.\n\nThere are two basic use cases:\n\n1. When the quota needs to be reset to a specific value periodically (for\n   example on a weekly or monthly basis), set ``initial_quota`` to the\n   required value.\n2. When the quota needs to be increased by a specific value periodically\n   (for example on a daily basis), set ``quota_increase``."
             },
             "QuotaSchedulerConfiguration": {
                 "properties": {

docs/devel_doc/openapi.md

@@ -8056,7 +8056,9 @@ There are three configuration options for each limiter:
 1. ``period`` is specified in a human-readable form, see
    https://www.postgresql.org/docs/current/datatype-datetime.html#DATATYPE-INTERVAL-INPUT
    for all possible options. When the end of the period is reached, the
-   quota is reset or increased.
+   quota is reset or increased. With the SQLite storage the period must be
+   a modifier of the SQLite function ``datetime()`` that moves the time
+   forward, for example ``7 days``; ``1 week`` is rejected.
 2. ``initial_quota`` is the value set at the beginning of the period.
 3. ``quota_increase`` is the value (if specified) used to increase the
    quota when the period is reached.

docs/models/successful_responses.json

@@ -4756,7 +4756,7 @@
             },
             "QuotaLimiterConfiguration": {
                 "additionalProperties": false,
-                "description": "Configuration for one quota limiter.\n\nThere are three configuration options for each limiter:\n\n1. ``period`` is specified in a human-readable form, see\n   https://www.postgresql.org/docs/current/datatype-datetime.html#DATATYPE-INTERVAL-INPUT\n   for all possible options. When the end of the period is reached, the\n   quota is reset or increased.\n2. ``initial_quota`` is the value set at the beginning of the period.\n3. ``quota_increase`` is the value (if specified) used to increase the\n   quota when the period is reached.\n\nThere are two basic use cases:\n\n1. When the quota needs to be reset to a specific value periodically (for\n   example on a weekly or monthly basis), set ``initial_quota`` to the\n   required value.\n2. When the quota needs to be increased by a specific value periodically\n   (for example on a daily basis), set ``quota_increase``.",
+                "description": "Configuration for one quota limiter.\n\nThere are three configuration options for each limiter:\n\n1. ``period`` is specified in a human-readable form, see\n   https://www.postgresql.org/docs/current/datatype-datetime.html#DATATYPE-INTERVAL-INPUT\n   for all possible options. When the end of the period is reached, the\n   quota is reset or increased. With the SQLite storage the period must be\n   a modifier of the SQLite function ``datetime()`` that moves the time\n   forward, for example ``7 days``; ``1 week`` is rejected.\n2. ``initial_quota`` is the value set at the beginning of the period.\n3. ``quota_increase`` is the value (if specified) used to increase the\n   quota when the period is reached.\n\nThere are two basic use cases:\n\n1. When the quota needs to be reset to a specific value periodically (for\n   example on a weekly or monthly basis), set ``initial_quota`` to the\n   required value.\n2. When the quota needs to be increased by a specific value periodically\n   (for example on a daily basis), set ``quota_increase``.",
                 "properties": {
                     "type": {
                         "description": "Quota limiter type, either user_limiter or cluster_limiter",

docs/models/successful_responses.md

@@ -2059,7 +2059,9 @@ There are three configuration options for each limiter:
 1. ``period`` is specified in a human-readable form, see
    https://www.postgresql.org/docs/current/datatype-datetime.html#DATATYPE-INTERVAL-INPUT
    for all possible options. When the end of the period is reached, the
-   quota is reset or increased.
+   quota is reset or increased. With the SQLite storage the period must be
+   a modifier of the SQLite function ``datetime()`` that moves the time
+   forward, for example ``7 days``; ``1 week`` is rejected.
 2. ``initial_quota`` is the value set at the beginning of the period.
 3. ``quota_increase`` is the value (if specified) used to increase the
    quota when the period is reached.

docs/user_doc/config.html

@@ -1886,7 +1886,10 @@ <h2 id="quotalimiterconfiguration">QuotaLimiterConfiguration</h2>
       <li><code>period</code> is specified in a human-readable form, see
 https://www.postgresql.org/docs/current/datatype-datetime.html#DATATYPE-INTERVAL-INPUT
 for all possible options. When the end of the period is reached, the
-quota is reset or increased.</li>
+quota is reset or increased. With the SQLite storage the period must be
+a modifier of the SQLite function <code>datetime()</code> that moves the
+time forward, for example <code>7 days</code>; <code>1 week</code> is
+rejected.</li>
       <li><code>initial_quota</code> is the value set at the beginning of the
 period.</li>
       <li><code>quota_increase</code> is the value (if specified) used to

docs/user_doc/config.json

@@ -1645,7 +1645,7 @@
       },
       "QuotaLimiterConfiguration": {
         "additionalProperties": false,
-        "description": "Configuration for one quota limiter.\n\nThere are three configuration options for each limiter:\n\n1. ``period`` is specified in a human-readable form, see\n   https://www.postgresql.org/docs/current/datatype-datetime.html#DATATYPE-INTERVAL-INPUT\n   for all possible options. When the end of the period is reached, the\n   quota is reset or increased.\n2. ``initial_quota`` is the value set at the beginning of the period.\n3. ``quota_increase`` is the value (if specified) used to increase the\n   quota when the period is reached.\n\nThere are two basic use cases:\n\n1. When the quota needs to be reset to a specific value periodically (for\n   example on a weekly or monthly basis), set ``initial_quota`` to the\n   required value.\n2. When the quota needs to be increased by a specific value periodically\n   (for example on a daily basis), set ``quota_increase``.",
+        "description": "Configuration for one quota limiter.\n\nThere are three configuration options for each limiter:\n\n1. ``period`` is specified in a human-readable form, see\n   https://www.postgresql.org/docs/current/datatype-datetime.html#DATATYPE-INTERVAL-INPUT\n   for all possible options. When the end of the period is reached, the\n   quota is reset or increased. With the SQLite storage the period must be\n   a modifier of the SQLite function ``datetime()`` that moves the time\n   forward, for example ``7 days``; ``1 week`` is rejected.\n2. ``initial_quota`` is the value set at the beginning of the period.\n3. ``quota_increase`` is the value (if specified) used to increase the\n   quota when the period is reached.\n\nThere are two basic use cases:\n\n1. When the quota needs to be reset to a specific value periodically (for\n   example on a weekly or monthly basis), set ``initial_quota`` to the\n   required value.\n2. When the quota needs to be increased by a specific value periodically\n   (for example on a daily basis), set ``quota_increase``.",
         "properties": {
           "type": {
             "description": "Quota limiter type, either user_limiter or cluster_limiter",

docs/user_doc/config.md

@@ -723,7 +723,9 @@ There are three configuration options for each limiter:
 1. ``period`` is specified in a human-readable form, see
    https://www.postgresql.org/docs/current/datatype-datetime.html#DATATYPE-INTERVAL-INPUT
    for all possible options. When the end of the period is reached, the
-   quota is reset or increased.
+   quota is reset or increased. With the SQLite storage the period must be
+   a modifier of the SQLite function ``datetime()`` that moves the time
+   forward, for example ``7 days``; ``1 week`` is rejected.
 2. ``initial_quota`` is the value set at the beginning of the period.
 3. ``quota_increase`` is the value (if specified) used to increase the
    quota when the period is reached.

src/models/config.py

@@ -2488,7 +2488,9 @@ class QuotaLimiterConfiguration(ConfigurationBase):
     1. ``period`` is specified in a human-readable form, see
        https://www.postgresql.org/docs/current/datatype-datetime.html#DATATYPE-INTERVAL-INPUT
        for all possible options. When the end of the period is reached, the
-       quota is reset or increased.
+       quota is reset or increased. With the SQLite storage the period must be
+       a modifier of the SQLite function ``datetime()`` that moves the time
+       forward, for example ``7 days``; ``1 week`` is rejected.
     2. ``initial_quota`` is the value set at the beginning of the period.
     3. ``quota_increase`` is the value (if specified) used to increase the
        quota when the period is reached.

tests/unit/utils/dumpers/test_models_dumper.py

@@ -6168,7 +6168,7 @@ def test_dump_models(tmpdir: Path) -> None:
                 },
                 "QuotaLimiterConfiguration": {
                     "additionalProperties": false,
-                    "description": "Configuration for one quota limiter.\n\nThere are three configuration options for each limiter:\n\n1. ``period`` is specified in a human-readable form, see\n   https://www.postgresql.org/docs/current/datatype-datetime.html#DATATYPE-INTERVAL-INPUT\n   for all possible options. When the end of the period is reached, the\n   quota is reset or increased.\n2. ``initial_quota`` is the value set at the beginning of the period.\n3. ``quota_increase`` is the value (if specified) used to increase the\n   quota when the period is reached.\n\nThere are two basic use cases:\n\n1. When the quota needs to be reset to a specific value periodically (for\n   example on a weekly or monthly basis), set ``initial_quota`` to the\n   required value.\n2. When the quota needs to be increased by a specific value periodically\n   (for example on a daily basis), set ``quota_increase``.",
+                    "description": "Configuration for one quota limiter.\n\nThere are three configuration options for each limiter:\n\n1. ``period`` is specified in a human-readable form, see\n   https://www.postgresql.org/docs/current/datatype-datetime.html#DATATYPE-INTERVAL-INPUT\n   for all possible options. When the end of the period is reached, the\n   quota is reset or increased. With the SQLite storage the period must be\n   a modifier of the SQLite function ``datetime()`` that moves the time\n   forward, for example ``7 days``; ``1 week`` is rejected.\n2. ``initial_quota`` is the value set at the beginning of the period.\n3. ``quota_increase`` is the value (if specified) used to increase the\n   quota when the period is reached.\n\nThere are two basic use cases:\n\n1. When the quota needs to be reset to a specific value periodically (for\n   example on a weekly or monthly basis), set ``initial_quota`` to the\n   required value.\n2. When the quota needs to be increased by a specific value periodically\n   (for example on a daily basis), set ``quota_increase``.",
                     "properties": {
                         "type": {
                             "description": "Quota limiter type, either user_limiter or cluster_limiter",