Add datasource description

Signed-off-by: Vamsi Manohar <[email protected]>
vmmusings · Sep 22, 2023 · dc2aeca · dc2aeca
1 parent 086bc74
commit dc2aeca
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 1 deletion.
diff --git a/core/src/main/java/org/opensearch/sql/datasource/model/DataSourceMetadata.java b/core/src/main/java/org/opensearch/sql/datasource/model/DataSourceMetadata.java
@@ -14,6 +14,7 @@
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;
+import javax.xml.crypto.Data;
 import lombok.AllArgsConstructor;
 import lombok.EqualsAndHashCode;
 import lombok.Getter;
@@ -31,6 +32,8 @@ public class DataSourceMetadata {
 
   @JsonProperty private String name;
 
+  @JsonProperty private String description;
+
   @JsonProperty
   @JsonFormat(with = JsonFormat.Feature.ACCEPT_CASE_INSENSITIVE_PROPERTIES)
   private DataSourceType connector;
@@ -39,6 +42,13 @@ public class DataSourceMetadata {
 
   @JsonProperty private Map<String, String> properties;
 
+  public DataSourceMetadata(String name, DataSourceType connector, List<String> allowedRoles, Map<String, String> properties) {
+    this.name = name;
+    this.connector = connector;
+    this.properties = properties;
+    this.allowedRoles = allowedRoles;
+  }
+
   /**
    * Default OpenSearch {@link DataSourceMetadata}. Which is used to register default OpenSearch
    * {@link DataSource} to {@link DataSourceService}.

diff --git a/datasources/src/main/java/org/opensearch/sql/datasources/utils/XContentParserUtils.java b/datasources/src/main/java/org/opensearch/sql/datasources/utils/XContentParserUtils.java
@@ -19,13 +19,15 @@
 import org.opensearch.core.xcontent.NamedXContentRegistry;
 import org.opensearch.core.xcontent.XContentBuilder;
 import org.opensearch.core.xcontent.XContentParser;
+import org.opensearch.identity.IdentityService;
 import org.opensearch.sql.datasource.model.DataSourceMetadata;
 import org.opensearch.sql.datasource.model.DataSourceType;
 
 /** Utitlity class to serialize and deserialize objects in XContent. */
 @UtilityClass
 public class XContentParserUtils {
   public static final String NAME_FIELD = "name";
+  public static final String DESCRIPTION_FIELD = "description";
   public static final String CONNECTOR_FIELD = "connector";
   public static final String PROPERTIES_FIELD = "properties";
   public static final String ALLOWED_ROLES_FIELD = "allowedRoles";
@@ -39,6 +41,7 @@ public class XContentParserUtils {
    */
   public static DataSourceMetadata toDataSourceMetadata(XContentParser parser) throws IOException {
     String name = null;
+    String description = null;
     DataSourceType connector = null;
     List<String> allowedRoles = new ArrayList<>();
     Map<String, String> properties = new HashMap<>();
@@ -50,6 +53,9 @@ public static DataSourceMetadata toDataSourceMetadata(XContentParser parser) thr
         case NAME_FIELD:
           name = parser.textOrNull();
           break;
+        case DESCRIPTION_FIELD:
+           description = parser.textOrNull();
+          break;
         case CONNECTOR_FIELD:
           connector = DataSourceType.fromString(parser.textOrNull());
           break;
@@ -74,7 +80,7 @@ public static DataSourceMetadata toDataSourceMetadata(XContentParser parser) thr
     if (name == null || connector == null) {
       throw new IllegalArgumentException("name and connector are required fields.");
     }
-    return new DataSourceMetadata(name, connector, allowedRoles, properties);
+    return new DataSourceMetadata(name, description, connector, allowedRoles, properties);
   }
 
   /**