docs: document flood_alert_level values and placeholder filtering
Add observed values and expected Alarmstufe levels to README and OpenAPI schema.
This commit is contained in:
1 parent
15c9a8cb70
commit
489a026b9c
2 files changed
+34
-4
No files matched your search
+19
-2
@@ -1,6 +1,6 @@
|
||||
from fastapi import FastAPI, HTTPException
|
||||
from fastapi.responses import JSONResponse, RedirectResponse
|
||||
from pydantic import BaseModel
|
||||
from pydantic import BaseModel, Field
|
||||
import feedparser
|
||||
import re
|
||||
import html
|
||||
@@ -54,7 +54,24 @@ class PegelEntry(BaseModel):
|
||||
title: str | None
|
||||
water_level_cm: float | None
|
||||
flow_m3s: float | None
|
||||
flood_alert_level: str | None
|
||||
flood_alert_level: str | None = Field(
|
||||
description=(
|
||||
"Meldestufe als Text. Beobachtete Werte: `Niedrigwasser`, `Kein Hochwasser`, "
|
||||
"`Kein Hochwassermeldepegel` (Pegel ohne Hochwassermeldefunktion). Bei "
|
||||
"Hochwasser sind laut HWIMS-Legende `Alarmstufe 1` bis `Alarmstufe 4` zu "
|
||||
"erwarten; deren genaue Schreibweise im Feed ist nicht verifiziert. "
|
||||
"Clients sollten unbekannte Werte tolerieren."
|
||||
),
|
||||
examples=[
|
||||
"Niedrigwasser",
|
||||
"Kein Hochwasser",
|
||||
"Kein Hochwassermeldepegel",
|
||||
"Alarmstufe 1",
|
||||
"Alarmstufe 2",
|
||||
"Alarmstufe 3",
|
||||
"Alarmstufe 4",
|
||||
],
|
||||
)
|
||||
|
||||
class PegelResponse(BaseModel):
|
||||
station_id: str
|
||||
|
||||
Reference in new issue
Block a user