Apply suggestions from code review

Co-authored-by: Casper Welzel Andersen <43357585+CasperWA@users.noreply.github.com>

openapi/index_openapi.json

@@ -241,11 +241,10 @@
           "200": {
             "description": "Successful Response",
             "content": {
-              "application/json": {
-                "schema": {}
-              },
               "text/csv": {
-                "schema": {}
+                "schema": {
+                  "type": "string"
+                }
               }
             }
           }
@@ -1606,7 +1605,7 @@
           "representation": {
             "title": "Representation",
             "type": "string",
-            "description": "A string with the part of the URL following the versioned or unversioned base URL that serves the API.\nQuery parameters that have not been used in processing the request MAY be omitted.\nIn particular, if no query parameters have been involved in processing the request, the query pary of the URL MAY be excluded.\nExample: `/structures?filter=nelements=2`"
+            "description": "A string with the part of the URL following the versioned or unversioned base URL that serves the API.\nQuery parameters that have not been used in processing the request MAY be omitted.\nIn particular, if no query parameters have been involved in processing the request, the query part of the URL MAY be excluded.\nExample: `/structures?filter=nelements=2`"
           }
         },
         "description": "Information on the query that was requested. "

openapi/openapi.json

@@ -879,11 +879,10 @@
           "200": {
             "description": "Successful Response",
             "content": {
-              "application/json": {
-                "schema": {}
-              },
               "text/csv": {
-                "schema": {}
+                "schema": {
+                  "type": "string"
+                }
               }
             }
           }
@@ -2783,7 +2782,7 @@
           "representation": {
             "title": "Representation",
             "type": "string",
-            "description": "A string with the part of the URL following the versioned or unversioned base URL that serves the API.\nQuery parameters that have not been used in processing the request MAY be omitted.\nIn particular, if no query parameters have been involved in processing the request, the query pary of the URL MAY be excluded.\nExample: `/structures?filter=nelements=2`"
+            "description": "A string with the part of the URL following the versioned or unversioned base URL that serves the API.\nQuery parameters that have not been used in processing the request MAY be omitted.\nIn particular, if no query parameters have been involved in processing the request, the query part of the URL MAY be excluded.\nExample: `/structures?filter=nelements=2`"
           }
         },
         "description": "Information on the query that was requested. "

optimade/models/optimade_json.py

@@ -161,7 +161,7 @@ class ResponseMetaQuery(BaseModel):
         ...,
         description="""A string with the part of the URL following the versioned or unversioned base URL that serves the API.
 Query parameters that have not been used in processing the request MAY be omitted.
-In particular, if no query parameters have been involved in processing the request, the query pary of the URL MAY be excluded.
+In particular, if no query parameters have been involved in processing the request, the query part of the URL MAY be excluded.
 Example: `/structures?filter=nelements=2`""",
     )
 

optimade/server/routers/index_info.py

@@ -16,7 +16,7 @@
 
 from optimade.server.config import CONFIG
 
-from .utils import meta_values, get_base_url
+from optimade.server.routers.utils import meta_values, get_base_url
 
 
 router = APIRouter(redirect_slashes=True)

optimade/server/routers/landing.py

@@ -5,8 +5,8 @@
 from starlette.routing import Router, Route
 from optimade import __api_version__
 
-from . import ENTRY_COLLECTIONS
-from .utils import meta_values
+from optimade.server.routers import ENTRY_COLLECTIONS
+from optimade.server.routers.utils import meta_values
 from optimade.server.config import CONFIG
 
 template_dir = Path(__file__).parent.joinpath("static").resolve()

optimade/server/routers/versions.py

@@ -6,20 +6,15 @@
 router = APIRouter(redirect_slashes=True)
 
 
+class CsvResponse(Response):
+    media_type = "text/csv"
+
+
 @router.get(
-    "/versions",
-    tags=["Versions"],
-    responses={
-        200: {
-            "description": "Successful Response",
-            "content": {"text/csv": {"schema": {}}},
-        }
-    },
+    "/versions", tags=["Versions"], response_class=CsvResponse,
 )
 def get_versions(request: Request):
     """Respond with the text/csv representation for the served versions."""
     version = BASE_URL_PREFIXES["major"].replace("/v", "")
     response = f"version\n{version}"
-    return Response(
-        content=response, media_type="text/csv", headers={"header": "present"}
-    )
+    return CsvResponse(content=response, headers={"header": "present"})

tests/server/utils.py

@@ -16,11 +16,8 @@ def get_regular_client() -> TestClient:
     from optimade.server.main import app
     from optimade.server.routers import info, links, references, structures
 
-    # We need to remove the version prefixes in order to have the tests run correctly.
-    app.include_router(info.router, prefix=VERSION_PREFIX)
-    app.include_router(links.router, prefix=VERSION_PREFIX)
-    app.include_router(references.router, prefix=VERSION_PREFIX)
-    app.include_router(structures.router, prefix=VERSION_PREFIX)
+    for endpoint in (info, links, references, structures):
+        app.include_router(endpoint.router, prefix=VERSION_PREFIX)
     # need to explicitly set base_url, as the default "http://testserver"
     # does not validate as pydantic AnyUrl model
     return TestClient(app, base_url=f"http://example.org{VERSION_PREFIX}")
@@ -31,7 +28,6 @@ def get_index_client() -> TestClient:
     from optimade.server.main_index import app
     from optimade.server.routers import index_info, links
 
-    # # We need to remove the version prefixes in order to have the tests run correctly.
     app.include_router(index_info.router, prefix=VERSION_PREFIX)
     app.include_router(links.router, prefix=VERSION_PREFIX)
     # need to explicitly set base_url, as the default "http://testserver"