From edf819c301118c0291008519b24025421a0e607e Mon Sep 17 00:00:00 2001 From: Luca Frosini Date: Wed, 10 Apr 2024 18:29:41 +0200 Subject: [PATCH] Fixing documentation --- .../org/gcube/grsf/publisher/rest/FisheryRESTAPIs.java | 10 +++++----- .../org/gcube/grsf/publisher/rest/StockRESTAPIs.java | 10 +++++----- .../grsf/publisher/rest/TraceabilityUnitRESTAPIs.java | 10 +++++----- 3 files changed, 15 insertions(+), 15 deletions(-) diff --git a/src/main/java/org/gcube/grsf/publisher/rest/FisheryRESTAPIs.java b/src/main/java/org/gcube/grsf/publisher/rest/FisheryRESTAPIs.java index dffeb0c..81d1918 100644 --- a/src/main/java/org/gcube/grsf/publisher/rest/FisheryRESTAPIs.java +++ b/src/main/java/org/gcube/grsf/publisher/rest/FisheryRESTAPIs.java @@ -201,7 +201,7 @@ public class FisheryRESTAPIs extends BaseRESTAPIs { /** * This API allows to read a fishery record - * @param the GRSF UUID of the fishery record to read + * @param id the GRSF UUID of the fishery record to read * @pathExample /fishery/d0145931-58d3-4561-bf64-363b61df016b * @responseExample application/json;charset=UTF-8 classpath:/api-docs-examples/fishery/read-fishery-response.json */ @@ -218,7 +218,7 @@ public class FisheryRESTAPIs extends BaseRESTAPIs { /** * This API allows to update a fishery record - * @param the GRSF UUID of the fishery record to update + * @param id the GRSF UUID of the fishery record to update * @pathExample /fishery/d0145931-58d3-4561-bf64-363b61df016b * @requestExample application/json;charset=UTF-8 classpath:/api-docs-examples/fishery/create-fishery-request.json * @responseExample application/json;charset=UTF-8 classpath:/api-docs-examples/fishery/create-fishery-response.json @@ -242,7 +242,7 @@ public class FisheryRESTAPIs extends BaseRESTAPIs { * adds tags or groups to the records. * The API does not guarantee that the record is removed from an * old group/tag associated due to the old property value. - * @param the GRSF UUID of the fishery record to patch + * @param id the GRSF UUID of the fishery record to patch * @pathExample /fishery/d0145931-58d3-4561-bf64-363b61df016b */ @PATCH @@ -263,7 +263,7 @@ public class FisheryRESTAPIs extends BaseRESTAPIs { * In case of delete, the fishery record is no longer visible, * but it still exists and can be restored. * In case of purge, the record is completely deleted and cannot be restored. - * @param the GRSF UUID of the fishery record to delete/purge + * @param id the GRSF UUID of the fishery record to delete/purge * @pathExample /fishery/d0145931-58d3-4561-bf64-363b61df016b?purge=true */ @DELETE @@ -281,7 +281,7 @@ public class FisheryRESTAPIs extends BaseRESTAPIs { /** * This API allows to purge a fishery record. * The record cannot be restored. - * @param the GRSF UUID of the fishery record to purge + * @param id the GRSF UUID of the fishery record to purge * @pathExample /fishery/d0145931-58d3-4561-bf64-363b61df016b */ @PURGE diff --git a/src/main/java/org/gcube/grsf/publisher/rest/StockRESTAPIs.java b/src/main/java/org/gcube/grsf/publisher/rest/StockRESTAPIs.java index 29a3953..97b1c8e 100644 --- a/src/main/java/org/gcube/grsf/publisher/rest/StockRESTAPIs.java +++ b/src/main/java/org/gcube/grsf/publisher/rest/StockRESTAPIs.java @@ -200,7 +200,7 @@ public class StockRESTAPIs extends BaseRESTAPIs { /** * This API allows to read a stock record - * @param the GRSF UUID of the stock record to read + * @param id the GRSF UUID of the stock record to read * @pathExample /stock/23fd6734-b7cd-37eb-8b43-03b1495dd7af * @responseExample application/json;charset=UTF-8 classpath:/api-docs-examples/stock/read-stock-response.json */ @@ -217,7 +217,7 @@ public class StockRESTAPIs extends BaseRESTAPIs { /** * This API allows to update a stock record - * @param the GRSF UUID of the stock record to update + * @param id the GRSF UUID of the stock record to update * @pathExample /stock/23fd6734-b7cd-37eb-8b43-03b1495dd7af * @requestExample application/json;charset=UTF-8 classpath:/api-docs-examples/fishery/create-fishery-request.json * @responseExample application/json;charset=UTF-8 classpath:/api-docs-examples/fishery/create-fishery-response.json @@ -241,7 +241,7 @@ public class StockRESTAPIs extends BaseRESTAPIs { * adds tags or groups to the records. * The API does not guarantee that the record is removed from an * old group/tag associated due to the old property value. - * @param the GRSF UUID of the stock record to patch + * @param id the GRSF UUID of the stock record to patch * @pathExample /stock/23fd6734-b7cd-37eb-8b43-03b1495dd7af */ @PATCH @@ -262,7 +262,7 @@ public class StockRESTAPIs extends BaseRESTAPIs { * In case of delete, the stock record is no longer visible, * but it still exists and can be restored. * In case of purge, the record is completely deleted and cannot be restored. - * @param the GRSF UUID of the stock record to delete/purge + * @param id the GRSF UUID of the stock record to delete/purge * @pathExample /stock/23fd6734-b7cd-37eb-8b43-03b1495dd7af */ @DELETE @@ -280,7 +280,7 @@ public class StockRESTAPIs extends BaseRESTAPIs { /** * This API allows to purge a stock record. * The record cannot be restored. - * @param the GRSF UUID of the stock record to purge + * @param id the GRSF UUID of the stock record to purge * @pathExample /stock/23fd6734-b7cd-37eb-8b43-03b1495dd7af */ @PURGE diff --git a/src/main/java/org/gcube/grsf/publisher/rest/TraceabilityUnitRESTAPIs.java b/src/main/java/org/gcube/grsf/publisher/rest/TraceabilityUnitRESTAPIs.java index 919c780..b1a7e36 100644 --- a/src/main/java/org/gcube/grsf/publisher/rest/TraceabilityUnitRESTAPIs.java +++ b/src/main/java/org/gcube/grsf/publisher/rest/TraceabilityUnitRESTAPIs.java @@ -200,7 +200,7 @@ public class TraceabilityUnitRESTAPIs extends BaseRESTAPIs