Add metadata to FastAPI endpoints for OpenAPI.

operation_ids give us better function names when generating the
typescript API from the openapi.json. BaseModel.Config.title does the
same for type names. Response models (or 204 status codes) need to be
explicit or the API will be declared as returning any.
This commit is contained in:
Dan Albert
2022-03-06 17:12:00 -08:00
parent 4053356e13
commit b7439cbd17
23 changed files with 142 additions and 30 deletions

View File

@@ -16,6 +16,9 @@ class HoldZonesJs(BaseModel):
permissible_zones: list[LeafletPoly] = Field(alias="permissibleZones")
preferred_lines: list[LeafletPoly] = Field(alias="preferredLines")
class Config:
title = "HoldZones"
@classmethod
def empty(cls) -> HoldZonesJs:
return HoldZonesJs(
@@ -62,6 +65,9 @@ class IpZonesJs(BaseModel):
permissibleZone: LeafletPoly = Field(alias="permissibleZone")
safeZones: list[LeafletPoly] = Field(alias="safeZones")
class Config:
title = "IpZones"
@classmethod
def empty(cls) -> IpZonesJs:
return IpZonesJs(homeBubble=[], ipBubble=[], permissibleZone=[], safeZones=[])
@@ -89,6 +95,9 @@ class JoinZonesJs(BaseModel):
permissible_zones: list[LeafletPoly] = Field(alias="permissibleZones")
preferred_lines: list[LeafletPoly] = Field(alias="preferredLines")
class Config:
title = "JoinZones"
@classmethod
def empty(cls) -> JoinZonesJs:
return JoinZonesJs(