docs: Improve auto-generated OpenAPI docs

barnslig · Jul 6, 2022 · eef0dae · eef0dae
1 parent 48f4beb
commit eef0dae
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 6 deletions.
diff --git a/backend/dpt_app/trails/api.py b/backend/dpt_app/trails/api.py
@@ -9,7 +9,7 @@
 from .qr_models import Code
 from .schemas import ClockSchema, GameSchema, PlayerSchema
 
-api = NinjaAPI()
+api = NinjaAPI(title="Kaigo API")
 
 
 class CodeAlreadyUsed(Exception):

diff --git a/backend/dpt_app/trails/schemas.py b/backend/dpt_app/trails/schemas.py
@@ -12,16 +12,22 @@ class Data(GenericModel, Generic[TypeT, AttributesT]):
     attributes: AttributesT
 
 
-class Document(GenericModel, Generic[TypeT, AttributesT]):
-    data: Data[TypeT, AttributesT]
+DataT = TypeVar("DataT", bound=Data)
+
+
+class Document(GenericModel, Generic[DataT]):
+    data: DataT
 
 
 class ClockAttributes(BaseModel):
     state: Literal["running", "paused"]
     speed: Optional[float]
 
 
-ClockSchema = Document[Literal["clock"], ClockAttributes]
+ClockData = Data[Literal["clock"], ClockAttributes]
+ClockData.__name__ = "ClockData"
+
+ClockSchema = Document[ClockData]
 ClockSchema.__name__ = "Clock"
 
 
@@ -30,7 +36,10 @@ class GameAttributes(BaseModel):
     hasUserParameterScope: Optional[bool]
 
 
-GameSchema = Document[Literal["game"], GameAttributes]
+GameData = Data[Literal["game"], GameAttributes]
+GameData.__name__ = "GameData"
+
+GameSchema = Document[GameData]
 GameSchema.__name__ = "Game"
 
 
@@ -39,5 +48,8 @@ class PlayerAttributes(BaseModel):
     character: Optional[str]
 
 
-PlayerSchema = Document[Literal["player"], PlayerAttributes]
+PlayerData = Data[Literal["player"], PlayerAttributes]
+PlayerData.__name__ = "PlayerData"
+
+PlayerSchema = Document[PlayerData]
 PlayerSchema.__name__ = "Player"