src/_module_template/config.py

@@ -1,5 +1,7 @@
 """
-Configurations for the <this> module
+Configurations for <this module>
 
-Exports:
+Configurations:
+ - List: Description
+ - Configs: Description
 """

src/_module_template/constants.py

@@ -1,5 +1,7 @@
 """
-Constants for the <this> module
+Constants and error codes for <this module>
 
-Exports:
+Constants:
+ - List: Description
+ - Consts: Description
 """

src/_module_template/dependencies.py

@@ -1,6 +1,11 @@
 """
-Dependencies related to the <this> module
+Router dependencies for <this module>
 
-Exports:
+Classes:
- - <dep_name>: <return_type>: <description>
+ - List: Description
+ - Classes: Description
+
+Functions:
+ - List: Description
+ - Functions: Description
 """

src/_module_template/exceptions.py

@@ -1,6 +1,7 @@
 """
-Exceptions related to the <this> modules
+Module specific exceptions for <this module>
 
 Exceptions:
- - <ExceptionName>: Details e.g. optional params
+ - List: Description
+ - Exceptions: Description
 """

src/_module_template/models.py

@@ -1,9 +1,7 @@
 """
-Database models for the <this> module
+Database models for <this module>
 
 Models:
- - <ModelName>:
+ - List: Description
-  - <normal_columns[FK][PK]>
+ - Models: Description
-  - <orm_relationships>
-  - <calculated_properties>
 """

src/_module_template/router.py

@@ -1,12 +1,13 @@
 """
-Router endpoints for the <this> module
+Router endpoints for <this module>
 
-Exports:
+Endpoints:
- - router: fastapi.APIRouter
+ - List: Description
+ - Endpoints: Description
 """
 from fastapi import APIRouter
 
 
-router = APIRouter(
+_router = APIRouter(
 	tags=[""],
 )

src/_module_template/schemas.py

@@ -1,8 +1,7 @@
 """
-Pydantic models for the <this> module
+Pydantic models for <this module>
 
-Models follow the nomenclature of:
+Models:
-- Sub-models: "<Resource><Opt:>Schema"
+ - List: Description
-- Mixins: "<Attribute>Mixin"
+ - Models: Description
-- Models: "<Module><Method><Resource><Opt:Resource><Direction>" ie ""
 """

src/_module_template/service.py

@@ -1,5 +1,11 @@
 """
-Module specific business logic for the <this> module
+Module specific business logic for <this module>
 
-Exports:
+Classes:
+ - List: Description
+ - Classes: Description
+
+Functions:
+ - List: Description
+ - Functions: Description
 """

src/_module_template/utils.py

@@ -1,3 +1,11 @@
 """
-Non-business logic reusable functions and classes for the <this> module
+Non-business logic reusable functions and classes for <this module>
+
+Classes:
+ - List: Description
+ - Classes: Description
+
+Functions:
+ - List: Description
+ - Functions: Description
 """

src/main.py

@@ -31,11 +31,7 @@ tags_metadata = [
 	{
 		"name": "User",
 		"description": "User related operations, includes getting information about the current user",
-	},
+	}
-	{
-		"name": "Service",
-		"description": "Services related operations, includes registering services and reissuing API keys",
-	},
 ]
 
 

src/service/router.py

@@ -26,29 +26,16 @@ router = APIRouter(
 	prefix="/service",
 )
 
-@router.get("/", status_code=status.HTTP_200_OK, response_model=ServiceGetServiceResponse, responses={
+@router.get("/", response_model=ServiceGetServiceResponse)
-	status.HTTP_200_OK: {"description": "Successful retrieval from database"},
-	status.HTTP_401_UNAUTHORIZED: {"description": "Unauthorized"},
-})
 async def get_all_services(db: db_dependency, org_model: org_model_root_claim_query_dependency):
-	"""
-	Returns the ID and name of all services registered to the hub.
-	"""
 	permission_models = db.query(Service).all()
 
 	return {"services": permission_models}
 
-@router.post("/", status_code=status.HTTP_200_OK, response_model=ServicePostServiceResponse, responses={
+@router.post("/", response_model=ServicePostServiceResponse)
-	status.HTTP_200_OK: {"description": "Successfully registered a new service"},
+async def register_service(db: db_dependency, su: super_admin_dependency, service_request: ServicePostServiceRequest):
-	status.HTTP_401_UNAUTHORIZED: {"description": "Unauthorized"},
-	status.HTTP_409_CONFLICT: {"description": "Service with this name already exists"},
-})
-async def register_service(db: db_dependency, su: super_admin_dependency, request_model: ServicePostServiceRequest):
-	"""
-	Registers a new service to the hub, generating and returning an API key for it.
-	"""
 	key = generate_api_key()
-	service_model = Service(name=request_model.name, api_key=key)
+	service_model = Service(name=service_request.name, api_key=key)
 
 	db.add(service_model)
 	try:
@@ -61,14 +48,8 @@ async def register_service(db: db_dependency, su: super_admin_dependency, reques
 	db.commit()
 	return {"service": response}
 
-@router.patch("/key", status_code=status.HTTP_200_OK, response_model=ServicePatchKeyResponse, responses={
+@router.patch("/key", response_model=ServicePatchKeyResponse)
-	status.HTTP_200_OK: {"description": "Successful update of API key"},
-	status.HTTP_401_UNAUTHORIZED: {"description": "Unauthorized"},
-})
 async def regenerate_api_key(db: db_dependency, su: super_admin_dependency, service_model: service_model_body_dependency, request_model: ServicePatchKeyRequest):
-	"""
-	Generates and returns a new API key for the service to access the hub.
-	"""
 	key = generate_api_key()
 	service_model.api_key = key
 
@@ -77,13 +58,7 @@ async def regenerate_api_key(db: db_dependency, su: super_admin_dependency, serv
 	db.commit()
 	return {"service": response}
 
-@router.delete("/", status_code=status.HTTP_204_NO_CONTENT, responses={
+@router.delete("/", status_code=status.HTTP_204_NO_CONTENT)
-	status.HTTP_204_NO_CONTENT: {"description": "Successfully removed service from db"},
-	status.HTTP_401_UNAUTHORIZED: {"description": "Unauthorized"},
-})
 async def remove_service(db: db_dependency, service_model: service_model_body_dependency, su: super_admin_dependency, request_model: ServiceDeleteServiceRequest):
-	"""
-	Removes a service from the hub.
-	"""
 	db.delete(service_model)
 	db.commit()