From 5a648abd528df21cb87c40f2ea5bc682000f73e9 Mon Sep 17 00:00:00 2001 From: Georg Herdt Date: Mon, 23 Nov 2020 09:56:10 +0100 Subject: [PATCH] added deprecation to old endpoint update docu and release notes Bug 5410 --- .../jaxrs/api/TrackedRaceListResource.java | 1 + .../webservices/api/v1/getRacesGetDoc.html | 46 ++++++++++++++++++- .../release_notes_admin.html | 3 +- 3 files changed, 48 insertions(+), 2 deletions(-) diff --git a/java/com.sap.sailing.server.gateway/src/com/sap/sailing/server/gateway/jaxrs/api/TrackedRaceListResource.java b/java/com.sap.sailing.server.gateway/src/com/sap/sailing/server/gateway/jaxrs/api/TrackedRaceListResource.java index a23568bfd8f..b48aa6af701 100644 --- a/java/com.sap.sailing.server.gateway/src/com/sap/sailing/server/gateway/jaxrs/api/TrackedRaceListResource.java +++ b/java/com.sap.sailing.server.gateway/src/com/sap/sailing/server/gateway/jaxrs/api/TrackedRaceListResource.java @@ -95,6 +95,7 @@ public class TrackedRaceListResource extends AbstractSailingServerResource { @GET @Produces(CONTENT_TYPE_JSON_UTF8) @Path("getRaces") + @Deprecated public Response raceList(@QueryParam("transitive") @DefaultValue("false") Boolean transitive, @QueryParam("events") @DefaultValue("") String strEvents, @QueryParam("pred") @DefaultValue("excl") String predicate) { diff --git a/java/com.sap.sailing.server.gateway/webservices/api/v1/getRacesGetDoc.html b/java/com.sap.sailing.server.gateway/webservices/api/v1/getRacesGetDoc.html index 8875794c21b..2f6ccd1f692 100644 --- a/java/com.sap.sailing.server.gateway/webservices/api/v1/getRacesGetDoc.html +++ b/java/com.sap.sailing.server.gateway/webservices/api/v1/getRacesGetDoc.html @@ -12,7 +12,8 @@

URL: /api/v1/trackedRaces/getRaces

Description: -

Gets all TrackedRaces found on the local instance, and optionally (depending on the "transitive" parameter) its remote servers. +

Please note: calling this interface using HTTP GET is deprecated. Use HTTP POST instead. +Gets all TrackedRaces found on the local instance, and optionally (depending on the "transitive" parameter) its remote servers. Only those TrackedRaces are contained that are reachable by any Event and have GPS data and a valid startOfRace.

Optionally a list of event UUIDs together with a predicate can be provided. The returned races list will be filtered by the given ids. The predicate specifies the behavior of the filter. @@ -56,6 +57,49 @@ given ids. The predicate specifies the behavior of the filter. http://www.sapsailing.com/sailingserver/api/v1/trackedRaces/getRaces +
+

Alternatively the interface can be called using http POST method. The parameters must be then provided within the request body as URL encoded form parameters (see https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST).

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Webservice Type:REST
Output format:Json
Mandatory parameters:None
Request Content-Type:application/x-www-form-urlencoded
Optional body parameters: +
+
    +
  • transitive (true or false) - determines whether the races + from other servers referenced remotely shall be collected in the + response
    • +
  • events: comma separated list of UUIDs depicting an event
    • +
  • pred: depicts the semantic of the filtering, when "incl" only races belonging to the depicted event UUIDs are + returned. When "excl" is provided the filtering behaves vice versa.
    • +
+
+
Request method:POST
Example:http://www.sapsailing.com/sailingserver/api/v1/trackedRaces/getRaces
Back to Web Service Overview diff --git a/java/com.sap.sailing.www/release_notes_admin.html b/java/com.sap.sailing.www/release_notes_admin.html index 72a07c5f46a..844b84b7631 100755 --- a/java/com.sap.sailing.www/release_notes_admin.html +++ b/java/com.sap.sailing.www/release_notes_admin.html @@ -26,7 +26,8 @@

November 2020

October 2020