Add prefixes at the router layer

Author: edan-bainglass

aiida_restapi/routers/auth.py

@@ -33,9 +33,9 @@ class UserInDB(orm.User.Model):
 
 pwd_context = PasswordHasher()
 
-oauth2_scheme = OAuth2PasswordBearer(tokenUrl='token')
+oauth2_scheme = OAuth2PasswordBearer(tokenUrl=f'{config.API_CONFIG["PREFIX"]}/auth/token')
 
-router = APIRouter()
+router = APIRouter(prefix='/auth')
 
 
 def verify_password(plain_password: str, hashed_password: str) -> bool:
@@ -113,7 +113,10 @@ async def get_current_active_user(
     return current_user
 
 
-@router.post('/token', response_model=Token)
+@router.post(
+    '/token',
+    response_model=Token,
+)
 async def login_for_access_token(
     form_data: OAuth2PasswordRequestForm = Depends(),
 ) -> dict[str, t.Any]:
@@ -130,7 +133,10 @@ async def login_for_access_token(
     return {'access_token': access_token, 'token_type': 'bearer'}
 
 
-@router.get('/auth/me/', response_model=orm.User.Model)
+@router.get(
+    '/me/',
+    response_model=orm.User.Model,
+)
 async def read_users_me(
     current_user: t.Annotated[orm.User.Model, Depends(get_current_active_user)],
 ) -> orm.User.Model:

aiida_restapi/routers/computers.py

@@ -15,16 +15,19 @@
 
 from .auth import UserInDB, get_current_active_user
 
-read_router = APIRouter()
-write_router = APIRouter()
+read_router = APIRouter(prefix='/computers')
+write_router = APIRouter(prefix='/computers')
 
 repository = EntityRepository[orm.Computer, orm.Computer.Model](
     entity_class=orm.Computer,
     identifier='pk',
 )
 
 
-@read_router.get('/computers/schema')
+@read_router.get(
+    '/schema',
+    response_model=dict,
+)
 async def get_computers_schema(
     which: t.Literal['get', 'post'] = Query(
         'get',
@@ -46,7 +49,10 @@ async def get_computers_schema(
         raise HTTPException(status_code=500, detail=str(exception)) from exception
 
 
-@read_router.get('/computers/projectable_properties', response_model=list[str])
+@read_router.get(
+    '/projectable_properties',
+    response_model=list[str],
+)
 async def get_computer_projectable_properties() -> list[str]:
     """Get projectable properties for AiiDA computers.
 
@@ -56,7 +62,7 @@ async def get_computer_projectable_properties() -> list[str]:
 
 
 @read_router.get(
-    '/computers',
+    '',
     response_model=PaginatedResults[orm.Computer.Model],
     response_model_exclude_none=True,
     response_model_exclude_unset=True,
@@ -74,7 +80,7 @@ async def get_computers(
 
 
 @read_router.get(
-    '/computers/{pk}',
+    '/{pk}',
     response_model=orm.Computer.Model,
     response_model_exclude_none=True,
     response_model_exclude_unset=True,
@@ -96,7 +102,10 @@ async def get_computer(pk: str) -> orm.Computer.Model:
         raise HTTPException(status_code=500, detail=str(exception)) from exception
 
 
-@read_router.get('/computers/{pk}/metadata', response_model=dict[str, t.Any])
+@read_router.get(
+    '/{pk}/metadata',
+    response_model=dict[str, t.Any],
+)
 @with_dbenv()
 async def get_computer_metadata(pk: str) -> dict[str, t.Any]:
     """Get metadata of an AiiDA computer by pk.
@@ -116,7 +125,7 @@ async def get_computer_metadata(pk: str) -> dict[str, t.Any]:
 
 
 @write_router.post(
-    '/computers',
+    '',
     response_model=orm.Computer.Model,
     response_model_exclude_none=True,
     response_model_exclude_unset=True,

aiida_restapi/routers/daemon.py

@@ -11,8 +11,8 @@
 
 from .auth import UserInDB, get_current_active_user
 
-read_router = APIRouter()
-write_router = APIRouter()
+read_router = APIRouter(prefix='/daemon')
+write_router = APIRouter(prefix='/daemon')
 
 
 class DaemonStatusModel(BaseModel):
@@ -23,7 +23,7 @@ class DaemonStatusModel(BaseModel):
 
 
 @read_router.get(
-    '/daemon/status',
+    '/status',
     response_model=DaemonStatusModel,
 )
 @with_dbenv()
@@ -46,7 +46,7 @@ async def get_daemon_status() -> DaemonStatusModel:
 
 
 @write_router.post(
-    '/daemon/start',
+    '/start',
     response_model=DaemonStatusModel,
 )
 @with_dbenv()
@@ -73,7 +73,7 @@ async def get_daemon_start(
 
 
 @write_router.post(
-    '/daemon/stop',
+    '/stop',
     response_model=DaemonStatusModel,
 )
 @with_dbenv()

aiida_restapi/routers/groups.py

@@ -15,16 +15,19 @@
 
 from .auth import UserInDB, get_current_active_user
 
-read_router = APIRouter()
-write_router = APIRouter()
+read_router = APIRouter(prefix='/groups')
+write_router = APIRouter(prefix='/groups')
 
 repository = EntityRepository[orm.Group, orm.Group.Model](
     entity_class=orm.Group,
     identifier='uuid',
 )
 
 
-@read_router.get('/groups/schema')
+@read_router.get(
+    '/schema',
+    response_model=dict,
+)
 async def get_groups_schema(
     which: t.Literal['get', 'post'] = Query(
         'get',
@@ -46,7 +49,10 @@ async def get_groups_schema(
         raise HTTPException(status_code=500, detail=str(exception)) from exception
 
 
-@read_router.get('/groups/projectable_properties', response_model=list[str])
+@read_router.get(
+    '/projectable_properties',
+    response_model=list[str],
+)
 async def get_group_projectable_properties() -> list[str]:
     """Get projectable properties for AiiDA groups.
 
@@ -56,7 +62,7 @@ async def get_group_projectable_properties() -> list[str]:
 
 
 @read_router.get(
-    '/groups',
+    '',
     response_model=PaginatedResults[orm.Group.Model],
     response_model_exclude_none=True,
     response_model_exclude_unset=True,
@@ -74,7 +80,7 @@ async def get_groups(
 
 
 @read_router.get(
-    '/groups/{uuid}',
+    '/{uuid}',
     response_model=orm.Group.Model,
     response_model_exclude_none=True,
     response_model_exclude_unset=True,
@@ -97,7 +103,7 @@ async def get_group(uuid: str) -> orm.Group.Model:
 
 
 @read_router.get(
-    '/groups/{uuid}/extras',
+    '/{uuid}/extras',
     response_model=dict[str, t.Any],
 )
 @with_dbenv()
@@ -118,7 +124,7 @@ async def get_group_extras(uuid: str) -> dict[str, t.Any]:
 
 
 @write_router.post(
-    '/groups',
+    '',
     response_model=orm.Group.Model,
     response_model_exclude_none=True,
     response_model_exclude_unset=True,

aiida_restapi/routers/nodes.py

@@ -22,8 +22,8 @@
 
 from .auth import UserInDB, get_current_active_user
 
-read_router = APIRouter()
-write_router = APIRouter()
+read_router = APIRouter(prefix='/nodes')
+write_router = APIRouter(prefix='/nodes')
 
 repository = NodeRepository[orm.Node, orm.Node.Model](
     entity_class=orm.Node,
@@ -40,7 +40,10 @@
     NodeModelUnion = model_registry.ModelUnion
 
 
-@read_router.get('/nodes/schema')
+@read_router.get(
+    '/schema',
+    response_model=dict,
+)
 async def get_nodes_schema(
     node_type: str | None = Query(
         None,
@@ -72,7 +75,10 @@ async def get_nodes_schema(
         raise HTTPException(status_code=500, detail=str(exception)) from exception
 
 
-@read_router.get('/nodes/projectable_properties')
+@read_router.get(
+    '/projectable_properties',
+    response_model=list[str],
+)
 @with_dbenv()
 async def get_node_projectable_properties(
     node_type: str | None = Query(
@@ -123,7 +129,10 @@ class NodeStatistics(pdt.BaseModel):
     )
 
 
-@read_router.get('/nodes/statistics', response_model=NodeStatistics)
+@read_router.get(
+    '/statistics',
+    response_model=NodeStatistics,
+)
 @with_dbenv()
 async def get_nodes_statistics(user: int | None = None) -> dict[str, t.Any]:
     """Get node statistics.
@@ -152,7 +161,7 @@ async def get_nodes_statistics(user: int | None = None) -> dict[str, t.Any]:
     return backend.query().get_creation_statistics(user_pk=user)
 
 
-@read_router.get('/nodes/download_formats')
+@read_router.get('/download_formats')
 async def get_nodes_download_formats() -> dict[str, t.Any]:
     """Get download formats for AiiDA nodes.
 
@@ -169,7 +178,7 @@ async def get_nodes_download_formats() -> dict[str, t.Any]:
 
 
 @read_router.get(
-    '/nodes',
+    '',
     response_model=PaginatedResults[orm.Node.Model],
     response_model_exclude_none=True,
     response_model_exclude_unset=True,
@@ -196,7 +205,10 @@ class NodeType(pdt.BaseModel):
     node_schema: str = pdt.Field(description='The URL to access the schema of this node type.')
 
 
-@read_router.get('/nodes/types', response_model=list[NodeType])
+@read_router.get(
+    '/types',
+    response_model=list[NodeType],
+)
 async def get_node_types() -> list:
     """Get all node types in machine-actionable format.
 
@@ -206,9 +218,9 @@ async def get_node_types() -> list:
     >>>   {
     >>>     "label": "Int",
     >>>     "node_type": "data.core.int.Int.",
-    >>>     "nodes": "/nodes?filters={\"node_type\":{\"data.core.int.Int.\"}}",
-    >>>     "projections": "/nodes/projectable_properties?type=data.core.int.Int.",
-    >>>     "node_schema": "/nodes/schema?type=data.core.int.Int.",
+    >>>     "nodes": ".../nodes?filters={\"node_type\":{\"data.core.int.Int.\"}}",
+    >>>     "projections": ".../nodes/projectable_properties?type=data.core.int.Int.",
+    >>>     "node_schema": ".../nodes/schema?type=data.core.int.Int.",
     >>>   },
     >>>   ...
     >>> ]
@@ -229,7 +241,7 @@ async def get_node_types() -> list:
 
 
 @read_router.get(
-    '/nodes/{uuid}',
+    '/{uuid}',
     response_model=orm.Node.Model,
     response_model_exclude_none=True,
     response_model_exclude_unset=True,
@@ -252,7 +264,7 @@ async def get_node(uuid: str) -> orm.Node.Model:
 
 
 @read_router.get(
-    '/nodes/{uuid}/attributes',
+    '/{uuid}/attributes',
     response_model=dict[str, t.Any],
 )
 @with_dbenv()
@@ -273,7 +285,7 @@ async def get_node_attributes(uuid: str) -> dict[str, t.Any]:
 
 
 @read_router.get(
-    '/nodes/{uuid}/extras',
+    '/{uuid}/extras',
     response_model=dict[str, t.Any],
 )
 @with_dbenv()
@@ -294,7 +306,7 @@ async def get_node_extras(uuid: str) -> dict[str, t.Any]:
 
 
 @read_router.get(
-    '/nodes/{uuid}/links',
+    '/{uuid}/links',
     response_model=PaginatedResults[NodeLinks],
     response_model_exclude_none=True,
     response_model_exclude_unset=True,
@@ -324,7 +336,10 @@ async def get_node_links(
         raise HTTPException(status_code=500, detail=str(exception)) from exception
 
 
-@read_router.get('/nodes/{uuid}/download')
+@read_router.get(
+    '/{uuid}/download',
+    response_class=StreamingResponse,
+)
 @with_dbenv()
 async def download_node(
     uuid: str,
@@ -414,7 +429,7 @@ class RepoDirMetadata(pdt.BaseModel):
 
 
 @read_router.get(
-    '/nodes/{uuid}/repo/metadata',
+    '/{uuid}/repo/metadata',
     response_model=dict[str, MetadataType],
 )
 @with_dbenv()
@@ -434,7 +449,10 @@ async def get_node_repo_file_metadata(uuid: str) -> dict[str, dict]:
         raise HTTPException(status_code=500, detail=str(exception)) from exception
 
 
-@read_router.get('/nodes/{uuid}/repo/contents')
+@read_router.get(
+    '/{uuid}/repo/contents',
+    response_class=StreamingResponse,
+)
 @with_dbenv()
 async def get_node_repo_file_contents(
     uuid: str,
@@ -491,7 +509,7 @@ def zip_stream() -> t.Generator[bytes, None, None]:
 
 
 @write_router.post(
-    '/nodes',
+    '',
     response_model=orm.Node.Model,
     response_model_exclude_none=True,
     response_model_exclude_unset=True,
@@ -518,7 +536,7 @@ async def create_node(
 
 
 @write_router.post(
-    '/nodes/file-upload',
+    '/file-upload',
     response_model=orm.Node.Model,
     response_model_exclude_none=True,
     response_model_exclude_unset=True,