[unomi] branch refacto-json-schema updated: UNOMI-568: code review handling comments and suggestions

[jk...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

jkevan pushed a commit to branch refacto-json-schema
in repository https://gitbox.apache.org/repos/asf/unomi.git


The following commit(s) were added to refs/heads/refacto-json-schema by this push:
     new 68ec61bde UNOMI-568: code review handling comments and suggestions
68ec61bde is described below

commit 68ec61bde213ebf6ed0bf3aa4eceea58e810626c
Author: Kevan <ke...@jahia.com>
AuthorDate: Wed May 11 11:18:20 2022 +0200

    UNOMI-568: code review handling comments and suggestions
---
 .../main/java/org/apache/unomi/schema/api/JsonSchemaWrapper.java    | 6 ++++++
 .../src/main/java/org/apache/unomi/schema/api/SchemaService.java    | 2 +-
 2 files changed, 7 insertions(+), 1 deletion(-)

diff --git a/extensions/json-schema/services/src/main/java/org/apache/unomi/schema/api/JsonSchemaWrapper.java b/extensions/json-schema/services/src/main/java/org/apache/unomi/schema/api/JsonSchemaWrapper.java
index 444a306d8..ce123879e 100644
--- a/extensions/json-schema/services/src/main/java/org/apache/unomi/schema/api/JsonSchemaWrapper.java
+++ b/extensions/json-schema/services/src/main/java/org/apache/unomi/schema/api/JsonSchemaWrapper.java
@@ -20,6 +20,12 @@ package org.apache.unomi.schema.api;
 import org.apache.unomi.api.Metadata;
 import org.apache.unomi.api.MetadataItem;
 
+/**
+ * Object which represents a JSON schema, it's a wrapper because it contains some additional info used by the
+ * Service layer of Unomi like the id and the target.
+ * The JSON schema is store as String to avoid transformation during JSON schema resolution in the Unomi SchemaService.
+ * Also, it's extending  MetadataItem so that it can be persisted like that in Unomi storage system.
+ */
 public class JsonSchemaWrapper extends MetadataItem {
     public static final String ITEM_TYPE = "jsonSchema";
 
diff --git a/extensions/json-schema/services/src/main/java/org/apache/unomi/schema/api/SchemaService.java b/extensions/json-schema/services/src/main/java/org/apache/unomi/schema/api/SchemaService.java
index 2692891a0..c479c4015 100644
--- a/extensions/json-schema/services/src/main/java/org/apache/unomi/schema/api/SchemaService.java
+++ b/extensions/json-schema/services/src/main/java/org/apache/unomi/schema/api/SchemaService.java
@@ -91,7 +91,7 @@ public interface SchemaService {
     void loadPredefinedSchema(InputStream schemaStream) throws IOException;
 
     /**
-     * unload a predefined schema into memory
+     * Unload a predefined schema into memory
      *
      * @param schemaStream inputStream of the schema to delete
      * @return true if the schema has been deleted