fix: inconsistent api descriptions and media types

GIScience · Aug 15, 2023 · 0caacdc · 0caacdc
1 parent 67cb961
commit 0caacdc
Showing 1 changed file with 8 additions and 5 deletions.
diff --git a/ors-api/src/main/java/org/heigit/ors/api/controllers/SnappingAPI.java b/ors-api/src/main/java/org/heigit/ors/api/controllers/SnappingAPI.java
@@ -83,16 +83,16 @@ public void getInvalidResponseType() throws StatusCodeException {
     @PostMapping(value = "/{profile}")
     @Operation(
             description = """
-                    Returns a list of points snapped to the nearest edge in the graph. \
-                    This method does not accept any request body or parameters other than profile, locations, maximum_snapping_radius.\
+                    Returns a list of points snapped to the nearest edge in the graph. In case an appropriate
+                    snapping point cannot be found within the specified search radius, "null" is returned.
                     """,
             summary = "Snapping Service"
     )
     @ApiResponse(
             responseCode = "200",
             description = "Standard response for successfully processed requests. Returns JSON.",
             content = {@Content(
-                    mediaType = "application/geo+json",
+                    mediaType = "application/json",
                     schema = @Schema(implementation = JsonSnappingResponse.class)
             )
             })
@@ -103,14 +103,17 @@ public JsonSnappingResponse getDefault(@Parameter(description = "Specifies the r
 
     @PostMapping(value = "/{profile}/json", produces = {"application/json;charset=UTF-8"})
     @Operation(
-            description = "Returns a list of points snapped to the nearest edge in the graph.",
+            description = """
+                    Returns a list of points snapped to the nearest edge in the graph. In case an appropriate
+                    snapping point cannot be found within the specified search radius, \"null\" is returned.
+                    """,
             summary = "Snapping Service JSON"
     )
     @ApiResponse(
             responseCode = "200",
             description = "JSON Response.",
             content = {@Content(
-                    mediaType = "application/geo+json",
+                    mediaType = "application/json",
                     schema = @Schema(implementation = JsonSnappingResponse.class)
             )
             })