Merge pull request #3 from indexdata/CIRCSTORE-452

Circstore 452
indexdata · Oct 3, 2023 · 8c306de · 8c306de
2 parents e7fde38 + f2ea5fe
commit 8c306de
Show file tree

Hide file tree

Showing 14 changed files with 68 additions and 26 deletions.
diff --git a/descriptors/ModuleDescriptor-template.json b/descriptors/ModuleDescriptor-template.json
@@ -403,7 +403,7 @@
     },
     {
       "id": "scheduled-notice-storage",
-      "version": "0.5",
+      "version": "0.6",
       "handlers": [
         {
           "methods": ["GET"],

diff --git a/ramls/anonymize-storage-loans-response.json b/ramls/anonymize-storage-loans-response.json
@@ -11,7 +11,7 @@
       }
     },
     "notAnonymizedLoans": {
-      "description": "tbd",
+      "description": "Not anonymized loan IDs",
       "type": "array",
       "items": {
         "description": "Collection of loans",

diff --git a/ramls/cancellation-reason.json b/ramls/cancellation-reason.json
@@ -1,25 +1,25 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
-  "description": "tbd",
+  "description": "Request cancellation reason",
   "type": "object",
   "properties": {
     "id": {
       "type": "string"
     },
     "name": {
-      "description": "tbd",
+      "description": "Reason name",
       "type": "string"
     },
     "description" : {
-      "description": "tbd",
+      "description": "Internal reason description",
       "type": "string"
     },
     "publicDescription": {
-      "description": "tbd",
+      "description": "Public reason description",
       "type": "string"
     },
     "requiresAdditionalInformation": {
-      "description": "tbd",
+      "description": "Flag that indicates whether reason requires additional information",
       "type": "boolean"
     },
     "source": {

diff --git a/ramls/fixed-due-date-schedule.json b/ramls/fixed-due-date-schedule.json
@@ -9,16 +9,17 @@
       "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
     },
     "name": {
-      "description": "tbd",
+      "description": "Schedule name",
       "type": "string"
     },
     "description": {
-      "description": "tbd",
+      "description": "Schedule description",
       "type": "string"
     },
     "schedules": {
       "description": "tbd",
       "id": "schedules",
+      "description": "List date ranges with a due date for each",
       "type": "array",
       "items": {
         "type": "object",

diff --git a/ramls/kv-configuration.json b/ramls/kv-configuration.json
@@ -2,41 +2,42 @@
   "$schema": "http://json-schema.org/draft-04/schema#",
   "description": "tbd",
   "type": "object",
+  "description": "Configuration entry",
   "properties": {
     "id": {
       "type": "string",
       "$ref": "raml-util/schemas/uuid.schema"
     },
     "module": {
-      "description": "tbd",
+      "description": "Name of a FOLIO module",
       "type": "string"
     },
     "configName": {
-      "description": "tbd",
+      "description": "Configuration name",
       "type": "string"
     },
     "code": {
-      "description": "tbd",
+      "description": "Configuration code",
       "type": "string"
     },
     "description": {
-      "description": "tbd",
+      "description": "Configuration description",
       "type": "string"
     },
     "default": {
-      "description": "tbd",
+      "description": "Flag that indicates whether this is the default configuration",
       "type": "boolean"
     },
     "enabled": {
-      "description": "tbd",
+      "description": "Flag that indicates whether this configuration is enabled",
       "type": "boolean"
     },
     "value": {
-      "description": "tbd",
+      "description": "Configuration value",
       "type": "string"
     },
     "userId": {
-      "description": "tbd",
+      "description": "User ID",
       "type": "string"
     },
     "metadata": {

diff --git a/ramls/kv-configurations.json b/ramls/kv-configurations.json
@@ -2,10 +2,12 @@
   "$schema": "http://json-schema.org/draft-04/schema#",
   "description": "tbd",
   "type": "object",
+  "description": "Collection of configuration entries",
   "properties": {
     "configs": {
       "description": "tbd",
       "id": "configurationData",
+      "description": "An array of configuration entries",
       "type": "array",
       "items": {
         "type": "object",

diff --git a/ramls/loan-policy.json b/ramls/loan-policy.json
@@ -15,12 +15,13 @@
       "type": "string"
     },
     "loanable": {
-      "description": "tbd",
+      "description": "Flag that indicates whether this policy allows loans",
       "type": "boolean"
     },
     "loansPolicy": {
       "description": "tbd",
       "type": "object",
+      "description": "Settings for loans",
       "additionalProperties": false,
       "properties": {
         "profileId": {
@@ -66,6 +67,7 @@
     "renewalsPolicy": {
       "description": "tbd",
       "type": "object",
+      "description": "Settings for renewals",
       "properties": {
         "unlimited": {
           "type": "boolean",
@@ -97,11 +99,13 @@
     "requestManagement": {
       "description": "tbd",
       "type": "object",
+      "description": "Settings for various request types",
       "additionalProperties": false,
       "properties": {
         "recalls": {
           "description": "tbd",
           "type": "object",
+          "description": "Settings for recall requests",
           "additionalProperties": false,
           "properties": {
             "alternateGracePeriod": {
@@ -134,6 +138,7 @@
         "holds": {
           "description": "tbd",
           "type": "object",
+          "description": "Settings for hold requests",
           "additionalProperties": false,
           "properties": {
             "alternateCheckoutLoanPeriod": {
@@ -155,6 +160,7 @@
         "pages": {
           "description": "tbd",
           "type": "object",
+          "description": "Settings for page requests",
           "additionalProperties": false,
           "properties": {
             "alternateCheckoutLoanPeriod": {

diff --git a/ramls/patron-notice-policy.json b/ramls/patron-notice-policy.json
@@ -68,6 +68,7 @@
           "sendOptions": {
             "description": "tbd",
             "type": "object",
+            "description": "Notice sending options",
             "additionalProperties": false,
             "properties": {
               "sendHow": {
@@ -95,11 +96,13 @@
               "sendBy": {
                 "description": "tbd",
                 "type": "object",
+                "description": "Delay before the first attempt to send a notice",
                 "$ref": "interval.json"
               },
               "sendEvery": {
                 "description": "tbd",
                 "type": "object",
+                "description": "Interval between attempts to send a recurring notice",
                 "$ref": "interval.json"
               }
             },
@@ -158,6 +161,7 @@
           "sendOptions": {
             "description": "tbd",
             "type": "object",
+            "description": "Notice sending options",
             "additionalProperties": false,
             "properties": {
               "sendHow": {
@@ -182,11 +186,13 @@
               "sendBy": {
                 "description": "tbd",
                 "type": "object",
+                "description": "Delay before the first attempt to send a notice",
                 "$ref": "interval.json"
               },
               "sendEvery": {
                 "description": "tbd",
                 "type": "object",
+                "description": "Interval between attempts to send a recurring notice",
                 "$ref": "interval.json"
               }
             },
@@ -245,6 +251,7 @@
           "sendOptions": {
             "description": "tbd",
             "type": "object",
+            "description": "Notice sending options",
             "additionalProperties": false,
             "properties": {
               "sendHow": {
@@ -272,11 +279,13 @@
               "sendBy": {
                 "description": "tbd",
                 "type": "object",
+                "description": "Delay before the first attempt to send a notice",
                 "$ref": "interval.json"
               },
               "sendEvery": {
                 "description": "tbd",
                 "type": "object",
+                "description": "Interval between attempts to send a recurring notice",
                 "$ref": "interval.json"
               }
             },

diff --git a/ramls/period.json b/ramls/period.json
@@ -2,6 +2,7 @@
   "$schema": "http://json-schema.org/draft-04/schema#",
   "description": "tbd",
   "type": "object",
+  "description": "Time interval defined by its duration",
   "properties": {
     "duration": {
       "type": "integer",

diff --git a/ramls/scheduled-notice-storage.raml b/ramls/scheduled-notice-storage.raml
@@ -1,6 +1,6 @@
 #%RAML 1.0
 title: Scheduled Notice Storage
-version: v0.5
+version: v0.6
 protocols: [ HTTP, HTTPS ]
 baseUri: http://localhost:9130
 

diff --git a/ramls/scheduled-notice.json b/ramls/scheduled-notice.json
@@ -2,6 +2,7 @@
   "$schema": "http://json-schema.org/draft-04/schema#",
   "description": "tbd",
   "type": "object",
+  "description": "Scheduled patron notice",
   "properties": {
     "id": {
       "type": "string",
@@ -58,6 +59,7 @@
     "noticeConfig": {
       "description": "tbd",
       "type": "object",
+      "description": "Scheduled notice configuration",
       "properties": {
         "timing": {
           "type": "string",

diff --git a/ramls/staff-slip.json b/ramls/staff-slip.json
@@ -2,24 +2,25 @@
   "$schema": "http://json-schema.org/draft-04/schema#",
   "description": "tbd",
   "type": "object",
+  "description": "Staff slip",
   "properties": {
     "id": {
       "type": "string"
     },
     "name": {
-      "description": "tbd",
+      "description": "Staff slip name",
       "type": "string"
     },
     "description": {
-      "description": "tbd",
+      "description": "Staff slip description",
       "type": "string"
     },
     "active": {
-      "description": "tbd",
+      "description": "Flag that indicates whether staff slip is active",
       "type": "boolean"
     },
     "template": {
-      "description": "tbd",
+      "description": "Staff slip template",
       "type": "string"
     },
     "metadata": {

diff --git a/src/main/resources/templates/db_scripts/insertEmptyCirculationRulesRecord.sql b/src/main/resources/templates/db_scripts/insertEmptyCirculationRulesRecord.sql
@@ -1,7 +1,20 @@
 -- ensure that there will be one row only
-ALTER TABLE ${myuniversity}_${mymodule}.${table.tableName}
-  ADD COLUMN IF NOT EXISTS
-    lock boolean DEFAULT true UNIQUE CHECK(lock=true);
+DO $$
+BEGIN
+  -- create constraints only if they do not exist, otherwise they are piling up
+  IF NOT EXISTS (
+    SELECT constraint_name
+    FROM information_schema.constraint_column_usage
+    WHERE table_schema = '${myuniversity}_${mymodule}'
+    AND table_name = '${table.tableName}'
+    AND column_name = 'lock'
+    AND constraint_name LIKE '${table.tableName}_lock_%'
+  ) THEN
+    ALTER TABLE ${myuniversity}_${mymodule}.${table.tableName}
+    -- this will create constraints even when column already exists
+    ADD COLUMN IF NOT EXISTS lock boolean DEFAULT true UNIQUE CHECK(lock=true);
+  END IF;
+END $$;
 INSERT INTO ${myuniversity}_${mymodule}.${table.tableName}
   SELECT id, jsonb_build_object('id', id, 'rulesAsText', '')
   FROM (SELECT md5('${myuniversity}_${mymodule}.${table.tableName}.rulesAsText')::uuid AS id) AS alias

diff --git a/src/main/resources/templates/db_scripts/schema.json b/src/main/resources/templates/db_scripts/schema.json
@@ -122,6 +122,12 @@
           "caseSensitive": false,
           "removeAccents": false,
           "sqlExpression": "(jsonb->'agedToLostDelayedBilling'->>'dateLostItemShouldBeBilled')"
+        },
+        {
+          "fieldName": "action",
+          "tOps": "ADD",
+          "caseSensitive": false,
+          "removeAccents": true
         }
       ],
       "fullTextIndex": [