👷 Add oaf-check.yml

Author: danielmursa-dev

.github/workflows/ci.yml

@@ -125,8 +125,6 @@ jobs:
               echo "Please update the environment documentation by running \`bin/generate_envvar_docs.sh\`"
               exit 1
           fi
-        env:
-          DJANGO_SETTINGS_MODULE: openvtb.conf.ci
 
   store-reusable-workflow-vars:
     name: create values which can be passed through a reusable workflow
@@ -144,8 +142,8 @@ jobs:
     needs:
       - store-reusable-workflow-vars
     with:
-      apt-packages: "libgdal-dev gdal-bin graphviz graphviz-dev"
-      main-branch: "main"
+      apt-packages: 'libgdal-dev gdal-bin graphviz graphviz-dev'
+      main-branch: 'main'
       run-docs: true
       python-version: '3.12'
       docker-image-name: ${{ needs.store-reusable-workflow-vars.outputs.image-name }}

.github/workflows/oaf-check.yml

@@ -0,0 +1,19 @@
+name: Check Open API Framework Version
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - '*'
+  workflow_dispatch:
+  schedule:
+    - cron: '0 7 * * 1'
+
+
+jobs:
+  open-api-workflow-check-oas:
+    uses: maykinmedia/open-api-workflows/.github/workflows/oaf-check.yml@v6
+
+    with:
+      python-version: '3.12'

docs/conf.py

@@ -75,17 +75,6 @@
 
 source_suffix = [".rst", ".md"]
 
-intersphinx_mapping = {
-    "requests": (
-        "https://docs.python-requests.org/en/latest/",
-        None,
-    ),
-    "django": (
-        "http://docs.djangoproject.com/en/4.2/",
-        "http://docs.djangoproject.com/en/4.2/_objects/",
-    ),
-}
-
 # Datamodel image settings
 graphviz_output_format = "png"
 
@@ -123,9 +112,14 @@
 extlinks = {}
 
 django_structlog_version = _version("django-structlog")
+oaf_version = _version("open-api-framework")
 intersphinx_mapping = {
     "django-structlog": (
         f"https://django-structlog.readthedocs.io/en/{django_structlog_version}",
         None,
     ),
+    "oaf": (
+        f"https://open-api-framework.readthedocs.io/en/{oaf_version}/",
+        None,
+    ),
 }

docs/installation/config/env_configuration.rst

@@ -29,7 +29,7 @@ Database
 * ``DB_HOST``: hostname of the PostgreSQL database. Defaults to ``db`` for the docker environment, otherwise defaults to ``localhost``.
 * ``DB_PORT``: port number of the database. Defaults to: ``5432``.
 * ``DB_CONN_MAX_AGE``: The lifetime of a database connection, as an integer of seconds. Use 0 to close database connections at the end of each request — Django’s historical behavior. This setting is ignored if connection pooling is used. Defaults to: ``60``.
-* ``DB_POOL_ENABLED``: Whether to use connection pooling. Defaults to: ``False``.
+* ``DB_POOL_ENABLED``: **Experimental:** Whether to use connection pooling. This feature is not yet recommended for production use. See the documentation for details: https://open-api-framework.readthedocs.io/en/latest/connection_pooling.html. Defaults to: ``False``.
 * ``DB_POOL_MIN_SIZE``: The minimum number of connection the pool will hold. The pool will actively try to create new connections if some are lost (closed, broken) and will try to never go below min_size. Defaults to: ``4``.
 * ``DB_POOL_MAX_SIZE``: The maximum number of connections the pool will hold. If None, or equal to min_size, the pool will not grow or shrink. If larger than min_size, the pool can grow if more than min_size connections are requested at the same time and will shrink back after the extra connections have been unused for more than max_idle seconds. Defaults to: ``None``.
 * ``DB_POOL_TIMEOUT``: The default maximum time in seconds that a client can wait to receive a connection from the pool (using connection() or getconn()). Note that these methods allow to override the timeout default. Defaults to: ``30``.

requirements/base.txt

@@ -264,7 +264,7 @@ mozilla-django-oidc-db==0.25.1
     #   open-api-framework
 notifications-api-common==0.9.0
     # via commonground-api-common
-open-api-framework==0.13.1
+open-api-framework==0.13.2
     # via -r requirements/base.in
 opentelemetry-api==1.38.0
     # via

requirements/ci.txt

@@ -499,7 +499,7 @@ notifications-api-common==0.9.0
     #   -c requirements/base.txt
     #   -r requirements/base.txt
     #   commonground-api-common
-open-api-framework==0.13.1
+open-api-framework==0.13.2
     # via
     #   -c requirements/base.txt
     #   -r requirements/base.txt

requirements/dev.txt

@@ -572,7 +572,7 @@ notifications-api-common==0.9.0
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   commonground-api-common
-open-api-framework==0.13.1
+open-api-framework==0.13.2
     # via
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt