diff --git a/src/main.py b/src/main.py index 3995edf..0092af0 100644 --- a/src/main.py +++ b/src/main.py @@ -31,7 +31,11 @@ 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", + }, ] diff --git a/src/service/router.py b/src/service/router.py index bf01a87..b9d664f 100644 --- a/src/service/router.py +++ b/src/service/router.py @@ -26,16 +26,22 @@ router = APIRouter( prefix="/service", ) -@router.get("/", response_model=ServiceGetServiceResponse) +@router.get("/", status_code=status.HTTP_200_OK, response_model=ServiceGetServiceResponse) 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("/", response_model=ServicePostServiceResponse) -async def register_service(db: db_dependency, su: super_admin_dependency, service_request: ServicePostServiceRequest): +@router.post("/", status_code=status.HTTP_200_OK, response_model=ServicePostServiceResponse) +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=service_request.name, api_key=key) + service_model = Service(name=request_model.name, api_key=key) db.add(service_model) try: @@ -48,8 +54,11 @@ async def register_service(db: db_dependency, su: super_admin_dependency, servic db.commit() return {"service": response} -@router.patch("/key", response_model=ServicePatchKeyResponse) +@router.patch("/key", status_code=status.HTTP_200_OK, response_model=ServicePatchKeyResponse) 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 @@ -60,5 +69,8 @@ async def regenerate_api_key(db: db_dependency, su: super_admin_dependency, serv @router.delete("/", status_code=status.HTTP_204_NO_CONTENT) 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()