docs: service docstrings

Issue: #13
This commit is contained in:
Chris Milne 2026-05-28 14:41:11 +01:00
parent 71f26a4c9b
commit d852bda091
9 changed files with 24 additions and 47 deletions

View file

@ -1,9 +1,11 @@
"""
Router endpoints for <this module>
Router endpoints for the services module
Endpoints:
- List: Description
- Endpoints: Description
- [GET](/): [root user]: Get a list of all services(id, name)
- [POST](/): [super admin]: Register a new service(name) on the hub, returns the API key for the service to access the hub.
- [PATCH](/key): [super_admin]: Refreshes the API key for a service(id), returning a new one.
- [DELETE](/): [super_admin]: Removes a service(id) from the hub.
"""
from fastapi import APIRouter, status
from psycopg.errors import UniqueViolation