added deprecation to old endpoint

update docu and release notes
Bug 5410
This commit is contained in:
Georg Herdt committed 2020-11-23 09:56:10 +01:00
1 parent 8428ea160b
commit 5a648abd52
3 files changed
+48 -2

No files matched your search

@@ -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) {
@@ -12,7 +12,8 @@
<h2>URL: /api/v1/trackedRaces/getRaces</h2>
<b>Description:</b>
<p>Gets all TrackedRaces found on the local instance, and optionally (depending on the "transitive" parameter) its remote servers.
<p>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.</p>
<p>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.
<td><a href="http://www.sapsailing.com/sailingserver/api/v1/trackedRaces/getRaces">http://www.sapsailing.com/sailingserver/api/v1/trackedRaces/getRaces</a></td>
</tr>
</table>
<br/>
<p>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).</p>
<table>
<tr>
<td>Webservice Type:</td>
<td>REST</td>
</tr>
<tr>
<td>Output format:</td>
<td>Json</td>
</tr>
<tr>
<td>Mandatory parameters:</td>
<td>None</td>
</tr>
<tr>
<td>Request Content-Type:</td>
<td>application/x-www-form-urlencoded</td>
</tr>
<tr>
<td>Optional body parameters:</td>
<td>
<div>
<ul>
<li>transitive (true or false) - determines whether the races
from other servers referenced remotely shall be collected in the
response</li>
<li>events: comma separated list of UUIDs depicting an event</li>
<li>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.</li>
</ul>
</div>
</td>
</tr>
<tr>
<td>Request method:</td>
<td>POST</td>
</tr>
<tr>
<td>Example:</td>
<td><a href="http://www.sapsailing.com/sailingserver/api/v1/trackedRaces/getRaces">http://www.sapsailing.com/sailingserver/api/v1/trackedRaces/getRaces</a></td>
</tr>
</table>
<div style="height: 1em;"></div>
<a href="index.html">Back to Web Service Overview</a>
</body>
@@ -26,7 +26,8 @@
<h2 class="articleSubheadline">November 2020</h2>
<ul class="bulletList">
<li>REST endpoint /api/v1/trackedRaces/getRaces to retrieve list of races that are available on the requested server
has been extended to filter returned list of races by given events. A inclusive/exclusive logic is available.</li>
has been extended to filter returned list of races by given events. A inclusive/exclusive logic is available.
Using HTTP is deprecated for this interface from now. Use HTTP POST instead.</li>
</ul>
<h2 class="articleSubheadline">October 2020</h2>
<ul class="bulletList">