MODINVSTOR-1342: Add "deleted" field to Instance schema (#1146)

folio-org · Feb 12, 2025 · 8225f3e · 8225f3e
1 parent 8aac814
commit 8225f3e
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 3 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -3,11 +3,11 @@
 * Description ([ISSUE](https://folio-org.atlassian.net/browse/ISSUE))
 
 ### New APIs versions
-* Provides `API_NAME vX.Y`
+* Provides `instance-storage v11.1`
 * Requires `API_NAME vX.Y`
 
 ### Features
-* update rollback mechanism for instances when linking/unlinking with subjects is failed. ([MODINVSTOR-1299](https://folio-org.atlassian.net/browse/MODINVSTOR-1299))
+* Update rollback mechanism for instances when linking/unlinking with subjects is failed. ([MODINVSTOR-1299](https://folio-org.atlassian.net/browse/MODINVSTOR-1299))
 * Unable to delete local Subject types/sources when they are linked to an Instance ([MODINVSTOR-1284](https://folio-org.atlassian.net/browse/MODINVSTOR-1284))
 * Modify endpoint for bulk instances upsert with publish events flag ([MODINVSTOR-1283](https://folio-org.atlassian.net/browse/MODINVSTOR-1283))
 * Change Kafka event publishing keys for holdings and items ([MODINVSTOR-1281](https://folio-org.atlassian.net/browse/MODINVSTOR-1281))
@@ -19,6 +19,7 @@
 * Extend domain events with eventId and eventTs ([MODINVSTOR-1322](https://folio-org.atlassian.net/browse/MODINVSTOR-1322))
 * Revert the publication period migration changes ([MODINVSTOR-1280](https://folio-org.atlassian.net/browse/MODINVSTOR-1280))
 * Optimize check for existing shadow Instance before creating it ([MODINVSTOR-1354](https://folio-org.atlassian.net/browse/MODINVSTOR-1354))
+* Add "deleted" field to Instance schema ([MODINVSTOR-1342](https://folio-org.atlassian.net/browse/MODINVSTOR-1342))
 
 ### Bug fixes
 * Add item barcode right truncation search index ([MODINVSTOR-1292](https://folio-org.atlassian.net/browse/MODINVSTOR-1292))

diff --git a/descriptors/ModuleDescriptor-template.json b/descriptors/ModuleDescriptor-template.json
@@ -167,7 +167,7 @@
     },
     {
       "id": "instance-storage",
-      "version": "11.0",
+      "version": "11.1",
       "handlers": [
         {
           "methods": ["GET"],

diff --git a/ramls/instance.json b/ramls/instance.json
@@ -439,6 +439,11 @@
       "description": "Records the fact that the record should not be displayed in a discovery system",
       "default": false
     },
+    "deleted": {
+      "type": "boolean",
+      "description": "Indicates whether the record was marked for deletion",
+      "default": false
+    },
     "statisticalCodeIds": {
       "type": "array",
       "description": "List of statistical code IDs",

diff --git a/src/main/java/org/folio/rest/support/InstanceBulkProcessingUtil.java b/src/main/java/org/folio/rest/support/InstanceBulkProcessingUtil.java
@@ -42,6 +42,7 @@ public static Instance mapBulkInstanceRecordToInstance(JsonObject extendedInstan
   public static void copyNonMarcControlledFields(Instance targetInstance, Instance sourceInstance) {
     targetInstance.setStaffSuppress(sourceInstance.getStaffSuppress());
     targetInstance.setDiscoverySuppress(sourceInstance.getDiscoverySuppress());
+    targetInstance.setDeleted(sourceInstance.getDeleted());
     targetInstance.setCatalogedDate(sourceInstance.getCatalogedDate());
     targetInstance.setStatusId(sourceInstance.getStatusId());
     targetInstance.setStatusUpdatedDate(sourceInstance.getStatusUpdatedDate());

diff --git a/src/test/java/org/folio/rest/support/InstanceBulkProcessingUtilTest.java b/src/test/java/org/folio/rest/support/InstanceBulkProcessingUtilTest.java
@@ -37,6 +37,7 @@ public void shouldPopulateFieldsNotControlledByMarc() {
     Instance sourceInstance = new Instance()
       .withDiscoverySuppress(Boolean.TRUE)
       .withStaffSuppress(Boolean.TRUE)
+      .withDeleted(Boolean.TRUE)
       .withPreviouslyHeld(Boolean.TRUE)
       .withCatalogedDate("1970-01-01")
       .withStatusId(UUID.randomUUID().toString())
@@ -49,6 +50,7 @@ public void shouldPopulateFieldsNotControlledByMarc() {
 
     assertEquals(sourceInstance.getDiscoverySuppress(), targetInstance.getDiscoverySuppress());
     assertEquals(sourceInstance.getStaffSuppress(), targetInstance.getStaffSuppress());
+    assertEquals(sourceInstance.getDeleted(), targetInstance.getDeleted());
     assertEquals(sourceInstance.getPreviouslyHeld(), targetInstance.getPreviouslyHeld());
     assertEquals(sourceInstance.getCatalogedDate(), targetInstance.getCatalogedDate());
     assertEquals(sourceInstance.getStatusId(), targetInstance.getStatusId());