feat: JSON schema changes to support URLs and description boxes (#874)

JSON schema changes to support URLs and description boxes Co-authored-by: Gayathri <[email protected]>
Zipstack · Dec 11, 2024 · 07963b2 · 07963b2
1 parent 5cc54da
commit 07963b2
Show file tree

Hide file tree

Showing 20 changed files with 25 additions and 40 deletions.
diff --git a/backend/workflow_manager/endpoint_v2/static/dest/db.json b/backend/workflow_manager/endpoint_v2/static/dest/db.json
@@ -1,6 +1,5 @@
 {
-    "title": "Workflow DB Destination",
-    "description": "Settings for DB Destination",
+    "title": "DB Destination Settings",
     "type": "object",
     "required": [
         "table",
@@ -13,13 +12,13 @@
             "type": "string",
             "title": "Table",
             "default": "",
-            "description": "Table to store the output. If your database supports schemas, use the format schema.table"
+            "description": "Table to store the output. If your database supports schemas, use the format `schema.table`"
         },
         "includeAgent": {
             "type": "boolean",
             "title": "Include 'created_by' column",
             "default": false,
-            "description": "Include the 'created_by' in the output row"
+            "description": "Include the `created_by` in the output row"
         },
         "agentName": {
             "type": "string",
@@ -28,7 +27,7 @@
                 "Unstract/DBWriter"
             ],
             "default": "Unstract/DBWriter",
-            "description": "Name of the agent to use as the 'created_by' value"
+            "description": "Name of the agent to use as the `created_by` value"
         },
         "includeTimestamp": {
             "type": "boolean",

diff --git a/backend/workflow_manager/endpoint_v2/static/dest/file.json b/backend/workflow_manager/endpoint_v2/static/dest/file.json
@@ -1,6 +1,5 @@
 {
-    "title": "Workflow File Destination",
-    "description": "Settings for File Destination",
+    "title": "File Destination Settings",
     "type": "object",
     "required": [
         "outputFolder"

diff --git a/backend/workflow_manager/endpoint_v2/static/src/api.json b/backend/workflow_manager/endpoint_v2/static/src/api.json
@@ -1,6 +1,5 @@
 {
-    "title": "Workflow API Source",
-    "description": "Settings for API Source",
+    "title": "API Source Settings",
     "type": "object",
     "required": [],
     "properties": {

diff --git a/backend/workflow_manager/endpoint_v2/static/src/file.json b/backend/workflow_manager/endpoint_v2/static/src/file.json
@@ -1,6 +1,5 @@
 {
-    "title": "Workflow File Source",
-    "description": "Settings for File Source",
+    "title": "File Source Settings",
     "type": "object",
     "required": [],
     "properties": {

diff --git a/tools/classifier/src/config/spec.json b/tools/classifier/src/config/spec.json
@@ -9,7 +9,7 @@
     "classificationBins": {
       "type": "array",
       "title": "Classification bins",
-      "description": "Specify at least two unique classification bins. 'unknown' and '__unstract_failed' are reserved bins. 'unknown' indicates the LLM can't determine the classification and `__unstract_failed` indicates a tool run failure for the given file.",
+      "description": "Specify at least two unique classification bins. `unknown` and `__unstract_failed` are reserved bins.\n - `unknown` indicates the LLM can't determine the classification\n - `__unstract_failed` indicates a tool run failure for the given file.",
       "items": {
         "type": "string"
       },

diff --git a/unstract/connectors/src/unstract/connectors/databases/bigquery/static/json_schema.json b/unstract/connectors/src/unstract/connectors/databases/bigquery/static/json_schema.json
@@ -1,6 +1,5 @@
 {
-  "title": "BigQuery database",
-  "description": "Designed with a patented new architecture to handle all aspects of data and analytics",
+  "title": "BigQuery Database",
   "type": "object",
   "required": [
     "connectorName",
@@ -17,7 +16,7 @@
       "format": "password",
       "title": "Credentials",
       "default": "",
-      "description": "You can download credentials from Google Clouds's iam-admin/serviceaccounts/Keys. Click on Add keys."
+      "description": "Refer [GCloud docs](https://developers.google.com/workspace/guides/create-credentials#create_credentials_for_a_service_account) on adding keys for service account"
     }
   }
 }
diff --git a/unstract/connectors/src/unstract/connectors/databases/mariadb/static/json_schema.json b/unstract/connectors/src/unstract/connectors/databases/mariadb/static/json_schema.json
@@ -1,6 +1,5 @@
 {
-  "title": "MariaDB database",
-  "description": "Designed with a patented new architecture to handle all aspects of data and analytics",
+  "title": "MariaDB Database",
   "type": "object",
   "required": [
     "connectorName",

diff --git a/unstract/connectors/src/unstract/connectors/databases/mssql/static/json_schema.json b/unstract/connectors/src/unstract/connectors/databases/mssql/static/json_schema.json
@@ -1,6 +1,5 @@
 {
-  "title": "MSSQL database",
-  "description": "Designed with a patented new architecture to handle all aspects of data and analytics",
+  "title": "MSSQL Database",
   "type": "object",
   "required": [
     "connectorName",

diff --git a/unstract/connectors/src/unstract/connectors/databases/mysql/static/json_schema.json b/unstract/connectors/src/unstract/connectors/databases/mysql/static/json_schema.json
@@ -1,6 +1,5 @@
 {
-  "title": "MySQL database",
-  "description": "Designed with a patented new architecture to handle all aspects of data and analytics",
+  "title": "MySQL Database",
   "type": "object",
   "required": [
     "connectorName",

diff --git a/unstract/connectors/src/unstract/connectors/databases/postgresql/static/json_schema.json b/unstract/connectors/src/unstract/connectors/databases/postgresql/static/json_schema.json
@@ -1,6 +1,5 @@
 {
-  "title": "PostgreSQL database",
-  "description": "Designed with a patented new architecture to handle all aspects of data and analytics",
+  "title": "PostgreSQL Database",
   "type": "object",
   "allOf": [
     {

diff --git a/unstract/connectors/src/unstract/connectors/databases/redshift/static/json_schema.json b/unstract/connectors/src/unstract/connectors/databases/redshift/static/json_schema.json
@@ -1,6 +1,5 @@
 {
-  "title": "Redshift database",
-  "description": "Designed with a patented new architecture to handle all aspects of data and analytics",
+  "title": "Redshift Database",
   "type": "object",
   "required": [
     "connectorName",

diff --git a/unstract/connectors/src/unstract/connectors/databases/snowflake/static/json_schema.json b/unstract/connectors/src/unstract/connectors/databases/snowflake/static/json_schema.json
@@ -1,6 +1,5 @@
 {
-  "title": "Snowflake data warehouse",
-  "description": "Designed with a patented new architecture to handle all aspects of data and analytics, it combines high performance, high concurrency, simplicity, and affordability at levels not possible with other data warehouses.",
+  "title": "Snowflake Data Warehouse",
   "type": "object",
   "required": [
     "connectorName",

diff --git a/...onnectors/src/unstract/connectors/filesystems/azure_cloud_storage/static/json_schema.json b/...onnectors/src/unstract/connectors/filesystems/azure_cloud_storage/static/json_schema.json
@@ -1,6 +1,5 @@
 {
   "title": "Azure Cloud Storage",
-  "description": "Access files in your Azure Cloud Storage with this connector",
   "type": "object",
   "required": [
     "connectorName",

diff --git a/unstract/connectors/src/unstract/connectors/filesystems/box/static/json_schema.json b/unstract/connectors/src/unstract/connectors/filesystems/box/static/json_schema.json
@@ -1,6 +1,6 @@
 {
-    "title": "Box connector",
-    "description": "A connector that allows for fetching data from Box content management(https://www.box.com/overview)",
+    "title": "Box Connector",
+    "description": "A connector that allows for fetching data from [Box content management](https://www.box.com/overview)",
     "type": "object",
     "required": [
       "connectorName",
@@ -15,7 +15,7 @@
       "box_app_settings": {
         "type": "string",
         "title": "Box App Settings JSON",
-        "description": "A JSON of your app configuration settings downloaded from the Box dev console. Ensure that the private key is filled and you're using an Enterprise Box account due to this issue (https://forum.box.com/t/free-developer-accounts-please-read/152/3)",
+        "description": "A JSON of your app configuration settings downloaded from the Box dev console. Ensure that the private key is filled and you're using an Enterprise Box account due to [this issue](https://forum.box.com/t/free-developer-accounts-please-read/152/3)",
         "format": "password"
       }
     }

diff --git a/...nnectors/src/unstract/connectors/filesystems/google_cloud_storage/static/json_schema.json b/...nnectors/src/unstract/connectors/filesystems/google_cloud_storage/static/json_schema.json
@@ -1,6 +1,5 @@
 {
   "title": "Google Cloud Storage",
-  "description": "Access files in your Google Cloud Storage with this connector",
   "type": "object",
   "required": [
     "connectorName",
@@ -18,7 +17,7 @@
       "title": "Credentials",
       "format": "password",
       "default": "",
-      "description": "You can download credentials from Google Clouds's iam-admin/serviceaccounts/Keys. Click on Add keys."
+      "description": "Refer [GCloud docs](https://developers.google.com/workspace/guides/create-credentials#create_credentials_for_a_service_account) on adding keys for service account"
     },
     "project_id": {
       "type": "string",

diff --git a/unstract/connectors/src/unstract/connectors/filesystems/google_drive/static/json_schema.json b/unstract/connectors/src/unstract/connectors/filesystems/google_drive/static/json_schema.json
@@ -1,6 +1,5 @@
 {
   "title": "Google Drive",
-  "description": "Access files in your Google Drive with this connector",
   "type": "object",
   "required": [
     "connectorName"

diff --git a/unstract/connectors/src/unstract/connectors/filesystems/http/static/json_schema.json b/unstract/connectors/src/unstract/connectors/filesystems/http/static/json_schema.json
@@ -15,7 +15,7 @@
       "base_url": {
         "type": "string",
         "title": "Base URL",
-        "description": "Base URL of the file server to connect to (for example: https://demo.unstract.connectors.com/)"
+        "description": "Base URL of the file server to connect to (for example: `https://demo.unstract.connectors.com/`)"
       },
       "username": {
         "type": "string",

diff --git a/...ract/connectors/src/unstract/connectors/filesystems/local_storage/static/json_schema.json b/...ract/connectors/src/unstract/connectors/filesystems/local_storage/static/json_schema.json
@@ -1,6 +1,5 @@
 {
     "title": "Local File Storage",
-    "description": "Local storage of the user`s machine, and enabling read/write to the specified file path.",
     "type": "object",
     "required": [
       "connectorName",
@@ -16,7 +15,7 @@
         "type": "string",
         "title": "Path",
         "default": "",
-        "description": "Path to restrict to. (example /path/to/restrict/to)"
+        "description": "Path to restrict to. (example `/path/to/restrict/to`)"
       }
     }
   }
diff --git a/unstract/connectors/src/unstract/connectors/filesystems/minio/static/json_schema.json b/unstract/connectors/src/unstract/connectors/filesystems/minio/static/json_schema.json
@@ -30,7 +30,7 @@
       "type": "string",
       "title": "Endpoint URL",
       "default": "https://s3.amazonaws.com",
-      "description": "Endpoint URL to connect to. (example https://s3.amazonaws.com)"
+      "description": "Endpoint URL to connect to. (example `https://s3.amazonaws.com`)"
     },
     "region_name": {
       "type": "string",

diff --git a/unstract/connectors/src/unstract/connectors/filesystems/zs_dropbox/static/json_schema.json b/unstract/connectors/src/unstract/connectors/filesystems/zs_dropbox/static/json_schema.json
@@ -1,6 +1,6 @@
 {
     "title": "Dropbox",
-    "description": "A connector that allows for fetching data from your Dropbox storage. Please note that this connector is in aplha and may not function as expected.",
+    "description": "A connector that allows for fetching data from your Dropbox storage. Please note that this connector is in aplha and is limited by the access token's expiry.",
     "type": "object",
     "required": [
       "connectorName",
@@ -16,7 +16,7 @@
         "type": "string",
         "title": "Access Token",
         "format": "password",
-        "description": "The generated access token from your Dropbox App Console"
+        "description": "The generated access token from your Dropbox App Console. [Here's](https://dropbox.tech/developers/generate-an-access-token-for-your-own-account) steps to generate one."
       }
     }
   }