diff --git a/CHANGELOG.md b/CHANGELOG.md index ae197a811..9e461044b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,16 @@ Alle bedeutenden Änderungen an diesem Projekt werden in dieser Datei dokumentie --- +## [1.1.74] – 2025-05-17 + +### Added + +- Übersichtsdokumentation für Webservices erstellt: + - `docs/frontend/redux/api/fromWebService/README.md` + - beschreibt Zweck, Parameterstruktur, und alle dokumentierten API-Dateien + +--- + ## [1.1.73] – 2025-05-17 ### Changed diff --git a/config/appVersion.js b/config/appVersion.js index 12dbf3c7c..d6807e71d 100644 --- a/config/appVersion.js +++ b/config/appVersion.js @@ -1,2 +1,2 @@ // /config/appVersion -export const APP_VERSION = "1.1.74"; +export const APP_VERSION = "1.1.75"; diff --git a/docs/frontend/redux/api/fromWebService/README.md b/docs/frontend/redux/api/fromWebService/README.md new file mode 100644 index 000000000..aea7dc01f --- /dev/null +++ b/docs/frontend/redux/api/fromWebService/README.md @@ -0,0 +1,61 @@ +# 📁 Webservice-Dokumentation – fromWebService + +Dieses Verzeichnis dokumentiert alle Webservice-Aufrufe, +die über `/redux/api/fromWebService/` im Projekt ausgeführt werden. + +--- + +## 🌐 Hintergrund + +Die TALAS.web-Anwendung übergibt `idMap` und `idUser` über die URL-Parameter: + +``` +http:///talas5/MessagesMap/mapTypeC.aspx?m=12&u=484 +``` + +Daraus entstehen Webservice-Aufrufe wie: + +``` +/talas5/ClientData/WebServiceMap.asmx/GisSystemStatic?idMap=12&idUser=484 +``` + +Alle Webservices nutzen den Port 80 – auch in der Entwicklungsumgebung. +Daher wird zentral über `.env.local` gesteuert: + +```env +NEXT_PUBLIC_API_PORT_MODE=dev +``` + +--- + +## 📄 Enthaltene Dokumentationen + +| Dateiname | Zweck | +|----------------------------------------|--------------------------------------| +| [`fetchGisSystemStatic.md`](./fetchGisSystemStatic.md) | Systemübersicht aller Geräte | +| [`fetchGisStationsMeasurements.md`](./fetchGisStationsMeasurements.md) | Messwerte der Geräte | +| [`fetchGisStationsStatic.md`](./fetchGisStationsStatic.md) | Statische Standortinformationen | +| [`fetchGisStationsStaticDistrict.md`](./fetchGisStationsStaticDistrict.md) | Gerätestruktur je Bezirk | +| [`fetchGisStationsStatusDistrict.md`](./fetchGisStationsStatusDistrict.md) | Aktueller Gerätestatus nach Bezirk | + +--- + +## 🔁 Verzeichnisstruktur + +```bash +/docs +└── frontend + └── redux + └── api + └── fromWebService + ├── fetchGisSystemStatic.md + ├── fetchGisStationsMeasurements.md + ├── fetchGisStationsStatic.md + ├── fetchGisStationsStaticDistrict.md + ├── fetchGisStationsStatusDistrict.md + └── README.md ← (diese Datei) +``` + +--- + +Diese Übersicht hilft Entwicklern beim Einstieg und zeigt, wie zentrale Webservice-Kommunikation im Projekt funktioniert. \ No newline at end of file