sr2/cloud-api
6
0
Fork 1
Code Issues 8 Pull requests 2 Projects Releases Packages Wiki Activity Actions

docs: service router details

Browse source
This commit is contained in:
Chris Milne 2026-05-28 15:25:29 +01:00
parent d03478637a
commit aa7dc46533
2 changed files with 22 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

6
src/main.py
View file

@ -31,7 +31,11 @@ tags_metadata = [
{ {
"name": "User", "name": "User",
"description": "User related operations, includes getting information about the current 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",
},
] ]

22
src/service/router.py
View file

@ -26,16 +26,22 @@ router = APIRouter(
prefix="/service", 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): 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() permission_models = db.query(Service).all()
return {"services": permission_models} return {"services": permission_models}
@router.post("/", response_model=ServicePostServiceResponse) @router.post("/", status_code=status.HTTP_200_OK, response_model=ServicePostServiceResponse)
async def register_service(db: db_dependency, su: super_admin_dependency, service_request: ServicePostServiceRequest): 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() 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) db.add(service_model)
try: try:
@ -48,8 +54,11 @@ async def register_service(db: db_dependency, su: super_admin_dependency, servic
db.commit() db.commit()
return {"service": response} 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): 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() key = generate_api_key()
service_model.api_key = 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) @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): 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.delete(service_model)
db.commit() db.commit()