add better descriptions + summary

This commit is contained in:
Michi 2025-03-30 18:22:20 +02:00
parent b1d7363e81
commit 6faba4a759

View file

@ -13,8 +13,8 @@ from crypto import hash_password, generate_new_token
################ API ################ ################ API ################
app = FastAPI( app = FastAPI(
title="BBZW-Horizon", title="BBZW-Horizon",
description="BBZW-Horizon", description="BBZW-Horizon ist ein Tool, welches entwickelt wurde, um durch die Erfassung und Auswertung von Luftqualitätsmesswerten die Luftqualität in den Schulzimmern des BBZW Sursee zu verbessern. Bei dieser API handelt es sich um die Kommunikationsschnittstelle, zwischen den Arduinos, welche mit Sensoren die Daten erfassen und an die API senden. Diese API speichert die Daten dann in der Datenbank, damit diese durch das Frontend abgerufen und visualisiert werden können.",
summary="BBZW-Horizon", summary="Die BBZW-Horizon API dient als Kommunikationsschnittstelle, um Luftqualitätsmesswerte von Arduinos, die mit Sensoren ausgestattet sind, zu erfassen",
version="0.0.2" version="0.0.2"
) )