Set correct meta->schema value automatically

.github/workflows/cd_release.yml

@@ -80,7 +80,7 @@ jobs:
       run: python -m build
 
     - name: Publish package to PyPI
-      uses: pypa/gh-action-pypi-publish/@release/v1
+      uses: pypa/gh-action-pypi-publish@release/v1
       with:
         user: __token__
         password: ${{ secrets.PYPI_PASSWORD }}

optimade/server/config.py

@@ -255,6 +255,17 @@ class ServerConfig(BaseSettings):
             "MongoDB-based backend."
         ),
     )
+
+    is_index: Optional[bool] = Field(
+        False,
+        description=(
+            "A runtime setting to dynamically switch between index meta-database and "
+            "normal OPTIMADE servers. Used for switching behaviour of e.g., `meta->optimade_schema` "
+            "values in the response. Any provided value may be overridden when used with the reference "
+            "server implementation."
+        ),
+    )
+
     schema_url: Optional[Union[str, AnyHttpUrl]] = Field(
         f"https://schemas.optimade.org/openapi/v{__api_version__}/optimade.json",
         description=(

optimade/server/main_index.py

@@ -133,6 +133,7 @@ def add_optional_versioned_base_urls(app: FastAPI):
 
 @app.on_event("startup")
 async def startup_event():
+    CONFIG.is_index = True
     # Add API endpoints for MANDATORY base URL `/vMAJOR`
     add_major_version_base_url(app)
     # Add API endpoints for OPTIONAL base URLs `/vMAJOR.MINOR` and `/vMAJOR.MINOR.PATCH`

optimade/server/routers/utils.py

@@ -2,7 +2,7 @@
 import re
 import urllib.parse
 from datetime import datetime
-from typing import Any, Dict, List, Set, Union
+from typing import Any, Dict, List, Optional, Set, Union
 
 from fastapi import Request
 from fastapi.responses import JSONResponse
@@ -59,7 +59,7 @@ def meta_values(
     data_returned: int,
     data_available: int,
     more_data_available: bool,
-    schema: str,
+    schema: Optional[str] = None,
     **kwargs,
 ) -> ResponseMeta:
     """Helper to initialize the meta values"""
@@ -74,6 +74,9 @@ def meta_values(
     else:
         url_path = url.path
 
+    if schema is None:
+        schema = CONFIG.schema_url if not CONFIG.is_index else CONFIG.index_schema_url
+
     return ResponseMeta(
         query=ResponseMetaQuery(representation=f"{url_path}?{url.query}"),
         api_version=__api_version__,
@@ -273,7 +276,9 @@ def get_entries(
             data_returned=data_returned,
             data_available=len(collection),
             more_data_available=more_data_available,
-            schema=CONFIG.schema_url,
+            schema=CONFIG.schema_url
+            if not CONFIG.is_index
+            else CONFIG.index_schema_url,
         ),
         included=included,
     )
@@ -321,7 +326,9 @@ def get_single_entry(
             data_returned=data_returned,
             data_available=len(collection),
             more_data_available=more_data_available,
-            schema=CONFIG.schema_url,
+            schema=CONFIG.schema_url
+            if not CONFIG.is_index
+            else CONFIG.index_schema_url,
         ),
         included=included,
     )

tests/server/test_server_validation.py

@@ -123,3 +123,43 @@ def test_versioned_base_urls(client, index_client, server: str):
                 f"Mandatory 'meta' top-level field not found in request to {response.url} for "
                 f"server {server!r}. Response: {json.dumps(json_response, indent=2)}"
             )
+
+
+@pytest.mark.parametrize("server", ["regular", "index"])
+def test_meta_schema_value_obeys_index(client, index_client, server: str):
+    """Test that the reported `meta->schema` is correct for index/non-index
+    servers.
+    """
+    try:
+        import simplejson as json
+    except ImportError:
+        import json
+
+    from optimade.server.routers.utils import BASE_URL_PREFIXES
+    from optimade.server.config import CONFIG
+
+    clients = {
+        "regular": client,
+        "index": index_client,
+    }
+
+    for version in BASE_URL_PREFIXES.values():
+
+        # Mimic the effect of the relevant server's startup
+        CONFIG.is_index = server == "index"
+        response = clients[server].get(url=version + "/links")
+        json_response = response.json()
+
+        assert response.status_code == 200, (
+            f"Request to {response.url} failed for server {server!r}: "
+            f"{json.dumps(json_response, indent=2)}"
+        )
+        assert "meta" in json_response, (
+            f"Mandatory 'meta' top-level field not found in request to {response.url} for "
+            f"server {server!r}. Response: {json.dumps(json_response, indent=2)}"
+        )
+
+        if server == "regular":
+            assert json_response["meta"].get("schema") == CONFIG.schema_url
+        else:
+            assert json_response["meta"].get("schema") == CONFIG.index_schema_url