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

Fixing documentation

This commit is contained in:
Luca Frosini 2024-04-10 18:29:41 +02:00
parent c36b950358
commit edf819c301
3 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -201,7 +201,7 @@ public class FisheryRESTAPIs extends BaseRESTAPIs<FisheryRecord> {
/** /**
* This API allows to read a fishery record * 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 * @pathExample /fishery/d0145931-58d3-4561-bf64-363b61df016b
* @responseExample application/json;charset=UTF-8 classpath:/api-docs-examples/fishery/read-fishery-response.json * @responseExample application/json;charset=UTF-8 classpath:/api-docs-examples/fishery/read-fishery-response.json
*/ */
@ -218,7 +218,7 @@ public class FisheryRESTAPIs extends BaseRESTAPIs<FisheryRecord> {
/** /**
* This API allows to update a fishery record * 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 * @pathExample /fishery/d0145931-58d3-4561-bf64-363b61df016b
* @requestExample application/json;charset=UTF-8 classpath:/api-docs-examples/fishery/create-fishery-request.json * @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 * @responseExample application/json;charset=UTF-8 classpath:/api-docs-examples/fishery/create-fishery-response.json
@ -242,7 +242,7 @@ public class FisheryRESTAPIs extends BaseRESTAPIs<FisheryRecord> {
* adds tags or groups to the records. * adds tags or groups to the records.
* The API does not guarantee that the record is removed from an * The API does not guarantee that the record is removed from an
* old group/tag associated due to the old property value. * 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 * @pathExample /fishery/d0145931-58d3-4561-bf64-363b61df016b
*/ */
@PATCH @PATCH
@ -263,7 +263,7 @@ public class FisheryRESTAPIs extends BaseRESTAPIs<FisheryRecord> {
* In case of delete, the fishery record is no longer visible, * In case of delete, the fishery record is no longer visible,
* but it still exists and can be restored. * but it still exists and can be restored.
* In case of purge, the record is completely deleted and cannot 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 * @pathExample /fishery/d0145931-58d3-4561-bf64-363b61df016b?purge=true
*/ */
@DELETE @DELETE
@ -281,7 +281,7 @@ public class FisheryRESTAPIs extends BaseRESTAPIs<FisheryRecord> {
/** /**
* This API allows to purge a fishery record. * This API allows to purge a fishery record.
* The record cannot be restored. * 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 * @pathExample /fishery/d0145931-58d3-4561-bf64-363b61df016b
*/ */
@PURGE @PURGE

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

@ -200,7 +200,7 @@ public class StockRESTAPIs extends BaseRESTAPIs<StockRecord> {
/** /**
* This API allows to read a stock record * 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 * @pathExample /stock/23fd6734-b7cd-37eb-8b43-03b1495dd7af
* @responseExample application/json;charset=UTF-8 classpath:/api-docs-examples/stock/read-stock-response.json * @responseExample application/json;charset=UTF-8 classpath:/api-docs-examples/stock/read-stock-response.json
*/ */
@ -217,7 +217,7 @@ public class StockRESTAPIs extends BaseRESTAPIs<StockRecord> {
/** /**
* This API allows to update a stock record * 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 * @pathExample /stock/23fd6734-b7cd-37eb-8b43-03b1495dd7af
* @requestExample application/json;charset=UTF-8 classpath:/api-docs-examples/fishery/create-fishery-request.json * @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 * @responseExample application/json;charset=UTF-8 classpath:/api-docs-examples/fishery/create-fishery-response.json
@ -241,7 +241,7 @@ public class StockRESTAPIs extends BaseRESTAPIs<StockRecord> {
* adds tags or groups to the records. * adds tags or groups to the records.
* The API does not guarantee that the record is removed from an * The API does not guarantee that the record is removed from an
* old group/tag associated due to the old property value. * 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 * @pathExample /stock/23fd6734-b7cd-37eb-8b43-03b1495dd7af
*/ */
@PATCH @PATCH
@ -262,7 +262,7 @@ public class StockRESTAPIs extends BaseRESTAPIs<StockRecord> {
* In case of delete, the stock record is no longer visible, * In case of delete, the stock record is no longer visible,
* but it still exists and can be restored. * but it still exists and can be restored.
* In case of purge, the record is completely deleted and cannot 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 * @pathExample /stock/23fd6734-b7cd-37eb-8b43-03b1495dd7af
*/ */
@DELETE @DELETE
@ -280,7 +280,7 @@ public class StockRESTAPIs extends BaseRESTAPIs<StockRecord> {
/** /**
* This API allows to purge a stock record. * This API allows to purge a stock record.
* The record cannot be restored. * 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 * @pathExample /stock/23fd6734-b7cd-37eb-8b43-03b1495dd7af
*/ */
@PURGE @PURGE

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

@ -200,7 +200,7 @@ public class TraceabilityUnitRESTAPIs extends BaseRESTAPIs<TraceabilityUnitRecor
/** /**
* This API allows to read a traceability unit record * This API allows to read a traceability unit record
* @param the GRSF UUID of the traceability unit record to read * @param id the GRSF UUID of the traceability unit record to read
* @pathExample /traceability-unit/00454650-b66c-32f9-ae32-eff038dd1e1d * @pathExample /traceability-unit/00454650-b66c-32f9-ae32-eff038dd1e1d
* @responseExample application/json;charset=UTF-8 classpath:/api-docs-examples/traceability-unit/read-traceability-unit-response.json * @responseExample application/json;charset=UTF-8 classpath:/api-docs-examples/traceability-unit/read-traceability-unit-response.json
*/ */
@ -217,7 +217,7 @@ public class TraceabilityUnitRESTAPIs extends BaseRESTAPIs<TraceabilityUnitRecor
/** /**
* This API allows to update a traceability unit record * This API allows to update a traceability unit record
* @param the GRSF UUID of the traceability unit record to update * @param id the GRSF UUID of the traceability unit record to update
* @pathExample /traceability-unit/00454650-b66c-32f9-ae32-eff038dd1e1d * @pathExample /traceability-unit/00454650-b66c-32f9-ae32-eff038dd1e1d
* @requestExample application/json;charset=UTF-8 classpath:/api-docs-examples/traceability-unit/create-traceability-unit-request.json * @requestExample application/json;charset=UTF-8 classpath:/api-docs-examples/traceability-unit/create-traceability-unit-request.json
* @responseExample application/json;charset=UTF-8 classpath:/api-docs-examples/traceability-unit/create-traceability-unit-response.json * @responseExample application/json;charset=UTF-8 classpath:/api-docs-examples/traceability-unit/create-traceability-unit-response.json
@ -241,7 +241,7 @@ public class TraceabilityUnitRESTAPIs extends BaseRESTAPIs<TraceabilityUnitRecor
* adds tags or groups to the records. * adds tags or groups to the records.
* The API does not guarantee that the record is removed from an * The API does not guarantee that the record is removed from an
* old group/tag associated due to the old property value. * old group/tag associated due to the old property value.
* @param the GRSF UUID of the traceability unit record to patch * @param id the GRSF UUID of the traceability unit record to patch
* @pathExample /traceability-unit/00454650-b66c-32f9-ae32-eff038dd1e1d * @pathExample /traceability-unit/00454650-b66c-32f9-ae32-eff038dd1e1d
*/ */
@PATCH @PATCH
@ -262,7 +262,7 @@ public class TraceabilityUnitRESTAPIs extends BaseRESTAPIs<TraceabilityUnitRecor
* In case of delete, the traceability unit record is no longer visible, * In case of delete, the traceability unit record is no longer visible,
* but it still exists and can be restored. * but it still exists and can be restored.
* In case of purge, the record is completely deleted and cannot be restored. * In case of purge, the record is completely deleted and cannot be restored.
* @param the GRSF UUID of the traceability unit record to delete/purge * @param id the GRSF UUID of the traceability unit record to delete/purge
* @pathExample /traceability-unit/00454650-b66c-32f9-ae32-eff038dd1e1d * @pathExample /traceability-unit/00454650-b66c-32f9-ae32-eff038dd1e1d
*/ */
@DELETE @DELETE
@ -280,7 +280,7 @@ public class TraceabilityUnitRESTAPIs extends BaseRESTAPIs<TraceabilityUnitRecor
/** /**
* This API allows to purge a traceability unit record. * This API allows to purge a traceability unit record.
* The record cannot be restored. * The record cannot be restored.
* @param the GRSF UUID of the traceability unit record to purge * @param id the GRSF UUID of the traceability unit record to purge
* @pathExample /traceability-unit/00454650-b66c-32f9-ae32-eff038dd1e1d * @pathExample /traceability-unit/00454650-b66c-32f9-ae32-eff038dd1e1d
*/ */
@PURGE @PURGE