MODOAIPMH-621:Migrate settings from mod-configuration to mod-settings

mod-configuration-server/src/main/java/org/folio/rest/impl/ConfigAPI.java

@@ -50,6 +50,10 @@ public void getConfigurationsEntries(
     PgUtil.streamGet(CONFIG_TABLE, Config.class, query, offset, limit, facets, "configs", routingContext, okapiHeaders, context);
   }
 
+  /**
+   * @deprecated deprecating this endpoint for the Trillium release.
+   */
+  @Deprecated(since = "Trillium", forRemoval = true)
   @Validate
   @Override
   public void postConfigurationsEntries(String lang, Config entity, RoutingContext routingContext,
@@ -103,6 +107,10 @@ public void getConfigurationsEntriesByEntryId(String entryId, String lang, Map<S
         GetConfigurationsEntriesByEntryIdResponse.class, asyncResultHandler);
   }
 
+  /**
+   * @deprecated deprecating this endpoint for the Trillium release.
+   */
+  @Deprecated(since = "Trillium", forRemoval = true)
   @Validate
   @Override
   public void deleteConfigurationsEntriesByEntryId(String entryId, String lang, Map<String, String>okapiHeaders,
@@ -112,6 +120,10 @@ public void deleteConfigurationsEntriesByEntryId(String entryId, String lang, Ma
         DeleteConfigurationsEntriesByEntryIdResponse.class, asyncResultHandler);
   }
 
+  /**
+   * @deprecated deprecating this endpoint for the Trillium release.
+   */
+  @Deprecated(since = "Trillium", forRemoval = true)
   @Validate
   @Override
   public void putConfigurationsEntriesByEntryId(

ramls/_schemas/audit.schema

@@ -1,21 +1,27 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
+  "description": "Schema for audit log entries capturing changes to key-value configurations",
   "type": "object",
   "properties": {
     "id": {
+      "description": "Unique identifier (UUID) for the audit log entry",
       "type": "string"
     },
     "orig_id": {
+      "description": "Original identifier (UUID) of the configuration entry being audited",
       "type": "string"
     },
     "operation": {
+      "description": "Type of operation performed (e.g., CREATE, UPDATE, DELETE)",
       "type": "string"
     },
     "jsonb": {
+      "description": "Snapshot of the configuration data at the time of the operation",
       "type": "object",
       "properties": {
         "content": {
           "id": "contentData",
+          "description": "Array of key-value configuration objects representing the state at the time of the audit",
           "type": "array",
           "items": {
             "type": "object",
@@ -25,6 +31,7 @@
       }
     },
     "createdDate": {
+      "description": "Timestamp when the audit record was created",
       "type": "string"
     }
   }

ramls/_schemas/audits.schema

@@ -1,16 +1,19 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
+  "description": "Schema for a collection of audit log entries",
   "type": "object",
   "properties": {
     "audits": {
       "id": "auditData",
+      "description": "Array of audit log entry objects",
       "type": "array",
       "items": {
         "type": "object",
         "$ref": "audit.schema"
       }
     },
     "totalRecords": {
+      "description": "Total number of audit log records available",
       "type": "integer"
     }
   },

ramls/_schemas/kv_configuration.schema

@@ -1,36 +1,47 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
+  "description": "Schema for key-value configuration objects used in the system",
   "type": "object",
   "properties": {
     "id": {
+      "description": "Unique identifier (UUID) for the configuration entry",
       "type": "string",
       "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}$"
     },
     "module": {
+      "description": "Module name this configuration belongs to",
       "type": "string"
     },
     "configName": {
+      "description": "Name of the configuration setting","description": "Name of the configuration setting",
       "type": "string"
     },
     "code": {
+      "description": "Optional code for the configuration",
       "type": "string"
     },
     "description": {
+      "description": "Description of the configuration setting",
       "type": "string"
     },
     "default": {
+      "description": "Indicates if this is the default configuration",
       "type": "boolean"
     },
     "enabled": {
+      "description": "Indicates if this configuration is enabled",
       "type": "boolean"
     },
     "value": {
+      "description": "Value of the configuration setting",
       "type": "string"
     },
     "userId": {
+      "description": "Identifier of the user who created or last modified this configuration",
       "type": "string"
     },
     "metadata": {
+      "description": "Metadata about the configuration entry",
       "$ref": "../raml-util/schemas/metadata.schema",
       "readonly": true
     }

ramls/_schemas/kv_configurations.schema

@@ -1,19 +1,23 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
+  "description": "Schema for a collection of key-value configuration objects",
   "type": "object",
   "properties": {
     "configs": {
       "id": "configurationData",
+      "description": "Array of key-value configuration objects",
       "type": "array",
       "items": {
         "type": "object",
         "$ref": "kv_configuration.schema"
       }
     },
     "totalRecords": {
+      "description": "Total number of configuration records available",
       "type": "integer"
     },
     "resultInfo": {
+      "description": "Information about the result set",
       "$ref": "../raml-util/schemas/resultInfo.schema",
       "readonly": true
     }

ramls/_schemas/library.schema

@@ -1,34 +1,45 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
+  "description": "Schema for library data objects",
   "type": "object",
   "properties": {
     "library_data": {
+      "description": "Array of library data objects",
       "type": "array",
       "items": {
+        "description": "Library data object",
         "type": "object",
         "properties": {
           "library_code": {
+            "description": "Short code representing the library",
             "type": "string"
           },
           "full_library_code": {
+            "description": "Full code representing the library",
             "type": "string"
           },
           "resource_sharing": {
+            "description": "Indicates if resource sharing is enabled for the library",
             "type": "boolean"
           },
           "name": {
+            "description": "Name of the library",
             "type": "string"
           },
           "description": {
+            "description": "Description of the library",
             "type": "string"
           },
           "scope": {
+            "description": "Scope information for the library",
             "type": "object",
             "properties": {
               "institution_id": {
+                "description": "Unique identifier for the institution",
                 "type": "string"
               },
               "library_id": {
+                "description": "Unique identifier for the library",
                 "type": "string"
               }
             }

ramls/configuration/config.raml

@@ -49,7 +49,7 @@ resourceTypes:
       is: [validate]
     /{entryId}:
       displayName: Module configurations
-      description: Get, Delete or Update a specific entry
+      description: DEPRECATED. Get, Delete or Update a specific entry
       type:
         collection-item:
           schema: config