Add configurable schema_url and index_schema_url options

optimade/server/config.py

@@ -18,7 +18,7 @@
 )
 from pydantic.env_settings import SettingsSourceCallable
 
-from optimade import __version__
+from optimade import __version__, __api_version__
 from optimade.models import Implementation, Provider
 
 
@@ -260,6 +260,20 @@ class ServerConfig(BaseSettings):
             "MongoDB-based backend."
         ),
     )
+    schema_url: Optional[Union[str, AnyHttpUrl]] = Field(
+        f"https://schemas.optimade.org/openapi/v{__api_version__}/optimade.json",
+        description=(
+            "A URL that will be provided in the `meta->schema` field for every response"
+        ),
+    )
+
+    index_schema_url: Optional[Union[str, AnyHttpUrl]] = Field(
+        f"https://schemas.optimade.org/openapi/{__api_version__}/optimade_index.json",
+        description=(
+            "A URL that will be provided in the `meta->schema` field for every response from the index meta-database."
+        ),
+    )
+
     log_level: LogLevel = Field(
         LogLevel.INFO, description="Logging level for the OPTIMADE server."
     )

optimade/server/exception_handlers.py

@@ -67,6 +67,7 @@ def general_exception(
             data_returned=0,
             data_available=0,
             more_data_available=False,
+            schema=CONFIG.schema_url,
             **debug_info,
         ),
         errors=errors,

optimade/server/routers/index_info.py

@@ -25,7 +25,13 @@
 )
 def get_info(request: Request) -> IndexInfoResponse:
     return IndexInfoResponse(
-        meta=meta_values(request.url, 1, 1, more_data_available=False),
+        meta=meta_values(
+            request.url,
+            1,
+            1,
+            more_data_available=False,
+            schema=CONFIG.index_schema_url,
+        ),
         data=IndexInfoResource(
             id=IndexInfoResource.schema()["properties"]["id"]["default"],
             type=IndexInfoResource.schema()["properties"]["type"]["default"],

optimade/server/routers/info.py

@@ -4,6 +4,7 @@
 from optimade import __api_version__
 from optimade.models import InfoResponse, EntryInfoResponse
 from optimade.server.routers.utils import meta_values, get_base_url
+from optimade.server.config import CONFIG
 from optimade.server.schemas import (
     ENTRY_INFO_SCHEMAS,
     ERROR_RESPONSES,
@@ -25,7 +26,9 @@ def get_info(request: Request) -> InfoResponse:
     from optimade.models import BaseInfoResource, BaseInfoAttributes
 
     return InfoResponse(
-        meta=meta_values(request.url, 1, 1, more_data_available=False),
+        meta=meta_values(
+            request.url, 1, 1, more_data_available=False, schema=CONFIG.schema_url
+        ),
         data=BaseInfoResource(
             id=BaseInfoResource.schema()["properties"]["id"]["default"],
             type=BaseInfoResource.schema()["properties"]["type"]["default"],
@@ -72,11 +75,14 @@ def get_entry_info(request: Request, entry: str) -> EntryInfoResponse:
     output_fields_by_format = {"json": list(properties.keys())}
 
     return EntryInfoResponse(
-        meta=meta_values(request.url, 1, 1, more_data_available=False),
+        meta=meta_values(
+            request.url, 1, 1, more_data_available=False, schema=CONFIG.schema_url
+        ),
         data=EntryInfoResource(
             formats=list(output_fields_by_format.keys()),
             description=schema.get("description", "Entry Resources"),
             properties=properties,
             output_fields_by_format=output_fields_by_format,
+            schema=CONFIG.schema_url,
         ),
     )

optimade/server/routers/utils.py

@@ -59,6 +59,7 @@ def meta_values(
     data_returned: int,
     data_available: int,
     more_data_available: bool,
+    schema: str,
     **kwargs,
 ) -> ResponseMeta:
     """Helper to initialize the meta values"""
@@ -82,6 +83,7 @@ def meta_values(
         provider=CONFIG.provider,
         data_available=data_available,
         implementation=CONFIG.implementation,
+        schema=schema,
         **kwargs,
     )
 
@@ -271,6 +273,7 @@ def get_entries(
             data_returned=data_returned,
             data_available=len(collection),
             more_data_available=more_data_available,
+            schema=CONFIG.schema_url,
         ),
         included=included,
     )
@@ -318,6 +321,7 @@ def get_single_entry(
             data_returned=data_returned,
             data_available=len(collection),
             more_data_available=more_data_available,
+            schema=CONFIG.schema_url,
         ),
         included=included,
     )

tests/server/utils.py

@@ -136,9 +136,9 @@ def test_meta_response(self):
             "provider",
             "data_available",
             "implementation",
+            "schema",
             # TODO: These keys are not implemented in the example server implementations
             # Add them in when they are.
-            # "schema",
             # "last_id",
             # "response_message",
             # "warnings",