From 52c0a2ae63d5577cbd6112771b35b360220d1b4e Mon Sep 17 00:00:00 2001
From: latlon team <info@lat-lon.de>
Date: Mon, 7 Oct 2024 05:25:40 +0000
Subject: [PATCH] Code drop
- XPLANBOX-3240 set REST API v1 to deprecated, added v2 as default (c791c82e4)
- XPLANBOX-3305 added known bug to user manual (3fad3b1e7)
Co-authored-by: Torsten Friebe <friebe@lat-lon.de>
Dropped from commit: a361ba7b51cadc3c4e982198db25ec3917d81146
---
.../src/main/asciidoc/XPlanManager_API.adoc | 11 ++++++++---
.../src/main/asciidoc/XPlanValidator_API.adoc | 13 +++++++++----
.../src/main/asciidoc/bekannteProbleme.adoc | 9 +++++----
3 files changed, 22 insertions(+), 11 deletions(-)
diff --git a/xplan-documentation/xplan-benutzerhandbuch/src/main/asciidoc/XPlanManager_API.adoc b/xplan-documentation/xplan-benutzerhandbuch/src/main/asciidoc/XPlanManager_API.adoc
index edb542648..75b124e47 100644
--- a/xplan-documentation/xplan-benutzerhandbuch/src/main/asciidoc/XPlanManager_API.adoc
+++ b/xplan-documentation/xplan-benutzerhandbuch/src/main/asciidoc/XPlanManager_API.adoc
@@ -6,11 +6,11 @@ Die REST-API des XPlanManager ermöglicht es, die Funktionen des XPlanManager ü
- `{planId}` - eindeutiger Schlüssel eines Plans (numerischer Wert, z.B. 10)
- `{planName}` - eindeutiger Name eines Plans (alphanumerischer Wert, z.B. HafenCity14)
- `{name}` - Name oder Suchtext (alphanumerischer Wert, z.B. Hafen )
-- `{id}` - eindeutiger Schlüssel einer Ressource (alphanumerischer Wert, Beispiele siehe Abschnitt <<xplanmanager-api-schluessel, eindeutige Schlüssel>>)
+- `{id}` - eindeutiger Schlüssel einer Ressource (alphanumerischer Wert, Beispiele siehe Abschnitt <<xplanmanager-api-schluessel,eindeutige Schlüssel>>)
Die REST-API des XPlanManager stellt folgende Ressourcen bereit:
-[width="100%",cols="25%,15%,60%",options="header"]
+[width="100%",cols="30%,10%,60%",options="header"]
|===
|Ressource |HTTP Methode |Beschreibung
|`/` |`GET` |Beschreibung der Schnittstelle als OpenAPI 3.0 Dokument
@@ -40,13 +40,18 @@ Die REST-API des XPlanManager stellt folgende Ressourcen bereit:
|`/plan/{planId}/rasterbasis/{id}` |`GET` |Abfrage einer Rasterbasisdatei zu einem Plan
|`/plan/{planId}/rasterbasis/{id}` |`PUT` |Hinzufügen/ersetzen einer Rasterbasisdatei zu einem Plan
|`/plan/{planId}/rasterbasis/{id}` |`DELETE` |Entfernen einer Rasterbasisdatei zu einem Plan
+|`/status/{uuid}` |`GET` |Abruf des Fortschritts für eine Validierungsanfrage
+|`/report/{uuid}` |`GET` |Abruf eines Validierungsberichts
+|`/report/{uuid}/geomfindings` |`GET` |Abruf von geometrischen Fehlern zu einem Validierungsbericht im Format GeoJSON
|===
Neben dem Datenformat JSON unterstützt die REST-API auch andere Inhaltstypen, die das Datenformat JSON (Inhaltstyp `application/json`) genauer beschreiben. Im Rahmen der Inhaltsvereinbarung zwischen Client und Server über das HTTP-Header-Feld `Accept` können auch die Inhaltstypen (media types) `application/vnd.xplanbox.api+json`, `application/vnd.xplanbox.api.v1+json` und `application/vnd.xplanbox.api.v2+json` angefragt werden. Einzelne Ressourcen wie z.B. `POST /plan` unterstützen diese anwendungsspezifischen Datentypen.
Eine vollständige Beschreibung der HTTP Status-Codes und der unterstützten Inhaltstypen (media types) und Formate (Encodings) für die jeweiligen Ressourcen sind in der OpenAPI-Schnittstellenbeschreibung enthalten.
-NOTE: Die URL für die REST-API des XPlanManager setzt sich wie folgt zusammen: http://<host>:<port>/xplan-manager-api/xmanager/api/v1/. Die URL für die xPlanBox-Demo lautet https://xplanbox.lat-lon.de/xmanager/api/v1/.
+NOTE: Die URL für die REST-API des XPlanManager setzt sich wie folgt zusammen: http://<host>:<port>/xplan-manager-api/api/v2/. Die URL für die xPlanBox-Demo lautet https://xplanbox.lat-lon.de/xplan-manager-api/api/v2/.
+
+IMPORTANT: Die REST-API v1 ist veraltet und wird in zukünftigen Versionen der xPlanBox entfernt! Stellen Sie Clients auf die neue REST-API v2 um!
[[xplanmanager-api-schluessel]]
==== Eindeutige Schlüssel für den Zugriff auf REST-Ressourcen
diff --git a/xplan-documentation/xplan-benutzerhandbuch/src/main/asciidoc/XPlanValidator_API.adoc b/xplan-documentation/xplan-benutzerhandbuch/src/main/asciidoc/XPlanValidator_API.adoc
index a02efe3ba..8dbc498ed 100644
--- a/xplan-documentation/xplan-benutzerhandbuch/src/main/asciidoc/XPlanValidator_API.adoc
+++ b/xplan-documentation/xplan-benutzerhandbuch/src/main/asciidoc/XPlanValidator_API.adoc
@@ -4,14 +4,19 @@
Die REST-API des XPlanValidator ermöglicht es, die Funktionen des XPlanValidator über eine Web-API aufzurufen.
Die REST-API des XPlanValidator stellt folgende Ressourcen bereit:
-[width="100%",cols="20%,20%,60%",options="header"]
+[width="100%",cols="30%,20%,50%",options="header"]
|===
|Ressource |HTTP Methode |Beschreibung
|`/` |`GET` |Beschreibung der Schnittstelle als OpenAPI 3.0 Dokument
-|`/validate` |`POST` |Validieren eines XPlanGML-Dokuments oder XPlanArchivs
|`/info` |`GET` |Informationen zur Software und Konfiguration
+|`/validate` |`POST` |Validieren eines XPlanGML-Dokuments oder XPlanArchivs
+|`/status/{uuid}` |`GET` |Abruf des Fortschritts für eine Validierungsanfrage
+|`/report/{uuid}` |`GET` |Abruf eines Validierungsberichts
+|`/report/{uuid}/geomfindings` |`GET` |Abruf von geometrischen Fehlern zu einem Validierungsbericht im Format GeoJSON
|===
-Eine vollständige Beschreibung der HTTP Status-Codes und der unterstützten Formate (Encodings) für die jeweiligen Ressourcen sind in der OpenAPI Schnittstellenbeschreibung enthalten.
+Eine vollständige Beschreibung der HTTP Status-Codes und der unterstützten Formate (Encodings) für die jeweiligen Ressourcen sind in der OpenAPI-Schnittstellenbeschreibung enthalten.
+
+NOTE: Die URL für die REST-API des XPlanValidator setzt sich wie folgt zusammen http://<host>:<port>/xplan-validator-api/api/v2/. Die URL für die xPlanBox-Demo lautet z. B. https://xplanbox.lat-lon.de/xplan-validator-api/api/v2/.
-NOTE: Die URL für die REST-API des XPlanValidator setzt sich wie folgt zusammen http://<host>:<port>/xplan-validator-api/xvalidator/api/v1/. Die URL für die xPlanBox-Demo lautet https://xplanbox.lat-lon.de/xvalidator/api/v1/.
\ No newline at end of file
+IMPORTANT: Die REST-API v1 ist veraltet und wird in zukünftigen Versionen der xPlanBox entfernt! Stellen Sie Clients auf die neue REST-API v2 um!
\ No newline at end of file
diff --git a/xplan-documentation/xplan-benutzerhandbuch/src/main/asciidoc/bekannteProbleme.adoc b/xplan-documentation/xplan-benutzerhandbuch/src/main/asciidoc/bekannteProbleme.adoc
index 81a9b1440..a948a9d00 100644
--- a/xplan-documentation/xplan-benutzerhandbuch/src/main/asciidoc/bekannteProbleme.adoc
+++ b/xplan-documentation/xplan-benutzerhandbuch/src/main/asciidoc/bekannteProbleme.adoc
@@ -21,7 +21,7 @@ IMPORTANT: Die Unterstützung von Microsoft Internet Explorer 9/10/11 ist mit Ve
Die Ausgabe der Zeilennummer bei semantischen Validierungsfehlern, kann je nach Formatierung des XML-Dokuments von der Zeile des verursachenden Elements abweichen.
Gute und exakte Ergebnisse bei der Ausgabe der Zeilennummer des Elements lassen sich dann erzielen, wenn das XML-Dokument ohne Formatierung der Attribute erfolgt, insbesondere der Deklaration der Namensräume im Wurzelelement. Die Zeilen werden entsprechend der https://www.w3.org/TR/REC-xml/#sec-line-ends[XML-Spezifikation] gezählt und stellen nur eine Annäherung an die Zeilennummer der Dokumententität oder der externen geparsten Entität dar, in der das Element erscheint, das das Ereignis auslöst.
-==== XPlanWMS - Mit Kartenvorschau im XPlanManagerWeb generierter GetMap-Request
+==== XPlanManagerWeb - Fehler bei Aufruf von generiertem GetMap-Request in Kartenvorschau
Der durch den Button "Plan im neuen Fenster öffnen" unterhalb der Kartenvorschau im XPlanManagerWeb generierte WMS GetMap-Request gibt im Fall, dass noch kein Rasterplan in das System importiert wurde, folgende erwartete Meldung aus:
@@ -78,6 +78,10 @@ Wird ein XPlanArchiv mit Begleitdokumenten oder Rasterdaten importiert und über
Wird beim Import eines Plans mit Rasterdaten die Option "Weiter ohne Rasterdaten" im Dialog "Analyse der Rasterdaten" ausgewählt, kann es in Folge zu Fehlern im XPlanMapServer und XPlanMapProxy kommen.
+==== XPlanManagerWeb - Ãœberspringen des Imports von Rasterdaten
+
+Wenn ein Plan mit Rasterdaten über den XPlanManagerWeb mit aktivierter Übernahme der Rasterdaten importiert wird, werden die Rasterdaten übernommen und in der Kartenvorschau angezeigt. Wird der Plan erneut importiert, aber mit aktivierter Option "ohne Rasterdaten importieren", führt dies dazu, dass die Rasterdaten auch bei dem zuvor importierten Plan nicht mehr in der Kartenvorschau angezeigt werden.
+
==== XPlanDokumenteAPI - Abruf des World-Files bei GeoTIFF nicht möglich
Bei Import eines Plans mit einer im XPlanGML referenzierten GeoTIFF-Datei als Rasterbasis und zusätzlich auch noch einem referenzierten World-File (tfw-Datei), dann ist die tfw-Datei nicht über die XPlanDokumenteAPI abfragbar. Wird die im exportierten XPlanGML angegebene URL aufgerufen, kann die tfw-Datei nicht abgerufen werden und ein HTTP-Statusfehler "404 - Not Found" wird von der XPlanDokumenteAPI zurückgegeben.
@@ -152,6 +156,3 @@ Derzeit werden die folgenden Attribute bei der Visualisierung berücksichtigt:
* XP_PPO
** Darstellung erfolgt als Kreis mit grauem Umring
** position
-
-
-
--
GitLab