gCubeSystem
/
grsf-publisher
16
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

improved documentation

This commit is contained in:
Luca Frosini 2024-04-10 18:39:32 +02:00
parent edf819c301
commit 881aabe95f
3 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
src/main/java/org/gcube/grsf/publisher/rest/FisheryRESTAPIs.java
View File

@ -264,6 +264,7 @@ public class FisheryRESTAPIs extends BaseRESTAPIs<FisheryRecord> {
* but it still exists and can be restored.
* In case of purge, the record is completely deleted and cannot be restored.
* @param id the GRSF UUID of the fishery record to delete/purge
* @param purge (default false) a boolean indicating if the fishery record must be deleted or purged (when true)
* @pathExample /fishery/d0145931-58d3-4561-bf64-363b61df016b?purge=true
*/
@DELETE

1
src/main/java/org/gcube/grsf/publisher/rest/StockRESTAPIs.java
View File

@ -263,6 +263,7 @@ public class StockRESTAPIs extends BaseRESTAPIs<StockRecord> {
* but it still exists and can be restored.
* In case of purge, the record is completely deleted and cannot be restored.
* @param id the GRSF UUID of the stock record to delete/purge
* @param purge (default false) a boolean indicating if the stock record must be deleted or purged (when true)
* @pathExample /stock/23fd6734-b7cd-37eb-8b43-03b1495dd7af
*/
@DELETE

1
src/main/java/org/gcube/grsf/publisher/rest/TraceabilityUnitRESTAPIs.java
View File

@ -263,6 +263,7 @@ public class TraceabilityUnitRESTAPIs extends BaseRESTAPIs<TraceabilityUnitRecor
* but it still exists and can be restored.
* In case of purge, the record is completely deleted and cannot be restored.
* @param id the GRSF UUID of the traceability unit record to delete/purge
* @param purge (default false) a boolean indicating if the traceability unit record must be deleted or purged (when true)
* @pathExample /traceability-unit/00454650-b66c-32f9-ae32-eff038dd1e1d
*/
@DELETE